Configuring Manifests

This topic describes how to configure Siebel Open UI manifests. It includes the following topics:

"Overview of Configuring Manifests"
"Configuring Custom Manifests"
"Adding Custom Manifest Expressions"
"Adding JavaScript Files to Manifest Administrative Screens"

Overview of Configuring Manifests

A manifest is a set of instructions that Siebel Open UI uses to identify the JavaScript files that it must download from the Siebel Server to the client so that it can render screens, views, applets, menus, controls, and other objects. For an overview of how Siebel Open UI uses this manifest, see "Example of How Siebel Open UI Renders a View or Applet".

Siebel CRM versions 8.1.1.9 and 8.1.1.10 use an XML manifest file to identify these JavaScript files in the following situations:

When Siebel Open UI initializes the Siebel application. Siebel Open UI does this download only for one Siebel application at a time.
The first time Siebel Open UI must display an applet in a Siebel application.

Starting with Siebel CRM versions 8.1.1.11 and 8.2.2.4, Siebel Open UI replaces the XML manifest file with manifest data that it stores in the Siebel Database. You cannot modify this predefined manifest data, but you can use the Manifest Administration screen in the client to configure the manifest data that your customization requires. For information about using a utility that migrates your custom manifest configurations from Siebel CRM version 8.1.1.9 or 8.1.1.10 to version 8.1.1.11 or 8.2.2.4, see the topic that describes migrating the Siebel Open UI manifest file in Siebel Database Upgrade Guide.

Example of How Siebel Open UI Identifies the JavaScript Files It Must Download

Figure 6-2 describes an example of how Siebel Open UI uses the manifest to identify the JavaScript file it must download so that it can use the presentation model for the SIS Account List Applet. The manifest maps the recyclebinpmodel.js file that resides in the siebel/custom folder to the presentation model that it uses to display this applet. For details about this example, see "Creating the Presentation Model" and "Configuring the Manifest for the Recycle Bin Example".

Figure 6-2 Example of How Siebel Open UI Identifies the JavaScript Files It Must Download

Explanation of Callouts

The example manifest administration includes the following items:

The Files list specifies the siebel/custom/recyclebinpmodel.js file.
The presentation model specifies siebel/custom/recyclebinpmodel when it calls the define method.

Example of a Completed Manifest Administration

Figure 6-3 includes an example of a completed manifest administration that configures Siebel Open UI to download JavaScript files for the Contact List Applet. For information about how to configure this example, see "Configuring Custom Manifests".

Figure 6-3 Example Manifest Administration

Explanation of Callouts

The example manifest administration includes the following items:

The Grid group uses the AND operator to group three expressions into the following group expression:

Desktop AND EditList AND Grid

A group expression is a type of expression that Siebel Open UI uses to arrange subexpressions into a group in the Object Expression list.
Siebel Open UI uses the Level field to determine the order it uses to evaluate expressions. It uses the following sequence:
1. It uses the Level field to determine the order it uses to evaluate group expressions. In this example, it uses the following sequence:
  - Evaluates the Grid group first.
  - Evaluates the Tile group next.
  - Evaluates the Map group last.
2. It uses the Level field within a group to determine the order it uses to evaluate each subexpression, which is a type of expression that Siebel Open UI displays as part of a group in the Object Expressions list. It displays each subexpression in an indented position below the group expression. In this example, it uses the following sequence to evaluate subexpressions that reside in the Grid group:
  - Evaluates the Desktop expression first.
  - Evaluates the EditList expression next.
  - Evaluates the Grid expression last.
  In this example, Siebel Open UI evaluates all the expressions that reside in the Grid group, and then does one of the following according to the result of this evaluation:
  - All expressions that reside in the Grid group evaluate to true. Siebel Open UI downloads the file that the Files list specifies.
  - Any expression that resides in the Grid group evaluates to false. Siebel Open UI discards the entire Grid group, and then evaluates the Tile group.
Siebel Open UI uses the Files list to identify the files it must download. In this example, it does the following evaluation:
- If the platform is a desktop, and if the mode is EditList, and if the user chooses Grid, then it downloads the siebel/jqgridrenderer.js file.
- If the platform is a desktop, and if the mode is EditList, and if the user chooses Tile, then it downloads the siebel/Tilescrollcontainer.js file.
To view an example that allows the user to choose Grid or Tile, see "Allowing Users to Change the Applet Visualization".

Configuring Custom Manifests

This topic describes how to configure the example described in "Example of a Completed Manifest Administration". For other examples that configure the manifest to download objects for:

Web templates and modified applet modes, see "Allowing Users to Change the Applet Visualization".
Different web templates, physical renderers, and presentation models depending on the applet and the user responsibility, see "Displaying Applets Differently According to the Applet Mode".
The physical renderer and the presentation model, see "Configuring the Manifest for the Recycle Bin Example".
A custom theme, see "Customizing the Logo" and "Customizing Themes".

To configure custom manifests

Make sure your custom presentation model or physical renderer uses the Define method:
1. Use a JavaScript editor to open your custom presentation model or physical renderer.
2. In the section where you configure Siebel Open UI to do the setup, make sure you use the Define method to identify the presentation model file or the physical renderer file.
  
  For an example that does this setup, see "Example of How Siebel Open UI Identifies the JavaScript Files It Must Download".
Configure the manifest files:
1. Log in to a Siebel client with administrative privileges.
2. Navigate to the Administration - Application screen, and then the Manifest Files view.
3. Verify that the Manifest Files view includes the files that Siebel Open UI must download for your custom deployment.
  
  For this example, verify that the Manifest Files view includes the following files:
```
siebel/listapplet.js
siebel/jqgridrenderer.js
```
  If the Manifest Files view does not include these files, then add them now. For more information, see "Adding JavaScript Files to Manifest Administrative Screens".
Configure the UI object:
1. Navigate to the Administration - Application screen, and then the Manifest Administration view.
2. In the UI Objects list, specify the following object.
  
  Field Value
  
  Type Applet
  
  Usage Type Physical Renderer
  
  Name Contact List Applet
For information, see "Fields of the UI Objects List".
Configure the Grid group:

For information about how to configure a group, see "Adding Group Expressions".
1. In the Object Expression list, add the following subexpression.
  
  Field Value
  
  Group Name Leave empty.
  
  Expression Desktop
  
  Level 1
  
  Operator Leave empty.
  
  Web Template Name Leave empty.
  
  For information, see "Fields of the Object Expression List".
2. Add another subexpression.
  
  Field Value
  
  Group Name Leave empty.
  
  Expression EditList
  
  Level 2
  
  Operator Leave empty.
  
  Web Template Name Leave empty.
3. Add another subexpression.
  
  Field Value
  
  Group Name Leave empty.
  
  Expression Grid
  
  Level 3
  
  Operator Leave empty.
  
  Web Template Name Leave empty.
4. Add the following group expression.
  
  Field Value
  
  Group Name Leave empty.
  
  Expression Grid
  
  Level 1
  
  Operator Leave empty.
  
  Web Template Name Leave empty.
5. Use the Move Up and Move Down buttons to arrange the subexpressions in ascending numeric order according to the value in the Level field. Make sure the Object Expression list displays all subexpressions below the group expression.
6. Use the Indent and Outdent buttons so that Siebel Open UI displays the subexpressions below and indented from the group expression. The tree in the Inactive Flag field displays this indentation.
7. In the UI Objects list, query the Name property for the name of the UI object that you are configuring. This query refreshes the Manifest Administration screen so that you can edit the Group Name and Operator fields of the group expression.
8. In the Object Expressions list, expand the tree that Siebel Open UI displays in the Inactive Flag field.
9. Set the following fields of the group expression.
  
  Field Value
  
  Group Name Grid
  
  Operator AND
Specify the files that Siebel Open UI must download for the Grid group:
1. Make sure the Grid group expression is chosen in the Object Expression list.
2. In the Files list, click Add.
3. In the Files dialog box, click Query.
4. In the Name field, enter the path and file name of the file.
  
  For example, enter the following value:
```
siebel/jqgridrenderer.js
```
5. Click Go.
  
  If the Files dialog box does not return the file that your deployment requires, then you must use the Manifest Files view to add this file before you can specify it in the Files list. For more information, see "Adding JavaScript Files to Manifest Administrative Screens".
6. Click OK.
Configure the Tile group:
1. Repeat Step 4, with the following differences:
  - For the group expression, set the Group Name field to Tile and the Level field to 2.
  - For the last subexpression, set the Expression field to Tile.
2. Repeat Step 5, except add the following file:
```
siebel/tilescrollrenderer.js
```
Configure the Map group:
1. Repeat Step 4, with the following differences:
  - For the group expression, set the Group Name field to Map and the Level field to 3.
  - Add only one subexpression with the Expression field set to Map.
2. Repeat Step 5, except add the following file:
```
siebel/custom/siebelmaprenderer.js
```
In the Object Expression list, use the Move Up, Move Down, Indent, and Outdent buttons until the Object Expression list resembles the configuration in Figure 6-3.

Field	Value
Type	Applet
Usage Type	Physical Renderer
Name	Contact List Applet

Field	Value
Group Name	Leave empty.
Expression	Desktop
Level	1
Operator	Leave empty.
Web Template Name	Leave empty.

Field	Value
Group Name	Leave empty.
Expression	EditList
Level	2
Operator	Leave empty.
Web Template Name	Leave empty.

Field	Value
Group Name	Leave empty.
Expression	Grid
Level	3
Operator	Leave empty.
Web Template Name	Leave empty.

Field	Value
Group Name	Leave empty.
Expression	Grid
Level	1
Operator	Leave empty.
Web Template Name	Leave empty.

Field	Value
Group Name	Grid
Operator	AND

Fields of the UI Objects List

Table 6-3 describes the fields of the UI Objects list.

Table 6-3 Fields of the UI Objects List

Field	Description
Inactive Flag	Set to one of the following values: Y. Make the object inactive. Make sure you set the Inactive Flag to Y for any custom object that your deployment does not require. N. Make the object active. Make sure you set the Inactive Flag to N for any custom object that your deployment requires. The Inactive Flag allows you to configure more than one manifest. You can activate or deactivate each of these configurations during development. You can set the Inactive Flag in the same way for each object that the Manifest Administration view displays.
Type	Choose one of the following values to specify the type of Siebel CRM object that you are customizing: Application View Applet Navigation Toolbar Menu Control For more information, see "How Siebel Open UI Chooses Files If Your Custom Manifest Matches a Predefined Manifest".
Usage Type	Specify how Siebel Open UI must download files. Choose one of the following values: Common. Siebel Open UI downloads the files when it initializes the Siebel application. Siebel Call Center is an example of a Siebel application. Theme. Siebel Open UI downloads only the files it requires to support a theme that you customize. For an example that uses this value, see "Customizing the Logo". Presentation Model. Siebel Open UI downloads the files that your custom presentation model requires. Physical Renderer. Siebel Open UI downloads the files that your custom physical renderer requires. Web Template. Siebel Open UI downloads files according to the Name property of the web template file. You specify this web template file in the web template in Siebel Tools. For more information, see "Identifying the Web Template File Name". For more information, see "How Siebel Open UI Chooses Files If Your Custom Manifest Matches a Predefined Manifest".
Name	Enter the name of your custom object. For example, if you set the Type to Applet, then you must specify the value that Siebel Tools displays in the Name property of the applet.

Fields of the Object Expression List

Table 6-4 describes the fields of the Object Expression list. You can configure a simple expression, or you can configure a complex expression that includes AND or OR operators, and that can include nested levels. For an example that includes complex expressions, see "Configuring Custom Manifests".

Table 6-4 Fields of the Object Expression List

Field	Description
Group Name	If the record that you are adding to the Object Expressions list is part of a group of two or more expressions, and if this record is the group expression, then enter a value in the Group Name field and leave the Expression field empty. The Object Expressions list is a hierarchical list. You can use it to specify complex expressions that you enter as more than one record in this list. You must add more than one record and indent at least one of them before you can enter a group name. For information about how to do this work, see "Adding Group Expressions".
Expression	If the record that you are adding to the Object Expressions list is: Not a group expression. Set a value in the Expression field and leave the Group Name field empty. A group expression. Leave the Expression field empty and enter a value in the Group Name field. If the Expression list does not include the expression that your deployment requires, then you must add a custom expression. For more information, see "Adding Custom Manifest Expressions".
Level	Enter a number to determine the order that Siebel Open UI uses to evaluate expressions that the Object Expression list contains. Siebel Open UI evaluates these expressions in ascending, numeric order according to the values that the Level field contains. If the Type field in the UI Objects list: Is Application, then Siebel Open UI evaluates every expression. It downloads each file that the Files list specifies for each expression that it evaluates to true. Is not Application, and if Siebel Open UI evaluates an expression to true, then it does the following: Downloads the file that the Files list specifies for this expression Does not process any expression that exists further down in the order Does not download any other files
Operator	If the record that you are adding to the Object Expressions list is a group expression, then you must specify the logical operator that Siebel Open UI uses to combine the subexpressions that the group contains. You can use one of the following values: AND. Specifies to combine subexpressions. If you specify AND, then Siebel Open UI downloads files only if it evaluates every subexpression in the group to true. OR. Specifies to consider individually each subexpression that resides in the group. If you specify OR, then Siebel Open UI downloads files according to the first subexpression that it evaluates to true. If the record that you are adding to the Object Expressions list is not a group expression, or if it does not reside at the top of the hierarchy, then leave the Operator field empty.
Web Template Name	If you set the Usage Type field in the UI Objects list to Web Template, then you must specify the name of the Siebel CRM web template file in the Web Template Name field. To identify this file name, see "Identifying the Web Template File Name".

Adding Group Expressions

You must use the sequence that this topic describes when you add a group expression. For an example that uses this sequence, see "Configuring Custom Manifests". For more information about group expressions and subexpressions, see "Example of a Completed Manifest Administration".

To add group expressions

Navigate to the Administration - Application screen, and then the Manifest Administration view.
In the UI Objects list, locate the UI object that you must modify.
In the Object Expression list, add the subexpressions.
Add the group expression. Leave the Group and Operator fields empty.
Use the Move Up and Move Down buttons to arrange the subexpressions in ascending numeric order according to the value in the Level field. Make sure the Object Expression list displays all subexpressions below the group expression.
Use the Indent and Outdent buttons so that Siebel Open UI displays the subexpressions below and indented from the group expression. The tree in the Inactive Flag field displays this indentation.
In the UI Objects list, query the Name property for the name of the UI object that you are configuring. This query refreshes the Manifest Administration screen so that you can edit the Group Name and Operator fields of the group expression.
In the Object Expressions list, expand the tree that Siebel Open UI displays in the Inactive Flag field.
Set the values for the Group Name field and the Operator field of the group expression.

How Siebel Open UI Chooses Files If Your Custom Manifest Matches a Predefined Manifest

If the values that you specify in the Type, Usage Type, and Name fields of the UI Objects list are identical to the values that a predefined UI object specifies, then Siebel Open UI uses your custom manifest. For example, Siebel Open UI comes predefined with a UI Object record with the Type set to Applet, the Usage Type set to Physical Renderer, and the Name set to Contact List Applet. To override this configuration, you must do the following work:

Create a new record in the UI Objects list that contains the same values in the Type, Usage Type, and Name fields that the predefined record contains.
Add a new record in the Object Expression list that evaluates to true.
Add a new record in the Files list for the object expression that evaluates to true.

The only exception to this rule occurs in the following situation:

You set the Type to Application.
You set the Usage Type to Common.
A winning expression exists in your customization. A winning expression is an expression that Siebel Open UI evaluates to true, and that Siebel Open UI then uses to identify the files it must download according to the configuration that the Manifest Administration view specifies.

In this situation, Siebel Open UI downloads the files that:

The predefined manifest configuration specifies
The winning expression of your custom manifest configuration specifies

Table 6-5 describes how Siebel Open UI chooses files if your manifest configuration matches the predefined manifest configuration for a UI object. The Configuration column describes values that the UI Objects list of the Manifest Administration screen contains.

Table 6-5 How Siebel Open UI Chooses Files If Your Custom Manifest Matches the Predefined Manifest

Configuration	Predefined Configuration Exists	Custom Configuration Exists	Result
Type is Application and Usage Type is Common	Yes	No	Siebel Open UI downloads files according to the winning predefined expressions.
Type is Application and Usage Type is Common	Yes	Yes	Siebel Open UI downloads files according to the winning predefined expression and the winning custom expressions.
Usage Type is not Common	Yes	No	Siebel Open UI downloads files according to the first predefined expression that it evaluates to true. If more than one expression exists, then it uses the level to determine the sequence it uses to evaluate these expressions.
Usage Type is not Common	Yes	Yes	Siebel Open UI downloads files according to the first custom expression that it evaluates to true. If more than one expression exists, then it uses the level to determine the sequence it uses to evaluate these expressions. If Siebel Open UI does not evaluate any custom expression to true, then it uses a predefined expression for this object.

Identifying the Web Template File Name

This topic describes how to identify the file name that a web template uses.

To identify the web template file name

Open Siebel Tools.

For more information, see Using Siebel Tools.
In the Object Explorer, click Web Template.
In the Web Templates list, locate the object definition for the web template.

For example, if you entered Applet Form Grid Layout in the Name field in the UI Objects list, then query the Name property in the Web Templates list for Applet Form Grid Layout.
In the Object Explorer, expand the Web Template tree, and then click Web Template File.
In the Web Template Files list, note the value that Siebel Tools displays in the Filename property.

For example, Siebel Open UI uses the CCAppletFormGridLayout.swt file for the Applet Form Grid Layout web template.

Adding Custom Manifest Expressions

This topic describes how to add a custom manifest expression.

To add custom manifest expressions

Log in to a Siebel client with administrative privileges.
Navigate to the Administration - Application screen, and then the Manifest Expressions view.

In the Expressions list, add the following expression.

Field	Value
Name	Enter text that describes the expression. For example, enter the following value: Desktop Siebel Open UI uses this value as an abbreviation for the expression that it displays in the Expression field in the Object Expression list in the Manifest Administration screen. It uses this abbreviation only to improve readability of the Object Expression list.
Expression	Enter an expression. For example, to apply the expression according to the: Platform, use the following expression: GetProfileAttr("Platform Name") = 'Desktop' This example applies the expression for desktop platforms. User position, use the following expression: GetProfileAttr("Primary Position Type") = "Sales Representative" This example applies the expression for the Sales Representative position. Siebel Open UI uses this value when it evaluates expressions that reside in the Object Expression list. For more information, see "GetProfileAttr Method".

Field

Value

Name

Enter text that describes the expression. For example, enter the following value:

Desktop

Siebel Open UI uses this value as an abbreviation for the expression that it displays in the Expression field in the Object Expression list in the Manifest Administration screen. It uses this abbreviation only to improve readability of the Object Expression list.

Expression

Enter an expression. For example, to apply the expression according to the:

Platform, use the following expression:

GetProfileAttr("Platform Name") = 'Desktop'

This example applies the expression for desktop platforms.

User position, use the following expression:

GetProfileAttr("Primary Position Type") = "Sales Representative"

This example applies the expression for the Sales Representative position.

Siebel Open UI uses this value when it evaluates expressions that reside in the Object Expression list. For more information, see "GetProfileAttr Method".

Using Temporary Manifest Expressions During Development

It is recommended that you configure a temporary manifest expression that makes the manifest specific to a single user. This configuration allows you to test and troubleshoot the manifest configuration, if necessary.

To use temporary manifest expressions during development

Configure a manifest.

For more information, see "Configuring Custom Manifests".
In the Expressions list, add an expression that configures the manifest for a single user.

For example:
Name Expression
CCHENG
GetProfileAttr("Login Name") = 'CCHENG'
Log out of the client, and then log back in to the client using the ID that you specified in Step 2.

If you encounter an error during the log in, or if the client stops responding, then do the following:
1. Close the client session.
2. Log in with a user ID that is different from the ID that you specified in Step 2.
3. Troubleshoot the manifest configuration error.
  
  For example, assume you configure a manifest that references a custom file in the siebel/custom folder, but you forget to add this custom file to this folder. If you attempt to log in to the client with this configuration, then the client might stop responding, and you might not be able to examine the manifest configuration. If you configure a temporary expression that is specific to a single user, then you can log in as a different user and troubleshoot the manifest configuration.
If necessary, fix the manifest configuration.
Remove the expression that you added in Step 2.

Name	Expression
CCHENG	GetProfileAttr("Login Name") = 'CCHENG'

Adding JavaScript Files to Manifest Administrative Screens

This topic describes how to add a JavaScript file to the manifest administrative screens.

To add JavaScript files to manifest administrative screens

Log in to a Siebel client with administrative privileges.
Navigate to the Administration - Application screen, and then the Manifest Files view.
In the Files list, add a new record for each JavaScript file that you must add.

Make sure you include the path. For example, to add the mycustomrenderer.js file, you add the following value:
```
custom/mycustomrenderer.js
```
You can now add this file in the Files list in the Manifest Administration view. For more information about how to do this, see Step 5.