Task Scheduler Configuration

Owned by Ada atrajer
Last updated: Aug 27, 2024 by Adam Davis
3 min read

Enable Task Scheduler

In order for Task Scheduler to appear in the Apliqo UX Settings dropdown list, following option needs to be enabled in default.constant.js file, which is available in the apq-c3-custom/ js folder.

"TASK_SCHEDULER_ENABLED":true,

Configuration

» Create 'externals' folder

In the settings.json file in the WEB-INF/config folder configure:

externalTasksFolderName: The location for storing the task files.

• ApliqoServer\webapps\appName\WEB-INF\config\tasks\externals

"taskSettings": { "externalTasksFolderName": "externals",

Note: externals folder is the default location for storing task files, however it will not be automatically generated. Please remember to add it manually under the location provided above before creating any tasks.

» Check printerStartingPort option

In the settings.json file in the WEB-INF/config folder configure:

printerStartingPort: In order for the export options to work correctly make sure to set the value for this option to 0.

"printerStartingPort": 0,

» Configure credentials

In the settings.json file in the WEB-INF/config folder under "taskSettings" configure:

credentials: Configure the instance, userName, useCAM and camNamespace:

  • instance: TM1 Instance

  • userName: TM1 User

  • useCAM: Set to 'true' if you're using CAM security (boolean values)

  • camNamespace: CAM Namespace (string value)

  • Input the password used as cleartext in the password parameter. It will then be encoded and encrypted and saved back into the file.

  • encryptedCredential will be auto-generated after restarting the Apliqo Application Services.

Note: Credentials need to be set per instance, as the CAM Namespace might differ, even when using the same username and password.

» Update Port number, host & Protocol

In the default.constant.js file in the apq-c3-custom\js folder configure:

  • "PORT_NUMBER":  Port Number - Apliqo Server is configured with. (e.g. 8880)

  • "TASK_BASE_PROTOCOL": Protocol - Apliqo Server is configured with. (e.g. http or https)

  • "TASK_BASE_HOST": Host DNS - Apliqo Server is configured with. (e.g. some-other.dns)

» Add credentials for the contentstore instance

Note: For the Task Scheduler to work properly it is necessary to add configured credentials to BatchJobCredentialJSON measure in }APQ UX Instance Attributes cube:

  • add configured credentials only for the contentstore instance

  • password and encryptedCredential are individually generated, please copy them from settings.json file

  • make sure that the added credentials match exactly those in the settings.json file (all data models need to be included)

» Email configuration

Task Scheduler allows users to send emails, configure the following SMTP settings in the settings.json file in the WEB-INF/config folder to enable this option:

"smtpPort": 22, 465 or 587