Running analytics
Run analytics immediately for ad hoc analysis without setting up a recurring schedule. To run an analytic, you must have Full permissions for the folder containing the analytic.
Note
If you want to run an analytic that publishes a table to AX Exception, you must schedule the analytic, even if you schedule it to run immediately. For more information, see Scheduling analytics.
Run an analytic
- In the Server Explorer, select the analytic you want to run and then from the menu, select Analytics > Run.
- 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 Run
- 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 Run.
- Enter or edit table, field, or input values as required, and click Next.
View the status of an 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.