Build Semantic Layer Views for Workable Data in APOS Live Data Gateway

APOS Live Data Gateway (LDG) is a data connection and data transformation solution that enables live data connectivity and expanded data source options for SAP Analytics Cloud and other SAP solutions. When paired with CData Connectors, users can build semantic layer views for live Workable data, enabling real-time analytics on Workable just like working with a relational database.

With built-in optimized data processing, the CData Connector offers unmatched performance for interacting with live Workable data. When you issue complex SQL queries to Workable, the driver pushes supported SQL operations, like filters and aggregations, directly to Workable and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Workable data using native data types.

Download and Install the Connector Files

In order to access Workable data through the APOS Live Data Gateway, you will need to download the connector files from APOS and install them on the machine hosting the Live Data Gateway. An APOS representative can deliver the necessary files.

• Install the CData DLL file (System.Data.CData.API.dll) to the APOS Live Data Gateway installation directory (C:\Program Files\Live Data Gateway\Admin\ by default).
• Install the CData JAR file (cdata.jdbc.api.jar) to the ConnectionTest_lib folder in the installation directory (C:\Program Files\Live Data Gateway\Admin\ConnectionTest_lib\ by default).
• Install the CData JAR file (cdata.jdbc.api.jar) to the lib folder in the Web UI installation directory (e.g.: C:\LDG_WebUI\lib\)

Configuring the Workable Connection String

Before establishing the connection to Workable from the APOS Live Data Gateway, you need to configure the Workable JDBC Connection String.

Built-in Connection String Designer

For assistance in constructing the JDBC Connection String, use the connection string designer built into the Workable JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.api.jar

Fill in the connection properties and copy the connection string to the clipboard.

Using API Key Authentication

Workable uses API key authentication to control access to the API. To obtain an API Key:

1. Log in to your Workable account.
2. Navigate to Settings > Integrations > API Access Tokens.
3. Click "Generate API Token".
4. Copy the generated token.

After obtaining your API Key, set the following connection properties:

• AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

• APIKey: Set this to your Workable API Key.
• Subdomain: Set this to your Workable account subdomain. For example, if your Workable URL is acmeinc.workable.com, then the Subdomain is 'acmeinc'.

Example Connection String

Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';

👁 Using the built-in connection string designer to generate a JDBC URL (workable is shown.)

Your connection string will look similar to the following:

jdbc:API:Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';

Connecting to Workable & Creating a Semantic Layer View

After installing the connector files and configuring the connection string, you are ready to connect to Workable in the Live Data Gateway Admin tool and build a semantic layer view in the Live Data Gateway Web UI.

Configuring the Connection to Workable

1. Log into your APOS Live Data Gateway Manager 👁 Logging into the APOS LDG Manager
   
2. If you haven't already, update your APOS LDG license file
   1. Click File -> Configurations
   2. Click on the "..." Menu for the License
   3. Select the license file from the APOS team that includes your CData Connector license
3. In the APOS Live Data Gateway Manager, click "Add"
4. In the APOS Live Data Gateway On the Connection tab, configure the connection:
   • Set Data Source to "Database"
   • Set Database to "CData Drivers"
   • Set Database CData Drivers to "Workable"
   • Set Connection String to the connection string configured earlier (e.g.:

     jdbc:API:Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';

   • Set Driver Class to "cdata.jdbc.api.APIDriver" (this should be set by default)
   👁 Configuring the Connection (Salesforce is shown).
   
5. Click Test Connection
6. Click Save
7. Give your connection a unique prefix (e.g. "api")
8. Highlight the newly created connection and click File -> "Approve Users For Web UI" 👁 Approving Users For Web UI.
   
9. Approve the appropriate DB users to create views and click "Save" 👁 Configuring which DB users can create views.
   

At this point, we are ready to build our semantic layer view in the Live Data Gateway Web UI.

Creating a Semantic Layer View

1. In your browser, navigate to the APOS Live Data Gateway Portal
2. Select a Connection (e.g. "api")
3. Since Workable does not require a User or Password to authenticate, you may use whatever values you wish for User Name and Password
4. Click "Login" 👁 Connecting from the Web UI (Salesforce is shown).
   
5. Once connected, click "Semantic Layer" to create a new semantic layer view
6. Click "New Semantic Layer View" 👁 Adding a new semantic layer view.
   
7. Set the Semantic Layer View Prefix and Semantic Layer View Name 👁 Setting the semantic layer view prefix and name.
   
8. Click "Step 2"
9. Select the table(s) and column(s) you wish to include in your view 👁 Selecting table(s) and column(s).
   
10. Click "Step 3"
11. Select the Measures from the available table columns 👁 Selecting the measure(s).
    
12. Click "Step 5" (we skipped the "Extra Dimensions" step)
13. Add any Variable Prompts
14. Click "Step 6"
15. Define any Table Joins
16. Click "Review"
17. Review you semantic layer view and click "Save" 👁 Saving the semantic layer view.
    

With the Semantic Layer View created, you are ready to access your Workable data through the APOS Live Data Gateway, enabling real-time data connectivity to Workable data from SAP Analytics Cloud and other SAP solutions.

More Information & Free Evaluation

Please visit APOS Systems - APOS Solutions - Request Evaluation Software to request evaluation software or email [email protected] for more information on working with your live Workable data in APOS Live Data Gateway.