API credentials for KPAX.
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 KPAX API and is required for any other CEO Juice processes that will leverage KPAX data. See the Alert Functionality section for the integrations that this API integrates with. See notes here on how to configure supply alerting with KPAX.
* * *
Variables
Variables
Variable Z: Once you have entered your KPAXt credentials in Profile/Integrations (see below), then use drop down in variable to point to those credentials.
Connection/API
API Details
We need your API Details entered by you on our website and set up as shown below. The user entering on our website will need 'Customer Admin' security role - ask us at help@ceojuice.com if you need to know who has.
Please enter credentials on our website (https://www.ceojuice.com/CustomerAdmin/Integrations) via Profile / Integrations:
Select KPAX:
Credentials needed:
These values can be found here in KPAX:
**Please contact is kpaxsupport@acd-inc.com directly for any support needed for retrieving these API values.**
URL:
Customer ID and Secret Customer:
Using the gear menu at the top right (probably requires elevated user rights inside KPAX), go to API Management:
Create API access for CEO Juice:
We need Customer ID and Secret Customer created:
Please set permissions (via Accounts section) as:
* * *
Alert Functionality
Alert Functionality
The function of this alert is to hold the API credentials for KPAX and pull data from KPAX 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 - Active
This process will pull information regarding low toner alerts and create sales orders using ID634. **Please note that we are pulling alerts that are generated from the DCA. If you are seeing supply alerts that shouldn't trigger, you will need to check the alert configuration in the DCA.**
KPAX Supply Configuration
KPAX Supply Configuration
Prior to testing, you will need to configure your alerts in KPAX. This is done by creating field names for the devices:
- Black Supply Alert Date
- Cyan Supply Alert Date
- Magenta Supply Alert Date
- Yellow Supply Alert Date
The field names are created in the Settings Menu, under Managing Custom Fields. Once these fields are created, the Low Supply Rule will need to be mapped to edit these fields based on the corresponding supply trigger.
Set the trigger criteria for time to empty or percentage remaining, then Add an action:
Select Edit Custom Fields
Choose the custom field to edit in the "Select a field" dropdown menu.
Then select Update today's date.
Choose the corresponding supply trigger that matches the custom field and select Validate. (If editing the Black Supply Alert Date, then select the Low black supply level detected.)
Repeat for all remaining colors. This will push the appropriate supply alerts into our background table to then create the sales orders in e-automate.
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.
For more details on how supply orders are created, see the documentation here.
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