Job Configuration
Last updated
Last updated
This is a reusable template that can be used to run, clone, and create a job every time a new job begins. This allows you to create a job in the replicate module and reuse the configuration as long as it is required, eliminating the need to recreate the job each time you need to work on the ‘Replicate’ module.
When creating the job configuration, select from: Backup, Hierarchical Backup, Archive, or Salesforce Live Data.
Access the “Job Config” under the “Replicate” module and create the “New Replicate Config” as shown below.
On clicking “New Replicate Config,” you will be prompted with “Replicate Config” with the dropdowns “Source”, “Destination”, and “Replicate Source.”
Replicate Source has the following values:
Backup
Hierarchical backup
Archive
Salesforce Live Date
For any selection of Backup, Hierarchical Backup & Archive.
Go to the “Replicate Config” page:
The following options are available to select:
Source Org: Source of the data for the Replicate operation
Destination Org: Destination where the data will be moved during the Replicate operation
Replicate Source: Defines the kind of data that will be sourced to the Replicate operation
Configurations: For the “Replicate Source” selected, provides the available configurations under the “Replicate Source”
You also have the table with the list of configurations created for the source selected.
Select the required ‘configs’ from the list of ‘configs’ selected.
On clicking “Next”, you will land on the “Select Components” page. There, you'll see “Metadata” and “Data” tabs.
The user can make the required selections under both the “Metadata” & “Data” tabs and continue to the next section.
Include all child objects: This selection ensures that all the child’s directly related and recursively related objects will be included.
Mappings: The user can click open and observe how the fields have been mapped for data transfer between the environments.
Records: The user can select the records by clicking the icon under the “Records” column.
Search Text: The user can search the fields.
Slider: By enabling and disabling the slider, the user can make the search case sensitive or case-insensitive
Choose File: The user can input the file using this option..
Change View: The user can the additional fields required to be displayed on the page and can remove the fields that are not required.
Masking Rules: The user can create and publish the rules under this section.
The user clicks on the “New Masking Rule” button to create the rule.
The rules that are created in a ‘Job Config’ will be specific to that unless it is published.
The following page will be displayed to the user on clicking the “New Masking Rule” button.
The user has to input the following for the creation of a rule:
Rule Name: Label/Name of the rule being created
Select Object: The object on which the rule is being created
Field Type: Type of field on which the rule is being created
Masking Style: Defines the pattern which will replace the data of the ‘Field Type” selected
“Add To VaultData Masking Rules List”: By selecting this checkbox, the user can directly add this rule to the global rules list.
The user can also publish a rule after saving the rule, by clicking the publish icon on the rule.
Once the user clicks the “Publish”, the following popup is displayed to the user for confirmation.
On clicking “OK”, the rule will be published and available with the global list of rules associated with the ORG.
On completing all the required actions, the user can click “Next” to continue to the “Config Details” section.
The user can fill in all required detail for the “Config Details”:
Replicate Config Label: The user can enter the name of the config to be created.
Batch Size: The user can specify the custom batch size and which Vault will utilize for processing the data.
Email Notification: The email to which the notifications can be triggered and sent.
The user can switch on all the required triggers available on the page.
Schedule: The user can set a custom schedule through the “Schedule” option available. The user’s set schedule will be utilized to run the job at different intervals.
Metadata: The user can observe the selected ‘meta data’ components during the config creation.
Data: The user can observe the objects that are selected during the config creation.
On completing all the required selections, the user can select either “Save” or “Save & Run”.
Save: Will save the config created. It will not trigger the job automatically while saving the job.
The user will observe “Save” on the “Replication Config Info” page if “Save” is selected.
Save & Run: Will save the config created and will trigger the job created to run, and, redirect the user to the “Job History” page.
The user can observe the related job running on the “Job History” page.
The user will see “Save & Run” on the “Replication Config Info” page if “Save & Run” is selected.
The user selects “Salesforce Live Data” on the “Replicate Config” window.
If the user selects “Salesforce Live Data”, then the user will land directly on the “Select Components” section of the Flow.
The User Can Verify Both The “Metadata” & “Data” tabs to go through the metadata components and objects in the data tabs, as shown below:
Include all child objects: Ensures that all the child’s directly related and the recursively related child’s will also be included.
To ensure optimal performance, only fixed objects are allowed to be selected. If any further child objects are to be selected, the selection can be made by going through the schema.
Mappings: The user will click on the mappings to map the fields on the source against the fields on the destination.
The mappings section contains three tabs: Fields, Record Type & Related Picklist.
The user can perform 'Automap' & 'Clear All' on the values of the tabs.
Fields: The fields on source are mapped against the field(s) on the destination.
Record Type: The record type on the source is mapped against the record type on the destination.
Restricted Picklist: On selecting the ‘restricted picklist’ from the source, the source field values will be mapped against the field values on the destination.
On completing the required selection on the tabs under the mappings, the users can perform ‘Apply’ & ‘Clear All.’
Filters: The user can input the query and can set the filter criteria for the records to be filtered. Once the user clicks “Publish”, a popup is displayed to the user for confirmation.
On clicking “OK” the rule will be published and be available with the global list of rules associated with the ORG.
On completing all the required actions, the user can click “NEXT” to continue to the “Config Details” section.
Ignore Failed Records: Enabling it will ensure that the nulls available in the source ORG will be pushed to the destination ORG.
Save: This saves the config created. It will not trigger the job automatically while saving the job.
The user will see “Save” on the “Replication Config Info” page if “Save” is selected.
Save & Run: Will save the config created and will trigger the job created to run and redirect the user to the “Job History” page.
The user can observe the related job running on the “Job History” page.
The user will observe “Save & Run” on the “Replication Config Info” page if “Save & Run” is selected.
Every entry has the following actions: Run, Edit, Clone, Schedule, & Delete.
Run: By clicking on the run icon, the following “Select Data to Replicate” screen will pop up.
Clicking “Replicate Now” will trigger the job and will create a new entry on the “Job History” page.
The user can verify and update any/all the details provided by the user during the “Job Config” creation.
Any changes or updates done to the “Config” created will only be applicable to the entry created in the “Job History” section. The Config will remain as it is created in its original state.
Edit: If the user clicks on the edit icon, the user will land on the edit flow of the Config, and, the user can perform modifications to the “Job Config” created.
The changes made to the config will affect the config entirely.
Clone: Clicking on the clone icon will pop the “Replicate Config” window to the user.
The user can select the “Source” and “Destination” ORGs and enter the label and click “Clone” to commence the clone operation.
The “Masking Rules” of the selected destination ORG, will be displayed to the user for selection.
On clicking 'Clone', an entry will be created on the “Job History” page.
Schedule: Will set a schedule for the config to automatically run periodically.
On clicking the “Schedule” icon, the “Replication Config Schedule” will be displayed to the user.
The user can select all the required entries to set the schedule.
On completing the required selection, the user can click on the “Save Schedule” button to save/set the schedule to the config being edited.
Delete: Will delete the CONFIG from the list of configs available. If a config is deleted, the corresponding job in the history will not be deleted.
