Scheduling analytics
Schedule a single analytic or chain of analytics to run at a specific date and time and then set the frequency of the analytic job.
Required permissions
To schedule an analytic, you must have Full permissions for the folder containing the analytic. Only AX Server Administrators can schedule analytic chains.
Supported frequencies
| No frequency | High frequency | Medium frequency | Low frequency |
|---|---|---|---|
| run once, do not repeat | every 10 minutes | daily | monthly |
| every 20 minutes | every weekday | the last day of the month | |
| every 30 minutes | weekly | yearly | |
| hourly | every two weeks (bi-weekly) |
Changing scheduled analytics
If an analytic is edited after being scheduled and the required input parameters are changed, any schedules for the analytic are suspended and will not run. The analytic must be rescheduled and the appropriate input values provided. For more information, see Managing scheduled analytics.
Schedule an analytic
- In the Server Explorer, select the analytic you want to schedule and then from the menu, select Analytics > Schedule.
- If the analytic requires input values, select one of the following ways to define the input values:
- Use an existing set select a previously created input value set that includes all the required values and click Next
- Copy an existing set select an existing input value set to copy as the basis of a new set, enter a name to assign to the copy, and click Next
- Edit an existing set select a previously created input value set you want to edit and click Next
- Create a new set enter a name for the new input value set and click Next to define the values
- If you did not select Use an existing set of input values:
- Enter or edit table, field, or input values as required, and click Next.
Depending on the complexity of the analytic, you may need to enter several pages of information. To exclude optional input values, select Do not pass a value to the analytic.
Note
If multiple input values can be entered in a single field, press Enter after each value so that each value is on a separate line, unless the analytic instructs you to do something else.
- In the Confirm Analytic Input Values page, confirm the information you have entered is correct and click Next.
- Enter or edit table, field, or input values as required, and click Next.
- Optional. To publish results to AX Exception, in the Publish Results page, select Publish results to AX Exception and then enter the following and click Next:
- Table to publish select the analytic result table to publish
- Entity select or enter an AX Exception entity to associate with the results
- Analytic name select or enter an AX Exception analytic to associate with the results
- Publish select for each table you want to publish to AX Exception
Note
To publish results, AX Exception must be installed and configured for AX Server. If the analytic author specifies which tables to publish in the analytic, these fields are disabled.
To publish more than one table to AX Exception, click Add Row and enter the required information.
- In Set Schedule, specify the analytic schedule and click Next:
- Date select the start date for the analytic job schedule
- Time select the time that the analytic job runs
- Repeat select the repeat frequency for the analytic job
- Optional. Configure a failure notification email:
- In the Email address(es) for failure notification field, provide one or more email addresses to receive the notification if the scheduled analytic fails.
Separate multiple email addresses with semi-colons: john_doe@example.com;jane_doe@example.com.
- To attach the log files from the failed analytic to the email, select Attach log file(s) to failure notification.
Note
Email notification and log file attachments are only available if the required mail server configuration is completed on AX Server by your Analytics Exchange administrator. Email notifications with multiple senders and file attachments may trigger spam filters. For best results, ensure that your IT team marks your AX email from address as Not Spam.
- In the Email address(es) for failure notification field, provide one or more email addresses to receive the notification if the scheduled analytic fails.
- Review the scheduled times for the analytic job(s). Up to ten jobs are listed depending on the frequency. If the scheduled times are correct, click Schedule.
Schedule an analytic chain
- In the Server Explorer, select an analytic to include in the chain and then from the menu, select Analytics > Schedule Chain.
- Set the sequence of analytics in your chain:
- To add analytics to the chain, from the Server Explorer, select the analytics you want to include and on the right-hand side of the tree, click the plus button (+).
- From the chain list, select the analytics and on the right-hand side of the tree, use the up and down arrows to set the execution order of the analytics you added.
Analytics run sequentially from top to bottom. To remove an analytic from the chain, from the chain list, select the analytic and on the right-hand side of the tree, click the minus button (-).
- Specify parameters for an analytic by doing one of the following:
- To select an existing parameter set, in the Parameter Set column, click the drop-down arrow and select the parameter set to use
- To create a new parameter set or edit an existing one, in the Parameter Set column, click the drop-down arrow, select More, and then use the wizard to specify the parameter values
- Optional. To publish results to AX Exception, in the Publish Results page, select Publish results to AX Exception and then enter the following and click Next:
- Table to publish select the analytic result table to publish
- Entity select or enter an AX Exception entity to associate with the results
- Analytic name select or enter an AX Exception analytic to associate with the results
- Publish select for each table you want to publish to AX Exception
Note
To publish results, AX Exception must be installed and configured on AX Server. If the analytic author specifies which tables to publish in the analytic, these fields are disabled.
To publish more than one table to AX Exception, click Add Row and enter the required information.
- In Set Schedule, specify the analytic chain schedule and click Next:
- Date select the start date for the analytic job schedule
- Time select the time that the analytic job runs
- Repeat select the repeat frequency for the analytic job
Note
Ensure that you allow an appropriate amount of time for the analytic chain to process all of the analytics before the next occurrence of the scheduled chain job starts.
- Optional. To allow the analytics in the analytic chain
to continue processing even if one of the analytics in the chain
fails, deselect Stop analytic chain on failure.
By default, this is selected so that the analytic chain will stop processing in the event of a single analytic failure.
- Optional. Configure a failure notification email:
- In the Email address(es) for failure notification field, provide one or more email addresses to receive the notification if the scheduled analytic chain fails.
Separate multiple email addresses with semi-colons: john_doe@example.com;jane_doe@example.com.
- To attach the log files from the failed analytic to the email, select Attach log file(s) to failure notification.
Note
Email notification and log file attachments are only available if the required mail server configuration is completed on AX Server by your Analytics Exchange administrator. Email notifications with multiple senders and file attachments may trigger spam filters. For best results, ensure that your IT team marks your AX email from address as Not Spam.
- In the Email address(es) for failure notification field, provide one or more email addresses to receive the notification if the scheduled analytic chain fails.
- To save your analytic chain schedule, click Save.
View the status of a scheduled analytic
- From the menu, select View > Job Status and then from the Job Status pane, select the appropriate jobs tab:
- Analytic Jobs displays information about running, stopped, and completed jobs
- Scheduled Analytic Jobs displays information about scheduled, queued, and suspended jobs
- System Jobs displays information about system-generated jobs
Note
If your organization exceeds the maximum number of analytics that can be run simultaneously, additional ad hoc and scheduled analytic jobs are queued and start at the next available opening. The maximum job limit is configured by your Analytics Exchange administrator.
- Optional. At the bottom of the Job Status pane, filter the displayed jobs:
- To refresh the list of jobs, click Refresh
- To automatically refresh the list every 30 seconds, select Auto-refresh
- To filter by a time period, from the View History By list, select a value.
The analytic End Time in the server system time is used when calculating the time period an analytic falls into. If you select Today, results include all jobs that ended on the current calendar day. Periods are calculated from the current time to the same time x days prior.
Example A job that ends at 2:55pm on October 1 does not fall into the time period of 7 days at 3:00pm October 8th.
- To see the status of the job, in the Status column, review the icon that is displayed:
- the analytic succeeded
- the analytic failed
- To view more information about an analytic job in the list:
- Select the job from the list.
The Analytic Job Details tab opens in the Properties view and displays the Job ID and detailed information about the selected job.
- Optional. To view advanced job details in the Analytic Job Details dialog box, select Click for More.
Tip
Use the Analytic Job Details dialog box to review error messages and log files when investigating failed analytic jobs. If the analytic failed to run, the log file is included in the results even if the analytic does not contain the //RESULT LOG tag.
- Select the job from the list.
