Settings
Overview
The objects displayed here have preconfigured settings for the following:
- Excluded
- External ID
- Excluded Fields
- Data Translations
- Data Masks
These are applied by default when creating a Data Template. For example, objects like AccountContactRelation, ApexClass, ApexPage, etc, will be excluded. You can change these using the Exclude Objects and Exclude Fields tabs.
External ID
External IDs are used by Salesforce to reconcile or create the parent-child relationships between the source and target object. When a field is marked with an External ID, its values can be used to match and associate related records to one another. This used by OrgTools to determine if the record already exists on the destination org. As a result, OrgTools is able to prevent duplicate inserts by performing an update operation in place of an insert operation.
When to create External IDs
If you have manually created records on the destination org or used another application to load data into the destination org, you must mark fields with external IDs. For example, you may be importing data from a .csv file with records that already exist in the destination environment and that don’t have a Salesforce record ID. To prevent creating a duplicate record, you would mark a field with an external ID in order to map the source and destination fields for that record.
If the data was populated through a sandbox refresh (i.e. Partial or Full Sandbox), or by the OrgTools application, you do not have to define External IDs as the ID mapping between the source and destination is automatically tracked internally by the application.
Note: external IDs supports composite keys.
Creating an External ID
Step 1. Click New External ID.
Step 2. In the External ID Form window, complete the following fields:
- Environment Object
- Source Field
- Destination Field
- Source RegEx: you have the option to apply a regular expression to the source field in order for its value to match with the destination field.
- Source Substitution: the value to replace the regular expression matched value.
Step 3. Click Save to continue.
Step 4. View or edit external IDs. (Optional)
Click on the object name to see a drop down of the external ID you have added. You can add additional external IDs for the same object by clicking the + button. Click to test the object’s RegEx. Click to remove all object external IDs. After you make an update to an external ID, click to save.
Exclude Objects
Exclude Objects is used to exclude any objects you may not want copied into the destination org. This can be because of data storage limitations or to filter for sensitive data.
If your object is not listed, this may be as a result of the object not having the following object and field-level permissions set to true: queryable, creatable, and updateable. Queryable is required to be true and either creatable or updatable must be true for OrgTools to be able to perform upsert and update operations.
Step 1. Enter object name. The value entered here will further filter from the selected alpha character.
Step 2. Select desired field and click Exclude or Include.
Note: you cannot exclude objects that have a positive record count. In order to exclude that object, perform an exclude record operation first. You can do so under the Record Selection tab.
Exclude Fields
Select fields on an object to exclude or include.
By default, OrgTools excludes fields that are encrypted, do not have a type of Blob, and are not calculated. Change these settings on the field in your source environment to see the fields populate in OrgTools.
Step 1. Enter an object name in the search bar. You can filter your search results down further by clicking on a letter.
Step 2. Select desired field and click Exclude or Include.
Data Translations
Transform source object field values and replace them with data that fits the requirements of the destination environment. Data translations are performed using the regular expressions you provide.
Step 1. Enter an object name in the search input using Search By Object. Alternatively, select Search Across Objects to search by field name.
Step 2. There are two ways to create regular expressions and substitutions in order to translate data.
Option 1 - Add Manually
Step 3. Select the desired field names and click Edit. In the Add Data Translation window, the object fields you choose will be displayed.
Step 4. Add the regular expression and its substitution pair in the text inputs and click Add.
To delete a pair, click Remove.
If multiple fields are selected, this window will display the data translations which are common amongst the selected fields.
Step 5. When finished, click Save.
Option 2 - Upload Files
Step 3. Select the desired field names and click Upload Files. File format must be .csv and formatted as follows:
myFirstImport.csv
\w,test
\s,fefe
Or
myFirstImport.csv
\w,test,\s,eit
Step 4. Click Edit to add a regular expression and a substitution pair for the data translation.
To remove a data translation, select the field name(s) and click Delete on the upper-right corner.
See Regular Expressions.
Data Mask
Manage and create data masks for projects, in contrast to creating global data masks in Organization Settings.
These data masks will be applicable only for the current data template. If organizational level or project level data masks are defined for the same fields as a data template level data mask, they will take precedence.
For a step-by-step guide and further information on creating data masks, see Data Masking.
Validations
By default, OrgTools will disable the following validation types:
Validation Rules
Required Fields
Lookup Filters
Allow Re-parenting Fields
Unique Fields
Hidden Fields
Read-Only Fields
Inaccessible Record Types
Triggers
Flows
Duplicate Rules
Workflows
Note: Metadata defined in managed packages cannot be disabled for certain metadata types. For example, if a managed package validation rule exists on a Standard Object, this would be disabled by the application. Conversely, if a managed package trigger exists, the application cannot disable this trigger because it is not modifiable by anyone other than the managed package vendor.
Note: To inactivate a trigger in Salesforce, the trigger must not have any active Apex Scheduled Jobs (i.e. Future methods) running while the application is inactivating the trigger.
Triggers are deployed using the Deploy() method of the Metadata API. All other validation types are enabled/disabled using CRUD operations.
The application uses the latest API version (i.e. Generally Available (GA)) when working with metadata.
Note: If a default record type is not defined for an object, it will automatically set the first record type as default.
Use this section to keep individual validations / validation types enabled during the data copy process. During a data copy, the application will only disable validations related to objects that are part of the data copy process (with the exception of Process Builder and Visual Flows).
- User starts Data Copy. In the Data Copy Confirmation window, checkmark the “Disable destination metadata during data copy.” checkbox to disable the validations during the data copy process (note: this option will be grayed out if the validations on the destination org are already disabled).
- If the validations are already disabled for the org, the application does not disable/re-enable the validations.
- If validations are not already disabled, the application will retrieve the validations associated to the objects that are being copied.
- OrgTools will save a backup of the validations which will be disabled.
- OrgTools will disable the validations on the destination org.
- Performs Data Copy
- OrgTools will retrieve the validations associated to the objects that are part of the data copy.
- OrgTools will enable the validations that were previously disabled in step 5.
- OrgTools will delete the backup taken on step 4.
To disable or enable all validations for an org, go to the Environment Hub Window, click the drop down arrow to the far right of the org’s row, and click Disable Validations.