Quick Start

This quick start guide describes how to create a configuration for transformations and how to do transformations.

The creation and the test of configuration for transformations is done in the RPS CoreConfiguration Web site.

The execution of the transformations on data is done using the Transform API

Setup

Before creating your transformation you need:

  • to be a registered user in RPS CoreConfiguration,
  • to select the account into which to create the transformation's configuration,
  • to belong to the Configuration user group of the selected account,
  • you also need to have a positive balance for the selected account.

Create your transformation

1) Define the target

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.

2) Define the configuration

Select the TRANSFORM>TARGETS>CONFIGURATIONS menu on the left. 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.

3) Model the data instances to transform

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.

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.

4) Define the transformers sequences

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.

5) Create and map rights contexts to data instances

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.

6) Map processing contexts to data instances and to transformers sequences

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.

7) Review the evidences

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.

8) Enable the transformation's configuration

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.

Test the transformation

You can test transformations requests to the Transform API directly via the web frontend of RPS CoreConfiguration

Select the TRANSFORM>TARGETS>CONFIGURATIONS menu on the left and then click on the name of the configuration you want to test. Then select the TRANSFORM>TARGETS>CONFIGURATIONS>Transform API menu on the left and click on NEW REQUEST button.

Enter the Secret key previously copied when enabling the configuration.

Complete the following steps in the wizard for generating a transformation API request:

  • Input: for each data entity enter the value you would like to transform.
    Select the evidences in order to define the rights context and processing context to be used for this transformation request. click on ADD NEW EVIDENCE button for each evidence to use.
    You can also click on the SELECT CONTEXT button in order to directly select the rights context and processing context to be used for this transformation request. The evidences will be filled automatically then.
    Click on the NEXT button to go to the second step of the wizard.
  • API Request: review the generated JSON body request in the left panel, and then click on the TRANSFORM button.
    The JSON response containing the result of the transformation will be displayed in the right panel.
    Click on CREATE REQUEST button to save this transformation API request for further tests.

Transform data

You now have your first transformation configuration defined, tested and ready to be used. In order to transform data in your application using RPS you have to:

  1. Request an authentication token using the Identity API endpoint, API key (#code[client_id]) and the Secret key (#code[client_secret]) obtained when enabling the configuration.
  2. Define the JSON transformation request as explained in the Transform API documentation, or using the TRANSFORM>TARGETS>CONFIGURATIONS>Transform API wizard in RPS CoreConfiguration.
  3. Execute the transformation request by providing the authentication token and the JSON transformation request to the Transform API endpoint.