Create and Schedule Runs
The default DataMart schedule performs a delta incremental update of target database run once a day at 3 AM CT.
Each mapping contains an Actions column with a toolbar with a number of options depending on the status of the mapping:
-
Start Run
: Start a run for the selected mapping. This starts a delta run or a full brush rebuild of the target database from scratch if there is no previously successful full brush. When you run a mapping for the first time with this option, DataMart creates the target database from scratch. This typically takes longer than a delta run because a full database schema is created. After the initial run, DataMart pulls delta changes only.
-
Edit mapping task schedule
: Display the Update Mapping window where you can edit the mapping and its automatic run schedule.
-
Rebuild reporting database
: Rebuild the database from scratch, also known as a full brush.
-
Database update with a database schema update
: Refresh your database with a database schema update by clearing the data from the database tables and rebuilding them one by one. This is also known as a soft brush. This takes less time than a full brush, but more time than a delta run.
You can run this task during business hours, but we recommend that you only run this task outside normal business hours.
-
Delete Mapping / Run
: Delete the mapping.
DataMart is limited to 8 concurrent tasks. If the limit is reached, tasks beyond the limit are queued. The Execution Events pane indicates when a task queued.
Select a Mapping Schedule to view its run events and statistics in the Execution Events pane.
Edit scheduled run
A scheduled run only carries out a delta incremental update of target database run, it does not rebuild the reporting database or refresh your database with a database schema update unless you choose an option that triggers a full brush rebuild of the target database from scratch. Before editing a scheduled run:
-
Clear your browser cache and history
-
Confirm that your normal delta run completes in the allotted time if changing the scheduled run to a more frequent interval. For example, if your DataMart delta runs in 3 hours, do not schedule the run to less than every 3 hours.
Delta runs automatically pick up schema changes for both global fields with a version release and client configured fields.
-
On the Dashboard page, in the row of the mapping you want to change click Edit mapping task schedule
in the Actions column.
The Update Mapping window opens.
-
Click 3 Schedule.
-
Select the schedules on which you want to the mapping to run and enter the details:
-
Hourly: Number of hours between each run in Every X Hours.
-
Daily:
-
Every X Days: Number of days between each run.
-
At: Time you want the run to occur.
-
-
Weekly:
-
Days of the Week: Days of the week the run is to occur.
-
At: Time the run is to occur.
-
-
Times / Day: Times during each day that you want to schedule the run for in the 24 hour clock format HH:mm. After each time, press Enter. Available in DataMart Version 7.0.176 and later.
-
-
Click 4 Settings.
-
Select the Record Types and schema options you want:
-
Name: Enter up to 20 characters for the mapping name.
-
Record Types: Select the record types you want this mapping to pull from.
By default, the mapping pulls all record types.
-
PGP Encrypt: Use PGP encryption for this mapping. PGP encryption is applied to the stream of bytes sent from IWMS to DataMart. DataMart writes decrypted XML as it reads the encrypted stream from the IWMS RESTful endpoint.
-
Global Fields First: Retrieve global fields before retrieving user defined fields.
This causes the global fields to be added to the first partitioned table. User defined fields always start on the second partitioned table.
-
Only Global Fields: Only retrieve global fields for the mapping.
If you modify the Global Fields First or Only Global Fields settings on an existing mapping, the Trigger Full Run warning displays. If you click Save in the warning message. The next run is a full run, and DataMart re-partitions your tables.
-
Auto Schema: Enable incremental updates. These updates include schema changes so that your DataMart instance includes both user defined fields and new global fields without having to do a full brush rebuild of the target database from scratch.
DataMart checks the number of fields which exist on a database table. If the maximum number has been exceeded, new fields are added to a subsequent table.
-
-
Click Save.
Rebuild reporting database
A full brush rebuild of the target database from scratch removes your target database and rebuilds it from scratch. This removes the current DataMart tables and updates the target database.
Changed or created fields are picked up during a delta (incremental) run or a Soft Brush run. If one or more records are not picked up by a full brush, DataMart fetches the missing records in a final query at the end of each record type. This is currently in place for all record types except Equipment Contracts.
A full brush is not necessary if you have created new tables or fields in your Lucernex firm, as these are automatically updated during a scheduled run. Only select this option if you are starting a fresh installation or you suspect a data corruption problem.
You must only run this task outside of normal business hours. Contact your Accruent representative if you need to schedule a rebuild during business hours.
-
If you have not already done so, create mappings.
-
On the Dashboard page, in the row of the mapping you want to rebuild click Rebuild reporting database
in the Actions column.
-
To reorder your table partitions, select Re-order partitioned tables.
Reordering your table partitions could break SQL integrations written on top of DataMart which reference specific fields and their table locations. Review the following information before selecting this option.
When Global Fields First is selected:
-
If Re-order table partitioning is selected:
-
If a new global field has been added to Lucernex, it is added to the first table partition in alphabetical order.
-
Your user defined fields, including those added after the previous successful full run, are rearranged and sorted in alphabetical order starting from the second table partition.
-
-
If Re-order table partitioning is cleared:
-
If a new global field has been added to Lucernex, it is added to the end of the first table partition.
If there are multiple new global fields, they are added to the end of the first table partition in alphabetical order. Previously added global fields are not reordered.
-
Any user defined fields added after the previous successful full run will be added to the end of last partitioned table.
If there are multiple new user-defined fields, they are added to the end of the last partitioned table in alphabetical order. Previously added user defined fields are not reordered.
-
When Only Global Fields is selected:
-
If Re-order table partitioning is selected:
-
If a new global field has been added to Lucernex, it is added to the first table partition in alphabetical order.
-
-
If Re-order table partitioning is cleared:
-
If a new global field has been added to Lucernex, it is added to the end of the first table partition.
If there are multiple new global fields, they will be added to the end of the first table partition in alphabetical order. Previously added global fields are not reordered.
-
For foreign key fields:
If a foreign key field is a global field, it follows the table partitioning rules defined for global fields.
If a foreign key field is a user-defined field, it will follow the table partitioning rules for user-defined fields.
-
-
Click Yes.
-
Click Edit mapping task schedule
in the Actions column to edit the current schedule if the next scheduled run is during business hours.
-
Verify that your full brush run was successful on the Dashboard page:
-
Select the FINISHED row for your run in the Mapping Schedules pane.
-
Scroll to the last entry in the Execution Events pane.
If the full brush was not successful, check for errors and correct them. A successful full brush must occur before DataMart can start a delta incremental update of target database run.
-
Refresh database with a database schema update
You can fully refresh you DataMart data without erasing your current data and keep DataMart data available while the update takes place. This is known as a soft brush refresh target database with a database schema update by clearing the data from the database tables and rebuilding them one by one.
-
If you have not already done so, create mappings.
On the Dashboard page, in the row of the mapping you want to refresh, click Database update with database schema update
in the Actions column.
The Database update with database schema update? dialog opens.
-
Click Yes.
The dialog box closes. The database schema update runs in the background.
Start a run
This either starts a delta incremental update of target database run or a full brush rebuild of the target database from scratch if there is no previously successful full brush. When you run a mapping for the first time with this option, DataMart creates the target database from scratch. This typically takes longer than a delta run because a full database schema is created. After the initial run, DataMart pulls delta changes only.
If one previous full brush was successful and one previous delta run was successful, subsequent delta runs that fail trigger a new delta run that starts from the point where the previous successful delta run stopped.
-
If you have not already done so, create mappings.
On the Dashboard page, in the row of the mapping you want to run, click Start execution
in the Actions column.
A Confirm dialog opens.
-
Click Yes.
The dialog box closes. The run starts in the background.
Delete a mapping or run
You can delete a mapping and all its run event artifacts or you can delete a single run event artifact.
-
In the Mapping Schedules pane Actions column, do one of the following:
-
Click Remove mapping and all execution artifacts
in the row of the mapping you want to delete.
-
Click Remove execution artifacts
in the row of the run event artifact you want to delete.
-
-
In the confirmation dialog that opens, click Yes.