Cleaning Transactional Data
Service Board ships with only a few preconfigured transaction data objects. To configure transactional data cleaning, you can work only with these predefined transaction data objects, and you can also create additional custom transaction data objects as needed. After you set objects as transactional, you create Data Clean Templates and optional Data Clean Template Sets, perform a dry run, and then run data cleaning manually. To automatically run data cleaning at specific time intervals, you can configure System Jobs.
To clean transactional data:
1. To configure transaction data objects, in Max Designer, on the Developer Tools (
) launchpad menu, click Objects, and then in the list view, click an object.
) launchpad menu, click Objects, and then in the list view, click an object.2. On the record page, on the System Info tab, select or clear the Transactional Data check box, and then in the top left corner, click Save and Close (
).
).3. To create a Data Clean Template record, in Max Admin, on the System Management (
) launchpad menu, click Data Clean Templates, and then in the list view, in the top left corner, click Create (
).
) launchpad menu, click Data Clean Templates, and then in the list view, in the top left corner, click Create ().4. On the record page, complete the fields as follows, and then in the top left corner, click Save and Close ().
).Field | Action |
|---|---|
Name | Enter a name that describes the purpose of the template, for example, Rejected Appointments. |
Related Object | Select the transaction data object for which records are to be cleaned, for example, Appointment. |
Conditions | Define SMQL conditions to use for filtering records, for example, svmx_workflow = 'Reject'. |
Filter Operation | Optionally, select the custom Filter Operation you want to use with this template. |
Cascade Delete Related Records | Select the check box to enable cascade deletion of related records. |
5. To create a Data Clean Template Set to clean records by using multiple Data Clean Templates, in Max Admin, on the System Management () launchpad menu, click Data Clean Template Set, and then in the list view, in the top left corner, click Create ().
) launchpad menu, click Data Clean Template Set, and then in the list view, in the top left corner, click Create ().6. On the record page, complete the fields as follows, and then in the top left corner, click Save and Close ().
).Field or Tab | Action |
|---|---|
Name | Enter a name that describes the purpose of the template set, for example, Aborted Appointments, and then in the top left corner, click Save(  ). |
Data Clean Templates tab | In the list view, in the top left corner, click Link (  ), and then link the Data Clean Templates that you want to add to the template set. |
7. To perform a dry run, in a Data Clean Template or Data Clean Template Set record, in the top right corner, on the Options (
) menu, click Dry Run, and then when the dry run is completed, in the bottom right corner, in the notification box, click Download.
) menu, click Dry Run, and then when the dry run is completed, in the bottom right corner, in the notification box, click Download.8. Review the downloaded list of records to be deleted and make any needed adjustments, and then in a Data Clean Template or Data Clean Template Set record, in the top right corner, on the Options () menu, click Run.
) menu, click Run.9. To create a system job to automatically run data cleaning at specific time intervals, in Max Admin, on the System Management () launchpad menu, expand the System Management section and click System Jobs, and then in the list view, in the top left corner, click Create () and complete the fields as follows.
) launchpad menu, expand the System Management section and click System Jobs, and then in the list view, in the top left corner, click Create () and complete the fields as follows.Field, Tab, or Window | Action |
|---|---|
Name | Enter a name that describes the purpose of the system job, for example, Clean Deleted Aborted Appointment. |
Cron Expression | Enter a cron expression to define the automation schedule, for example, 0 0 2 ? * SUN. |
User | Select the user that has permissions to run this system job, for example, System Administrator. |
Operation | Select Data Clean System Job, and then in the top left corner, click Save( ). |
Parameters tab | In the list view, in the top left corner, click Create ( ). |
Create New System Job Parameter dialog box | Name: Enter a name for the parameter. |
Identifier: Enter data_clean_template. | |
Parameter Datatype: Select Dynamic Relationship. | |
Reference Field: Select Data Clean Template (Set). | |
Parameter Value: Select a Data Clean Template or Data Clean Template Set, click Save and Close. |
For more information: