x

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:

• You can also create a synonym from the Adapters page by right-clicking a configured adapter connection and selecting Create Synonym.
• When creating a synonym, if you choose the Validate check box (where available), the server adjusts special characters and checks for reserved words. For more information, see Validation for Special Characters and Reserved Words.

x

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 Catalog and Cube Name

If you wish to filter your selections, click this check box and enter a catalog and/or cube name in the input boxes.

You can enter a full catalog or cube name or use a wildcard character (%) as needed, at the beginning and/or end of the string. For example, enter: ABC% to select catalogs or cubes that begin with the letters ABC; %ABC to select catalogs or cubes that end with the letters ABC; %ABC% to catalogs or cubes that contain the letters ABC at the beginning, middle, or end.

Field Name Case

Select whether you want mixed-case or uppercase field names. Mixed-case is the default value.

Next button

Click the Next button to proceed, either with or without filtering.

Select 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.

Select cubes

Select the cubes for which you wish to create synonyms:

• To select all cubes in the list, select the check box to the left of the Default Synonym Name column heading.
• To select specific cubes, select the corresponding check boxes.

Default Synonym Name

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

Top of page

Example: Creating a Synonym

To generate a synonym for the Budget cube, enter the following information on the Create Synonym panes of the Web Console or the Data Management Console:

1. On the first Create Synonym pane, click the Filter by Catalog and Cube Name check box.
2. Enter Food% in the Catalog field and Bud% in the Cube Name field.
3. Click the Next button.
4. On the second Create Synonym pane, select Budget from the list of displayed cubes in the FOODMART 2000 catalog.
5. 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.

6. From the message window, click Applications on the menu bar.
7. Open the baseapp application folder in the navigation pane and click the synonym Sales.
8. 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

FILENAME=BUDGET, SUFFIX=MSOLAP  , $
  SEGMENT=BUDGET, SEGTYPE=S0, $
$ MEASURES FOR CUBE Budget 
   FIELDNAME=AMOUNT, ALIAS=Amount, USAGE=P10.2MB, ACTUAL=P8,MISSING=ON,
      TITLE='Amount', REFERENCE=SUM.AMOUNT, PROPERTY=MEASURE,  $
 DIMENSION=[Account], CAPTION='Account', $
  HIERARCHY=[Account], CAPTION='Account',HRY_DIMENSION=[Account],
       HRY_STRUCTURE=STANDARD, $
   FIELDNAME=ACCOUNT_LEVEL_02, ALIAS='Level 02', USAGE=A11, ACTUAL=A11,
      MISSING=ON, TITLE='Account Level 02', WITHIN='*[Account]', $
   FIELDNAME=ACCOUNT_LEVEL_03, ALIAS='Level 03', USAGE=A13, ACTUAL=A13,
      MISSING=ON, TITLE='Account Level 03', WITHIN='ACCOUNT_LEVEL_02', $
   FIELDNAME=ACCOUNT_LEVEL_04, ALIAS='Level 04', USAGE=A24, ACTUAL=A24,
      MISSING=ON, TITLE='Account Level 04', WITHIN='ACCOUNT_LEVEL_03', $
 DIMENSION=[Category], CAPTION='Category', $
  HIERARCHY=[Category], CAPTION='Category', HRY_DIMENSION=[Category],
      HRY_STRUCTURE=STANDARD, $
   FIELDNAME=CATEGORY_DESCRIPTION, ALIAS='Category Description', USAGE=A27,
      ACTUAL=A27, TITLE='Category Description', WITHIN='*[Category]', $
 DIMENSION=[Store], CAPTION='Store', $
  HIERARCHY=[Store], CAPTION='Store',HRY_DIMENSION=[Store],HRY_STRUCTURE=STANDARD, $
   FIELDNAME=STORE_COUNTRY, ALIAS='Store Country', USAGE=A6, ACTUAL=A6,
      TITLE='Store Country', WITHIN='*[Store]', $
   FIELDNAME=STORE_STATE, ALIAS='Store State', USAGE=A9, ACTUAL=A9,
      TITLE='Store State', WITHIN='STORE_COUNTRY', $
   FIELDNAME=STORE_CITY, ALIAS='Store City', USAGE=A13, ACTUAL=A13,
      TITLE='Store City', WITHIN='STORE_STATE', $
   FIELDNAME=STORE_NAME, ALIAS='Store Name', USAGE=A8, ACTUAL=A8,
      TITLE='Store Name', WITHIN='STORE_CITY', $

$ LEVEL [Store].[Store Name] PROPERTIES
   FIELDNAME=STORE_MANAGER, ALIAS='Store Manager', USAGE=A8, ACTUAL=A8,
      TITLE='Store Manager', REFERENCE=STORE_NAME, PROPERTY=ATTRIBUTE,  $
   FIELDNAME=STORE_SQFT, ALIAS='Store Sqft', USAGE=A5, ACTUAL=A5,
      TITLE='Store Sqft', REFERENCE=STORE_NAME, PROPERTY=ATTRIBUTE,  $
   FIELDNAME=STORE_TYPE, ALIAS='Store Type', USAGE=A19, ACTUAL=A19,
      TITLE='Store Type', REFERENCE=STORE_NAME, PROPERTY=ATTRIBUTE,  $
 DIMENSION=[Time], CAPTION='Time', $
  HIERARCHY=[Time], CAPTION='Time',HRY_DIMENSION=[Time],HRY_STRUCTURE=STANDARD, $
   FIELDNAME=YEAR, ALIAS=Year, USAGE=I4, ACTUAL=I4, TITLE='Year',
      WITHIN='*[Time]', $
   FIELDNAME=QUARTER, ALIAS=Quarter, USAGE=A2, ACTUAL=A2, TITLE='Quarter'
      WITHIN='YEAR', $
   FIELDNAME=MONTH, ALIAS=Month, USAGE=I2, ACTUAL=I2, TITLE='Month',
      WITHIN='QUARTER', $

The Master File that is produced contains a segment for each dimension in the OLAP outline. For each generation within a dimension, a field description is produced. The WITHIN keyword is used to describe the hierarchy inherent in each dimension structure.

Note: Master Files should not be altered. Manipulating the Master File causes incorrect query results.

The Measures dimension can contain calculated and non-calculated members. Calculated members in the Measures dimension will contain a Reference defining the calculated member and a Property. Some properties are mandatory while others may be user-defined.

Generated Access File

SEGNAME=BUDGET, CUBENAME=Budget, SCHEMA=, CATALOG=FoodMart 2000,
   DATASOURCE=VOLKOV, $
 CSTM_ROLLUP=ALL_LEVEL, LEVEL_NAME=*[Account], ROLLUP_TYPE=ADDITIVE, $
 CSTM_ROLLUP=REG_LEVEL, LEVEL_NAME=ACCOUNT_LEVEL_02,
   ROLLUP_TYPE=NON-ADDITIVE, $
 CSTM_ROLLUP=REG_LEVEL, LEVEL_NAME=ACCOUNT_LEVEL_03,
   ROLLUP_TYPE=NON-ADDITIVE, $
 CSTM_ROLLUP=REG_LEVEL, LEVEL_NAME=ACCOUNT_LEVEL_04,
   ROLLUP_TYPE=NON-ADDITIVE, $

x

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
Edit	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 Edit 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.
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 clipboard.
Delete	Deletes the synonym. You are asked to confirm this selection before the synonym is deleted.
Cut	Deletes the synonym and places it in clipboard.
Properties	Displays the properties of the synonym, including physical location, last modified date, and description.

x

Keyword	Description
SEGNAME	Value must be identical to the SEGNAME value in the Master File.
CUBENAME	Name of the OLAP cube.
SCHEMA	Schema that describes the cube.
DATASOURCE	Microsoft SQL Server 2000 Analysis Services (MS OLAP) name.
CATALOG=	Name of the data source (catalog) the OLAP cube is using.

Note: Access Files reflect the structure of the cube Master File that is produced and contains a segment for each dimension in the OLAP outline. For each generation within a dimension, a field description is produced. The WITHIN keyword is used to describe the hierarchy inherent in each dimension structure.