Search External Phoenix Objects in Salesforce Connect
CData Connect AI, enables you to access Phoenix data from cloud-based applications like the Salesforce console and mobile applications like the Salesforce Mobile App. In this article, you will use CData Connect AI and Salesforce Connect to access external Phoenix objects alongside standard Salesforce objects.
Connect to Phoenix from Salesforce
To work with live Phoenix data in Salesforce Connect, we need to connect to Phoenix from Connect AI, provide user access to the connection, and create a Workspace for the Phoenix data.
Connect to Phoenix from Connect AI
CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.
- Log into Connect AI, click Sources, and then click Add Connection
- Select "Phoenix" from the Add Connection panel
-
Enter the necessary authentication properties to connect to Phoenix.
Connect to Apache Phoenix via the Phoenix Query Server. Set the Server and Port (if different from the default port) properties to connect to Apache Phoenix. The Server property will typically be the host name or IP address of the server hosting Apache Phoenix.
Authenticating to Apache Phoenix
By default, no authentication will be used (plain). If authentication is configured for your server, set AuthScheme to NEGOTIATE and set the User and Password properties (if necessary) to authenticate through Kerberos.
- Click Save & Test
-
Navigate to the Permissions tab in the Add Phoenix Connection page and update the User-based permissions.
Add a Personal Access Token
When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.
- Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
- On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
- The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.
Configure Phoenix Endpoints for Salesforce Connect
After connecting to Phoenix, create a workspace for your desired table(s).
-
Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace).
- Click Add to add new assets to the Workspace.
-
Select the Phoenix connection (e.g. ApachePhoenix1) and click Next.
-
Select the table(s) you wish to work with and click Confirm.
- Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}
With the connection, PAT, and Workspace configured, you are ready to connect to Phoenix data from Salesforce Connect.
Connect to Phoenix Data as an External Data Sources
Follow the steps below to connect to the feed produced by Connect AI.
- Log into Salesforce and click Setup -> Integrations -> External Data Sources.
- Click Now External Data Sources.
- Enter values for the following properties:
- External Data Sources: Enter a label to be used in list views and reports.
- Name: Enter a unique identifier.
- Type: Select the option "Salesforce Connect: OData 4.0".
- URL: Enter the URL to the OData endpoint of Connect AI: https://cloud.cdata.com/api/odata/{workspace_name}
- Select JSON in the Format menu.
- In the Authentication section, set the following properties:
- Identity Type: If all members of your organization will use the same credentials to access Connect AI, select "Named Principal". If the members of your organization will connect with their own credentials, select "Per User".
- Authentication Protocol: Select Password Authentication to use basic authentication.
- Certificate: Enter or browse to the certificate to be used to encrypt and authenticate communications from Salesforce to your server.
- Username: Enter a CData Connect AI username (e.g. [email protected]).
- Password: Enter the user's PAT.
Synchronize Phoenix Objects
After you have created the external data source, follow the steps below to create Phoenix external objects that reflect any changes in the data source. You will synchronize the definitions for the Phoenix external objects with the definitions for Phoenix tables.
- Click the link for the external data source you created.
- Click Validate and Scan.
- Select the Phoenix tables you want to work with as external objects.
Access Phoenix Data as Salesforce Objects
After adding Phoenix data as an external data source and syncing Phoenix tables as external objects, you can use the external Phoenix objects just as you would standard Salesforce objects.
-
Create a new tab with a filter list view:
-
Create reports of external objects:
Simplified Access to Phoenix Data from Cloud Applications
At this point, you have a direct, cloud-to-cloud connection to live Phoenix data from Salesforce. For more information on gaining simplified access to data from more than 100 SaaS, Big Data, and NoSQL sources in cloud applications like Salesforce, refer to our Connect AI page.