Integrating Threekit visualization
Summarize
Summary of Integrating Threekit visualization
This integration enables ServiceNow CPQ customers to synchronize configuration inputs with Threekit visualization, allowing real-time updates of visual assets as users modify configuration fields. The integration is achieved through the blueprint layout definition, where administrators specify how and where Threekit visualizations render within the ServiceNow CPQ user interface.
Show less
Configuration Details
The integration is defined in a layout CSV file that includes:
- Rendering location: For example, a sidebar container positioned in the upper right of the UI.
- Threekit authorization token (authToken): Identifies the Threekit environment (production or non-production). It is critical to use the correct token matching the ServiceNow CPQ environment to avoid displaying incorrect assets.
- Asset ID field (assetIdField): Specifies the ServiceNow CPQ field holding the dynamic Threekit asset IDs to optimize image load times and allow flexible asset management. If only one static asset is used, it can be hard-coded instead.
- API subdomain (apiSubdomain): The subdomain for the Threekit environment URL.
- Event fields (eventFields): Key-value pairs mapping ServiceNow CPQ field variable names to Threekit variable names, enabling dynamic data exchange for visualization updates.
Important Considerations
- Ensure the correct authToken is used for each environment (production vs non-production) when copying layouts to prevent incorrect asset display.
- Utilize assetIdField for dynamic asset loading to improve user experience by allowing multiple asset definitions if needed.
- The integration supports advanced use cases, such as pairing with set repeaters for complex visualization scenarios.
Benefits for ServiceNow CPQ Customers
- Improved user experience through real-time visualization updates based on configuration changes.
- Flexible visualization management by linking dynamic asset IDs and mapping multiple configuration fields.
- Clear separation of production and non-production visualization environments to maintain content accuracy and governance.
Integrate Threekit for visualization. Sync configuration inputs with visual updates to enhance user experience.
ServiceNow CPQ can share field values with Threekit so that Threekit visualization is updated in real time as the user changes ServiceNow CPQ configuration inputs.
Integration between ServiceNow CPQ and Threekit is accomplished in the blueprint layout definition. The following layout CSV file contains a sample of how the ServiceNow CPQ administrator defines where the Threekit visualization will be rendered in the UI, specifies the Threekit environment authorization token, and identifies the ServiceNow CPQ field data to be sent.
Layout_ThreeKit_in_sidebar [Google Sheet]
- In the layout definition sample, the Threekit rendering displays in a sidebar BasicContainer positioned on the upper right of the UI.
- The JSON provided in the
valuecolumn of the ThreeKit element row contains the following syntax:{ "authToken": "3KIT_AUTH_TOKEN", "assetIdField": "<LGK field that holds 3KIT Asset ID", "apiSubdomain": "exampleThreekitSubdomain" "eventFields": { "LGK_FIELD1_VARNAME": "3KIT_FIELD1_VARNAME", "LGK_FIELD2_VARNAME": "3KIT_FIELD2_VARNAME", "LGK_FIELD3_VARNAME": "3KIT_FIELD3_VARNAME" } } authToken: an authorization token provided by the Threekit application environment.Important:When copying a layout from one ServiceNow CPQ environment to another, be aware that this manual edit must be made. Otherwise, non-production Threekit assets may be inadvertently displayed in ServiceNow CPQ production layouts.The authToken is how Threekit determines which of its environments will serve the visual asset: production or non-production. Therefore, be sure that the production ServiceNow CPQ environment passes the Threekit production authToken; nonproduction ServiceNow CPQ environments must pass the Threekit non-production authToken.assetIdFielddefines the name of the ServiceNow CPQ text field that holds the Threekit asset IDs, as provided by Threekit. In this way, ServiceNow CPQ can pass a dynamic Threekit asset ID. This helps Threekit optimize image load times. This feature provides flexibility, should the Threekit model need to be broken into two or more asset definitions to facilitate a better user experience.Note:If your ServiceNow CPQ blueprint only passes one static Threekit asset ID, you can replace theassetIdFieldparameter withassetId: <hard-coded Threekit Asset ID>.apiSubdomain: The subdomain of your Threekit environment URL.eventFieldscontains key-value pairs where each key is the variable names of the ServiceNow CPQ field passed to Threekit. The corresponding values are the variable names, as defined in Threekit.
To learn more about the use of Threekit visualization with a set repeater, see Use case: Pairing set repeaters and visualization components
For a discussion of the features available in supported visualization applications in integration with ServiceNow CPQ, see Integrating ServiceNow CPQ with visualization tools.