Connect to HCL Domino Data in RunMyProcess through Connect Cloud

Akorbi Digital RunMyProcess makes it easy to create applications for complex business applications, such as budget application and contract management. CData Connect Cloud creates a live connection to HCL Domino and can be used to generate an OData API (natively supported in RunMyProcess) for HCL Domino. By pairing RunMyProcess with CData Connect Cloud, you get true cloud-to-cloud connectivity to all your SaaS and cloud-based Big Data and NoSQL sources - no need to migrate your data or write your own integrations. Simply connect to Connect Cloud from RunMyProcess as you would any other REST service and get instant, live access to your HCL Domino data.

In this article, we walk through connecting to HCL Domino from CData Connect Cloud and accessing HCL Domino data through an OData feed in RunMyProcess.

Connect to HCL Domino from RunMyProcess

To work with live HCL Domino data in RunMyProcess, we need to connect to HCL Domino from Connect Cloud, provide user access to the connection, and create OData endpoints for the HCL Domino data.

(Optional) Add a New Connect Cloud User

As needed, create Users to connect to HCL Domino through Connect Cloud.

1. Navigate to the Users page and click Invite Users
2. Enter the new user's email address and click Send to invite the user
3. You can review and edit users from the Users page

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

1. Click on your username at the top right of the Connect Cloud app and click User Profile.
2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
3. Give your PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Connect to HCL Domino from Connect Cloud

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources.

1. Log into Connect Cloud, click Connections and click Add Connection
2. Select "HCL Domino" from the Add Connection panel
3. Enter the necessary authentication properties to connect to HCL Domino.

   Connecting to Domino

   To connect to Domino data, set the following properties:

   • URL: The host name or IP of the server hosting the Domino database. Include the port of the server hosting the Domino database. For example: http://sampleserver:1234/
   • DatabaseScope: The name of a scope in the Domino Web UI. The driver exposes forms and views for the schema governed by the specified scope. In the Domino Admin UI, select the Scopes menu in the sidebar. Set this property to the name of an existing scope.

   Authenticating with Domino

   Domino supports authenticating via login credentials or an Azure Active Directory OAuth application:

   Login Credentials

   To authenticate with login credentials, set the following properties:

   • AuthScheme: Set this to "OAuthPassword"
   • User: The username of the authenticating Domino user
   • Password: The password associated with the authenticating Domino user

   The driver uses the login credentials to automatically perform an OAuth token exchange.

   AzureAD

   This authentication method uses Azure Active Directory as an IdP to obtain a JWT token. You need to create a custom OAuth application in Azure Active Directory and configure it as an IdP. To do so, follow the instructions in the Help documentation. Then set the following properties:

   • AuthScheme: Set this to "AzureAD"
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • OAuthClientId: The Client ID obtained when setting up the custom OAuth application.
   • OAuthClientSecret: The Client secret obtained when setting up the custom OAuth application.
   • CallbackURL: The redirect URI defined when you registered your app. For example: https://localhost:33333
   • AzureTenant: The Microsoft Online tenant being used to access data. Supply either a value in the form companyname.microsoft.com or the tenant ID.

     The tenant ID is the same as the directory ID shown in the Azure Portal's Azure Active Directory > Properties page.

4. Click Create & Test
5. Navigate to the Permissions tab in the Add HCL Domino Connection page and update the User-based permissions.

Configure HCL Domino Endpoints for RunMyProcess

After connecting to HCL Domino, create a workspace and virtual dataset for your desired table(s).

1. Navigate to the Virtual Datasets page and click Add to create a new Workspace (or select an existing workspace).
2. Click Add to add new assets to the Workspace.
3. Select the HCL Domino connection (e.g. Domino1) and click Next.
4. Select the table(s) you wish to work with and click Confirm.
5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

Sample URLs for OData Feeds

Once you have configured a connection to HCL Domino, created a user, and created OData endpoints in Connect Cloud, you can access OData feeds for HCL Domino data. Below, you will see the URLs to access tables and the list of tables. For information on accessing the tables, you can navigate to the OData page for Connect Cloud. For the URLs, you will need the URL of Connect Cloud: https://cloud.cdata.com/api/odata/{workspace_name}.

As with standard OData feeds, if you wish to limit the fields returned, you can add a $select parameter to the query, along with other standard OData URL parameters, such as $filter, $orderby, $skip, and $top. See the help documentation for more information on supported OData queries.

With the connection and Workspace configured, you are ready to connect to HCL Domino data from RunMyProcess.

Retrieve HCL Domino Data from RunMyProcess DigitalSuite Studio

With the connection to HCL Domino and OData endpoints created, we are ready to add HCL Domino data to RunMyProcess for Retrieval.

Create a Provider

1. Log into RunMyProcess and open DigitalSuite Studio.
2. Click Resources to bring up the Resources page, then select then the CONNECTORS tab.
3. Click the + (New Provider) button to create a new provider, choose the account to use, then click Confirm.
4. In the provider settings page, configure the following properties.
   • URL: Set the OData endpoint in the Connect Cloud OData page: https://cloud.cdata.com/api/odata/{workspace_name}.
   • Authentication Schema: Select Login/Password.
   • Login: Specify a CData Connect Cloud username (e.g. user@mydomain.com).
   • Password: Specify the PAT of the Connect Cloud user.
5. Fill in the same properties in the ACCEPTANCE and TEST tabs. Note: You can copy the configured settings by clicking 'Copy this configuration button,' then pasting the content in the new tab by clicking 'Paste previously copied configuration.'
6. Click Save to save the properties.

Retrieve HCL Domino Data by Creating a Connector

1. In the CONNECTORS tab, click the button with three dots to create the provider, then select Add connector from the menu.
2. In the following page, set Connector URL to the OData endpoint configured in Connect Cloud (e.g. https://cloud.cdata.com/api/odata/{workspace_name})
3. Click Save then Launch to test the connector execution. Click Launch test to execute. The process is successful if you get the JSON response of your configured table information.

More Information & Free Trial

Now, you have created a provider and connector to retrieve HCL Domino data. For more information on creating OData feeds from HCL Domino (and more than 100 other data sources), visit the Connect Cloud page. Sign up for a free trial and start working with live HCL Domino data in RunMyProcess.