User Documentation

Org Master

Summary:

Org Master holds various connected org, to create Org Master we need a Named Credential Name. For example, if we want to move data from production to sandbox, create org master record on production which points to sandbox.

   Follow the steps for creating an Org under Org master.
●   Navigate to App Launcher → iSyncSF → Tab → Org Master.
●   Click on New Button to create a New connected org.
●   Provide All Necessary Information.
●   Name: Provide User-friendly destination org Name, Example (UAT1)
●   Named Credential Name: Provide Valid Named Credential Name – How to Create Named Credential” – Click Here.
●   Authentication Mode: Keep this as “Named Credential” only.
●   Permission Set Name: Provide a permission set name which exists in the Destination Org, this permission set would be used when the application tries to create new Fields or Objects.
● Click the Save button.

Note:

Once you hit the save button, System will try to validate the named credential which you have provided. If Named credential is valid, System will populate the following fields automatically. (This is an async process so it might take a few seconds)
Is Production, Instance Name, Org ID, Org Name, Is Active.

 


 

Templates

Summary:

As the name suggests, this is just like a sandbox template; these templates store template lines & various settings for the data sync. Template contains a template-line that has a primary object and other related objects can be configured from the same template-line. For related objects, no sequence needs to be defined.

●   Following are the steps for how to Create Template.
●   Navigate to App Launcher → iSyncSF. And select tab’s Template.
●   Click on New Button to create a new template or click on edit to modify it.

Template Details:

●   Name: Provide logical template name (Example: CPQ Master Data or Project X Dev Sandbox)
●   Skip Transactional Objects – Check this, if you don’t want to include a transactional object’s record. User can mention transactional object list in the custom setting name: Data Sync Transactional Objects
●   Delta Sync? – Check this if the user wants to migrate data which modified or created after a specific date
●   Last Sync Date: By default, the system will store last sync data, but the user can override it based on the requirement.
●   Preview Batch Size: Default batch size is 100, Adjust this based on the expected # of related records, decrease the batch size if single record having high # of related records.

Template Line:

●   Click on Add New button
●   Select the object which you want to sync/migrate.
●   Multiple Objects can be added by clicking on the add new button again.

●   Click on Configuring Related Objects: – no need to add each object separately in each template line – simply select it from the popup – The application will maintain relationship and sequence internally.

●   Select the related objects based on the requirement.
●   Provide filter/limit & sort by for further data filtering.
●   Click on the save button to save the selection of related objects.

● Click on filter (icon) to filter the Template-Line Object.

●   Users can build the complex condition by adding groups
●   System will provide hint on expected value while changing fields
●   Click on “Apply” Button.

Example:

Let’s say a user wants to migrate Account, Opportunity, contact, cases & Product data from one org to another org.

●   Post creating template, Click on Add New to add blank template line
●   Select Account as object in template line
●   Click on gear icon to select related objects
●   Select opportunity, Opportunity line item, contact & cases.
●   Click on filter by icon to apply data filter
●   Since Product is not related to Account or any of their related objects, user needs to add new line and select the product object- just like account, user can select product’s related data also.
●   Click on ‘save line’ to save Template line configuration.

Preview:

●   User needs to click on the preview button, System will start processing in the background and the user will see the preview result on screen. (This operation might take some time depending on the amount of data)
●   Once the preview is completed, the user can see the # of records which need to migrate.
●   Users can also click on detailed report to see which all object/records are going to be migrated – verify this before executing the sync process.

Detailed Report:

●   This is a simple SFDC report which can be customized based on each organization’s requirements.
●   Verify the data before execute.

Execute:

The Execute Tab has 4 actions.

●   Select Destination org
●   Check Metadata/Mismatch
●   Start Sync
●   Detailed Report

Select Destination org:

●   Select the destination org from the pop-up
●   Users can see the Org ID, Org Name, Credential, Instance Name and Is Production flag.
●   Click anywhere on the row, to select destination org

Check Metadata/Mismatch:

●   This will provide list of fields/objects which are not available in Destination org
●   User can create fields/objects/record type in Destination org by clicking on Fix Metadata Mismatch button
●   Please note: Metadata which is part of a managed package, cannot be moved but it will be displayed to the user – so they can take required action.

Start Sync:

●   Finally click on Start Sync, this can take some time based on the data volume
●   Once progress is completed 100%, users can verify data on destination org or they can click on a detailed report for the same.

 
Detailed Report

●   This is a simple SFDC report which can be customized based on each organization’s requirements.

History:

●   In History, we can see past activities
●   Users can click on details to see if there are any errors during the data sync operation.


Object Settings

Summary:

Object settings are employed when specific configurations are required during data migration. This feature allows you to define unique parameters such as batch size, virtual key, and inclusion/exclusion of relationships. Utilizing object settings provides a tailored approach to ensure precision and customization in the data migration process.

   Following are the steps for how to Create Object Settings.
●   Navigate to App Launcher → iSyncSF → Tab → Object settings.
●   Click on New Button to create an Object Settings or click on Edit to modify it.

Information Section

●   Setting Name: Provide a predefined name object setting name.
●   Object API Name: Provide Object API Name which you want object specific setting to provide object api name.
●   Max Batch Size (Destination): # of max records processed in a single transaction.
●   Data Conceal Setting: Provide conceal setting object name when you created in conceal setting section.
●    If you created any object or custom object‘s JSON Data (Data masking) for Important and sensitive data in Conceal setting. And that object you defined Data conceal setting in object setting for this object all data are applied in data masking.
●   Update Existing Records? : If Checked – The system will perform an update operation on Existing records.

Migration Settings Section

●   Exclude Custom Child Relationship Name: if you want to same exclude data in migration process provide Comma-separated child relationship names.
●   Include Standard Relationships : comma-separated standard relationship name to include during sync
●   For Example: OpportunityLineItems,Quotes
●   Exclude Parent Fields : Comma-separated relationship field names to exclude during sync
●    Must use when recursive data structure

●   Text Relationship Fields: This field should contain a comma-separated field (Text field which needs to consider as a relationship field) API names.

●   Child Filter : This filed will store the child relationship name along with the filter condition
●   Unique Key Fields : Unique key identifier – there has to unique key fields in order to match the records (This fields can be, text/number/date/Boolean)
●    For multi-use Comma-separated field names to work as a unique key to match id in destination org
●    Long text area not supported
●   For Example: Name,IsActive,Fname,Lname
●   Custom External ID: This field will store the mapping of custom external id, if an external id does not exist, the system will create a destination record with source record id.
●    The value should be:SourceField=DestinationField
●   For Example: ID=CustomExternalID__C


Field Mappings

Summary:

The term “field mapping” encapsulates a pivotal role in the context of data migration, serving as the mechanism that delineates the correlation between fields in the source and destination objects. This mapping acts as a blueprint, dictating how data from one object should be transposed and aligned with the corresponding fields in another. In essence, it is a structured representation that ensures the seamless transfer of information, providing a clear and comprehensible guide for data transformation. The precision and accuracy of field mapping are instrumental in maintaining data integrity throughout the migration process, guaranteeing that information is accurately and coherently transferred from the source to the destination object.

   Following are the steps for how to Create Field Mappings.
●   Navigate to App Launcher → iSyncSF → Tab → Field Mappings.
●   Click on New Button to create an Field Mappings or click on Edit to modify it.

 Object Name: provide object name.
Source Field: provide Field name.
Org Master: If Org Master Provided, the system will override field value only for specific Org Otherwise, it will apply to all org.
Template: If a Template provided, the system will override field value only for specific Template Otherwise, it will apply to all templates.
Target Field: provide the Target Field name.
Update Check Field: Utilize this field when you intend to update the destination record in case the value of this field changes. By default, the system will update the record based on criteria or the last modified date. This is particularly beneficial in a two-way sync scenario where you only wish to initiate a record update based on specific field value change.

 


Conceal Settings

Summary:

This JSON-formatted summary encapsulates data masking settings. It defines parameters and configurations for concealing sensitive information. The structure adheres to the JSON format, ensuring seamless integration with systems that utilize or manage data masking functionality.

   Following are the steps for how to Create Conceal Settings.
●   Navigate to App Launcher → iSyncSF → Tab → Conceal Settings.
●   Click on New Button to create an Conceal Settings or click on Edit to modify it.

 Object Name: provide object name.
Object API Name: provide object API name.
JSON Data: Store custom JSON, Format {“FieldName”:”Mask Format”,”FIELDNAME2″:”Mask Format2″}
Example:
{
“NumberOfEmployees”:”[randomnumber]”,
“AnnualRevenue”:”[randomdouble]”,
“Phone”:”[randomtext]”,
“Industry”:”[randomtext]”
}