Periodic jobs functionality allows you to automate recurring tasks, such as invoicing or running macros.
You can add only optional periodic jobs.
Go to the
Configuration menu → Integration → Periodic Jobs.
💡 For details on managing periodic jobs, see the https://help.xtm.cloud/xtrf/home-portal/configuration-menu/en/periodic-jobs.html article.
Click the Add button on top of the Periodic Jobs table. You will be directed to the Add page.
Select the periodic job’s Type
Type |
|---|
Description | |
|---|---|
Client Invoicing |
Filters and selects the tasks that will be automatically added to new Client Invoices within the configured time frame. To learn more about this periodic job, see the |
Automate client invoicing guide. |
Filter Subscription |
Pulls data from a browsing view with any filter combination applied to it and sends the filtered data to the list of |
e-mail subscribers. |
Macro Subscription |
Runs a macro and sends the results to a specified Home Portal user. | |
Overdue Invoices Reminder |
Sends notifications to a specified Home Portal user and, optionally, to the invoice signatory and the PM responsible for the jobs related to the overdue invoices. | |
Report Subscription |
Pulls data from reports and sends it to the list of |
e-mail subscribers. |
Time Control Synchronization Job |
Aggregates the work logs of selected groups for the selected time period and sends the summary to the recipients. | |
Vendor Invoicing |
Filters and selects the jobs that will be automatically added to new Vendor Invoices within the configured time frame. |
| Info |
|---|
The Text Message Delivery Check and WeLocalize Synchronization periodic jobs are deprecated. |
Provide a name for the new periodic job.
Click the Save button. You will be directed to the Periodic Job page.
In the Job Configuration section, select or
enter the
required settings.
This section’s content depends on the periodic job type.
Field name | Description |
|---|---|
Data to be Sent | Scope of the periodic job. |
View | By selecting a specific view, you can filter the data on which the periodic job will be executed. The available options depend on the Data to be Sent field value. |
Recipient Subscribers | Home Portal users who will receive the results of the periodic job. |
Reports and Subscribers | Select particular reports from the list and people to send them to. |
Invoicing details:
| Periodic jobs related to invoicing allow the automatic creation of client or vendor invoices. You can pre-configure some of the invoice settings. |
Macro | Select a macro that will be run automatically by a Macro Subscription type periodic job. The available options depend on the Data to be Sent field value. |
File Name Expression | You can use the following tags to generate unique file names for periodic job results exported to a .csv file:
Example: Expression for a periodic job with the selected view ‘Projects from last 30 days’:
Result name: ‘Projects from last 30 days 2021 8 11 18 54.csv’. |
XTRF Macro Executed as a Post-action | Select a macro that will be run automatically after this periodic job is executed. |
In the Execution Configuration section, decide when and how often the job has to be executed:
With the radio button, select one of the options:
Daily
Days per Week
Days per Month
Advanced
(For Daily and Days per Week options) From the Type drop-down list, select whether the job will be executed Once per day or Periodically.
Use the fields below to specify the
required schedule.
(For Advanced) Provide the appropriate Cron Expression.
In the Periodic Job Statistics section, you can check
The Number of Executions
Last Execution Time
Available logs for this job.
Click the Save button to confirm the changes.