Payload Parameters for Siebel CRM Deployment

The following table lists and provides details of the Siebel CRM deployment payload parameters:

Payload Parameter Section Description

name

(top level)

(Required) A short name for identification of the environment. This name is used as a prefix in all the resources. The namespace in the Kubernetes cluster is created with this name. Choose something meaningful and short (no more than 10 to 15 alphanumeric characters), such as DevExample (perhaps using the name of your company or organization).

config_id

(top level)

(Required for customization workflow) The configuration ID that is obtained as described in Customizing Configurations Prior to Greenfield Deployment. You specify this configuration ID in the payload only when you provision a greenfield environment with a configuration that you previously customized.

database_type

siebel

(Required for greenfield deployments) Specifies the database type to use for a greenfield deployment. The available options are:

  • Sample

  • Vanilla

Note: This parameter is used only for greenfield deployments and is not used for the deployment scenario that uses the Siebel Lift utility.

industry

siebel

(Required for greenfield deployments) Specifies the industry-specific functionality to enable in a greenfield deployment. The available options are:

  • Automotive

  • Financial Services

  • Life Sciences

  • Sales

  • Service

  • Partner Relationship Management

  • Public Sector

  • Telecommunications

  • Loyalty

  • Consumer Goods

  • Hospitality

    Note: This parameter is used only for greenfield deployments and is not used for the deployment scenario that uses the Siebel Lift utility.

registry_url

siebel

(Required) Specifies the URL of the Open Container Initiative (OCI) compliant container registry.

For example, for the Oracle Cloud Infrastructure container registry in the Ashburn region, you might use iad.ocir.io. For more information, see the registry concepts information in the Oracle Cloud Infrastructure documentation (https://docs.oracle.com/en-us/iaas/Content/Registry/Concepts/registryprerequisites.htm).

registry_user

siebel

(Required) Specifies the user ID to connect to the container registry. This user must have container registry access to push and pull images.

registry_password

siebel

(Required) Specifies the password or authentication token for this user.

registry_prefix

siebel

(Optional) Specifies a prefix that's appended after the registry_url.

For OCI container registry, registry_prefix must be the tenancy namespace, if needed, you can add a suffix to it. As it's an optional field, it can be left blank.

architecture

siebel

(Required for Siebel Component Services deployments) Specifies the architecture for your Siebel CRM deployment. Specify one of the following values:

  • SCS. For deployments of Siebel Component Services.

  • CRM. For deployments of Siebel CRM. (This value is the default, if the parameter is omitted.)

bucket_url

siebel

Specifies the bucket that the Siebel Lift utility creates when it is run and uploads deployment artifacts. Create a pre-authenticated request URL for the bucket. The access type must permit object reads and the bucket must enable object listing.

Note: This parameter is used only for the deployment scenario that uses the Siebel Lift utility and is not used for greenfield deployments.

You must not configure this parameter if the nfs section is configured under the siebel section in the Siebel CRM deployment payload.

To create a pre-authenticated request URL:

  1. Launch the OCI console and navigate to Storage/Buckets. Open the bucket that is created during the lift process.
  2. Click the Pre-Authenticated Requests link in the Resources section.
  3. Click Create Pre-Authenticated Request.
  4. Provide a name, select the target as Bucket, and specify the access type as reads.
  5. Select Enable Object Listing (check box).

keystore

siebel

(Optional) This parameter allows for Custom Keystore Management.

gateway_deployment_type siebel

(Optional) Use this parameter to specify the Siebel Gateway deployment mode. Allowed values are standalone or cluster. Set the value of this parameter to:

  • standalone for creating a single Siebel Gateway node without any cluster features.
  • cluster for high availability with multiple Siebel Gateway nodes (this is the default).

Note: If you configure the gateway_cluster_replica_count parameter, the gateway deployment type is automatically set to cluster. So, do not set gateway_deployment_type to standalone when gateway_cluster_replica_count is configured. Use only one of these options at a time to avoid conflicts.

gateway_cluster_replica_count

siebel

(Optional) Use this parameter to install and configure a gateway cluster, based on the specified number. Applies to both Greenfield and Lift-and- Shift deployments.

The Siebel Gateway cluster requires a minimum of three replicas. We recommend using an odd number of replicas for optimal operation.

By default, a three-node gateway cluster is created if this parameter is not overridden. If you override the parameter in the payload, the gateway cluster is created with the specified value instead.

Note: If you configure the gateway_cluster_replica_count parameter, the gateway deployment type is automatically set to cluster. So, do not set gateway_deployment_type to standalone when gateway_cluster_replica_count is configured. Use only one of these options at a time to avoid conflicts.

security_adapter_type

siebel

(Optional) Specify the security adapter type. Supported values are 'DB' and 'LDAP'. Default value: DB.

path siebel > nfs

This parameter is used to specify the NFS server directory path that holds the lifted Siebel CRM artifacts.

Note: You must not configure this parameter if you have configured the bucket_url parameter in the Siebel CRM deployment payload.

server siebel > nfs

This parameter is used to specify the NFS server endpoint.

Note: You must not configure this parameter if you have configured the bucket_url parameter in the Siebel CRM deployment payload.

storage siebel > nfs

This parameter is used to specify the Persistent Volume Claim (PVC) size of the intermediate Artifactory server. Default size is 100 GB.

Note: You must not configure this parameter if you have configured the bucket_url parameter in the Siebel CRM deployment payload.

use_self_signed_certificate siebel (Required only if you want SCM to generate self-signed certificates.)

This Boolean parameter controls whether SCM generates self-signed certificates, or you provide your own custom keystore. Set the value of this parameter to:

  • true to have SCM generate self-signed certificates.
  • false, or omit the parameter, to use your own custom certificate (keystore).

siebel_server_keystore_path

siebel > keystore

(Required only when you want to use your own certificate.)

This parameter specifies the path to a custom keystore (.jks) file that contains the Siebel server and Siebel Controller certificates.

siebel_client_keystore_path siebel > keystore (Required only when you want to use your own certificate.)

This parameter specifies the path to a custom keystore (.jks) file that contains the Siebel client certificate. For more information, see Using Custom Keystore.

siebel_truststore_path

siebel > keystore

(Required only when you want to use your own certificate.)

This parameter specifies the path to a custom keystore (.jks) file that contains the root certificate. For more information, see Using Custom Keystore.

siebel_server_keystore_password

siebel > keystore

(Required only when you want to use your own certificate.)

This parameter specifies the password for the keystore file specified in the siebel_server_keystore_path parameter. For more information, see Using Custom Keystore.

siebel_client_keystore_password siebel > keystore

(Required only when you want to use your own certificate.)

This parameter specifies the password for the keystore file specified in the siebel_client_keystore_path parameter. For more information, see Using Custom Keystore.

siebel_truststore_password

siebel > keystore

(Required only when you want to use your own certificate.)

This parameter specifies the password for the truststore. For more information, see Using Custom Keystore.

siebel_server_certificate_alias

siebel > keystore

(Required only when you want to use your own certificate.)

This parameter specifies the alias used when importing the Siebel server certificate into the keystore specified in the siebel_server_keystore_path parameter. For more information, see Using Custom Keystore.

siebel_client_certificate_alias siebel > keystore

(Required only when you want to use your own certificate.)

This parameter specifies the alias used when importing the Siebel client certificate into the keystore specified in the siebel_client_keystore_path parameter. For more information, see Using Custom Keystore.

siebel_controller_certificate_alias

siebel > keystore

(Required only when you want to use your own certificate.)

This parameter specifies the alias used when importing the Siebel Controller certificate into the keystore specified in the siebel_server_keystore_path parameter. For more information, see Using Custom Keystore.

ldap_host_name

siebel > ldap

(Required) Host name of the ldap server for ldap authentication.

Note that you may have to include the IP address if the server is configured to listen only with the IP address:

You must specify the FQDN (fully qualified domain name) of the LDAP server, not just the domain name. For example, specify ldapserver.example.com, not example.com.

ldap_port

siebel > ldap

(Required) Specify the port number for the ldap for ldap authentication. For example, 389.

application_user_dn

siebel > ldap

(Required) Specify the user name of a record in the directory with sufficient permissions to read any user's information and do any necessary administration.

This user provides the initial binding of the LDAP directory with the Application Object Manager when a user requests the login page, or else anonymous browsing of the directory is required.

You enter this parameter as a full distinguished name (DN), for example "uid=appuser, ou=people, o=example.com" (including quotes) for LDAP. The security adapter uses this name to bind.

You must implement an application user.

application_password

siebel > ldap

(Required) OCID of the secret containing the password for the user defined by the Application User Distinguished Name parameter. The secret must be stored encrypted in the vault. In an LDAP directory, the password is stored in an attribute and clear text passwords are not supported for the LDAPSecAdpt named subsystem.

base_dn

siebel > ldap

(Required) Specify the base distinguished name, which is the root of the tree under which users of this Siebel application are stored in the directory. Users can be added directly or indirectly after this directory.

For example, a typical entry for an LDAP server might be:

BaseDN = "ou=people, o=domain_name"

where:

  • o denotes organization
  • ou denotes organization unit and is the subdirectory in which users are stored

credentials_attribute_type

siebel > ldap

(Required) Specify the attribute type that stores a database account. For example, if Credentials Attribute is set to dbaccount, then when a user with user name HKIM is authenticated, the security adapter retrieves the database account from the dbaccount attribute for HKIM.

This attribute value must be of the form username=U password=P, where U and P are credentials for a database account. There can be any amount of space between the two key-value pairs but no space within each pair. The keywords username and password must be lowercase.

In LDAP security adapter authentication to manage the users in the directory through the Siebel client, the value of the database account attribute for a new user is inherited from the user who creates the new user. The inheritance is independent of whether you implement a shared database account, but does not override the use of the shared database account.

password_attribute_type

siebel > ldap

(Required) Specify the attribute type under which the user’s login password is stored in the directory.

roles_attribute_type

siebel > ldap

(Optional) Specify the attribute type for roles stored in the directory.

For example, if Roles Attribute is set to roles, then when a user with user name HKIM is authenticated, the security adapter retrieves the user’s Siebel responsibilities from the roles attribute for HKIM.

shared_db_credentials_dn

siebel > ldap

(Optional) Specify the absolute path (not relative to the Base Distinguished Name) of an object in the directory that has the shared database account for the application.

If not set, then the database account is looked up in the user’s DN as usual.

If set, then the database account for all users is looked up in the shared credentials DN instead. The attribute type is determined by the value of the Credentials Attribute parameter.

For example, if the Shared Database Account Distinguished Name parameter is set to "uid=HKIM, ou=people, o=example.com" when a user is authenticated, the security adapter retrieves the database account from the appropriate attribute in the HKIM record. This parameter’s default value is an empty string.

shared_db_username

siebel > ldap

(Optional) Specify the user name to connect to the Siebel database. You must specify a valid Siebel user name and password for the Shared DB User Name and Shared DB Password parameters.

Specify a value for this parameter if you store the shared database account user name as a parameter rather than as an attribute of the directory entry for the shared database account. To use this parameter, you can use an LDAP directory.

shared_db_password

siebel > ldap

(Optional) OCID of the secret containing the password associated with the Shared DB User Name parameter.

username_attribute_type

siebel > ldap

(Required) Specifies the attribute type under which the user’s login name is stored in the directory.

For example, if User Name Attribute Type is set to uid, then when a user attempts to log in with user name HKIM, the security adapter searches for a record in which the uid attribute has the value HKIM. This attribute is the Siebel user ID, unless the Security Adapter Mapped User Name check box is selected.

use_adapter_username

siebel > ldap

(Optional) If this boolean parameter is set to true, then when the user key name passed to the security adapter is not the Siebel User ID, then the security adapter retrieves the Siebel User ID for authenticated users from an attribute defined by the Siebel Username Attribute parameter.

siebel_username_attribute_type

siebel > ldap

This is mandatory parameter when 'use_adapter_username' is set to 'true'

If set, then this parameter is the attribute from which the security adapter retrieves an authenticated user’s Siebel User ID. If not set, then the user name passed in is assumed to be the Siebel User ID.

siebel_admin_username

siebel > ldap

(Required) The username of the Siebel CRM administrative user.

siebel_admin_password

siebel > ldap

(Required) OCID of the secret containing the Siebel CRM Administration User password.

anonymous_username

siebel > ldap

(Required) The username of the web anonymous user.

anonymous_user_password

siebel > ldap

(Required) OCID of the secret containing the anonymous user password which will be updated.

propagate_change

siebel > ldap

(Optional)

This is a boolean flag.

Set this parameter to True to allow administration of the directory through Siebel Business Applications UI. When an administrator then adds a user or changes a password from within the Siebel application, or a user changes a password or self-registers, the change is propagated to the directory.

A non-Siebel security adapter must support the SetUserInfo and ChangePassword methods to allow dynamic directory administration.

hash_db_password

siebel > ldap

(Optional)

This is a boolean flag.

Set this parameter to True to specify password hashing for database credentials passwords.

Hash Algorithm will be set to "SHA1", which is the default value, is read-only for the Siebel Gateway (SGW) security profile.

hash_user_password

siebel > ldap

(Optional)

This is a boolean flag.

Set this parameter to True to specify password hashing for user passwords.

Hash Algorithm will be set to "SHA1", which is the default value, is read-only for the SGW security profile

salt_attribute_type

siebel > ldap

(Optional)

This is a boolean flag.

Specifies the attribute that stores the salt value if you have chosen to add salt values to user passwords. The default attribute is title.

salt_user_password

siebel > ldap

(Optional)

This is a boolean flag.

Set this parameter to True to specify that salt values are to be added to user passwords before they are hashed. This parameter is ignored if the Hash User Password parameter is set to False.

enable_ssl

siebel > ldap

(Optional) Specifies whether to enable SSL for connections to the LDAP server ( that is, LDAP over SSL or, in short, LDAPs).

ldap_wallet_path

siebel > ldap

(Required only when enable_ssl is set to 'True')

This parameter specifies the path to the wallet file required for LDAP over SSL connection.

The wallet file (Example: ewallet.p12) wont be lifted during lift process and one needs to manually copy it to OCI SCM container location and pass the path in this payload parameter. You can also copy the wallet file to the SCM container using File Sync Utility, for more information see Uploading Files to the SCM Container Using File Sync Utility.

Here, the wallet should be created from Oracle Wallet Manager and the Oracle wallet must contain CA server certificate that has been issued by Certificate Authorities to LDAP directory server.

ldap_wallet_password

siebel > ldap

(Required when enable_ssl is set to 'True')

OCID of the secret containing the password to open the LDAP wallet that contains a certificate for the certificate authority used by the LDAP directory server.

git_type infrastructure > git

(Required) Used to specify the SCM Git provisioning type.

Allowed values are 'gitlab' or 'byo_git'.

If the value is set to 'gitlab'’, SCM will create and manage the Git repositories.

If the value is set to 'byo_git', SCM will read the SCM repository and Helm repository details from the payload and use the same during Siebel CRM provisioning.

git_user infrastructure > git > byo_git

(Required when git_type is set to 'byo_git')

Used to specify the user who has access to manage Git projects in the specified Git repositories.

git_protocol_type infrastructure > git > byo_git

(Required when git_type is set to 'byo_git')

Used to specify the protocol type to transfer data.

Allowed values are 'ssh' and 'http'.

git_accesstoken infrastructure > git > byo_git

(Required when git_protocol_type is set to 'http')

Used to specify the access token with API scope for the Git user. You can create the access token in user settings.

git_ssh_private_key infrastructure > git > byo_git

(Required when git_protocol_type is set to 'ssh')

Used to specify the path of the ssh private key file required to access the Git repositories.

Note: An encrypted private key protected with a passphrase isn'tsupported. You must ensure that the key is decrypted before you use it in the deployment payload.

The current user must have read and write access to the private key, but other users should not have access to it. Hence, you must assign the private key permissions as follows:

chmod 600 <git_ssh_private_key>
git_scm_repo_url infrastructure > git > byo_git

(Required when git_type is set to 'byo_git')

Used to specify the Git repository URL to use as the SCM repository. You can provide both http and https URLs in this parameter.

git_scm_repo_branch infrastructure > git > byo_git

(Required when git_type is set to 'byo_git')

Used to specify the branch of the Git repository to use for the SCM repository.

git_scm_flux_folder infrastructure > git > byo_git

(Required when git_type is set to ‘byo_git’)

Used to specify the folder to use for Flux bootstrap setup in the SCM repository.

SCM will have full control over this folder. Hence, it's recommended to use a dedicated folder for the Flux folder in the SCM repository.

Note:

  • If folder exists, SCM will clean up the existing content and continue with deployment.
  • If this folder doesn’t exist, SCM will create the folder and continue with deployment.
git_helm_repo_url infrastructure > git > byo_git

(Required Used to specify the Git repository URL to use as the Helm repository.

Note: SCM will have full control over the Helm repository. So use a dedicated repository for the Helm repository.

git_helm_repo_branch infrastructure > git > byo_git (Required) Used to specify the Git repository branch to use for the Helm repository.
git_selfsigned_cacert infrastructure > git > byo_git (Optional) Used to specify the path to a self-signed certificate.

For example, if you copy the Git certificate from the Git instance to the SCM instance in the /home/opc/cmapp/<CM_RESOURCE_PREFIX>/certs directory, which is volume mounted to the /home/opc/certs directory in the SCM container, you can assign /home/opc/certs/rootCA.crt as the value for this parameter.

You can also copy the certificates to SCM using File Sync Utility, for more information see Uploading Files to the SCM Container Using File Sync Utility.

git_url Infrastructure > git > gitlab (Required) Used to specify the URL for the GitLab instance.
git_user infrastructure > git > gitlab (Required) Used to specify the user with access to create GitLab projects in the specified GitLab instance.
git_accesstoken infrastructure > git > gitlab (Required) Used to specify the access token, with the API scope, for the GitLab user. You can create the access token in user settings.
git_selfsigned_cacert infrastructure > git > gitlab

(Required) Used to specify the path to a self-signed certificate.

For example, if you copy the Git certificate from the Git instance to the SCM instance in the "/home/opc/cmapp/<CM_RESOURCE_PREFIX>/certs" directory, which is volume mounted to the "/home/opc/certs" directory in the SCM container, you can assign "/home/opc/certs/rootCA.crt" as the value for this parameter.

You can also copy the certificates to SCM using File Sync Utility, for more information see Uploading Files to the SCM Container Using File Sync Utility.

siebel_lb_subnet_cidr

infrastructure

(Required for advanced network configuration) CIDR range for Load Balancer subnet. For more information about CIDR ranges for subnets, see Using Advanced Network Configuration.

siebel_private_subnet_cidr

infrastructure

(Required for advanced network configuration) CIDR range for Kubernetes worker nodes private subnet.

siebel_db_subnet_cidr

infrastructure

(Required for advanced network configuration) CIDR range for the database private subnet.

siebel_cluster_subnet_cidr

infrastructure

(Required for advanced network configuration) CIDR range for OKE cluster subnet (Kubernetes API server).

siebel_lb_subnet_ocid

infrastructure

(Required for using existing VCN resource) OCID of the regional subnet where the Load Balancer will be attached. Allow TCP port 443 from your client network where the users will access Siebel application.

siebel_private_subnet_ocid

infrastructure

(Required for using existing VCN resource) OCID of the subnet where the OKE worker nodes will be attached. The following needs to be ensured:

  • Allow all TCP port traffic in the same subnet, enables pods on one worker node to communicate with pods on other worker nodes.
  • Allow all TCP port traffic from cluster subnet, enables Kubernetes control plane to communicate with worker nodes.
  • Allow TCP port 22 ingress from SCM instance subnet/VCN, for SCM to SSH to worker nodes.
  • Allow egress rule for "All <region> Services in Oracle Services Network", enables accessing OCI container registry and other OCI services from worker nodes.
  • Allow egress for TCP port 6443, 12250 to cluster subnet, enables Kubernetes worker to Kubernetes API endpoint communication and Kubernetes worker to control plane communication.
  • Allow ICMP Port 3 and 4 for instances to receive Path MTU Discovery fragmentation messages.

siebel_db_subnet_ocid

infrastructure

(Required for using existing VCN resource) OCID of the subnet where the Database will be created. The following needs to be ensured:

  • Allow TCP port 22 ingress from SCM instance subnet/VCN, for SCM to SSH to DBCS node.
  • Allow TCP port 1521, 1522 from SCM instance subnet for database import and worker nodes for Siebel CRM to connect to the database.

siebel_cluster_subnet_ocid

infrastructure

(Required for using existing VCN resource) OCID of the subnet where the Kuberenetes API end point will be made available. The following needs to be ensured:

  • Allow all TCP port traffic from worker nodes private subnet, enables Kubernetes control plane to communicate with worker nodes.
  • Allow ingress for TCP port 6443 to the cloud manager instance subnet for accessing the Kubernetes cluster.
  • Allow ingress for TCP port 6443 and 12250 to the worker nodes for connecting with the API server.
  • Allow ICMP port 3 and 4 for instances to receive Path MTU Discovery fragmentation messages.
  • Allow egress rule for "All <region> Services in Oracle Services Network", enables accessing OCI container registry and other OCI services from worker nodes.

vcn_ocid_of_db_subnet

infrastructure

(Required for using existing VCN resource) OCID of the VCN which will be attached to the access control list of autonomous database (ATP). This is needed for establishing connection when the database is launched in a different VCN than the worker node subnet.

load_balancer_type

infrastructure

(Optional) Option to make load balancer as private/public

Customer can restrict visibility of the Siebel application using this payload parameter.

Supported values are one of: Private, Public.

Choosing the "Public" option will assign a loadbalancer with public IP for public access.

Choosing the "Private" option will create a loadbalancer with only private IP which can be accessed within the network only.

If it is not specified, a public IP will be assigned.

load_balancer_ssl_cert_path infrastructure

(Optional) Specifies the path of the ssl certificate file which contains public certificate or collection of public certificates that you can provide as an aggregated group for load balancer.

The ssl certificate should be in PEM format only.

If your ssl certificate submission returns an error, the most common reasons are:

  • Your ssl public certificate is malformed.
  • The system does not recognize the encryption method used for your certificate.
load_balancer_private_key_path infrastructure

(Optional) Speficies the path of the private key file for the Load Balancer TLS/SSL certificate.

The private key should be in PEM format only.

If your private key submission returns an error, the most common reasons are:

  • You provided an incorrect password.
  • Your private key is malformed.
  • The system does not recognize the encryption method used for your key.
load_balancer_private_key_password infrastructure

(Optional) The OCID of the secret containing the password of the Load Balancer private key.

This will be used to decrpyt the private key provided in the 'load_balancer_private_key_path' parameter.

load_balancer_tls_secret_name infrastructure

Specifies the name of the Load Balancer tls secret name to be given during environment provisioning.

Note: If you provide ingress annotations, the value of tls-secret annotation should be same as the value of this parameter.

The default value for load_balancer_tls_secret_name is "lb-tls-certificate". You can provide "lb-tls-certificate" for the value of tls-secret annotation under the ingress controller annotation section if this parameter is not configured in the payload.

shift_siebel_fs infrastructure (Optional) This parameter specifies whether shifting of the file system is to be executed or skipped while BYO-FS(infrastructure > mounttarget_exports) is used. Default value is set to True.
mounttarget_exports infrastructure

(Required if the "Use existing resources" option is chosen during SCM stack creation)

The mount_target_private_ip and export_path information to be used for Siebel file system.

kubernetes_type infrastructure > kubernetes

Specifies type of kubernetes supported by SCM.

Allowed values are OKE or BYO_OKE or BYO_OCNE or BYO_OTHER

If OKE, then SCM will create an OKE during environment provisioning

If BYO_OKE, user needs to provide OKE cluster details.

If BYO_OCNE, user needs to provide OCNE cluster details.

If BYO_OTHER, user can provide any other type of cluster which adheres to CNCF standards.

This field will become mandatory if the "Use existing resources" option is chosen during SCM stack creation).

oke_node_count infrastructure > kubernetes > oke

(Optional) Specifies the number of nodes to be created in the cluster. On a region with multiple availability domains, node pools are distributed across all availability domains. The default is 3 availability domains. For more information about node counts, see OCI documentation.

oke_node_shape infrastructure > kubernetes > oke

(Optional for Flex shape type) Specifies the compute shape for the cluster node. Example shape options include:

  • VM.Standard.Flex
  • VM.Standard.E4.Flex
  • VM.Standard2.4 (default shape, which might be appropriate for a minimal sized Siebel CRM environment)

Note: For Flex (flexible) node shape options only, the parameters under node_shape_config specify values for the memory and ocpus parameters. (For non-flexible node shape options, these parameters are not editable.)

For more information about compute shapes, see OCI documentation.

memory_in_gbs infrastructure > kubernetes > oke > oke_node_shape_config

(Optional for Flex shape type) Specifies the amount of memory available to each node in the node pool, in gigabytes. This setting is editable only for flexible node shape options.

ocpus infrastructure > kubernetes > oke > oke_node_shape_config

(Optional for Flex shape type) Specifies the number of Oracle CPUs (OCPUs) available to each node in the node pool. This setting is editable only for flexible node shape options.

oke_cluster_id

Note: You can either pass oke_cluster_id and oke_endpoint or you can pass only oke_kubeconfig_path in payload

infrastructure > kubernetes > byo_oke

(Required when 'kubernetes_type' is BYO_OKE)

The OCID of the OCI Kubernetes Cluster.

Note:

  • The SCM instance should have access to the OKE cluster to perform any operation on cluster-related resources. The following policy statement enables <subject> to access and perform operations on cluster-family in compartment id <oke_compartment_ocid> - Allow <subject> to manage cluster-family in compartment id <oke_compartment_ocid>
  • VCN peering is required if OKE and SCM instance reside in different VCNs. For more information, refer to Access to Other VCNs: Peering.

For more information, see Using Vault for Managing Secrets.

oke_endpoint

Note: You can either pass oke_cluster_id and oke_endpoint or you can pass only oke_kubeconfig_path in payload

infrastructure > kubernetes > byo_oke

(Required when 'kubernetes_type' is BYO_OKE)

Specifies the endpoint used to generate kubeconfig and access cluster.

The available options are

  • PRIVATE
  • PUBLIC

Depending on the input, either private or public endpoint will be used to access cluster.

oke_kubeconfig_path infrastructure > kubernetes > byo_oke

(Required when 'kubernetes_type' is BYO_OKE)

Specifies the path of kubeconfig file of an existing OKE to access and configure cluster.

Copy the kubeconfig file to the SCM container at this location: '/home/opc/siebel' and provide the path for the file, such as '/home/opc/siebel/kubeconfig'.

Note:

  • You can provide OKE information either by passing parameters (oke_cluster_id and oke_endpoint) or directly passing kubeconfig path using parameter oke_kubeconfig_path
  • SCM instance should be having access to OKE to perform any operation on cluster-related resources. The following policy statement enables <subject> to access and perform operation on cluster-family in comartment id <oke_compartment_ocid> - Allow <subject> to manage clusterfamily in compartment id <oke_compartment_ocid>
  • VCN peering is required if OKE and SCM instance reside in different VCNs. For more information, refer to Access to Other VCNs: Peering.

For more information, see Using Vault for Managing Secrets.

kubeconfig_path infrastructure > kubernetes > byo_ocne

infrastructure > kubernetes > byo_other

(Required when 'kubernetes_type' is BYO_OCNE or BYO_OTHER)

Specifies the path of kubeconfig file of an existing Kubernetes cluster (other than OKE, for example, an OCNE cluster) to access and configure cluster.

Copy the kubeconfig file to the SCM container at this location: '/ home/opc/siebel' and provide the path for the file, such as '/home/opc/ siebel/kubeconfig'.

Note: SCM instance should have access to Kubernetes cluster to perform any operation on cluster-related resources.

byo_ns

infrastructure > kubernetes > byo_ocne

infrastructure > kubernetes > byo_other

infrastructure > kubernetes > byo_oke

(Optional) Specifies whether the namespace is user managed or not. When set to true, SCM will skip creating and deleting the Kubernetes namespace during Siebel CRM provisioning and cleanup operations.

Note: You must ensure that the existing namespace meets the following criteria for seamless integration:

  • The existing namespace name must match the name field in the Siebel CRM deployment payload.
  • The existing namespace must be empty, with no existing flux configurations or deployments.
ingress_service_type infrastructure > ingress_controller

Specifies ingress service type to be provisioned during Siebel CRM deployment.

Allowed values are LoadBalancer or NodePort.

ingress_controller_service_annotations infrastructure > ingress_controller

(Optional) Specifies annotations that needs to be added to ingress service

Note: When ingress_service_type is LoadBalancer and for 'BYO OKE' or 'BYO OCNE' use case 'service.beta.kubernetes.io/oci-load-balancer-subnet1' annotation is required under sub-section 'ingress_controller_service_annotations'

siebfs_mt_export_paths

infrastructure > mounttarget_exports

(Required if the "Use existing resources" option is chosen during SCM stack creation)

The list of mount_target_private_ip and export_path information to be used for Siebel file system matching the number of siebel_file_system_count in source environment.

The payload structure would be:

"infrastructure": { "mounttarget_exports":{ "siebfs_mt_export_paths":[ {"mount_target_private_ip" : ****,"export_path": "/exttest2-siebfs0"}, {"mount_target_private_ip" : **** ,"export_path": "/exttest2-siebfs1"}, {"mount_target_private_ip" : ****, "export_path": "/exttest2-siebfs1"} ] }, (other infrastructure payload parameters) }

migration_package_mt_export_path

infrastructure > mounttarget_ exports

(Required if the "Use existing resources" option is chosen during SCM stack creation)

The mount_target_private_ip and export_path information to be used for Migration storage.

The payload structure would be:

      { "mounttarget_exports":
          { "migration_package_mt_export_path":
                {"mount_target_private_ip" : "****", "export_path": "/test-migration"}
         }
     }

Note: If this parameter is not provided for SCM created Siebel Deployment, SCM will create a dedicated export path for migration storage with path /<env_namespace-migration. This can be mounted in target environments.

db_type

database

Specifies one of the following:

  • ATP (for Oracle Autonomous Database)

  • DBCS_VM (for Oracle Database Cloud Service)

  • BYOD (stands for Bring Your Own Database – for the case when the "Use existing resources" option is chosen during Cloud Manager stack creation )

For ATP, also include options under database > atp.

For DBCS_VM, also include options under database > dbcs_vm.

For BYOD, also include options under database > byod. For more information, see Notes on BYOD (Bring Your Own Database).

siebel_admin_username

database > auth_info

(Mandatory) The username of the Siebel administrative user.

siebel_admin_password

database > auth_info

(Mandatory) OCID of the secret containing the Siebel Administration User password. Password should not contain the username as a part of it.

For more information on the password format criteria, refer to the "Characters Supported in Siebel Passwords" section in the Siebel Security Guide.

For more information, see Using Vault for Managing Secrets.

table_owner_user

database > auth_info

(Mandatory) The Table owner in which the Siebel schema will be imported.

table_owner_password

database > auth_info

(Mandatory) OCID of the secret containing he login password used for the Siebel table owner. Password should have at least 2 Upper characters, 2 Lower characters, 2 Digits and 2 special characters from _,#,- of length 9 to 30 characters. Password should not contain the username as a part of it.

For more information, see Using Vault for Managing Secrets.

default_user_password

database > auth_info

(Mandatory) OCID of the secret containing the default user password updated for all the users.

For more information on the password format criteria, refer to the "Characters Supported in Siebel Passwords" section in the Siebel Security Guide.

For more information, see Using Vault for Managing Secrets.

anonymous_user_password

database > auth_info

(Mandatory) OCID of the secret containing the anonymous user password which will be updated.

For more information on the password format criteria, refer to the "Characters Supported in Siebel Passwords" section in the Siebel Security Guide.

For more information, see Using Vault for Managing Secrets.

admin_password

database > atp

OCID of the secret for the password of the ATP database administrator user. Password should be have at least 12 to 30 characters, 1 upper character, 1 lower character and one number. Password cannot contain "" or the word "admin" in it. Review the password policy for shared ATP infrastructure in OCI and provide a valid password. For more information about the Oracle Autonomous Database, see https://docs.oracle.com/en/cloud/paas/atp-cloud/index.html on Oracle Help Center.

For more information, see Using Vault for Managing Secrets.

wallet_password

database > atp

(OCID)(Required) OCID of the secret containing the password for ATP wallet download. Password can contain alphanumeric characters and of length 8 to 60.

For more information, see Using Vault for Managing Secrets.

cpu_cores

database > atp

(Required) Specifies the ATP database's allocated Elastic CPUs (ECPUs). The minimum value is 2.

whitelist_cidrs database > atp

Specifies the cidrs to be added to the ATP DB ACL list when cloudmanager creates database

Cloudmanager creates Autonomous Database with the Secure access from allowed IPs and VCNs only option, you can restrict network access by defining Access Control Lists (ACLs).

When using bring your own flow like BYO OCNE and if you want to include cidrs of bring your own components in ACL list of ATP DB to establish connection between them, you can utilize this parameter.

Example:

"whitelist_cidrs": "[129.0.0.0/8]"

storage_in_tbs

database > atp

(Required) Specifies the ATP database's disk storage, in terabytes. The minimum value is 1.

db_version

database > atp

(Optional) Specifies the ATP database version. Supported values are 23ai or 19c. The default is 19c.

wallet_path

database > byod

(Required for user provided database if the "Use existing resources" option is chosen during SCM stack creation)

The absolute path of the Oracle net services configuration files or Oracle client credentials (wallet) is required for connecting to the database. The wallet files have to be copied inside the SCM container. The wallet should contain atleast the tnsnames.ora for a valid folder. During environment provisioning the wallet will be validated if it contains the tnsnames.ora. TLS enabled wallets are also supported. The provided wallet path will be copied inside the environment directory for usage. For more information, see Notes on BYOD (Bring Your Own Database).

tns_connection_name

database > byod

(Required for user provided database if the "Use existing resources" option is chosen during SCM stack creation)

This is the connection identifier which will be used by the Siebel CRM application to establish connection to the database. The provided connection identifier will be validated if it’s present in the tnsnames.ora. For more information, see Notes on BYOD (Bring Your Own Database).

drg_ocid database > byod (Optional) OCID of the DRG to be attached with the OKE nodes subnet to allow traffic from the VCN (where Database resides) provided that the both the DB VCN and CM VCN is peered.

For more information, see Using Vault for Managing Secrets.

destination_db_cidr_block database > byod (Optional) Destination CIDR block where traffic has to be routed from OKE nodes subnet to the VCN (where Database resides) provided that the both the DB VCN and CM VCN is peered.

availability_domain

database > dbcs_vm

(Optional) The availability domain in which the database is to be used. Possible availability domains are 1, 2, and 3, depending on the region. Defaults to 1.

cpu_count

database > dbcs_vm

(Optional) The OCPU count for the DBCS database node. Possible values are from 4 to 64. Required memory is calculated on the formula of 16 GB times the number of OCPU cores. The current supported flex type relevant to this setting is VM.Standard.E4.Flex.

data_storage_size_in_gbs

database > dbcs_vm

(Required) The storage size of the database instance, in gigabytes. The different storage sizes are: 256, 512, 1024, 2048, 4096, 6144, 8192, 10240, 12288, 14336, 16384, 18432, 20480, 22528, 24576, 26624, 28672, 30720, 32768, 34816, 36864, 38912, or 40960.

database_edition

database > dbcs_vm

(Optional) The edition of Oracle Database to be used. Currently supported versions are:

  • DATABASE_EDITION_ENTERPRISE_EDITION (default)

  • DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE

db_admin_username

database > dbcs_vm

(Required) Username for the Oracle schema user to be created with DBA privileges for administration activities. Username should have atleast 6 to 15 characters and only alphabets.

db_admin_password

database > dbcs_vm

(OCID)(Required) OCID of the secret for the password of the Oracle schema user. Password should have atleast 2 Upper characters, 2 Lower characters, 2 Digits and 2 special characters from _,#,- of length 9 to 30 characters. Password should not contain the username as a part of it.Password should not contain the username as a part of it.

For more information, see Using Vault for Managing Secrets.

mount_target_ip database>dbcs_vm (Required when infrastructure > mounttarget_exports is provided) IP address of the mount target used for creating the database directory in the DB node.
export_path database>dbcs_vm (Required when infrastructure > mounttarget_exports is provided) Export path in the mount target used for creating the database directory in the DB node.

Note: This export path will be used for copying the database dumps and database directory for the import in database shifting stage.

db_version

database > dbcs_vm

(Mandatory) Specifies the DBCS database version. Supports versions from 19c to 23ai.

shape

database > dbcs_vm

(Required) The shape of the node for the Oracle Database instance. The different shapes in which the database can be provisioned can be found in the Limits, Quotas, and Usage section in the OCI console.

cpu

size > ses_resource_limits

(Optional) Specifies CPU resource limits of SES containers.

This parameter specifies the max number of CPU units that can be allocated to the container. It can be given as a whole number like "1" or as a decimal number like "0.5" or in milliCPU units like "500m". The default is "2". Precision finer than "1m" is not allowed. For more information, refer to Kubernetes documentation.

If not specified in payload, default value is used.

ses_resource_limits must be greater than or equal to the value of ses_resource_requests parameter.

memory

size > ses_resource_limits

(Optional) Specifies memory resource limits of SES containers.

This parameter specifies the max amount of memory that can be allocated to the container. It can be given in Ki,Mi,Gi and Ti units. The default is "4Gi". Specify in multiples of 2, such as 4, 8, 16, and so on. For more information, refer to Kubernetes documentation.

If not specified in payload, default value is used.

ses_resource_limits must be greater than or equal to the value of ses_resource_requests parameter.

cpu

size > ses_resource_requests

(Optional) Specifies the minimum guaranteed amount of CPU resources that is to be reserved for SES containers.

It can be given as a whole number or with a decimal point like "0.5" or in milliCPU units like "500m". The default is "1". A request with a decimal point, such as "0.1", is converted to "100m" (100 milliCPU) by the API. Precision finer than "1m" is not allowed. For more information, refer to Kubernetes documentation.

If not specified in payload, default value is used.

ses_resource_limits must be greater than or equal to the value of ses_resource_requests parameter.

memory

size > ses_resource_requests

(Optional) Specifies the minimum guaranteed amount of memory resources that is to be reserved for SES containers.

It can be given in Ki,Mi,Gi and Ti units. The default is "4Gi". Specify in multiples of 2, such as 4, 8, 16, and so on. For more information, refer to Kubernetes documentation.

If not specified in payload, default value is used.

ses_resource_limits must be greater than or equal to the value of ses_resource_requests parameter.

cpu

size > cgw_resource_limits

(Optional) Specifies CPU resource limits of Siebel Cloud Gateway containers.

Default value is "2". If not specified in payload, default value is used.

cgw_resource_limits must be greater than or equal to the value of cgw_resource_requests parameter.

memory

size > cgw_resource_limits

(Optional) Specifies memory resource limits of Siebel Cloud Gateway containers.

Default value is "4Gi". If not specified in payload, default value is used.

cgw_resource_limits must be greater than or equal to the value of cgw_resource_requests parameter.

cpu

size > cgw_resource_requests

(Optional) Specifies the minimum guaranteed amount of CPU resources that is to be reserved for Siebel Cloud Gateway containers.

Default value is "1". If not specified in payload, default value is used.

cgw_resource_limits must be greater than or equal to the value of cgw_resource_requests parameter.

memory

size > cgw_resource_requests

(Optional) Specifies the minimum guaranteed amount of memory resources that is to be reserved for Siebel Cloud Gateway containers

Default value is "4Gi". If not specified in payload, default value is used.

cgw_resource_limits must be greater than or equal to the value of cgw_resource_requests parameter.

cpu

size > sai_resource_limits

(Optional) Specifies CPU resource limits reserved for Siebel Application Interface containers (SAI).

Default value is "2". If not specified in payload, default value is used.

sai_resource_limits must be greater than or equal to the value of sai_resource_requests parameter.

memory

size > sai_resource_limits

(Optional) Specifies memory resource limits of Siebel Application Interface containers (SAI).

Default value is "4Gi". If not specified in payload, default value is used.

sai_resource_limits must be greater than or equal to the value of sai_resource_requests parameter.

cpu

size > sai_resource_requests

(Optional) Specifies the minimum guaranteed amount of CPU resources that is to be reserved for Siebel Application Interface containers (SAI).

Default value is "1". If not specified in payload, default value is used.

sai_resource_limits must be greater than or equal to the value of sai_resource_requests parameter.

memory

size > sai_resource_requests

(Optional) Specifies the minimum guaranteed amount of memory resources that is to be reserved for Siebel Application Interface containers (SAI).

Default value is "4Gi". If not specified in payload, default value is used.

sai_resource_limits must be greater than or equal to the value of sai_resource_requests parameter.

siebel_monitoring

observability

(Optional) Set this value to true if you want to enable Siebel CRM Observability – Monitoring feature.

Set this value to false to disable all of monitoring feature.

enable_oci_monitoring

observability

(Optional) Set this value to true to send metrics from Prometheus to the OCI monitoring service and create an OCI Application Performance Monitoring (APM) dashboard in OCI.

Set this value to false to restrict sending the metrics from Prometheus to the OCI monitoring service and to restrict creating the OCI APM dashboard.

Notes:

The OCI infrastructure metrics for OCI resources will be available in OCI irrespective of the value of this parameter.

siebel_monitoring should be 'true' and the oci_config parameter must be configured when enable_oci_monitoring is set to 'true'.

send_alerts

observability

(Optional) Set this value to true if you want to enable alerting feature in Siebel CRM Observability – Monitoring

Set this value to false to disable alerting feature in Siebel CRM Observability – Monitoring.

Note: siebel_monioring should be 'true' when send_alerts is set to 'true' in payload.

siebel_logging

observability

(Optional) Set this value to true if you want to enable Siebel CRM Observability – Log Analytics feature.

Set this value to false to disable Siebel CRM Observability – Log Analytics feature.

enable_oci_log_analytics

observability

Set this value to true if you want to enable log streaming to OCI Logging Analytics.

Set this value to false to disable log streaming to OCI Logging Analytics.

Note: siebel_logging should be 'true' when enable_oci_log_analytics is set to 'true' in payload.

enable_oracle_opensearch

observability

Set this value to true if you want to create Oracle OpenSearch infrastructure and enable log streaming to Oracle OpenSearch.

Set this value to false to disable log streaming to Oracle OpenSearch.

Note: siebel_logging should be 'true' when enable_oracle_opensearch is set to 'true' in payload.

oci_log_analytics

observability

Required only for enabling OCI Logging Analytics for BYOR scenario, else optional. This section provides identifiers for various input parameters needed for enabling OCI Logging Analytics when BYOR ("Use existing resource") option is chosen during SCM installation.

smc_log_group_id

observability > oci_log_analytics

OCID of the log group in OCI Logging Analytics to send all SMC logs.

This is required only when enable_oci_log_analytics is set to 'true' in "Siebel CRM Observability – Monitoring and Log Analytics" solution and "Use existing resources" option is selected.

sai_log_group_id

observability > oci_log_analytics

OCID of the log group in OCI Log Analytics to push all SAI related logs.

This is required only when enable_oci_log_analytics is set to 'true' in "Siebel CRM Observability – Monitoring and Log Analytics" solution and "Use existing resources" option is selected.

ses_log_group_id

observability > oci_log_analytics

OCID of the log group in OCI Log Analytics to push all SES related logs.

This is required only when enable_oci_log_analytics is set to 'true' in "Siebel CRM Observability – Monitoring and Log Analytics" solution and "Use existing resources" option is selected.

gateway_log_group_id

observability > oci_log_analytics

OCID of the log group in OCI Log Analytics to push all Gateway related logs.

This is required only when enable_oci_log_analytics is set to 'true' in "Siebel CRM Observability – Monitoring and Log Analytics" solution and "Use existing resources" option is selected.

node_logs_log_group_id

observability > oci_log_analytics

OCID of the log group in OCI Log Analytics to push all Pod logs.

This is required only when enable_oci_log_analytics is set to 'true' in "Siebel CRM Observability – Monitoring and Log Analytics" solution and "Use existing resources" option is selected.

log_source_name

observability > oci_log_analytics

Name of the log source in OCI Log Analytics for identifying the origin of logs.

This is required only when enable_oci_log_analytics is set to 'true' in "Siebel CRM Observability – Monitoring and Log Analytics" solution and "Use existing resources" option is selected.

mount_target_private_ip

observability->monitoring_mt_export_path

Mount target private IP details required for monitoring component.

export_path

observability->monitoring_mt_export_path

Mount target export path details required for monitoring component.

storage_class_name

observability > prometheus

observability > oracle_opensearch

(Optional In SCM Observability feature, Prometheus and Oracle OpenSearch use block volume.

Block Volumes can be provisioned in one of the two following ways.

  • Dynamic provisioning involves automatic creation of storage volumes as needed by applications running in Kubernetes Cluster. Example: oci-bv
  • Static provisioning involves manual creation of storage volumes and making them available to applications by predefining them in Kubernetes cluster. For example: local-storage

If your Kubernetes cluster doesn't have support for dynamic provisioning of block volumes, and you want to use local storage of a node for Prometheus or Oracle OpenSearch., you can provide local-storage as the storage_class_name.

You can also provide your own custom integration storage type by passing the name of the storage class in this parameter.

Default value for this field is 'oci-bv'.

local_storage

observability > prometheus > local_storage_info

observability > oracle_opensearch > local_storage_info

If storage_class_name is local-storage, then this parameter specifies the local storage path.
kubernetes_node_hostname

observability > prometheus > local_storage_info

observability > oracle_opensearch > local_storage_info

If storage_class_name is local-storage, then this parameter specifies the hostname in which the local storage path is present.

oci_config_path

observability->oci_config

Specifies the path to the oci config file.

This is required only when either siebel_monitoring or enable_oci_log_analytics is enabled.

Note: The region defined in the oci configuration file provided as oci_config_path parameter should be same as region where SCM is deployed.

oci_private_api_key_path

observability->oci_config

Specifies the path to the oci private key file.

This is required only when either siebel_monitoring or enable_oci_log_analytics is enabled for Siebel CRM Observability – Monitoring and Log Analytics solution.

oci_config_profile_name

observability->oci_config

Specifies the profile name to be used in the oci config file.

This is required only when either siebel_monitoring or enable_oci_log_analytics is enabled for Siebel CRM Observability – Monitoring and Log Analytics solution.

smtp_host

observability->alertmanager_email_config

Specifies the SMTP host name required for SMTP configuration.

This is required only when send_alerts is set to 'true' in Siebel CRM Observability – Monitoring and Log Analytics solution.

smtp_from_email

observability->alertmanager_email_config

Specifies the SMTP from email address using which emaill will be sent required for SMTP configuration.

This is required only when send_alerts is set to 'true' in Siebel CRM Observability – Monitoring and Log Analytics solution.

smtp_auth_username

observability->alertmanager_email_config

Specifies the SMTP auth username required for SMTP configuration.

This is required only when send_alerts is set to 'true' in Siebel CRM Observability – Monitoring and Log Analytics solution.

smtp_auth_password_vault_ocid

observability->alertmanager_email_config

Specifies the ocid having SMTP auth password required for SMTP configuration.

This is required only when send_alerts is set to 'true' in Siebel CRM Observability – Monitoring and Log Analytics solution.

to_email

observability->alertmanager_email_config

Specifies the email to which alerts should be sent.

This is required only when send_alerts is set to 'true' in Siebel CRM Observability – Monitoring and Log Analytics solution.

enable_oracle_db_monitoring observability

(Optional) This parameter is used to enable Oracle DB monitoring. Set the value of this parameter to:

  • 'true' to enable Oracle DB monitoring.
  • 'false' to disable Oracle DB monitoring.

By default, the value is set to 'false'.

Note: If Siebel monitoring is not enabled, make sure that the siebel_monitoring parameter is set to 'true' when enable_oracle_db_monitoring is set to 'true'.

db_metrics_exporter_username observability > auth_info

(Required only when enable_oracle_db_monitoring is set to 'true' and db_type is set to 'BYOD')

The username that Oracle DB Exporter uses to authenticate with the Oracle Database and collect database metrics.

Note:

db_metrics_exporter_password observability > auth_info

(Required only when enable_oracle_db_monitoring is set to 'true')

The OCID of the secret that contains the DB Exporter user password. If you are not using a vault, enter the password as plain text.

For more information on the password format criteria, refer to the "Characters Supported in Siebel Passwords" section in the Siebel Security Guide.

For more information, see Using Vault for Managing Secrets.

wallet_path observability > auth_info (Required only when enable_oracle_db_monitoring is set to 'true' and db_type is set to 'BYOD')

The absolute path of the Oracle net services configuration files or Oracle client credentials (wallet) that is required for connecting to the database. You must copy the wallet files into the SCM container. The specified wallet path is then copied into the environment directory for use.

tns_connection_name observability > auth_info (Required only when enable_oracle_db_monitoring is set to 'true' and db_type is set to 'BYOD')

The connection identifier that Oracle DB Exporter uses to connect to the database. The connection identifier is validated to ensure it is present in the tnsnames.ora file.

data_as_metrics_exporter_username observability > auth_info

(Required only when enable_oracle_db_monitoring is set to 'true' and db_type is set to 'BYOD')

The username which Oracle DB Exporter will use to authenticate with Oracle database and execute custom SQL queries and provide it as database metrics.

Note:

data_as_metrics_exporter_password

observability > auth_info

(Required only when enable_oracle_db_monitoring is set to 'true')

The OCID of the secret that contains the password of the user specified in the data_as_metrics_exporter_username parameter. If you are not using a vault, enter the password as plain text.

For more information on the password format criteria, refer to the "Characters Supported in Siebel Passwords" section in the Siebel Security Guide.

For more information, see Using Vault for Managing Secrets.