Create translation sets and links

A translation set is a list of individual translations, which map two values to each other. Learn about translation sets.

1. Review any translation sets in the environment on the Translation sets tab. Click the Create translation set button.
2. The translation set wizard opens. Enter the translation set name, then click the Next button.

   Name requirements

   A translation set name can't exceed 500 characters. Also, the name must be unique for each environment. In other words, staging and production environments can't have the same names for translation sets.

   The name appears as the column title for the translation set table.

   
3. Next, the Setup details tab opens. You can either:

1. Log in to the Redox dashboard.
2. From the side nav menu, click the Operations drop-down.
3. The Operations options expand. Click the Translations option.

   
4. By default, the Value sets tab displays. Click the Translation sets tab.
5. Any defined translation sets appear on the page.
6. To see details of a specific translation set, click the three-dots icon.
7. From the drop-down menu, click the View option.
8. The translation set's details appear.

1. Review any translation sets in the environment on the Translation sets tab. Find the translation set you want to edit. Click the three-dots icon.
2. From the drop-down menu, click the Edit option.
3. The translation set wizard opens. Add, edit, or delete translations in the set.

   Edit values in a translation

   Remember to edit a value set first if you need to edit specific values in a translation. Learn how to edit a value set.

   Changing directionality

   A translation set is bi-directional by default. However, a bi-directional set changes to uni-directional if you add at least two mappings with the same TO value. You must remove any TO-FROM links first, though, since you can't have TO-FROM links with duplicate TO values.

   To change a uni-directional set back to bi-directional, you must remove all mappings with duplicate TO values.

4. When you're finished, click the Update set button.

   

   Inactive value sets

   A translation set may point to an inactive value set version. However, once you edit an active translation set, it will automatically point to the latest active version of value set(s). In other words, you can’t edit an active translation set with outdated value set(s).

   If you don’t want to use the active version(s) of value sets, you can cancel out of any edits to the translation set.

1. Review any translation sets in the environment on the Translation sets tab. Find the translation set you want to delete. Click the three-dots icon.
2. From the drop-down menu, click the Delete option.

   Deleting a translation set

   You may not delete a translation set that's in use. Remove any links first to successfully delete a translation set.

3. A confirmation modal appears. Click the Delete button.
4. The translation set is successfully deleted.

   

To use a translation set, you must link it to the relevant stage of log processing (i.e., REQUEST and RESPOND or SEND and RECEIVE).

1. Review any translation sets in the environment on the Translation sets tab. Find the translation set you want to link. Click the three-dots icon.
2. From the drop-down menu, click the View option.
3. The translation set's activity and details display. Under the Links section, click the Link set button.

   Uni-directional sets

   You can't link a uni-directional translation set in the TO-FROM direction.

4. The translation set wizard opens. The Set name drop-down automatically populates with the translation set you selected on the previous screen. Or, you can select a different translation set from the drop-down.

   
5. Click the Next button.
6. The Select subscription tab opens. If the translation set is bi-directional, two options display for directionality. Select the radio button for the direction of this specific translation link.

   

   Two links for bi-directional translation set

   If you do want a translation set to be bi-directional, you’ll need to create two separate links, one for each direction. However, you can only create one link at a time.

   A note about directionality

   Technically, a translation set is bi-directional by default, so the value sets could be either FROM or TO values. The directionality only changes to uni-directional when you add at least two mappings with the same TO value from the drop-down on the right.

   You can link bi-directional translation sets either FROM-TO or TO-FROM. However, you can only link uni-directional sets FROM-TO. Learn more about directionality.

7. Next, click the Select subscription link.
8. A modal opens with the subscriptions in your environment. Use the Search field or the Connection drop-down to narrow down the available options. If needed, use the page options at the bottom of the modal to navigate through the pages. Then select the radio button of the subscription you want to link a translation set to.
9. Click the Select Subscription button.

   
10. After selecting a subscription, an edit option and the available stages in the log processing display. If your organization doesn't own a processing stage, the location is grayed out. From the When drop-down, select the processing stage (i.e., REQUEST, RECEIVE, RESPOND) to link the translation set to.
11. Click the Next button.

    
12. The Field paths section appears. Click the Select Field Path drop-down to view a list of fields.
13. Select the field you want to link the translation set to.
14. A modal opens for testing the field path and value. You can change your selection by clicking the Field Path drop-down again to view a list of fields.
15. Once you have the correct path, use the validation tools to test your choice. Or, if you don't want to test, you can skip and proceed to the next step.
    1. Find a log payload for the subscription you want to translate. Learn more about searching for logs.
    2. Copy and paste the log payload into the Test Message section.
    3. On the right side of the modal, under Field Values, the value that displays is the one found at the field path you selected.

       No Redox validation

       Keep in mind that Redox doesn't validate the translation set link. But it does give you an idea of whether you selected the right field path by using an existing log payload.

16. Click the Select Path button on the bottom right of the modal.

    
17. To add another field path, click the plus button next to right of the drop-down field. Repeat steps 12 through 16 for as many field paths you want to include in the translation set link.

    
18. Review the information for the link, then when you're ready. To edit any of the details, click the Previous button. If everything looks good, click the Create Link button.
19. The new link appears in the table, and it automatically takes effect on the related subscription.

    

    Operation details in logs

    If a log has undergone filtering or translation, you can view the related operation details when you click the related processing stage.

    Learn about data operations and:

    • log details for filters
    • log details for translation sets
    • log details for config modifiers (beta feature)

20. You can link the same translation set multiple times. To create another link, click the Link set button to repeat the process.

1. Review any translation sets in the environment on the Translation sets tab. Find the translation set you want to link. Click the three-dots icon.
2. From the drop-down menu, click the View option.
3. The Settings page opens. Under the Links section, find the link you want to edit or delete. Click the three-dots icon.
4. From the drop-down menu, click the Delete option or click the Edit option.

   Deleting a translation set link

   If you click the Delete button, a modal opens to confirm. You may delete a translation set link that’s in use. Logs will still process, but without the translation set link, no translation will happen.

5. The translation set wizard opens. Edit any of the details, then click the Update Link button.

   

After testing in staging, you can promote a translation set to production. Learn about promoting assets.

1. Log in to the Redox dashboard.
2. From the Environments drop-down, select the Staging environment.

   
3. From the side nav menu, click the Operations drop-down.
4. The Operations options expand. Click the Translations option.

   
5. By default, the Value sets tab opens. Click on the Translation sets tab.
6. The list of existing translation sets displays. Find the translation set you want to promote. Click the three-dots icon.
7. From the drop-down menu, click the View option.
8. The Settings page opens. Click the Promote button.
9. A modal appears to let you know you’re exiting the staging environment and proceeding to the production environment. Click the Proceed button. Otherwise, click the Cancel button to discard the promotion.

   
10. The Settings page in the production environment opens.
    1. To make any changes to the translation set, click the Go to Staging button.

       
    2. A modal appears to confirm that you want to switch environments. Click the Proceed button to continue.
    3. The translation set settings page opens in the staging environment. Follow the instructions to edit a translation set.
    4. Once changes are successfully made, re-promote the filter to keep the assets in sync across environments.
11. Next, add link(s) to subscriptions to apply the translation set in your production environment.

You can restore a version of a translation set that’s not currently in use. This may be helpful when troubleshooting to see where an error may have been introduced or to resolve an error by using a version that worked previously.

1. Follow the instructions for viewing existing translation sets.
2. From the list of existing translation sets, click on the translation set you want to update.
3. The Settings page opens. Click the Restore button.

   
4. A modal appears to restore a version. From the drop-down, select a version to restore.

   Restore notes

   Restoring means activating a version that’s not in use. That means you can go backwards or forwards a version. However, you can’t restore a version that’s already in use.

5. The diff view shows what’s different between the current and selected version. Review the differences. When finished, click the Restore button.

   Versions after editing

   If you edit an asset after restoring a previously used version, a new version is created.

   For example, let’s say you were on version 3 and you restore version 2. Then you make and save edits to version 2. This creates version 4 of the asset. At that point, you can still restore to version 3 at any time.

   
6. For promoted assets, restoring a version only applies to the current environment. If you restore a version in staging, you may need to re-promote the asset if you want to apply it to production as well.

   

   

   What happens to value sets?

   If a restored translation set points to an inactive value set version, the restored translation set will continue to use the inactive value set(s). Translations will still process as defined by the inactive value set(s).

   However, once you edit an active translation set, it will automatically point to the latest active version of value set(s). In other words, you can’t edit an active translation set with outdated value set(s).