Use Cases for Creating or Removing Custom Entities

This topic provides detailed information about changes to make to support use cases for creating or removing custom entities. No restarts apply in these use cases. This topic is part of Use Cases for Making Incremental Changes. You can create or remove the following custom entities:

  • Component definitions

  • Named subsystem definitions

  • Component group definitions

Use Cases for Creating or Removing Custom Component Definitions, Named Subsystem Definitions, and Component Group Definitions

Use Case/Notes Sample Data Format

1. Component definition, creating

File:

comp_definitions.yaml

Notes:

  • Replace all occurrences of the CustomADMBatchProc definition shown here, and its settings and parameters, with those for your custom component definition.

Verification:

  • New component definition can be seen in SMC configuration screen.

CustomADMBatchProc:
  definition:
    CC_ALIAS: CustomADMBatchProc
    CC_DESC_TEXT: Exports data items in batch
    CC_DISP_ENABLE_ST: Active
    CC_ENABLE_STATE: Enabled
    CC_INCARN_NO: '0'
    CC_NAME: Application Deployment Manager Batch Processor
    CC_RUNMODE: Batch
    CG_ALIAS: ADM
    CG_NAME: Application Deployment Manager
    CT_ALIAS: UDA Service
    CT_NAME: Custom Business Service Manager
  parameters:
  - basic_params:
    - PA_ALIAS: Method
      PA_VALUE: BatchExport
    url: https://smc-0.smc.<namespace>.svc.cluster.local:4430/siebel/v1.0/cloudgateway/enterprises/enterprise_name/compdefs/CustomADMBatchProc/parameters
    url: https://smc-0.smc.<namespace>.svc.cluster.local:4430/siebel/v1.0/cloudgateway/enterprises/enterprise_name/compdefs/CustomADMBatchProc/parameters
  - advanced_params: []
    url: https://smc-0.smc.<namespace>.svc.cluster.local:4430/siebel/v1.0/cloudgateway/enterprises/enterprise_name/compdefs/CustomADMBatchProc/parameters?advanced=true
  url: https://smc-0.smc.<namespace>.svc.cluster.local:4430/siebel/v1.0/cloudgateway/enterprises/enterprise_name/compdefs/CustomADMBatchProc

2. Component definition, removing configuration

File:

comp_definitions.yaml

Notes:

  • Delete the relevant block under the component_definitions header.

Verification:

  • Component definition removal can be seen in SMC configuration screen.

Remove the entire block representing the custom component definition (for example, the configuration block in the previous row).

3. Named subsystem, creating

File:

named_subsystem.yaml

Notes:

  • Add the relevant block under the named_subsystem header.

  • Replace all occurrences of the CustomADSISecAdpt definition shown here, and its settings and parameters, with those for your custom named subsystem definition.

Verification:

  • New named subsystem can be seen in SMC configuration screen.

CustomADSISecAdpt:
  definition:
    NSS_ALIAS: CustomADSISecAdpt
    NSS_DESC: Custom ADSI Security Adapter used for authentication by customer facing applicationss
    NSS_NAME: ADSI Security Adapter
    SS_ALIAS: InfraSecAdpt_LDAP
  parameters:
  - basic_params:
    - PA_ALIAS: CredentialsAttributeType
      PA_VALUE: physicalDeliveryOfficeName
    - PA_ALIAS: SecAdptDllName
      PA_VALUE: sscfadsi
    - PA_ALIAS: ServerName
      PA_VALUE: CHANGE_ME
    url: https://smc-0.smc.<namespace>.svc.cluster.local:4430/siebel/v1.0/cloudgateway/enterprises/enterprise_name/namedsubsystems/CustomADSISecAdpt/parameters
  url: https://smc-0.smc.<namespace>.svc.cluster.local:4430/siebel/v1.0/cloudgateway/enterprises/enterprise_name/namedsubsystems/CustomADSISecAdpt

4. Named subsystem, removing configuration

File:

named_subsystem.yaml

Notes:

  • Delete the relevant block under the named_subsystem header.

Verification:

  • Named subsystem definition removal can be seen in SMC configuration screen.

Remove the entire block representing the custom named subsystem definition (for example, the configuration block in the previous row).

5. Component group, creating

File:

comp_definitions.yaml

Notes:

  • Add the relevant block under the component_groups header.

  • Replace all occurrences of the CustomLoyaltyEngine definition shown here, and its settings and parameters, with those for your custom component group definition.

Verification:

  • New component group can be seen in SMC configuration screen.

CustomLoyaltyEngine:
  definition:
    CG_ALIAS: CustomLoyaltyEngine
    CG_DESC_TEXT: Siebel Loyalty Engine Components
    CG_DISP_ENABLE_ST: Enabled
    CG_ENABLE_STATE: Enabled
    CG_ENT_ENABLED: Y
    CG_NAME: Siebel Loyalty Engine
    CG_NUM_COMPONENTS: '3'
  url: https://smc-0.smc.<namespace>.svc.cluster.local:4430/siebel/v1.0/cloudgateway/enterprises/enterprise_name/compgroups/CustomLoyaltyEngine

6. Component group, removing configuration

File:

comp_definitions.yaml

Notes:

  • Delete the relevant block under the component_group header.

Verification:

  • Component group definition removal can be seen in SMC configuration screen.

Remove the entire block representing the custom component group definition (for example, the configuration block in the previous row).