Siebel Business Component builder inputs

Portlet Factory, Version 6.1.2

Siebel Business Component builder inputs

This topic describes the Siebel Business Component builder inputs.

Table 1. Siebel Business Component builder inputs
Input Name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Connection

Properties File Enter the name of the properties file to be used to establish a connection with the backend Siebel server.
Example: my_siebel.properties
Note: This file must be located in the WEB-INF/config/siebel_config directory
Test Connection Button Press this button to test the builder's connection to the Siebel server. If the connection is successful, a connection confirmation dialog is displayed.
If the connection is unsuccessful, an error dialog will be displayed with information about why the builder was unable to contact the Siebel server.
The connection properties are taken from the properties file defined for the builder and any overrides you specified in the Connection Override advanced group. If you have connection problems remember to review both inputs for correctness.
Runtime Credentials Select the type of credentials to use at runtime to access the Siebel server. You can choose:

Use same credentials properties for all users

To use the user name and password credentials specified in the .properties file regardless of which user is running the Siebel builder.

Specify execution credentials

To specify a user name and password that will be used by this builder at runtime to access the Siebel server.

Execution User Name This input is available when Specify Execution Credentials is selected as the Runtime Credentials input.
Specify an indirect reference to the location used to store the Siebel user name. This location might be a variable or method result.
Execution Password This input is available when Specify Execution Credentials is selected as the Runtime Credentials input.
Specify an indirect reference to the location used to store the password.
Business Component Selection

Get Business Object and Business Component Names Button Press this button to get a list of Business Objects and Components available on the Siebel server.
If successful, the Business Object input picker will list the available Business Objects Interfaces.
If the operation was unsuccessful, an error dialog will be displayed with information about why the builder was unable to get the list of Business Object Interfaces.
Note: If the picker does not list any Business Objects, or you do not see the expected list of names, then the user name provided by the properties file may not have permission to access any Business Objects and Components.
Business Component Select the name of the Siebel Business Component to be accessed by this builder.
Note: Once you select a Business Object, the Business Component selection list will be populated with the components available in that Business Object.
View Mode Select a view mode.
Note: These are standard Siebel definitions that control the visibility of fields of a Business Component. The usual choice is "Personal." See your Siebel documentation for more information.
You can choose:

Sales Rep
Manager
Personal
All
Organization
Group
Catalog
Sub Organization

Access Info This read-only field will display the delete, insert, and update status/characteristics of the selected Business Component.
Enable schema caching Use this check box to enable the caching of the schema for the specified Siebel Business Component. When enabled, the builder's regeneration phase uses a cached version of the Business Component schema. If a different Business Component is selected a new version of the schema will be cached.
Selecting this option provides two benefits:

Enhanced Performance

This helps during editing models containing this builder.

Enhanced Security

A cached schema avoids exposing model generation time credentials once an initial regen has been performed. To leverage this specify to use separate runtime credentials.

Note: If the schema for the data changes on the Siebel server, disable this input, regenerate the model, and enable this input again.
Note: If you have the Generate Resource Labels input checked uncheck this input to generate the resource files for the labels. Once the resource bundles are generated you can enable schema caching again, and then disable the Generate Resource Labels input.
Field Selection

Copy summary field choices to detail fields Press to copy the currently selected (true) fields in the left hand (summary) column of the Field Choices table to the detail column. Copied items will be merged with any other choices already there.
You may need to close the builder and reopen it for the widgets to refresh to show the new values.
Clear summary field choices Press to clear all the summary field choices in the Field Choices table, setting all the values to false.
You may need to close the builder and reopen it for the widgets to refresh to show the new values
Clear detail field choices Press to clear all the detail field choices in the Field Choices table, setting all the values to false.
You may need to close the builder and reopen it for the widgets to refresh to show the new value
Field choices Use this table to select the fields of the Business Component that you want to have available in Summary and Detail operations on the Business Component.
Fields selected will be indicated in the name_DetailFieldNames and name_SummaryFieldNames Variables that are generated in the Webapp, and will be the fields of the Business Component that are activated and returned in data retrieval and save operations.
Note: Fields chosen here, and then fed via the name_DetailRow and name_SearchResults variables to DataPage builders for display, can be hidden in those displayed pages using other builders such as Data Field Modifier and Data Column Modifier.
Note: The order of the fields (which is by default alphabetic) can be changed simply by dragging a desired row up or down the table. This action feeds into the generated schema and the variables generated and becomes the default order of the fields seen when displayed using Data Page with Make UI from Schema selected.
The field name showing in the 3rd column is the Siebel field name. The 4th column (Attributes) shows selected metadata information on that field gathered from Siebel. Values shown, if set, are required, calculated and readOnly. Typically you would not choose a "calculated" field for a detail view, since the detail view can be used for record creation.
Connection Override

Connection String Use this input to override the ConnectionString property specified in the connection properties file.
You might want to do this if you need to use a different Siebel server than the one specified in the properties file or you want to profile the selection of the Siebel server.
Example: 10.10.2.125:2320/siebel_es/SSEObjMgr_enu/wicdemo9
User Name Use this input to override the UserName property specified in the connection properties file.
You might want to do this if you need to use different credentials than the ones specified in the properties file
Password Use this input to override the Password property specified in the connection properties file.
You might want to do this if you need to use different credentials than the ones specified in the properties file
Resource Bundle Generation

Generate Label Resources Enable the check box to have the builder construct a resource bundle that can be used by other builders, such as Data Page, to create presentable web pages.
The resource bundle is written to WEB-INF/source/nls and WEB-INF/classes/nls when the model is regenerated. The bundle name is created from a combination of the model path and file name, builder name, and Business Component name to ensure uniqueness. For example a model located in WEB-INF/models/a/b/c/Dee.model with a Siebel Business Component builder call named sbl to a component named Account, would generate a resource bundle named like the following:
WEB-INF/work/source/nls/a/b/c/Dee_sbl_Account.properties

Note: The builder writes the resource bundle only if it does not already exist. This means you can manually customize the content of the bundle if change one or more of the labels for some reason.
Note: You must disable Enable schema caching in order to generate the resource files for the labels. Once the resource bundles are generated you can enable schema caching again, and then disable the Generate Resource Labels input.

Parent topic: Siebel Business Component builder

Library | Support |

Input Name	Description
Name	Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Connection
Properties File	Enter the name of the properties file to be used to establish a connection with the backend Siebel server. Example: my_siebel.properties Note: This file must be located in the WEB-INF/config/siebel_config directory
Test Connection Button	Press this button to test the builder's connection to the Siebel server. If the connection is successful, a connection confirmation dialog is displayed. If the connection is unsuccessful, an error dialog will be displayed with information about why the builder was unable to contact the Siebel server. The connection properties are taken from the properties file defined for the builder and any overrides you specified in the Connection Override advanced group. If you have connection problems remember to review both inputs for correctness.
Runtime Credentials	Select the type of credentials to use at runtime to access the Siebel server. You can choose: Use same credentials properties for all users To use the user name and password credentials specified in the .properties file regardless of which user is running the Siebel builder. Specify execution credentials To specify a user name and password that will be used by this builder at runtime to access the Siebel server.
Execution User Name	This input is available when Specify Execution Credentials is selected as the Runtime Credentials input. Specify an indirect reference to the location used to store the Siebel user name. This location might be a variable or method result.
Execution Password	This input is available when Specify Execution Credentials is selected as the Runtime Credentials input. Specify an indirect reference to the location used to store the password.
Business Component Selection
Get Business Object and Business Component Names Button	Press this button to get a list of Business Objects and Components available on the Siebel server. If successful, the Business Object input picker will list the available Business Objects Interfaces. If the operation was unsuccessful, an error dialog will be displayed with information about why the builder was unable to get the list of Business Object Interfaces. Note: If the picker does not list any Business Objects, or you do not see the expected list of names, then the user name provided by the properties file may not have permission to access any Business Objects and Components.
Business Component	Select the name of the Siebel Business Component to be accessed by this builder. Note: Once you select a Business Object, the Business Component selection list will be populated with the components available in that Business Object.
View Mode	Select a view mode. Note: These are standard Siebel definitions that control the visibility of fields of a Business Component. The usual choice is "Personal." See your Siebel documentation for more information. You can choose: Sales Rep Manager Personal All Organization Group Catalog Sub Organization
Access Info	This read-only field will display the delete, insert, and update status/characteristics of the selected Business Component.
Enable schema caching	Use this check box to enable the caching of the schema for the specified Siebel Business Component. When enabled, the builder's regeneration phase uses a cached version of the Business Component schema. If a different Business Component is selected a new version of the schema will be cached. Selecting this option provides two benefits: Enhanced Performance This helps during editing models containing this builder. Enhanced Security A cached schema avoids exposing model generation time credentials once an initial regen has been performed. To leverage this specify to use separate runtime credentials. Note: If the schema for the data changes on the Siebel server, disable this input, regenerate the model, and enable this input again. Note: If you have the Generate Resource Labels input checked uncheck this input to generate the resource files for the labels. Once the resource bundles are generated you can enable schema caching again, and then disable the Generate Resource Labels input.
Field Selection
Copy summary field choices to detail fields	Press to copy the currently selected (true) fields in the left hand (summary) column of the Field Choices table to the detail column. Copied items will be merged with any other choices already there. You may need to close the builder and reopen it for the widgets to refresh to show the new values.
Clear summary field choices	Press to clear all the summary field choices in the Field Choices table, setting all the values to false. You may need to close the builder and reopen it for the widgets to refresh to show the new values
Clear detail field choices	Press to clear all the detail field choices in the Field Choices table, setting all the values to false. You may need to close the builder and reopen it for the widgets to refresh to show the new value
Field choices	Use this table to select the fields of the Business Component that you want to have available in Summary and Detail operations on the Business Component. Fields selected will be indicated in the name_DetailFieldNames and name_SummaryFieldNames Variables that are generated in the Webapp, and will be the fields of the Business Component that are activated and returned in data retrieval and save operations. Note: Fields chosen here, and then fed via the name_DetailRow and name_SearchResults variables to DataPage builders for display, can be hidden in those displayed pages using other builders such as Data Field Modifier and Data Column Modifier. Note: The order of the fields (which is by default alphabetic) can be changed simply by dragging a desired row up or down the table. This action feeds into the generated schema and the variables generated and becomes the default order of the fields seen when displayed using Data Page with Make UI from Schema selected. The field name showing in the 3rd column is the Siebel field name. The 4th column (Attributes) shows selected metadata information on that field gathered from Siebel. Values shown, if set, are required, calculated and readOnly. Typically you would not choose a "calculated" field for a detail view, since the detail view can be used for record creation.
Connection Override
Connection String	Use this input to override the ConnectionString property specified in the connection properties file. You might want to do this if you need to use a different Siebel server than the one specified in the properties file or you want to profile the selection of the Siebel server. Example: 10.10.2.125:2320/siebel_es/SSEObjMgr_enu/wicdemo9
User Name	Use this input to override the UserName property specified in the connection properties file. You might want to do this if you need to use different credentials than the ones specified in the properties file
Password	Use this input to override the Password property specified in the connection properties file. You might want to do this if you need to use different credentials than the ones specified in the properties file
Resource Bundle Generation
Generate Label Resources	Enable the check box to have the builder construct a resource bundle that can be used by other builders, such as Data Page, to create presentable web pages. The resource bundle is written to WEB-INF/source/nls and WEB-INF/classes/nls when the model is regenerated. The bundle name is created from a combination of the model path and file name, builder name, and Business Component name to ensure uniqueness. For example a model located in WEB-INF/models/a/b/c/Dee.model with a Siebel Business Component builder call named sbl to a component named Account, would generate a resource bundle named like the following: WEB-INF/work/source/nls/a/b/c/Dee_sbl_Account.properties Note: The builder writes the resource bundle only if it does not already exist. This means you can manually customize the content of the bundle if change one or more of the labels for some reason. Note: You must disable Enable schema caching in order to generate the resource files for the labels. Once the resource bundles are generated you can enable schema caching again, and then disable the Generate Resource Labels input.