Create and edit chores

You can create chores to automate the execution of TurboIntegrator processes at defined intervals.

About this task

You must be a Planning Analytics Administrator or Modeler to be able to see chores in the Databases tree and have access to the chores shortcut menu options. To create or edit chores, you must also be a member of the Admin or DataAdmin group on the Planning Analytics database.
Note: To use chores, you must be running a Planning Analytics database version 11.3 or later. Planning Analytics database 11.3 is the version that is included with Planning Analytics version 2.0.5. If you are using a Planning Analytics database version prior to 11.3, chores will not be available in the Databases tree and you cannot create or edit chores in Planning Analytics Workspace.

Procedure

  1. To create a new chore:
    1. On a modeling workbench, expand the database in the Databases tree on which you want to create the new chore.
    2. Right-click the Chores group.
    3. Click Create chore.
    4. You can change the database where the chore is stored by selecting a database from the list. The current database is selected by default.
    5. Enter a Chore name.
    6. Click Create.
  2. To edit an existing chore:
    1. On a modeling workbench, right-click the chore in the Databases tree.
    2. Click Edit chore.
  3. Specify which processes are included in the chore.
    1. Click Add process.
    2. You can add both user-defined processes and control processes to a chore. To narrow the focus of available processes, click either Processes or Control processes.
    3. In the list of Available processes, click the Add icon for each process you want to add to the chore. The processed you select are added to the list of Selected processes.
    4. To delete a process from the list of Selected processes, click the Delete icon for the process in the list.
    5. Click Add.
  4. Set the order in which processes are executed.
    1. Click a process in the list of chore processes.
    2. Click Move up icon or Move down icon to move the process to the desired order in the chore. Repeat for any other processes until the desired execution order is set.
  5. You must set parameter values for any processes in the chore that include parameters. The values you set are passed into the process upon execution within the chore.

    If any process includes parameters that have not been set, an Info icon warns you of this condition.

    Process showing the need to set parameters
    1. Click the parameter listing for the process.
    2. Enter a value for each parameter.
    3. Click Save.
  6. Set the Commit each process individually option.

    When this option is enabled, each process in the chore is committed individually, as a series of separate transactions. Any locks that are required for a given process are held only for the duration of the process in which the lock is acquired.

    When this option is disabled, all processes in the chore are processed together and committed as a single transaction. Any locks acquired by any processes in the chore are held until the last process is complete. This means locks can potentially be held for very long periods of time.

  7. Specify the initial chore execution date and time, and set a subsequent execution interval. Chore execution time is set using Coordinated Universal Time (UTC).
    1. Click the Schedule tab.
    2. Click the Date box and pick the initial execution data.
    3. Set the execution time, using your local time, in the Time box. The time you enter is converted and saved as UTC.
      Cloud hosts on IBM® Planning Analytics on Cloud are configured for UTC time, which does not follow Daylight Saving Time. Even when the Daylight Savings Time Sensitive feature is enabled, the chore runs at the scheduled UTC time. Chores should be updated twice annually to ensure accurate execution time.
    4. Set a Frequency for chore execution, either Daily or Custom. If you select Custom, you can set the frequency of chore execution down to the second.
    5. Select the DST Sensitive checkbox if you want the chore time to be automatically updated when the daylight saving time starts or ends for the region in which the TM1 server is located.
  8. Enable the Scheduled option to activate the chore schedule.
    If you do not enable this option, the chore is saved on your database, but is not executed until you enable the schedule or execute the chore on demand.
  9. Click Save.

    You can optionally click Run to execute the chore immediately.