1. Installation Guide
  2. Configuring config.json

Configuring config.json

Siebel Open Integration configuration is driven by config.json. You can configure the connection details for the Siebel Server and specify the Siebel CRM artifacts that you want to expose through REST, in config.json.

The installer creates a template file named config-template.jsonin the <INSTALL_DIR>/openint-deploydirectory. You must copy the config-template.jsonfile in the same folder and rename the copy as config.json.

You must configure the following sections in config.json:

  • app: Use the appsection to configure how Siebel Open Integration connects to the Siebel Server, the port at which Open Integration start, and the path of the transaction metrics.
  • apigen: Use the apigen section to define which Siebel CRM artifacts you want to expose through REST. Siebel Open Integration uses this section to generate and deploy REST APIs based on artifacts in your Siebel application, such as applets, business components, business services, and workflows.
  • eps: Use eps to define EPS and Kafka event settings. It is optional, but when present, it must follow the schema.

The app Section Parameters

You must use the app section to configure how Siebel Open Integration connects to the Siebel Server. It includes these parameters:

Parameter Section Description
siebel app This section includes the information to connect to Siebel Server.
useCG app> siebel Use this parameter to specify where Siebel Open Integration gets the connection string from.
  • Set to true to fetch the connection string from Cloud Gateway by using cg-url.
  • Set to false to use the value in connect-string.
cg-url app> siebel (Required if the useCG parameter is set to true.) Use this parameter to specify the Cloud GatewayURL.
connect-string app> siebel (Required if the useCG parameter is set to false.) Use this parameter to specify the connection string that Siebel Open Integration uses to connect to Siebel.

This parameter supports both TLS and TCP connection strings. Oracle recommends using TLS-based connection strings to provide secure communication.
loginpath app> siebel Use this parameter to specify the relative URLfor the Siebel application that handles UI requests. For example: /siebel/app/ callcenter/enu.
context app Use this parameter to specify the first path segment in Siebel Open Integration REST URLs. For example: oracle.
port app Use this parameter to specify the port on which the Open Integration server starts. For example: 8433.
metrics-path app Use this parameter to specify the file system location where the Open Integration server stores transactions.
baseURL app Use this parameter to specify the base URL used to generate URLs for resources in REST responses.

The apigen Section Parameters

Use the apigen section to define which Siebel CRM artifacts you want to expose through REST. You can configure these resources in the apigen section:

  • The resources section to specify the artifacts that Open Integration exposes through REST APIs. Provide each artifact in the appropriate section based on its type:
    • openintegration/v1.0/ui: List view and applet pairs to expose UI-based resources. The REST API executes a ui query within the specified View and Applet scope. The query follows the user’s roles and responsibilities. For example, to fetch data from the View All Account List View and the Applet SIS Account Entry Applet, specify that View and Applet pair in the ui section as follows: All Account ListView/SIS Account Entry Applet.

      After you deploy the Open Integration service, you can use the provided URL to fetch data from the server that runs the service. For example: https://<hostname:port>/<oracle>/openintegration/v1.0/ui/Account/All Account List View/SIS Account Entry Applet

      For more information and examples, see AppletAPIs (CRUD Operations)

    • openintegration/v1.0/data: List business object and business component pairs to access Siebel CRM Business Objects. For example, Account/Account/. For more information and examples, see Business Object APIs in the Siebel REST API Guide.
    • openintegration/v1.0/workflow: List Siebel workflows that you want to expose as REST APIs. For example, EAISiebDemo and ISS Promotion WS - ApplyProductPromotion – Order. For more information and examples, see Workflow APIs in the Siebel REST API Guide.
    • openintegration/v1.0/service: List Siebel business services that you want to expose through REST APIs. For example, SiebelAccount/Insert. For more information and examples, see Business Service APIs in the Siebel REST API Guide.
  • The apigen.integration-domains section to specify the Integration Domains associated with the Open Integration project. Add each Integration Domain that the project uses to expose, organize, or manage integration-related artifacts. If the project doesn't use any Integration Domains, you can omit this section.
Note: apigen.externalREST and apigen.outboundEvents are defined in domain files in integration-configurations/<Domain>/domain-configurations/, not in the base config.json file.

The eps Section Parameters

You must use the epssection to configure the Kafka event settings. It includes the following parameters:

Parameter Section Description
SecureAIEgressServer eps (Optional) Use this parameter to specify whether the AI Egress server uses secure communication. Set the value to true to enable secure communication or false to disable it.
SecureAIToKafkaCommunication eps Use this parameter to specify whether communication between AI services and Kafka uses secure transport. Set the value to true to enable secure communication. When enabled, you must also configure the Kafka keystore, truststore, and password parameters.
AIEgressPort eps (Optional) Use this parameter to specify the port on which the AI Egress server listens for connections.
KafkaServers eps Use this parameter to specify the Kafka bootstrap servers that Open Integration uses to connect to the Kafka cluster
KafkaKeyStoreName eps (Required if SecureAIToKafkaCommunication is set to true.) Use this parameter to specify the keystore file that contains the client certificate and private key used for secure Kafka communication.
KafkaKeyStorePassword eps (Required if SecureAIToKafkaCommunication is set to true.) Use this parameter to specify the password for the Kafka keystore.
KafkaTrustStoreName eps (Required if SecureAIToKafkaCommunication is set to true.) Use this parameter to specify the truststore file that contains the trusted certificates used to validate Kafka server certificates.
KafkaTrustStorePassword eps (Required if SecureAIToKafkaCommunication is set to true.) Use this parameter to specify the password for the Kafka truststore.
KafkaPassword eps (Required if SecureAIToKafkaCommunication is set to true.) Use this parameter to specify the password used for Kafka authentication.
aieventconfig eps This section contains the AI event processing configuration.
ConfigParam

eps > aieventconfig

 This section contains the configuration parameters used for AI event processing and Kafka integration.
SynchronousKafkaProduce eps > aieventconfig > ConfigParam Use this parameter to specify whether Kafka messages are produced synchronously. Set the value to true to wait for message delivery confirmation before continuing processing.
BaseSiebelComponent eps > aieventconfig > ConfigParam This section contains the default Siebel component configuration used for event processing.
Alias eps > aieventconfig > ConfigParam > BaseSiebelComponent Use this parameter to specify the alias of the Siebel component.
SessionPoolSize eps > aieventconfig > ConfigParam > BaseSiebelComponent Use this parameter to specify the number of Siebel sessions maintained in the session pool.
User eps > aieventconfig > ConfigParam > BaseSiebelComponent Use this parameter to specify the number of Siebel sessions maintained in the session pool.
Password eps > aieventconfig > ConfigParam > BaseSiebelComponent Use this parameter to specify the password for the Siebel user account.
SessionTime eps > aieventconfig > ConfigParam > BaseSiebelComponent Use this parameter to specify the session timeout value for Siebel sessions.
NumberOfProducers eps > aieventconfig > ConfigParam (Optional) Use this parameter to specify the number of Kafka producer instances created for event publishing.
KafkaProducerMaxRequestSize eps > aieventconfig > ConfigParam Use this parameter to specify the maximum request size, in bytes, that a Kafka producer can send.
KafkaTopicConsumerFetchMaxBytes eps > aieventconfig > ConfigParam Use this parameter to specify the maximum amount of data, in bytes, that a Kafka consumer can retrieve in a single fetch request.
KafkaConsumerPollInterval eps > aieventconfig > ConfigParam Use this parameter to specify the interval used by Kafka consumers when polling for messages.
Events eps > aieventconfig > ConfigParam This section contains the list of event definitions processed by the AI event framework.
EventStore eps > aieventconfig > ConfigParam > Events Use this parameter to specify the event store associated with the event configuration.
NumberOfConsumers eps > aieventconfig > ConfigParam > Events Use this parameter to specify the number of Kafka consumer instances assigned to the event.
KafkaConsumerGroupId eps > aieventconfig > ConfigParam > Events

Use this parameter to specify the Kafka consumer group identifier used by consumers for the event.
SiebelComponent eps > aieventconfig > ConfigParam > Events This section contains Siebel component settings that apply specifically to the event configuration.
Alias eps > aieventconfig > ConfigParam > Events > SiebelComponent Use this parameter to specify the alias of the Siebel component used for the event.
SessionPoolSize eps > aieventconfig > ConfigParam > Events > SiebelComponent Use this parameter to specify the number of Siebel sessions maintained in the session pool for the event.
KafkaConsumerPollInterval eps > aieventconfig > ConfigParam > Events > SiebelComponent Use this parameter to specify the polling interval used by the Kafka consumer for the event.
User eps > aieventconfig > ConfigParam > Events > SiebelComponent

Use this parameter to specify the Siebel user name used to establish sessions for the event.
Password eps > aieventconfig > ConfigParam > Events > SiebelComponent Use this parameter to specify the password for the Siebel user account.
SessionTime eps > aieventconfig > ConfigParam > Events > SiebelComponent Use this parameter to specify the session timeout value for the event-specific Siebel sessions.
Note: The config-template.json file shows inline help as commented example strings, but JSON doesn't support comments. For the app section, replace every placeholder with an actual value. For apigen, if you don't want to configure a resource type (for example: workflow), remove the entire entry instead of leaving the placeholder text. Otherwise, the pipeline can fail with an “expected resources are not found” error.

You can use the ui section to list View and Applet pairs.

The REST API executes a ui query within the specified View and Applet scope. The query follows the user’s roles and responsibilities.