Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

General Properties

The following properties are used for the superordinate definition of the schedule workers. This definition is independent of the specific tasks that the schedule workers execute.

Property

Description

Schedule[].Tenant

Schedule[].Name

Schedule[].Timer*

Schedule[].RunOnce

Properties for defining one or more schedule-worker instances running in parallel

These schedule-worker instances execute global tasks independently of the processing scenarios (e.g., for cleanup tasks).

Not all tasks must necessarily be related to a specific tenant. However, some task types do require naming by tenant, namely all those that access 1) the tenant-specific administration database, 2) the temporary storage, and, if logging is enabled, 3) the internal database. Always specify the name of the tenant under .Tenant (default value: Default).

The purpose of the property .Name is to give the instance a descriptive name for display in the log and in the Status Monitor (optional).

The property .Timer sets the execution time for this instance (syntax: see Miscellaneous).

The Boolean value .RunOnce is intended for the special case that the worker is only to start tasks exactly once at the first execution time during the runtime of the program, regardless of the success of this single execution (default value: false).

Schedule[].Task[].Name

Schedule[].Task[].Type*

Schedule[].Task[].BreakOnError

Any number of tasks can be defined by scheduler instance. They will be executed one after another at a specified time.

The purpose of the property .Name is to display the name of a task in the log and in the Status Monitor (optional).

The .Type property determines the type of the task. The following types are available:

  • DbTransfer: transfer of data records from one database to another

  • Macro: execution of a global macro function

  • UpdateCheck: check for and, if necessary, installation of available updates for the current program instance

  • XSuiteHelixDataImport: transfer of master data from xSuite-specific database tables to the Data Service in the xSuite Helix Cloud

  • XSuiteHelixLookupImport: transfer of master data from SAP or from a local data source to the Lookup Service in the xSuite Helix Cloud (This is an old procedure that has been replaced by XSuiteHelixDataImport )

Notice

Depending on the task type, additional properties must be configured. For more information, see Task "XSuiteHelixLookupImport" and Task "Macro".

The Boolean value .BreakOnError specifies whether a task is terminated if it fails to execute. If set to terminate, execution of all subsequent tasks will be cancelled (default value: false).