Custom Processing Settings

IPF Custom Processing Settings service (referred to as CPS henceforth in the documentation) provides a way for IPF client implementations to create and maintain custom dynamic configurations. Unlike pre-defined setting categories supported on IPF core, CPS allows implementations to define their own setting keys with associated values of various types. Refer to Processing Settings to know more about the core processing settings supported on IPF. `

CPS leverages the IPF design pattern known as "Dynamic Processing Settings" (DPS v2) for dynamic management of custom processing settings. Refer to Dynamic Processing Settings to know more about DPS and dynamic configuration management using DPS.

IPF CPS supports following setting value types for custom processing settings:

  • Boolean

  • String

  • Number

  • Number Array

  • String Array

CPS does not support complex object definitions on the payload of the dynamic configurations.
Note

  1. IPF does not provide a way to manage the custom processing settings through IPF core operational dashboard. Client implementations must create and maintain custom screens that allow management of custom processing settings using the user interface. For details on how a client can create a Custom Processing Settings view with the IPF Operational Dashboard SDK.

  2. In the absence of UI screens, the setting management of custom processing settings can be done by using DPSv2 setting management APIs directly. Refer to CPS Setting Management API for DPS setting management API specs.

  3. The custom processing settings can be used within IPF studio by mapping them into IPF studio variables that are enabled for dynamic management. This is done by using an IPF component Dynamic Config Adapter. Please refer to Dynamic Config Adapter and Rules Framework - Dynamic Expressions.

How to use this documentation?

The documentation has the following sections:

  1. Features - Overview and specification of Custom Processing Settings capabilities including value types, searchable fields, and notification mechanisms. Refer Features.

  2. Getting Started - Practical steps for integrating and using the Custom Processing Settings service including API integration and configuration. Refer to Client Library and Custom Processing Settings Query.

  3. Integration - OpenAPI specification for all setting management endpoints. Refer API Reference.

  4. Deployment - Example of Docker environment deployment, as well as Kubernetes deployment. Refer Deployment.