1. Deploying Siebel CRM Containers on Kubernetes using Siebel Cloud Manager
  2. Use Cases for Enabling Component Groups or Components

Use Cases for Enabling Component Groups or Components

This topic provides detailed information about changes to make to support use cases for enabling component groups or components on a server. This topic is part of Use Cases for Making Incremental Changes. No restarts apply in these use cases.

Note: If you use SSH for Git, you must set the GIT_SSH_COMMAND environment variable in the current shell before you run your first remote Git command. For more information, see the "Configuring SSH for Manual Git Operations" section in Using Existing Git Repositories.
Use Case/Notes Sample Data Format

1. Component group, enabling on a server

Files:

  • server_edge.yaml
  • sai_quantum.yaml
  • siebel-ingress-app.yaml

Notes:

In server_edge.yaml:

  • Add the relevant block under the component_groups header.
  • Replace all occurrences of the SiebelWebTools component group shown here, and its components,with those for your custom component definition.
  • All components in that component group must be mentioned. Components that are not identified are disabled.

In sai_quantum.yaml:

  • Add entry for each Interactive Component/Object Manager in the component group in ConfigParam/Applications

  • Substitute the values required for your object manager component.

  • Perform git add, git commit, and git push operations after updating sai_quantum.yaml.

In siebel-ingress-app.yaml:

  • Update the required ingress content to provide access to components and services.

  • Substitute the values required for your deployment, to confirm the updates made in the other configuration files.

  • Perform git add, git commit, and git push operations after updating siebel-ingress-app.yaml.

 In server_edge.yaml : 
SiebelWebTools:
  components:
    SWToolsObjMgr_enu:
      definition:
        CC_ALIAS: SWToolsObjMgr_enu
        CC_RUNMODE: Interactive
        CG_ALIAS: SiebelWebTools
        CT_ALIAS: AppObjMgr
      parameters:
      - basic_params: []

In server_edge.yaml : Add the new Component group to be enabled in "profiles → ServerConfigParams → EnableCompGroupsSIA". This change is required to keep the server_edge.yaml Profile configuration to be intact with the list of Component Groups enabled in the server. 

profiles:
    Profile:
      LastUpdated: 2021/12/21 11:08:59
      ProfileName: siebel
    ServerConfigParams:
      EnableCompGroupsSIA: EAI,SiebelWebTools

In sai_quantum.yaml: 

sai_quantum:
  profiles:
  - ConfigParam:
      Applications:
      - AnonUserPool: 0
        AppDisplayName: ''
        AppDisplayOrder: 0
        AppIcon: ''
        AuthenticationProperties:
          AnonPassword: *****
          AnonUserName: GUESTCST
          GuestSessionTimeout: 300
          MaxTabs: 1
          SessionTimeout: 900
          SessionTimeoutWLCommand: UpdatePrefMsg
          SessionTimeoutWLMethod: HeartBeat
          SessionTimeoutWarning: 60
          SessionTokenMaxAge: 2880
          SessionTokenTimeout: 900
          SingleSignOn: false
          TrustToken: ''
          UserSpec: ''
        AvailableInSiebelMobile: false
        EAISOAPMaxRetry: 0
        EAISOAPNoSessInPref: false
        EnableExtServiceOnly: false
        Language: enu
        Name: webtools
        ObjectManager: SWToolsObjMgr_enu
        StartCommand: ''
        UseAnonPool: false

In siebel-ingress-app.yaml (located in the Siebel Cloud Manager Container /home/opc/siebel/<env_id>/<namespace>-cloudmanager/flux-crm/traefik/traefik-resources):

- match: PathPrefix(`/siebel/app/siebelwebtools/enu`)
    kind: Rule
    middlewares:
      - name: siebel-add-slash
      - name: siebel-max-body-size
    services:
      - name: quantum
      port: 4430
      scheme: https
      serversTransport: siebel-transport
      sticky:
      cookie:
        name: siebel-app-ingress
        httpOnly: true
        secure: true
        maxAge: 172800

2. Component group, removing configuration

Files:

  • server_edge.yaml
  • sai_quantum.yaml
  • siebel-ingress-app.yaml

Notes:

In server_edge.yaml:

  • Delete the relevant block under the component_groups header.

  • Perform git add, git commit, and git push operations after updating server_edge.yaml.

  • Verification:

    Component group removal can be seen in SMC configuration screen

In sai_quantum.yaml:

  • Delete the entry for each Interactive Component/Object Manager in the component group in ConfigParam/Applications

  • Perform git add, git commit, and git push operations after updating sai_quantum.yaml.

  • Verification:

    Component group removal can be seen in SMC configuration screen.

In siebel-ingress-app.yaml:

  • Delete the object manager related ingress content rule.

  • Perform git add, git commit, and git push operations after updating siebel-ingress-app.yaml.

 In server_edge.yaml:

Remove the entire block representing the component group configuration (for example, the below configuration block for removing SiebelWebTools ).

SiebelWebTools:
  components:
    SWToolsObjMgr_enu:
      definition:
        CC_ALIAS: SWToolsObjMgr_enu
        CC_RUNMODE: Interactive
        CG_ALIAS: SiebelWebTools
        CT_ALIAS: AppObjMgr
      parameters:
      - basic_params: []

In server_edge.yaml : Remove the Component group to be disabled from " Profiles→ServerConfigParams → EnableCompGroupsSIA ". This change is required to keep the server_edge.yaml Profile configuration to be intact with the list of Component Groups enabled in the server. 

rofiles:
    Profile:
      LastUpdated: 2021/12/21 11:08:59
      ProfileName: siebel
    ServerConfigParams:
      EnableCompGroupsSIA: SiebelWebTools (To be removed)

In sai_quantum.yaml:

Remove the entire block representing the Interactive Object_manager configuration (for example, the below configuration block for removing SWToolsObjMgr_enu).

sai_quantum:
  profiles:
  - ConfigParam:
      Applications:
      - AnonUserPool: 0
        AppDisplayName: ''
        AppDisplayOrder: 0
        AppIcon: ''
        AuthenticationProperties:
          AnonPassword: *****
          AnonUserName: GUESTCST
          GuestSessionTimeout: 300
          MaxTabs: 1
          SessionTimeout: 900
          SessionTimeoutWLCommand: UpdatePrefMsg
          SessionTimeoutWLMethod: HeartBeat
          SessionTimeoutWarning: 60
          SessionTokenMaxAge: 2880
          SessionTokenTimeout: 900
          SingleSignOn: false
          TrustToken: ''
          UserSpec: ''
        AvailableInSiebelMobile: false
        EAISOAPMaxRetry: 0
        EAISOAPNoSessInPref: false
        EnableExtServiceOnly: false
        Language: enu
        Name: webtools
        ObjectManager: SWToolsObjMgr_enu
        StartCommand: ''
        UseAnonPool: false

In siebel-ingress-app.yaml :

Remove the below configuration for removing the siebelwebtools endpoint. (located in the Siebel Cloud Manager Container /home/opc/siebel/<env_id>/<namespace>-cloudmanager/flux-crm/traefik/traefik-resources):

- match: PathPrefix(`/siebel/app/siebelwebtools/enu`)
    kind: Rule
    middlewares:
      - name: siebel-add-slash
      - name: siebel-max-body-size
    services:
      - name: quantum
      port: 4430
      scheme: https
      serversTransport: siebel-transport
      sticky:
      cookie:
        name: siebel-app-ingress
        httpOnly: true
        secure: true
        maxAge: 172800

3. Component, enabling on a server.

Files:

  • server_edge.yaml
  • sai_quantum.yaml
  • siebel-ingress-app.yaml

Notes:

In server_edge.yaml:

  • Provide the required values under the components header.

  • Replace the component shown here with those for the components you are enabling.

  • Perform git add, git commit, and git push operations after updating server_edge.yaml

In sai_quantum.yaml:

  • Add entry for Interactive Component/Object Manager in ConfigParam/Applications

  • Substitute the values required for your object manager component.

  • Perform git add, git commit, and git push operations after updating sai_quantum.yaml.

In siebel-ingress-app.yaml:

  • Update the required ingress content to provide access to components and services.

  • Substitute the values required for your deployment, to confirm the updates made in the other configuration files.

  • Perform git add, git commit, and git push operations after updating siebel-ingress-app.yaml.

In server_edge.yaml: 

SWToolsObjMgr_enu:
  definition:
    CC_ALIAS: SWToolsObjMgr_enu
    CC_RUNMODE: Interactive
    CG_ALIAS: SiebelWebTools
    CT_ALIAS: AppObjMgr
  parameters:
  - basic_params: []

In sai_quantum.yaml: 

- AnonUserPool: 0
  AppDisplayName: ''
  AppDisplayOrder: 0
  AppIcon: ''
  AuthenticationProperties:
    AnonPassword: *****
    AnonUserName: GUESTCST
    GuestSessionTimeout: 300
    MaxTabs: 1
    SessionTimeout: 900
    SessionTimeoutWLCommand: UpdatePrefMsg
    SessionTimeoutWLMethod: HeartBeat
    SessionTimeoutWarning: 60
    SessionTokenMaxAge: 2880
    SessionTokenTimeout: 900
    SingleSignOn: false
    TrustToken: ''
    UserSpec: ''
  AvailableInSiebelMobile: false
  EAISOAPMaxRetry: 0
  EAISOAPNoSessInPref: false
  EnableExtServiceOnly: false
  Language: enu
  Name: webtools
  ObjectManager: SWToolsObjMgr_enu
  StartCommand: ''
  UseAnonPool: false

In siebel-ingress-app.yaml (located in /home/opc/siebel/<env_id>/<namespace>-cloudmanager/flux-crm/traefik/traefik-resources):

- match: PathPrefix(`/siebel/app/siebelwebtools/enu`)
    kind: Rule
    middlewares:
      - name: siebel-add-slash
      - name: siebel-max-body-size
    services:
      - name: quantum
      port: 4430
      scheme: https
      serversTransport: siebel-transport
      sticky:
      cookie:
        name: siebel-app-ingress
        httpOnly: true
        secure: true
        maxAge: 172800

4. Component, removing configuration.

Files:

  • server_edge.yaml
  • sai_quantum.yaml
  • siebel-ingress-app.yaml

Notes:

In server_edge.yaml:

  • Delete the relevant block under the components header.

  • Perform git add, git commit, and git push operations after updating server_edge.yaml.

  • Verification:

    Component group removal can be seen in SMC configuration screen

In sai_quantum.yaml:

  • Delete the entry for Interactive Component/Object Manager in the component group in ConfigParam/Applications

  • Perform git add, git commit, and git push operations after updating sai_quantum.yaml.

  • Verification:

    Component group removal can be seen in SMC configuration screen.

In siebel-ingress-app.yaml:

  • Delete the object manager related ingress content rule.

  • Perform git add, git commit, and git push operations after updating siebel-ingress-app.yaml.

In server_edge.yaml:

Remove the entire block representing the component configuration. (Refer Use case 2, Removing a component group)

In sai_quantum.yaml:

Remove the entire block representing the Interactive Object_manager configuration.(Refer Use case 2, Removing a component group)

In siebel-ingress-app.yaml :

Remove the ingress content rule for removing the Object manager endpoint. (Refer Use case 2, Removing a component group)