Configure the Reltio UI for BvD on-demand buttons

Learn how to configure the Reltio UI for BvD on-demand buttons so that BvD actions appear in the Organization profile side panel.

Configure the Reltio UI to add BvD on-demand buttons to the profile side panel.These buttons use the RIH proxy to send secure requests to the configured Integration Hub endpoint and support actions such as BvD match, company information retrieval, and hierarchy or contact enrichment.

After you complete this configuration, you can run BvD actions directly from the profile side panel.

Prerequisites

You have access to Console > UI Modeler.
You have created a Reltio Support ticket to request RIH proxy creation for your environment.
Your ticket includes the Reltio tenant ID, environment, and RIH API profile name.
The RIH API profile name does not contain spaces or special characters.
You have the BvD API endpoints configured in your Workato environment.
You have a backup of the current config.json.

To configure the UI for BvD buttons

In the Console, select UI Modeler.
Generate an access token for the RIH proxy. For more information, see Create Access Token for RIH Proxy.
From the left navigation menu, select Import/Export UI Config Files. The Import/export UI Config files page is displayed.
Select the config.json file by clicking on the checkbox next to it.

Click Export. The file is exported to your local file system.

Open the downloaded JSON file in a text editor.
Under the entity definition, add the required sidePanelViews. For more information, see Configure profile screens.
If the BvD buttons do not appear, confirm that the updated config.json file was published to the correct environment.

Add the BvD button definition object with "id": "BvD".

Example

{
                            "id": "BvD",
                            "views": [
                                {
                                    "point": "com.reltio.plugins.ui.view",
                                    "id": "com.reltio.plugins.entity.org.BvDMatch",
                                    "class": "com.reltio.plugins.ui.CustomActionView",
                                    "label": "BvD match",
                                    "url": "https://tst-01-rih-proxy.reltio.com/api/v1/proxy/workato/invoke_endpoints?xxx=",
                                    "success": "Success:",
                                    "fail": "Failure:",
                                    "loading": "Loading...",
                                    "height": 34,
                                    "profileName": "<profile_name>", // fetched from previous doc
                                    "workatoEndpoint": "https://apim.workato.com/reltioapi/bvd-v1/tst-01/BvDIntegrationCT/match",
                                    "proxyMethod": "GET",
                                    "action": {
                                        "permissions": [
                                            "https://tst-01-rih-proxy.reltio.com",
                                            "https://apim.workato.com"
                                        ],
                                        "files": [
                                            "https://reltio-ui-files.s3.amazonaws.com/custom-scripts/b2b_application_bvd_proxy.js"
                                        ]
                                    }
                                },
                                {
                                    "point": "com.reltio.plugins.ui.view",
                                    "id": "com.reltio.plugins.entity.org.BvDDetails",
                                    "class": "com.reltio.plugins.ui.CustomActionView",
                                    "label": "BvD details",
                                    "url": "https://tst-01-rih-proxy.reltio.com/api/v1/proxy/workato/invoke_endpoints?xxx=",
                                    "checkAttributeToEnable": "BvDId",
                                    "success": "Success:",
                                    "fail": "Failure:",
                                    "loading": "Loading...",
                                    "height": 34,
                                    "profileName": "<profile_name>",
                                    "workatoEndpoint": "https://apim.workato.com/reltioapi/bvd-v1/tst-01/BvDIntegrationCT/hierarchy",
                                    "proxyMethod": "GET",
                                    "action": {
                                        "permissions": [
                                            "https://tst-01-rih-proxy.reltio.com",
                                            "https://apim.workato.com"
                                        ],
                                        "files": [
                                            "https://reltio-ui-files.s3.amazonaws.com/custom-scripts/b2b_application_bvd_proxy.js"
                                        ]
                                    }
                                }
                            ]
                        }

Replace the url value with the RIH proxy URL provided by Reltio Support.
Replace <profile_name> in profileName with the profile name created for the RIH proxy.
Replace the workatoEndpoint value with the BvD real-time REST API endpoint configured in your Workato environment. Do not change the parameters in the workatoEndpoint value.

Note: If the environment is not tst-01, change the action.permissions URL from https://tst-01-rih-proxy.reltio.com to https://360-rih-proxy.reltio.com.
Save the config.json file.

In the UI Modeler, select the configuration file, and then select Import & Replace. The Select file page is displayed.
1. In the Browse File filed, select the updated configuration file that must be imported and replaced.
2. Click Continue. The Review page is displayed where you can review the changes.
3. Select Replace. This action replaces the current configuration with the Imported configuration file.
4. Select Publish.

Result

The BvD buttons appear in the side panel of the profile in the Reltio UI. You can use these buttons for BvD-related actions, including record enrichment.

The BvD Details button remains inactive until you run BvD Match and merge a suitable potential match with the entity so that the entity receives the BvD Identifier attribute.

Verification steps

Open the profile in the Reltio UI.
Confirm that the BvD buttons appear in the side panel view.
Select BvD Match and confirm that the action starts as expected.
After the entity receives the BvD Identifier attribute, confirm that the BvD Details button becomes active.

Unify and manage your data

Configure the Reltio UI for BvD on-demand buttons

Footer