Admin: Deploying RPI
Prerequisites
Click this link to access documentation on deploying RPI in Kubernetes using Helm.
Commencing deployment
RPI is deployed using endpoints exposed at the Redpoint Interaction Configuration Home page. The following sections describes how to deploy RPI.
Run and set up the Configuration Service
To begin deploying RPI, run the Configuration Service container.
Once the service is running, browse to the Redpoint Interaction Configuration Home page. Click the Configuration Service button to display the Configuration Service Application Settings Editor. The editor can be used to identify environment variable names or generate appsetting files as per the pages described in the redpoint-integration-api Application Settings section above.
redpoint-interaction-api
redpoint-interaction-core-help
redpoint-interaction-execution-service
redpoint-interaction-node-manager
redpoint-interaction-plugins-callbackservicewebapi
redpoint-realtime-agent
redpoint-realtime-api
redpoint-realtime-plus-agent
Once any changes to default Configuration Service settings have been made, restart the container to pick up the same.
Execute the install cluster endpoint
Click the Swagger Documentation button in the Redpoint Interaction Configuration Home page’s API Help section to display the Redpoint Interaction Deployment API documentation.
In the Deployment section, locate the api/deployment/installcluster endpoint. Click to expand and view the endpoint’s payload signature.
Use the endpoint to create the server’s operational databases, and define the core user settings.
Install a tenant’s databases
Return to the Redpoint Interaction Configuration Home page. Click the Tenant Database Install button to display the Tenant Database Editor.
Use the editor to configure the accompanying JSON Output section, which is used to define the payload to be passed to the Add Client endpoint (documented below).
Note re. the Client ID setting: optionally, the AML client ID can be provided here to ensure alignment between the AML and tenant client IDs.
Using a template tenant
The Tenant Database Editor's Template Tenant property allows you to define whether you wish a new tenant to be based on an existing tenant. The RPI Configuration interface allows for the exporting of the following from an existing tenant:
Users in Tenant
User Groups
File System
Config Values
Offer History Queue Configuration
Auxiliary Database Configuration
The Template Tenant dropdown exposes three options:
No Template Tenant: the new tenant will not be based on an existing tenant.
Use Template Files: the new tenant will be based on file exported from an existing tenant.
Use Template TenantID: the new tenant will be based on another tenant within the cluster; this is done by passing that tenant's ID at invocation of the Add Client endpoint.
Execute the add client endpoint
Click the Swagger Documentation button in the Redpoint Interaction Configuration Home page’s API Help section to display the Redpoint Interaction Deployment API documentation.
In the Deployment section, locate the api/deployment/addclient endpoint. Click to expand and view the endpoint’s payload signature.
Use the endpoint to add a new tenant by creating its operational databases and specifying its data warehouse.
Download the RPI client application
Click the Client button in the Redpoint Interaction Configuration Home page’s Downloads section to download the Client.zip archive.
The Client folder contains all files necessary to run the RPI client application. Double click Interaction.exe to run the client.