API credentials for EKM (Predictive-Insight).
Jump to a specific section by clicking on the link:
Overview | Variables | API Details | Alert Functionality | Related Alerts
Overview
Overview
This process integrates with the EKM API and is required for any other CEO Juice processes that will leverage EKM data. See the Alert Functionality section for the integrations that this API integrates with.
* * *
Variables
Variables
There are currently no variables for this process.
* * *
Connection/API
API Details
To set up the EKM integrations, we need your API Details entered by you on our website and set up as shown below. Only users with the Customer Admin security role can enter these credentials. If you’re unsure who has this role, please contact us at help@ceojuice.com.
Entering Credentials on the CEO Juice Website:
1. Go to CEO Juice Customer Admin Integrations and navigate to Profile > Integrations.
2. Select EKM from the list of available integrations.
3. After entering the API details, make sure to click SAVE to store your information.
Obtaining the API Key and Secret in EKM
To create an API account in EKM and obtain your API Key and Secret:
-
Admin Access Required: If you don’t have admin rights, an admin user will need to complete this setup for you. For details, please refer to the API User Guide attached at the bottom of this article.
-
Configuration Requirements: The API user must have Global scope with the Data Reader role to ensure access to all necessary data. See the example setup below for reference.
- Note: For assistance setting up the API account, resellers may need to contact the EKM US helpdesk at support@predictive-insight.com, as this function is often limited to portal admin roles. Larger resellers with dedicated portals may be able to set it up independently. Refer to the API User Guide for more information.
- Copying the API Key and Secret: Once the API user is created, a dialog will appear with the generated API key and secret. Copy these values immediately, as they cannot be re-displayed and can only be re-generated if lost.
For any issues obtaining the Key and Secret, reach out to the EKM US help desk (support@predictive-insight.com) for assistance.
API Access and Portal URLs
The API URL for accessing your EKM data can be in a few different formats. Generally, you’ll take the URL you use to access the EKM Portal UI and replace /PortalWeb with /PortalAPI.
Standard API URL Format:
Most portals follow this standard format:
Examples: We do have lots of US portals, so it depends which one they are on e.g.
- https://predictiveinsight.insightportal.net/PortalAPI/
- https://predictiveinsight2.insightportal.net/PortalAPI/
- https://printsolvportal.insightportal.net/PortalAPI/
Custom Domain Names:
Some portals use unique domain names rather than the standard format(https://xxxxxxxxx.insightportal.net). For example:
* * *
Alert Functionality
Alert Functionality
The function of this alert is to hold the API credentials for EKM and pull data from EKM to various background tables that work with other CEO Juice processes. You will need to be subscribed to the process noted below for each CEO Juice process.
Active: Integration is available for all clients
Beta: Integration is currently in the Beta testing process and not yet available
ID968 - Meters - Active
This process will populate the meter tables, the meters are inserted with ID968.
ID634 - Sales Orders - Beta
This process will pull information regarding low toner alerts and create sales orders using ID634.
By default, our process will not create a new Sales Order if it finds an open Sales Order for the same Equipment, toner color or one fulfilled in the last 10 days. The process DOES assume just-in-time delivery, meaning the expectation is for the customer to replace the toner soon after receiving it.
The customer is derived from the serial number on the DCA alert, the serial number is also used to link an equipment record and contract to the sales order to be created. The branch on the sales order is pulled from the branch assigned to the equipment record. The sales rep is pulled from the customer record.
ID350 - Toner Supply App - Beta
This process can pull information from the DCA into the ID350 toner supply app.
ID147 and ID774 - Power BI Dashboards - Active
The data from the DCAs can be pulled into various Power BI dashboards:
- Unmanaged devices - ID147
- Quarterly Business Report - ID774
ID815 - Workflow Process (If This Then That) - Beta
Once the sales order has been created in e-automate with ID634, you can use ID815 to create a workflow that will automatically create the linked purchase order.
* * *
Related Alerts
Related Alerts
ID147 - Power BI Non Managed Devices
ID288 - Notify Tech for New DCA Install
ID350 - Supply Entry App
ID634 - Supply Order Creation
ID774 - Customer Business Review
ID815 - If This Then That Workflow
ID968 - Insert Meter Readings from External Sources
* * *
0 Comments