Automation Schedules
Form ID: (SM205020)
On this form, you can select a processing form and schedule the automatic execution of a specific operation for documents that match certain conditions. Also, you can view other schedules that have been defined for the same form or other forms and modify them as needed. For details on using automation schedules, see Automated Processing: General Information.
Form Toolbar
The form toolbar includes standard and form-specific buttons and commands. For the list of standard buttons, see Form Toolbar and More Menu. The form-specific commands are listed in the following table.
| Button | Description |
|---|---|
| View Screen | Navigates to the form that is the object of automation. |
| View History | Opens the Automation Schedule History (SM205035) form. |
Summary Area
In the Summary area, you select an existing automation schedule for viewing or editing its settings or specify the settings of a new schedule.
| Element | Description |
|---|---|
| Schedule ID | The identifier of the automation schedule. When you are saving a newly created schedule, the system generates the identifier automatically based on the value in Description. |
| Active | A check box that indicates (if selected) that the automation schedule is active and can be used for automation. |
| Description | Required. A description of the automation schedule. |
| Screen ID | Required. The name of the MYOB Advanced processing or inquiry form, that is the object of automation. You click the magnifier icon in the box to open the Select Screen ID dialog box where you can select the form by searching or filtering by its title, screen ID, workspace, or category. |
| Action Name |
The action that the system should perform by schedule. If a processing form is selected in the Screen ID box, you select the <Operation> All option, because there is no way to perform a selection of the records for processing. If an inquiry form is selected in the Screen ID box, the value in this box is always Raise Business Event, which means that the system should raise and process the business events configured for this inquiry form on the Business Events (SM302050) form. |
Details Tab
| Element | Description |
|---|---|
| Starts On |
The date when the schedule starts. By default, the box contains the current business date. |
| Expires On | The date when the schedule expires. |
| No Expiration Date | A check box that indicates (if selected) that the schedule never expires. |
| Execution Limit | The number of times the schedule should be executed. |
| No Execution Limit | A check box that indicates (if selected) that the schedule can be executed an unlimited number of times. |
| Executions to Keep in History | The number of the latest schedule executions that are stored in the history. The oldest records of the schedule executions are removed from the schedule history along with the information about the processed documents if the number of records stored in the history exceeds the number specified in this box. |
| Keep Full History | A check box that indicates (if selected) that the automatic deletion of the execution history is disabled. Selecting this check box makes the Executions to Keep in History box unavailable. |
| Process with Branch |
The branch or the company without branches under which the schedule should be processed. For example, if documents are created by this schedule, the system creates these documents and specifies the selected branch or company for each document. By default, when the schedule is created, the system inserts in this box the default branch specified for the admin user. This box appears on the form only if multiple branches or companies are configured in the system and the currently signed-in user has access to multiple branches or companies on the form selected in the Screen ID box of the Summary area. |
| Executed | A read-only box that displays the number of times the schedule has been executed. |
| Last Executed | The date when the schedule was executed last. |
| Next Execution | The date when the schedule will be executed next. |
| Time Zone |
The time zone in which the schedule operates. By default, this is a time zone specified in the profile of the user who creates the schedule. If a time zone is not specified for the user, then it is time zone set for the application server. |
Schedule Tab
You can use the Schedule tab to specify particular the particular interval, days, and time to execute the action.
| Element | Description |
|---|---|
| Daily | An option button you select to configure the schedule to be executed daily. |
| Weekly | An option button you select to configure the schedule to be executed weekly. |
| Monthly | An option button you select to configure the schedule to be executed monthly. |
| By Financial Period | An option button you select to configure the schedule to be executed by financial period. |
| Element | Description |
|---|---|
| Next Execution Date |
Required. The date when the schedule will be executed next. The system fills in the value in this box automatically based on the value specified in Starts On on the Details tab and the values of other elements specified in this section. You can adjust the value in this box manually. |
| For the Daily schedule type | |
| Every x Day(s) | An integer that represents the time interval (in days) for action execution. For example, 1 means every day and 2 means every other day, starting on the date specified in Starts On on the Details tab. |
| For the Weekly schedule type | |
| Every x Week(s) | An integer that represents the time interval (in weeks) for action execution, with the boxes below indicating the day of the week when the action should be executed. You can select any of the check boxes below. |
| Sunday | A check box that indicates (if selected) that the system should execute the action on Sunday. |
| Monday | A check box that indicates (if selected) that the system should execute the action on Monday. |
| Tuesday | A check box that indicates (if selected) that the system should execute the action on Tuesday. |
| Wednesday | A check box that indicates (if selected) that the system should execute the action on Wednesday. |
| Thursday | A check box that indicates (if selected) that the system should execute the action on Thursday. |
| Friday | A check box that indicates (if selected) that the system should execute the action on Friday. |
| Saturday | A check box that indicates (if selected) that the system should execute the action on Saturday. |
| For the Monthly schedule type | |
| Every x Month(s) | An integer that represents the time interval (in months) for action execution, with the options below indicating the day of the month when the action should be executed. You can select one of the options below. For example, a 3 in this box represents action execution every three months. |
| On Day x | An option that configures the action to be executed on the specified day of the month. |
| On the Nth Day of the Week | An option that configures the action to be executed on the specified day of the week, such as 2nd Thursday. In the left box, you specify the ordinal number that represents the week in the month. In the right box, you specify the day of the week. |
| For the By Financial Period schedule type | |
| Every x Period(s) | An integer that represents the time interval between schedule executions, measured in financial periods, with the options below indicating the date when the action should be executed. All the transactions will be dated on this date. You can select one of the options below. |
| End of the Period | An option that sets the end date of the financial period as the day when the action should be executed. |
| Start of the Period | An option that sets the start date of the financial period as the day when the action should be executed. |
| Fixed Day of the Period | An option that defines a particular day of the financial period when the action should be executed. |
| Element | Description |
|---|---|
| Starts On | Required. The hour and minute when the first session of the schedule should start. |
| Stops On | The hour and minute when the first session of the schedule should stop. When the specified time comes, the system finishes processing of the current document (if the processing is in mid-document at the stop time) and proceeds with the next documents at the next execution time. |
| Every |
The interval in hours and minutes between successive sessions of execution if the schedule must be executed multiple times a day. If you specify a value in this box, you must specify the value in the Stops On box. |
| Next Execution Time |
Required. The time when the next session should start. When the schedule is created, the system inserts in this box the default value that depends on the current time and the value selected in the Starts On box. |
| Exact Time |
A check box that indicates (if selected) that the schedule should be executed next at exactly the time specified in the Next Execution Time box. If the check box is cleared, the system may shift the next execution time of the schedule by multiple minutes. We recommend that you select this check box if another schedule that depends on the current schedule should be executed after the current schedule. By default, this check box is cleared. |
Conditions Tab
On the Conditions tab, you define the conditions for the schedule to be executed. If documents or records on the MYOB Advanced form specified in the Screen ID box match the conditions specified here, the action specified in the Action Name box of the Summary area will be executed for this document.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.
| Column | Description |
|---|---|
| Active | A check box that indicates (if selected) that the condition is active. |
| Field Name | The field on the selected form. You can set up conditions on the field value. |
| Condition | The logical operation to apply to the value of the selected data field. The following options are available: Equals, Does Not Equal, Is Greater Than, Is Greater Than or Equal To, Is Less Than, Is Less Than or Equal To, Contains, Starts With, Ends With, Does Not Contain, Is Between, Is Empty, and Is Not Empty. |
| Relative | A check box that indicates (if selected) that the value of the date field is relative with respect to the current business date. This option is used only if the field selected in the Field Name column for this row is a date field. |
| Value | The first value of the condition to be compared with the value of the data field selected in this row. |
| Value2 | The second value of the condition, if required by the condition selected in this row. Most of the conditions require only one value to be specified, while Is Between requires two values. |
Filter Values Tab
If the scheduled form (the form selected in the Screen ID box of the Summary) is a processing form that has a Selection area, on this tab, you can assign values to any of the elements in the Selection area of the form that has been selected for processing. This tab appears on the form only if the processing form has a Selection area.
If the scheduled form is a generic inquiry form with parameters, on this tab, you can assign values to any of the parameters of the generic inquiry. This tab appears on the form only if the generic inquiry has parameters.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.
| Column | Description |
|---|---|
| Active | A check box that indicates (if selected) that the condition is active and will be used during schedule execution. |
| Field Name | The field in the Selection area whose value you want to set or the parameter of the generic inquiry. |
| Relative |
A check box that indicates (if selected) that the field value is relative with respect to the current business date. This option is used only if the field selected in the Field Name column for this row is a date field. The system calculates delta between the current business date and the date you specify in the Value column. On every execution, the system applies the delta to the execution date and filters data using the resulted date. For example, you need an automated schedule to prepare and email customer statements on the 1st of the month. You need the system to filter customer data on a date that is the day before the execution date. When you configure the schedule, you select Statement Date field in the Field Name column, select the Relative check box and specify yesterday's date (with respect to the current business date) in the Value column. When you save the configuration the system calculates the delta between the current business date and the date you specified, which is minus one (-1). The system will apply the delta to the execution date and use the resulted date to filter customer data. |
| Value | The value to be assigned to the field selected in the Field Name column for this row. |
| Ignore Error |
This check box is obsolete and is preserved for backward compatibility. A check box that indicates (if selected) that the system should ignore any errors occurred during processing with the specified field value or execution of the generic inquiry with the specified parameter value. |
Events
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.
| Column | Description |
|---|---|
| Event ID | The unique identifier of the business event. You can click the link in the column to open the Business Events (SM302050) form for the selected event. |
| Description | A description of the business event. |
| Active | A check box that indicates (if selected) that this business event is active and the system can process the subscribers specified on the Subscribers tab if this business event has occurred. |
| Type |
The type of the business event, which can be
one of the following:
|