6Siebel ADM Supported Data Types

Siebel ADM Supported Data Types

This chapter provides deployment and activation details and limitations for Siebel Application Deployment Manager (ADM) data types. The ADM data types described in this chapter represent Oracle's Siebel CRM customizations that are available for migration using the ADM framework. This chapter has the following topics:

How to Use This Appendix

This chapter contains details on each supported Siebel Application Deployment Manager (ADM) data type and the data types' behavior and dependencies during the ADM packaging, deployment, and activation processes. The tables in Summary of Siebel ADM Data Types and Siebel ADM Data Type Dependencies list this information.

A subset of data types requires additional consideration or configuration during the deployment process and are described in Siebel ADM Data Type Details.

Use this collected information on supported ADM data types to determine a migration strategy or when setting IT or infrastructure update policies. This information can help form a best course of action when performing complex ADM deployments with many dependencies.

You can also use this chapter to categorize the development data types based on the system impact or deployment behavior. This information is useful when combined with your internal release strategy. For example, data types that do not require activation can be deployed and made available immediately, with no downtime.

About the Siebel ADM Data Type Summary Table

This topic describes the column headings in the table in Summary of Siebel ADM Data Types that provide a summary definition of the content and functionality of individual Siebel Application Deployment Manager (ADM) data types. For information about how to use this information during the ADM packaging and deployment phases, see How to Use This Appendix.

The following list explains the terms used in the table in Summary of Siebel ADM Data Types:

  • Data Type. Name of the ADM data type, which represents the customized application data. Some of the listed data types are linked to subtopics in Siebel ADM Data Type Details, where more information can be found.

  • Deployment Alias. Alternate name or alias of the ADM data type used during deployment.

  • Category. High-level category of the ADM data types. There are three categories: database types, repository types, and file types.

  • A (Activate). Indicates if the ADM data type is available for activation on the target environment. If it is not available, then the data type does not require activation to be deployed and becomes active as soon as the copy process is complete.

  • S (System Impact). Indicates impact to the system, if any, when items of this type are deployed and activated. These are the possible values:

    • No impact. The data type can be deployed without any impact to the availability of the system.

    • User reconnect. The user must log in again to access any newly deployed items for this data type.

    • Manual activation. The data type does not support activation through the ADM framework; therefore, manual steps must be taken to complete the deployment.

    • Web server restart. Restart Web servers to fully deploy and activate the items for this data type.

    • Rolling server restart. Restart Siebel Servers to fully deploy and activate the items for this data type. However, it is possible to limit the impact on server availability by performing the deployment (and server restart) to a subset of the Siebel Servers at a time; that is, in a rolling fashion.

    • Siebel Enterprise Server restart. Restart the entire target Siebel Enterprise Server to fully deploy and activate items for this data type.

Summary of Siebel ADM Data Types

The following table presents summary data for each of the supported Siebel Application Deployment Manager (ADM) data types.

In this table, A indicates Activate and S indicates System Impact. For more information about each of the column headings, see About the Siebel ADM Data Type Summary Table.

Table ADM Supported Data Types

Data Type

Deployment Alias

Category

A

S

Access Controlled Business Service

Access Controlled Business Service

Database

Yes

No impact

Access Controlled Task

Access Controlled Task

Database

Yes

No impact

Access Group

AccessGroup

Database

No

No impact

Account Promotion

AccntPromo

Database

No

No impact

ADM Abs Admin Service Region

ADM Abs Admin Service Region

Database

No

No impact

ADM Abs Admin Time Window Map

ADM Abs Admin Time Window Map

Database

No

No impact

ADM Comm Inbound Group

ADM Comm Inbound Group

Database

No

No impact

ADM Comm Package

ADM Comm Package

Database

No

No impact

ADM CommSrv CM Adapter Administration

ADM CommSrv CM Adapter Administration

Database

No

No impact

ADM Internal Division

Internal Division

Database

No

User Reconnect

ADM Organization

Organization

Database

No

User Reconnect

ADM Position

Position

Database

No

User Reconnect

Note: ADM Internal Division, ADM Organization, and ADM Position are hierarchically related and must be implemented in a specific order. For more information, see Organizations, Divisions, and Positions.

ADM Project

ADM Project

Database

No

No impact

ADM Search Category Available Flds

ADM Search Category Available Flds

Database

No

No impact

ADM Search Connector

ADM Search Connector

Database

No

No impact

ADM Search Engine

ADM Search Engine

Database

No

No impact

ADM Search Parent Category

ADM Search Parent Category

Database

No

No impact

ADM Shift Exception

ADM Shift Exception

Database

No

No impact

ADM Shift Schedule

ADM Shift Schedule

Database

No

No impact

Aggregate Discount

AggrDiscount

Database

Yes

No impact

Aggregate Discount Sequence

AggrDiscSeq

Database

Yes

No impact

Assignment Group

AssignGroup

Database

No

No impact

Assignment Rule

AssignRule

Database

No

No impact

Attribute Adjustments

AttrAdjustments

Database

Yes

No impact

Audit Trail Admin

Audit Trail Admin

Database

Yes

No impact

Business Rule

Business Rule

Database

Yes

No impact

Content Fixup

Content Fixup

Database

No

No impact

Correspondence Template

Correspondence Template

Database

No

No impact

Cost List

CostList

Database

No

No impact

Data Map

DataMapObject

Database

No

No impact

Discount Matrices

Discount and EC Matrix

Database

Yes

No impact

EAI Data Map

EAI Data Map

Database

Yes

No impact

EAI Dispatch Service Rule Set

EAI Dispatch Service Rule Set

Database

Yes

No impact

ExpLOV: Expense Type LOV

ExpLOV

Database

Yes

No impact

ExpType: Expense Type

ExpType

Database

No

No impact

Fund

Fund

Database

No

No impact

Host Table

Host Table

Database

No

No impact

iHelp

iHelp

Database

Yes

No impact

iHelp - Header

iHelp - Header

Database

Yes

No impact

List of Values

LOV

Database

Yes

No impact

Message Types, Administration - Order Management

MessageType

Database

Yes

No impact

Personalization - Actions

Personalization - Actions

Database

No

No impact

Personalization - Applets

Personalization - Applets

Database

Yes

No impact

Personalization - Event Defs

Personalization - Event Defs

Database

No

No impact

Personalization - Events

Personalization - Events

Database

Yes

No impact

Personalization - Views

Personalization - Views

Database

Yes

User reconnect

Personalization - Rules

Personalization - Rules

Database

No

No impact

Predefined Query

PDQ

Database

No

No impact

Price List

PriceList

Database

Yes

No impact

Product Catalog

ProductCatalog

Database

No

No impact

Product Feature

ProdFeature

Database

No

No impact

Product Line

ProdLine

Database

No

No impact

Products

ProductData

Database

No

No impact

Promotion

Promotion

Database

No

No impact

Proposal Template

Proposal Template

Database

No

No impact

Responsibility

Responsibility

Database

No

No impact

Run-Time Business Service

Run-Time Business Service

Database

No

No impact

SmartScript

SmartScript

Database

Yes

No impact

SSO System

SSO System

Database

No

User reconnect

State Model

StateModel

Database

No

No impact

Symbolic URL

Symbolic URL

Database

No

User reconnect

UI Theme

UIThemeMapping

Database

No

No impact

User List

UserList

Database

No

No impact

View

View

Database

No

No impact

Volume Discount

VolumeDiscount

Database

Yes

No impact

Web Application

Web Application

Database

No

No impact

Web Service - Inbound

Web Service - Inbound

Database

Yes

No impact

Web Service - Outbound

Web Service - Outbound

Database

Yes

No impact

Workflow Action Type

Workflow Action Type

Database

Yes

No impact

Workflow Group

Workflow Group

Database

Yes

No impact

Workflow Policy

Workflow Policy

Database

Yes

No impact

Workload Rule

Workload Rule

Database

No

No impact

Workspace Projects

Workspace Projects

Database

No

Manual activation

About the Siebel ADM Data Type Dependency Table

This topic describes the column headings in the table in Siebel ADM Data Type Dependencies that provide general information about deployment dependencies of individual Siebel Application Deployment Manager (ADM) data types. For information about how to use this information during the ADM packaging and deployment phases, see How to Use This Appendix.

  • Data Type. The ADM data type of interest. For more information about this data type, see Summary of Siebel ADM Data Types. Some of the listed data types are linked to subtopics in Siebel ADM Data Type Details, where more information can be found.

  • Run-Time Customization Dependency. The names of objects that must exist before the specific data type item can be imported. (This dependency relates to deployment and not to the functionality itself.)

  • Repository Item Dependency. The names of repository objects that must exist before the specific data type item can be imported. (This dependency relates to deployment and not to the functionality itself.)

  • Runtime Repository Dependency. Describes if there are any Siebel Runtime Repository dependencies for the specific data type before deploying ADM data types.

Siebel ADM Data Type Dependencies

The following table presents deployment dependency data for each of the supported Siebel Application Deployment Manager (ADM) data types. For more information about each of the column headings, see About the Siebel ADM Data Type Dependency Table.

Table ADM Data Type Dependencies

Data Type

Run-Time Customization Dependency

Repository Item Dependency

Runtime Repository

Access Controlled Business Service

Business Services, Responsibilities

None

None

Access Controlled Task

Tasks, Responsibilities

None

None

Access Group

User lists

None

None

Account Promotion

Products, Promotions

None

None

ADM Abs Admin Service Region

Not applicable

Not applicable

Not applicable

ADM Abs Admin Time Window Map

Not applicable

Not applicable

Not applicable

ADM Comm Inbound Group

Not applicable

Not applicable

Not applicable

ADM CommSrv CM Adapter Administration

Not applicable

Not applicable

Not applicable

ADM Project

Data types

None

None

ADM Search Category Available Flds

None

Business components

Integration object and content object

ADM Search Connector

None

Business components

Integration object and content object

ADM Search Engine

None

Business components

Integration object and content object

ADM Search Parent Category

None

Business components

Integration object and content object

ADM Shift Exception

Not applicable

Not applicable

Not applicable

ADM Shift Schedule

Not applicable

Not applicable

Not applicable

Aggregate Discounts

Products

None

None

Aggregate Discount Sequence

Aggregate Discounts

None

None

Assignment Group

None

Assignment Object

None

Assignment Rule

None

Assignment Object

None

Attribute Adjustments

Product Class, Product Attributes, Variable Maps

None

None

Audit Trail Admin

None

None

None

Business Rule

None

None

None

Content Fixup

None

None

None

Correspondence Template

Microsoft Word document files

Business components

Integration object and content object

Cost List

Products

None

None

Data Map

None

Business objects, business components

None

Discount Matrices

Product, Volume Discount, Attribute Adjustments, Product Class, Product Lines

None

None

Divisions

Organizations

None

None

EAI Data Map

None

None

Integration object

EAI Dispatch Service Rule Set

None

None

None

ExpLOV: Expense Type LOV

None

None

Integration object

ExpType: Expense Type

List of Values

None

Integration object

Fund

Period

None

None

Host Table

None

None

None

iHelp

Access Groups, Responsibilities

None

Screens

iHelp - Header

Access Groups, Responsibilities

None

Screens

List of Values

None

None

None

Message Types, Administration - Order Management

None

None

None

Organizations

None

None

None

Personalization - Actions

None

None

None

Personalization - Applets

None

None

None

Personalization - Event Defs

Depends on personalization profile attributes (can be set at run-time)

None

None

Personalization - Events

Depends on personalization profile attributes (can be set at run-time)

None

None

Personalization - Rules

Depends on personalization profile attributes (can be set at run-time)

None

None

Personalization - Views

None

None

None

Positions

Organizations, Divisions

None

None

Predefined Query

None

None

None

Price List

Products, Volume Discounts, Attribute Adjustments

None

None

Product Catalog

Catalog Category, Products, Access Group

None

None

Product Feature

Product Line

None

None

Product Line

Products

None

None

Products

Product Line, Product Class

None

None

Promotion

None

None

None

Proposal Template

Microsoft Word files, other literature files

Applet repository data, business components

Integration object and content object

Responsibility

Views

None

Views being deployed

SmartScript

None

None

Any references to custom objects

SSO System

Symbolic URL

None

None

State Model

List of Values

None

None

Symbolic URL

Web Application Administration,

Host Administration, Fixup Administration

None

Target of the symbolic URL does not display unless the symbolic URL name is used as a calculated field value on the underlying business component.

UI Theme

None

None

None

User List

Responsibility and View

None

None

View

None

None

Views being deployed

Volume Discount

None

None

None

Web Application

None

None

None

Web Service - Inbound

None

None

Business Service

Web Service - Outbound

None

None

Business Service

Web Template

None

None

None

Workflow Action Type

None

None

None

Workflow Group

None

None

None

Workflow Policy

None

None

None

Workload Rule

None

Assignment object

None

Workspace Projects

None

None

None

Siebel ADM Data Type Details

The Siebel Application Deployment Manager (ADM) deployment process can vary somewhat, or have limitations or configurations associated with it, depending on the data type selected for migration. Review the following subset of data types for further details to configure or to take into account during ADM deployment and activation.

You can create hierarchy for any objects that you migrate using ADM. If your data type is close to a standard data type, then you can create a new data type. To do this, navigate to the Application Deployment Manager screen, then the Data Type Details view. Select the existing data type, choose Copy Record, and then modify the new data type record.

For example, the AssignRule data type has a child type Workload Rule. If the assignment rule does not have a workload rule, then this data type cannot be used to deploy assignment rules. You can create a new ADM data type by copying the AssignRule data type and giving it a different name. After creating the new data type, delete its child data type Workflow Rule. To do this, navigate to the Application Deployment Manager screen, then the Data Type Explorer view. In general, it is recommended not to modify the standard data type.

The following ADM data types are some of those that have additional ADM details:

    List of Values

    The List of Values (LOV) data type has the following behavior when deployed using ADM: the hierarchy in the List of Values Explorer view is different from the hierarchy in the List of Values list view. The List of Values Explorer view defines relations between different LOV types. To define relations within the same LOV type, use the Parent LIC field in the List of Values list view instead.

    Note: Hierarchical LOV data for the same LOV type that is defined in the List of Values Explorer view cannot be migrated using ADM. An error is generated during data export in this case.

      Organizations, Divisions, and Positions

      Organizations, divisions, and positions are implemented as a hierarchy as follows:

      Organizations
         Divisions
            Positions
      

      You cannot implement divisions without first implementing organizations. Similarly, you cannot implement positions without implementing organizations first and then divisions.

        Personalization - Actions

        The Personalization - Actions data type has the following behavior when deployed using ADM: this data type is imported together with, but before, the Personalization - Events data type. Both data types require the same activation and restore activation, which are defined only for Personalization - Events.

          Personalization - Event Defs

          The Personalization - Events Def data type has the following behavior when deployed using ADM: this data type is imported together with, but before, the Personalization - Events data type. Both data types require the same activation and restore activation, which are defined only for Personalization - Events.

            Personalization - Rules

            The Personalization - Rules data type has the following behavior when deployed using ADM: this data type is imported together with, but before, the Personalization - Applets data type. Both data types require the same activation and restore activation, which are defined only for Personalization - Applets.

              Run-Time Business Service

              The Run-Time Business Service data type has the following condition when packaging this data with ADM: the Run-Time Business Service data is only allowed in Synchronize deployment mode.

                SmartScript

                The SmartScript data type has the following limitations when deploying with ADM:

                • The new version of existing SmartScripts are activated when all users have stopped using the old version.

                • Make sure SmartScripts deployed using ADM are valid. For information about how to validate SmartScripts, see Validating the SmartScript Data Type.

                  Validating the SmartScript Data Type

                  SmartScripts deployed using ADM must be valid. If you export unverified SmartScripts, then the generated XML file is incorrect. For more information about SmartScripts, see Siebel SmartScript Administration Guide.

                  To validate SmartScripts

                  1. Navigate to the Administration - SmartScript screen, then the Scripts view. Select a SmartScript.

                  2. From the Menu button, select Verify.

                  3. The wizard starts and displays the Verify Intro view.

                    For more information about this task, see Siebel SmartScript Administration Guide.

                    UI Theme

                    The following task describes how to access the UI Theme data type when packaging it with ADM.

                    To access the UI Theme data type when packaging it with ADM

                    • Click the UI Themes data type link from the Deployment Projects, Data Type list to display the ISS Product Administration View.

                      From this view, you can access UI Theme records in the pick applets of the Base Theme or Product Theme fields in the Administration - Product screen, User Interface list applet.

                      Workflow Policy

                      The Workflow Policy data type requires additional attention when activating it after an ADM deployment. Perform the following task to make sure that additional configurations are satisfied.

                      To make sure that the Workflow Policy data type is ready for activation

                      1. Make sure that the Workflow Management (alias Workflow) component group is enabled. For information about this procedure, see Siebel System Administration Guide.

                      2. Update the following parameters for the Generate Triggers (alias GenTrig) server component:

                        • PrivUserName to Table Owner Name (for example, SIEBEL)

                        • PrivUserPass to table password (for example, db2)

                          Note: PrivUserName is the Table Owner Name.
                      3. Update the named subsystem ADMJavaSubsys:

                        • Navigate to the Administration - Server Configuration screen, then Enterprises, and then the Profile Configuration view.

                        • In the Profiles list, select ADMJavaSubsys.

                        • In the Profile Parameters list, select the JVM Classpath parameter, and add siebelmgrclient.jar to the class path.

                          Note: The number of characters in the class path must not exceed 100 characters.
                      4. Synchronize the batch server component Application Deployment Manager Processor (ADMProc).

                        For information about this task, see Siebel System Administration Guide.

                      5. Make sure that the Workflow Policy Activation Server (WfPolicyActSrvr) in the ADM enterprise profile is the name of the correct server.

                      6. Restart Oracle's Siebel Server.

                        Workspace Projects

                        The Workspace Projects data type has the following variations to general ADM deployment behavior:

                        • The deployment mode selection in the ADM Deployment Project view is set to custom for Workspace Projects, because this data type implements its own migration method (similar to synchronize) to make sure that the entire Workspace Project is fully migrated.

                        • The Workspace Project data type has its own syntax for the deployment filter field:

                          [Name] = "Any joint workspace name" [Full] = "Y/N"
                          

                          where:

                          • [Name] is required.

                          • [Full] is optional. The filter field defaults to N if no value is specified.

                          The optional Y or N flag indicates a full structure export or single object export for the objects that are included in the Workspace Project. In other words, Y indicates a full structure export, and N indicates a single object export.

                          For example, if a Workspace Project named Vehicle Products includes a Product called Car, then if [Full] is set to Y, then the associated product attributes like colors, options, accessories, and so on, are also exported, but if set to N, then they are not exported. Also, only one Workspace Project name can be specified in the filter and be exported for each entry.