Quick Start#

Select the TRANSFORM>TARGETS menu on the left. From the targets list screen, clicking on the CREATE NEW FROM TEMPLATE button and select one of the available configuration. Two configuration templates are available:

• REGDATA examples / API library example which gives configuration example for encryption, tokenization and anonymization of fields often protected on RPS Platform (names, birth dates...)
• REGDATA examples / MailTrain integration example which provides a use case of protecting the MailTrain open source solution.

Click on the name of this new target (REGDATA examples) in the list and you will be directed to the target context where the configuration API library example is already present.

Select the TRANSFORM>TARGETS>CONFIGURATIONS>Instances menu on the left. You will find 5 data instances, Among them three properties "Birthdate", "FirstName" and "LastName", belonging to the class "User" and two properties called "Amount" and "Date" for the class "Payment". These will be the instances we will transform in the final step.

Under the TRANSFORM>TARGETS>CONFIGURATIONS>Transformations menu, you will find the transformations to be used on the instances shown above. There is eight of them, a protection and a deprotection for each property belonging to class "User" and an anonymization for the two remaining properties. The first three protections provide examples of the usual technics used: tokenization for birth dates, AES deterministic encryption of first names and AES based searchable encryption for last names, along with their respective deprotections. The anonymisations of the remaining fields do not require deprotection in this example, assuming the payment information is randomized for long term storage.

In TRANSFORM>TARGETS>CONFIGURATIONS>Rights Contexts you will find the rights contexts for this example. Rights can be set to Transform, Read or Not defined. Here all contexts (for each fields) are set to "Transform" for the user "Admin"

Processing contexts, defined in TRANSFORM>TARGETS>CONFIGURATIONS>Processing Contexts show the transformation to apply to a field as a function of the process (here "Deprotect" and "Protect", usually one could also find "Search"). As expected we find the protection context for all fields under "Protect" and deprotection context for fields of the class "User" under "Deprotect".

After reviewing the evidences set for the example in TRANSFORM>TARGETS>CONFIGURATIONS>Evidences, you can enable the configuration by going back to the TRANSFORM>TARGETS>CONFIGURATIONS menu on the left. You need to enable the configuration to start transforming data using that configuration via the Transform API. Click on the button on the right of the configuration and select Enable configuration.

Copy or download all the information showed in the confirmation window, such as the API key and the Secrets key. IMPORTANT: RPS SaaS platform does not store any API secrets. Lost or forgotten API secrets need to be regenerated by disabling and re-enabling the configuration.

Select the TRANSFORM>TARGETS menu on the left. From the targets list screen, clicking on the NEW TARGET button will open the form for the creation of a new target.

Enter the name of the new target and click on ADD.

The new target will be created and will appear in the targets list. Click on the name of the new target in the list and you will be directed to the target context. All new configurations will be created in this new target until you change the target context.

Click on the name of the target you just created. From the configurations list screen, clicking on the NEW CONFIGURATION button will open the form for the creation of a new configuration.

Enter the name of the new configuration and click on ADD.

The new configuration will be created and will appear in the configurations list. Click on the name of the new configuration in the list and you will be switched to the configuration context. You can now begin to define the configuration of your transformation in details.

Select the TRANSFORM>TARGETS>CONFIGURATIONS>Instances menu on the left. From the data instances list screen, clicking on the NEW DATA INSTANCES button will open the form for the creation of a new data instance. You can also access the data instances list by selecting the TRANSFORM>TARGETS>CONFIGURATIONS menu on the left and then click on the name of the configuration. you want to test.

In the New data instance panel on the bottom of the screen enter the Class name and the Property name. Then click on ADD. Your data instance will be created and added to the list.

Repeat the operation for each data instance you would like to create.

Select the TRANSFORM>TARGETS>CONFIGURATIONS>Transformations menu on the left. From the transformers sequences list screen, clicking on the NEW TRANSFORMER SEQUENCE button will open the page for the creation of a new transformers sequence.

In the new transformers sequence page enter the Name of the sequence, then click on ADD A TRASFORMER button in order to add transformers to the sequence.

For the sake of this quick start guide, please do not use the SELECT TEMPLATE functionality.

Select the transformer on the right part of the input panel using the Transformer name drop down. This drop down shows the full list of transformers that are available. You can filter the available transformers using the Transformer type, Applicable data entity type and Is searchable UI controls.

Enter the configuration parameters of the selected transformer.

For instance you can choose the AES deterministic encryption transformer; in this case you must enter an enter an encryption key, wich will be use by the AES deterministic encryption transformer to encrypt data instance values.

Then click on ADD A TRASFORMER button in order to add other transformers to the sequence or click on SAVE buttons to save the transformers sequence.

Select the TRANSFORM>TARGETS>CONFIGURATIONS>Rights Contexts menu on the left. From the rights contexts list screen, clicking on the NEW RIGHT CONTEXT button will open the wizard for the creation of a new rights context and for mapping it to the data instances.

Complete the following steps in the wizard to modify the rights context:

• Target: enter the name and, if wanted, the description of the rights context.
  For each data instance listed in the Rights on data instances list, click on Not defined and select the appropriate right from the drop down list.
  Within this quick start guide please select Transform context.
  Click on NEXT button to go to the second step of the wizard.
• Evidences: click on NEW EVIDENCE SET button in order to start adding the evidences sets to the definition of this rights context.
  For each evidences set add the evidences by entering the name and the value of each evidence, then click on the ADD NEW EVIDENCE button. Repeat the same operation for each evidence you would like to add to the set.
  Add other evidences sets or click on NEXT button to go to the last step of the wizard.
• Summary: Review all data. If they are valid, then click on the CREATE RIGHT CONTEXT button.

Select the TRANSFORM>TARGETS>CONFIGURATIONS>Processing Contexts menu on the left. From the processing contexts list screen, clicking on the NEW PROCESSING CONTEXT button will open the wizard for the creation of a new processing context and for the mapping of the data instances to the transformers sequence.

Complete the following steps in the wizard to modify a processing context:

• Target: enter the name and, if wanted, the description of the processing context.
  For each data instance listed in the Sequences on data instances list click on Not defined and select the appropriate transformers sequence from the drop down list.
  Click on NEXT button to go to the second step of the wizard.
• Evidences: click on NEW EVIDENCE SET button to start adding the evidences set to the definition of this processing context.
  For each evidences set add the evidences by entering the name and the value of each of them, then click on the ADD NEW EVIDENCE button. Repeat the same operation for each evidence you would like to add to the set.
  Add other evidences sets or click on the NEXT button to go to the last step of the wizard.
• Summary: Review all the data. If they are valid, then click on the CREATE PROCESSING CONTEXT button.

Select the TRANSFORM>TARGETS>CONFIGURATIONS>Evidences menu on the left. You will get an overview the evidences you used or defined in the previous steps for the the definition of the rights and of the processing contexts.

Go back to the Configurations list by selecting the TRANSFORM>TARGETS>CONFIGURATIONS menu on the left. You need to enable the configuration to start transforming data using that configuration via the Transform API. Click on the button on the right of the configuration and select Enable configuration.

Copy or download all the information showed in the confirmation window, such as the API key and the Secrets key. IMPORTANT: RPS SaaS platform does not store any API secrets. Lost or forgotten API secrets need to be regenerated by disabling and re-enabling the configuration.