Skip to main content

Step 2: Run DataMasker from DevOps

*This step is Optional

Overview​

Data Masking is a process to mask all sensitive data available in Sandbox which will prevent developers or other users from viewing sensitive data.

In the particular use cases where the Data Masking needs to be invoked by an external system, Cloud Compliance offers an API interface for masking sensitive data.

You can automate your Data Masking to be triggered from leading DevOps & CI/CD tools such as Copado, Gearset, Jenkins, AutoRABIT, Flosum, or GitHub.

This document explains how to invoke Data Masking configurations that are pre-configured via APEX-based callout. The API performs data masking of sensitive data in the relevant sandbox, the details of which are provided in the configuration.

The APEX APIs that are developed for this requirement are as follows:

  • Navigate->Configurations tab of the Data Masker application.

DataMasker's interface showcasing the 'Configurations' dropdown menu, indicating the selection step before executing APEX API data masking.

  • Click on the Configuration name. In this case, Click on ‘APEX API – UAT sandbox’.

Screenshot showing the 'APEX API - UAT Sandbox' configuration selected within the Data Masker tool for initiating data masking through APEX API

  • Copy the Configuration ID and paste this ID into the APEX API script that needs to be executed for data masking.

DataMasker interface displaying the APEX API configuration for UAT Sandbox with the Configuration ID ready for script integration.

Solution Steps​

  • Navigate-> Copado Release Management app and Make sure that ‘Destination org’ should be connected in Deployments.

Screenshot of the Copado Release Manager showing a successful CI deployment status for a UAT Sandbox environment.

Deployment step setup displaying an APEX script execution command for data masking within Copado Release Manager.

  • Select ‘Apex’ from the type of call-outs and use our Data Masking API to execute data masking. The input parameter is the Configuration ID which was copied above, for eg. ‘5856347d64232790a3157ca39f341477’pcldm.DM_DataMaskingService.execute(‘5856347d64232790a3157ca39f341477’);
  • Click on ‘Deploy’ and then ‘Deploy All’

CI/CD interface with buttons for 'Deploy', 'Cancel Deployment', 'View Deployment Status', and 'Show Hook URL'.

Deployment panel with 'Deploy All' option for executing an APEX script call to Data Masker in a CI/CD environment.

  • Check The Status

Dashboard notification indicating a 'Completed Successfully' status for a CI/CD deployment, with a checkmark icon.

Table row from Copado Deployment History showing an update from 'In progress' to 'Completed Successfully' for a deployment.

  • You can check the execution status in the DataMasker.

Execution record displaying 'Completed' status with all records processed successfully in the Data Masking tool.