Managing Siebel Metadata

In this section:

When the server accesses a data source, it needs information on how to interpret the data stored there. For each data source the server will access, you create a synonym that describes the structure of the data source and the server mapping of the Siebel data types.


Top of page

x
Creating Synonyms

How to:

Reference:

x

Synonyms define unique names (or aliases) for each Business Component (BC) that is accessible from a server. Synonyms are useful because they hide location information and the identity of the underlying data source from client applications. They also provide support for extended metadata features of the server such as virtual fields and additional security mechanisms.

Using synonyms allows an object to be moved or renamed while allowing client applications to continue functioning without modification. The only modification required is a redefinition of the synonym on the server. The result of creating a synonym is a Master File and Access File.



x
Procedure: How to Create a Synonym

To create a synonym, you must have previously configured the adapter. You can create a synonym from the Applications or Adapters pages of the Web Console.

  1. From the Web Console menu bar, click Applications.

    The Applications page opens.

  2. Click the New button and select Synonym from the drop-down menu.

    The Select adapter to configure or Select connection to create synonym pane opens.

  3. Click a connection for the configured adapter.

    The first of a series of synonym creation panes opens.

  4. Enter values for the parameters required by the adapter as described in the synonym creation parameters reference.
  5. After entering the parameter values, click Create Synonym.

    The Status pane indicates that the synonym was created successfully.

The synonym is created and added under the specified application directory.

Note:



x
Reference: Synonym Creation Parameters for Siebel

The following list describes the parameters for which you will need to supply values, and related tasks you will need to complete in order to create a synonym for the adapter. These options may appear on multiple panes. To advance from pane to pane, click the buttons provided, ending with the Create Synonym button, which generates the synonym based on your entries.

Filter by Business Objects

Select this option to filter the Business Objects for which you wish to create synonyms.

When you filter by name, the Business Object Name input box is displayed. Enter a string for filtering the Business Objects, inserting the wildcard character (%) as needed at the beginning and/or end of the string. For example, enter ABC% to select Business Objects which begin with the letters ABC; %ABC to select Business Objects which end with the letters ABC; %ABC% to select Business Objects which contain the letters ABC at the beginning, middle, or end.

Select BOs button

Click this button to display the Business Objects that meet the specified criteria.

Filter Business Components

Select this option to filter the Business Components for which you wish to create synonyms. When you choose to filter, the Business Component Name input box is displayed.

Enter a string for filtering the Business Component, inserting the wildcard character (%) as needed at the beginning and/or end of the string. For example, enter ABC% to select Business Component which begin with the letters ABC; %ABC to select Business Component which end with the letters ABC; %ABC% to select Business Component which contain the letters ABC at the beginning, middle, or end.

Select Company Object

Select the business object for which you want to see business components.

Select BCs button

Click this button to display the Select Business Components. All Business Components that meet the specified criteria appear.

Validate

Select the Validate check box if you wish to convert all special characters to underscores and perform a name check to prevent the use of reserved names. (This is accomplished by adding numbers to the names.) This parameter ensures that names adhere to specifications. See Validation for Special Characters and Reserved Words for more information.

When the Validate option is unchecked, only the following characters are converted to underscores: '-'; ' '; ' \'; '/'; ','; '$'. No checking is performed for names.

Make unique

Select the Make unique check box if you wish to set the scope for field and group names to the entire synonym. This ensures that no duplicate names are used, even in different segments of the synonym. When this option is unchecked, the scope is the segment.

Application

Select an application directory. The default value is baseapp.

Prefix/Suffix

If you have tables with identical table names, assign a prefix or a suffix to distinguish them. For example, if you have identically named human resources and payroll tables, assign the prefix HR to distinguish the synonyms for the human resources tables. Note that the resulting synonym name cannot exceed 64 characters.

If all tables and views have unique names, leave the prefix and suffix fields blank.

Overwrite Existing Synonyms

To specify that this synonym should overwrite any earlier synonym with the same fully qualified name, select the Overwrite existing synonyms check box.

Note: The connected user must have operating system write privileges in order to recreate a synonym.

Default Synonym Name

This column displays the name that will be assigned to each synonym. To assign a different name, replace the displayed value.

Select Business Object and Component
  • To select all Business Objects/Business Components in the list, select the check box to the left of the Default Synonym Name column heading.
  • To select specific Business Objects/Business Components, select the corresponding check boxes.


Example: Creating a Synonym

To generate a synonym for the ACCOUNT Siebel Business Object and Siebel Business Component, enter the following information on the Create Synonym panes of the Web Console or the Data Management Console:

  1. Click the Filter Business Objects check box, enter ACCOUNT in the Name field, and click the Select BOs button.
  2. On the second Create Synonym pane, click the Filter Business Components check box, enter ACCOUNT, and click the Select BCs button.
  3. Select Account in the Default Synonym name column.
  4. Click Create Synonym. The synonym is created and added under the specified application directory (baseapp is the default).

    A status window displays the message: All Synonyms Created Successfully

  5. From the message window, click Applications on the menu bar.
  6. Open the baseapp application folder in the navigation pane and click the synonym account.
  7. Choose Edit as Text from the menu to view the generated Master File, then choose Edit Access File as Text to view the corresponding Access File.

Generated Master File account.mas

FILENAME=ACCOUNT, SUFFIX=SIBIN   , $
  SEGMENT=ACCOUNT, SEGTYPE=S0, $
    FIELDNAME=VISIBILITY_MODE, ALIAS=VISIBILITY_MODE, USAGE=A15, ACTUAL=A15,
      ACCEPT='SalesRep' OR 'Manager' OR 'Personal' OR 'All' OR 'Organization' OR
      'Contact' OR 'Group' OR 'Catalog' OR 'SubOrganization', $
    FIELDNAME=ACCOUNT_COMPETITORS, ALIAS='Account Competitors', USAGE=A500,
      ACTUAL=A500, MISSING=ON, $
    FIELDNAME=ACCOUNT_CONDITION, ALIAS='Account Condition', USAGE=A500, ACTUAL=A500,
      MISSING=ON, $
    FIELDNAME=ACCOUNT_MARKETS, ALIAS='Account Markets', USAGE=A500, ACTUAL=A500,
      MISSING=ON, $
    FIELDNAME=ACCOUNT_ORGANIZATION_INTEGRATION_ID,
      ALIAS='Account Organization Integration Id', USAGE=A30, ACTUAL=A30,
      MISSING=ON, $
    FIELDNAME=ACCOUNT_PRODUCTS, ALIAS='Account Products', USAGE=A500, ACTUAL=A500,
      MISSING=ON, $
    FIELDNAME=ACCOUNT_ROLE, ALIAS='Account Role', USAGE=A30, ACTUAL=A30, MISSING=ON, 
$
.
.
.
    FIELDNAME=MISSION, ALIAS=Mission, USAGE=A500, ACTUAL=A500,MISSING=ON, $
    FIELDNAME=NAME, ALIAS=Name, USAGE=A100, ACTUAL=A100, MISSING=ON, $
    FIELDNAME=NAME_AND_LOCATION, ALIAS='Name and Location', USAGE=A255, ACTUAL=A255,
      MISSING=ON, $
    FIELDNAME=NOT_MANAGER_FLAG, ALIAS='Not Manager Flag', USAGE=A255, ACTUAL=A255,
      MISSING=ON, $
.
.
.

Generated Access File account.acx

SEGNAME=ACCOUNT, CONNECTION=SIB1, SEGNAME_MVG=Account,
  REPOSITORY=Siebel Repository, BS_OBJECT=Account, BS_COMPONENT=Account,$
SEGNAME=CREDIT_CONTROL_AREA_CODE, SEGNAME_MVG=Credit Control Area Code, $
SEGNAME=SYNONYM, SEGNAME_MVG=Synonym, $
SEGNAME=BILL_TO_POSTAL_CODE, SEGNAME_MVG=Bill To Postal Code, $
SEGNAME=BILL_TO_FIRST_NAME, SEGNAME_MVG=Bill To First Name, $
SEGNAME=BILL_ADDRESS_FLAG, SEGNAME_MVG=Bill Address Flag, $
SEGNAME=DEDUP_KEY_UPDATE, SEGNAME_MVG=DeDup Key Update, $
SEGNAME=INDUSTRY, SEGNAME_MVG=Industry, $
SEGNAME=BACK_OFFICE_DISTRIBUTION_CHANNEL,
  SEGNAME_MVG=Back Office Distribution Channel, $
SEGNAME=TYPE_MVF, SEGNAME_MVG=Type MVF, $
SEGNAME=ROW_STATUS, SEGNAME_MVG=Row Status, $
SEGNAME=TERRITORY, SEGNAME_MVG=Territory, $
SEGNAME=AGREEMENT_END_DATE, SEGNAME_MVG=Agreement End Date, $
SEGNAME=SHIP_TO_POSTAL_CODE, SEGNAME_MVG=Ship To Postal Code, $
SEGNAME=SHIP_TO_FIRST_NAME, SEGNAME_MVG=Ship To First Name, $
SEGNAME=TERRITORY_0015, SEGNAME_MVG=Territory, $

The Master File root segment describes the Siebel Business Component. All scalar fields of the Business Component are described as fields in the root segment. All Multi Value fields (MVG) of the Business Component are described as descendant segments of the root. The name of the segment representing an MVG is derived from the Business Component Multi Value field name. All other Multi Value fields related to the same Multi Value Link are not shown in the Master File. The MVG segment contains references to the appropriate fields in the linked Business Component instead. All scalar fields of the MVG are described as fields in the MVG segment. All MVG fields of an MVG become descendant segments of the segment representing this parent MVG.

Master File field aliases represent real Siebel Business Component field names. Long names (between 67 and 75 characters) are stored in the Access File. Corresponding Master File fields must have no aliases. Similarly, long segment names are stored in the Access File as well.

A special virtual field VISIBILITY_MODE is added to the root segment to enable the client to set the visibility type for the Business Component. Available visibility modes are enumerated in the ACCEPT parameter for this field. Siebel Versions 6 and 7 support different sets of visibility modes, which is reflected in the ACCEPT list.

The visibility modes are:

Siebel v7: SalesRep, Manager, Personal, All, Organization, Contact, Group, Catalog, and SubOrganization.



x
Reference: Managing Synonyms

Once you have created a synonym, you can right-click the synonym name in the Adapter navigation pane of either the Web Console or the Data Management Console to access the following options.

Option

Description

Open

Opens the Master File for viewing and editing using a graphical interface. If an Access file is used it will be also available.

Edit as Text

Enables you to view and manually edit the Master File synonym.

Note: To update the synonym, it is strongly recommended that you use the graphical interface provided by the Open option, rather than manually editing the Master File.

Edit Access File as Text

Enables you to view and manually edit the Access File synonym.

Note: This option is available only when an Access File is created as part of the synonym.

Sample Data

Retrieves up to 20 rows from the associated data source.

Data Profiling

Data Profiling provides the data characteristics for synonym columns.

Alphanumeric columns provide the count of distinct values, total count, maximum, minimum, average length, and number of nulls.

Numeric columns provide the count of distinct values, total count, maximum, minimum, average value, and number of nulls.

Refresh Synonym (if applicable)

Regenerates the synonym. Use this option if the underlying object has been altered.

Data Management

Followed by these options, if applicable:

Recreate DBMS Table. Recreates the data source table. You are asked to confirm this selection before the table is regenerated. (Note that the table will be dropped and recreated. During the process, data may be lost.)

Delete All Data. Deletes all existing data. You are asked to confirm this selection before the data is deleted.

Insert Sample Data. Inserts specified number of sample records, populating all fields with counter values.

Reorganize. Recreates the data source table preserving original data.

Note: This option is not available in the Web Console.

Impact Analysis

Generates reports on procedures, synonyms, and columns that provide information on the flows/stored procedures available on a particular server, and the synonyms and columns they use. These reports enable you to evaluate changes before they are made by showing which components will be affected. See the Server Administration for UNIX, Windows, OpenVMS, IBM i, and z/OS manual for details about Impact Analysis reports.

Copy

Copies the synonym to the clipboard.

Delete

Deletes the synonym. You are asked to confirm this selection before the synonym is deleted.

Cut

Deletes the synonym and places it on the clipboard.

Properties

Displays the properties of the synonym, including physical location, last modified date, description, and privileges.



x
Syntax: How to Set Visibility Mode
IF VISIBILITY_MODE EQ 'All'

This syntax tells Siebel to look at the user ID referenced in the .prf file and according to that user's ID authorization privileges, Siebel returns a view of ALL for the requested output.

If no visibility mode is set in the report, it defaults to the personal visibility mode.



Example: Using Visibility Mode in a Report Request

The following request prints the NAME field where the VISIBILITY MODE is set to All.

TABLE FILE ACCOUNT
 PRINT NAME VISIBILITY_MODE
 WHERE ( VISIBILITY_MODE EQ 'All' )
 AND ( NAME LIKE '%WLI%' ) ;
END

The output is:

 NAME                                                VISIBILITY_MODE
 ----                                                ---------------
 Yelena WLI 81 0129 iway55                           All
 Yelena WLI 81 0129 iway55 JCA2                      All
 Yelena WLI 81 IDE                                   All


Example: Using Visibility Mode in a SQL Request

The follow selects NAME and VISIBILITY_MODE based on VISIBILITY MODE and wildcards in NAME.

SQL
 SELECT NAME, VISIBILITY_MODE FROM ACCOUNT
 WHERE VISIBILITY_MODE = 'All' AND NAME LIKE '%WLI%'
END

The output is:

NAME                                     VISIBILITY_MODE
 ----                                     ---------------
 Yelena WLI 81 0129 iway55                All
 Yelena WLI 81 0129 iway55 JCA2           All
 Yelena WLI 81 IDE                        All


x
Reference: Access File Attributes

Keyword

Description

CONNECTION=connection_name

Indicates access to specified Siebel Server. Defaulted to the default connection.

SEGNAME

Name of the corresponding segment in the Master File.

SEGNAME_LONG

Long (1 to 75 characters) Siebel segment name.

BS_OBJECT

Siebel Business Object name.

BS_COMPONENT

Siebel Business Component name.

REPOSITORY

Siebel Repository.



x
Data Type Support

All Siebel scalar, alphanumeric, and currency fields are treated as alphanumeric fields. All Siebel date and integer fields are supported.


iWay Software