Skip to main content
Nederlands
Nederlands

Service Task parameters

For each service task, a number of parameters are added by default, depending on the type of service task you selected.

Below is a list of possible additional parameters you can configure.

Service task detail

On the detail page of the service task itself, the following fields can be filled in:

Field Comment
Name Enter the name of the service task
Type task Select the type of service task you want to run
Planningstype Possible values are:
  • Daily: performed once a day
  • Weekly: runs on selected days
  • Monthly: executed on the selected days in the selected months
  • Manual: is not executed automatically. The user must start the process.
  • Continuous: executed every 5 minutes
Months Appears only as an option when you have selected "Monthly" as planning type
Days Appears as an option only when you have selected "Monthly" or "Daily" as the planning type
Startdate This is the day on which the scheduled task will be executed the first time
Time The time at which the task should start
State Possible values are:
  • Unknown: this appears if the task was never executed
  • Waiting: this task has been activated to be executed, but the process has not yet started
  • Ongoing: this task is being performed
  • Successful: the task has been completed successfully
  • Failed: task execution failed. Check the log for the error message
Active Indicates whether this service task is still actively used. If unchecked, it is not executed on the specified schedule.

 

Additional parameters

Code Comment
API The external API used to send event notifications
APIOAuth Ask the external API for a token before sending triggers to the event notification API
BackupLocation This is the location where a copy of the export file is kept. Note: this may only be a local disk path - check with the epowerhr helpdesk.
Encoding If the exported file is a CSV file, you can specify the encoding for this CSV file here. Possible values:
  • utf-7
  • utf-8
  • utf-16
  • utf-32
  • ASCII
  • Unicode
ExecutingType

This parameter is only used for the Protime export.

Possible value

  • Manually: if this value is entered, the application will not mark the exported records with an export date.
File

This is the name of the export file. This name can be dynamic with the following substitute values:

  • %D% --> date format yyyymmdd
  • %T% --> time format hhmmss
  • %SequenceNumber:Calendar% --> the sequence number on the SD Worx Calendar interface

Bv. %SequenceNumber:Calendar%_CAL_%D%%T%.xml
Filter This parameter can be used for the service task:
  • Compress files: here you can put a wild card expression of which files are to be compressed, e.g. employees*.txt
FTP If a file is to be exported to a specific (s)FTP server, you can enter the ID of the remote account in this field.
Location

This contains the path where the file should be saved, e.g. /prd/out/

Note: do not forget the slash at the beginning and at the end
Mail Each time the task is completed, a message is sent to the e-mail address(es) specified in this field. If you specify multiple e-mail addresses, they should be separated by a comma. This parameter will not work if used in combination with the "MailOnError" parameter.
MailOnerror Each time the task is completed and has the status "Failed", a message is sent to the e-mail address(es) specified in this field. If you specify multiple e-mail addresses, they must be separated by a comma. This parameter does not work when used in combination with the "Mail" parameter.
Mime Do not use any more
MininumFiles Can only be used for service task type "Compress files". Specifies the minimum number of files that must be available before the ZIP file is compressed
Report This field contains a dropdown with the existing reports in the application that can be scheduled to be run via a service task.
SplitFilesAfterLines If the export should only contain a maximum number of lines, you can enter a numeric value here to indicate that an additional file should be created after every X lines. This can only be used for the export of Protime scheduled training sessions.
SQL Do not use any more
Template Do not use any more
XML For some service tasks, you can create a more advanced configuration. Documentation on how to use this XML option is beyond the scope of this article.