Configuration Deployment
  • 27 Sep 2022
  • 10 Minutes to read
  • Contributors
  • Dark
    Light

Configuration Deployment

  • Dark
    Light

ON THIS PAGE

Understanding Deploy Configuration

Deploy configuration is a mechanism that lets you quickly deploy data components to your target environment, either through record-based migration or a dataset configured in your Salesforce org.

Validating the Datasets Before Actual Deployment

These step-by-step procedures identify how to validate the datasets before the actual deployment begins. 

  1. In your browser, navigate to: https://{my-organization}.autorabit.com
  2. Enter your login credentials.
  3. Click Login.
  4. Click on the Salesforce CPQ tile to, navigate to the Record Migrator portal.
  5. Click on the Deploy Configuration box.
  6. Select Create Dataset box, and click on Next.
  7. Select the Source Sandbox.
  8. Choose the configuration template and its template version from the App Config Template and Version dropdown respectively. This retrieves the objects that are part of the configuration template.
  9. For each object listed, you'll have a provision to apply data masking (encryption of sensitive details) to its records or apply a filter to extract records within a specified limit.
    Note:
    • Data Masking: Data masking refers to the process of changing certain data elements within a data store so the structure remains similar while the information itself is changed to protect sensitive information. This ensures that sensitive customer information is inaccessible beyond the permitted production environment. 
    • Filter: Enter criteria in the Filters section to extract records within a specified limit. 
  10. To apply data masking, click on the () icon.
  11. In the Data Masking popup screen, click on + Create New. 
  12. To create a masking rule,
    1. Give a name to the data masking rule in the Rule Name field.
    2. Choose the Field Type of the record, e.g., string, date, phone, etc.,
    3. Select the Fields (Records) from the list.
    4. Choose the Masking Style:
      • Prefix: This option adds the character before the selected field name. For example, if the field value in the source org is ABC, and the prefix masking value is kept as 123, then the final field value being deployed will be 123.ABC
      • Suffix: This option adds the character after the selected field name. For example, if the field value in the source org is ABC, and the suffix masking value is kept as 123, then the final field value being deployed will be ABC.123
      • Replace: This option substitutes the selected field name with the character you enter in the Masking Value field. For example, if the field value in the source org is ABC, and the replace masking value is kept as 123, then the final field value being deployed will be 123
      • Shuffle: This selection shuffles the data in the column (like a deck of cards) and leaves the other columns untouched. For example, if the field value in the source org is ABCDE, then the final field value being deployed might be DCBEA
      • Generate Random: This option is useful for masking the original value with a random value within a specified range. For example, if the field value in the source org is ABC, and the random string length value is set to 7, then the final field value being deployed might be something like 15d3aRG
    5. Enter the masking value
    6. Click on the Create button to save the masking rule.
    7. Click Apply to go back to the Objects page.
  13. In addition, you can also apply filters to extract the records based on the criteria specified. 
    1. Click on the Filter () icon.
    2. You can use either Add Group or Add Condition on your selected object to build a SOQL query in both conditions (AND / OR). To add a condition to your selected objects, for example, click the Add Condition button. To add multiple conditions, click Add Condition and then repeat the process.
    3. You can even filter the details via date or a date literal. A date literal is a fixed expression that represents a relative range of time, such as last month, this week, or next year. (Refer HERE for the list of data literals supported).
    4. The filter query gets added and displayed in the filter box. Multiple queries can be added based on your requirement. Validate your query to see if the query entered is stable or not. Additionally, you'll be able to view the number of records that will be fetched.
    5. The Limit box will limit the number of records to be extracted from the source, giving a value in this field.
  14. Click Next to proceed to the final screen where you need to give the process a Label Name.
  15. Save and you will be redirected to the Configuration Deployments summary page where you can track the deployment process recently created.
  16. Once the deployment is configured successfully, you can deploy the datasets to your destination environment. Click on the three-dot icon to the right, and select Deploy.
  17. Select the Destination Org from the dropdown.
  18. Next, specify the criteria for the deployment process. The table below lists the configurations to choose from along with their description:
    ConfigurationsDescription
    Disable Workflows RulesThe workflow of the Salesforce objects is deactivated, and the data is transferred from the source to the destination sandbox. Once the migration is completed, workflows are reactivated.
    Disable Validation RulesValidation rules verify that the data a user enters in a record meets the criteria you specify before the user can save the record. On selection, all the validation rules of the Salesforce objects are deactivated, and the data is transferred from the source to the destination sandbox. Once the migration is completed, validation rules are reactivated.
    Use Bulk APIThe Bulk API is based on REST principles, and it’s optimized for inserting, updating, and deleting large sets of data. You can use the Bulk API to process jobs either in serial mode or in parallel mode. Processing batches serially means running them one after another, and processing batches in parallel means running multiple batches at the same time.

    Note: When you run a Bulk API job, processing more of its batches in parallel means giving that job a higher degree of parallelism, which in turn gives your overall run better data throughput.
    Insert/update with null valuesThis will either insert or update record field values with null in the destination org.
  19. Click Deploy and you will be redirected to the Configuration Deployments summary page, where you can track the deployment triggered.

Deploying Datasets Using the Configuration Templates

This section provides step-by-step procedures to deploy the datasets to your destination environment.

  1. In your browser, navigate to: https://{my-organization}.autorabit.com
  2. Enter your login credentials.
  3. Click Login.
  4. Click on the Salesforce CPQ tile to, navigate to the Record Migrator portal.
  5. Click on the Deploy Configuration box.
  6. Select the Deploy Dataset box, and click on Next.
  7. Select the Source Sandbox.
  8. Choose the configuration template and its template version from the App Config Template and Version dropdown respectively. This retrieves the objects that are part of the configuration template.
  9. Choose your Destination Sandbox from the dropdown.
  10. For each object listed, you'll have a provision to apply data masking (encryption of sensitive details) to its records, field mappings, or a filter to extract records within a specified limit.
    Note:
    • Data Masking: Data masking refers to the process of changing certain data elements within a data store so the structure remains similar while the information itself is changed to protect sensitive information. It ensures that sensitive customer information is inaccessible beyond the permitted production environment. 
    • Filter: You need to specify criteria in the Filters section to extract records within a specified limit. 
    • Field Mappings: You can use an external ID in place of a related record's Salesforce record ID to relate or associate records with each other. For example, if Object B has a lookup field to Object A you can use the values contained in a field that's marked as an external ID on Object A to relate the two (Object B to Object A records).
  11. To apply data masking, click on the () icon.
  12. In the Data Masking popup screen, click on + Create New. 
  13. To create a masking rule:
    1. Enter a name for the data masking rule in the Rule Name field.
    2. Choose the Field Type of the record, e.g., string, date, phone, etc.,
    3. Select the Fields (Records) from the list.
    4. Choose the Masking Style:
      • Prefix: This option adds the character before the selected field name. For example, if the field value in the source org is ABC, and the prefix masking value is kept as 123, then the final field value being deployed will be 123.ABC
      • Suffix: This option adds the character after the selected field name. For example, if the field value in the source org is ABC, and the suffix masking value is kept as 123, then the final field value being deployed will be ABC.123
      • Replace: This option substitutes the selected field name with the character you enter in the Masking Value field. For example, if the field value in the source org is ABC, and the replace masking value is kept as 123, then the final field value being deployed will be 123
      • Shuffle: This shuffles the data in the column (like a deck of cards) and leaves the other columns untouched. For example, if the field value in the source org is ABCDE, then the final field value being deployed might be DCBEA
      • Generate Random: This option is useful for masking the original value with a random value within a specified range. For example, if the field value in source org is ABC, and the random string length value is set to 7, then the final field value being deployed might be something like 15d3aRG
    5. Enter the masking value
    6. Click on Create button to save the masking rule.
    7. Click Apply to go back to the Objects page.
  14. Next, to apply the field mappings, click on the () icon. Mappings are the process of matching objects and their related fields in your Salesforce org. You will need to ensure you have all required fields, as well as IDs, which are needed to verify data. 
    • In the Source field: Select which source field values will get populated in the destination External ID field.
    • In the Destination field: Select which required field from the destination org values will remain unique for all the records.
  15. You can automatically map the members and the fields using Automap. It compares the destination fields with the fields available for the object. If they both match, then the value is selected automatically.
  16. Click Save.
  17. In addition, you can also apply filters to extract the records based on the criteria specified. 
    1. Click on the Filter () icon.
    2. You can use either Add Group or Add Condition on your selected object to build a SOQL query in both conditions (AND / OR). To add a condition to your selected objects, for example, click the Add Condition button. To add multiple conditions, click Add Condition and then repeat the process.
    3. You can even filter the details via date or a date literal. A date literal is a fixed expression that represents a relative range of time, such as last month, this week, or next year. (Refer HERE for the list of data literals supported).
    4. The filter query gets added and gets displayed in the filter box. Nevertheless, multiple queries can be added based on your requirement. Validate your query to see if the query entered is stable or not. Additionally, you'll be able to view a number of records that will get fetched.
    5. The Limit box will limit the number of records to be extracted from the source, giving a value in this field.
  18. Click Next to proceed to the Review and Save screen, where you'll give the current process a label name and specify the criteria for your deployment process. The table below lists the configurations to choose from along with their descriptions:
    ConfigurationsDescription
    Disable Workflows RulesThe workflow of the Salesforce objects is deactivated, and the data is transferred from the source to the destination sandbox. Once the migration is completed, workflows are reactivated.
    Disable Validation RulesValidation rules verify that the data a user enters in a record meets the criteria you specify before the user can save the record. On selection, all the validation rules of the Salesforce objects are deactivated, and the data is transferred from the source to the destination sandbox. Once the migration is completed, validation rules are reactivated.
    Use Bulk APIThe Bulk API is based on REST principles, and it’s optimized for inserting, updating, and deleting large sets of data. You can use the Bulk API to process jobs either in serial mode or in parallel mode. Processing batches serially means running them one after another, and processing batches in parallel means running multiple batches at the same time.

    Note: When you run a Bulk API job, processing more of its batches in parallel means giving that job a higher degree of parallelism, which in turn gives your overall run better data throughput.
    Insert/update with null valuesThis will either insert or update record field values with null in the destination org.
  19. Click Deploy and you will be redirected to the Configuration Deployments summary page where you can track the deployment triggered.

Was this article helpful?