Managing Metadata for Excel (via Direct Retrieval)

In this section:

When the server accesses a data source, it needs to know 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 data types.


Top of page

x
Creating Synonyms

How to:

Reference:

Synonyms define unique names (or aliases) for each Excel worksheet that is accessible from the server. Synonyms are useful because they hide the underlying data source location and identity 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 that represents the server metadata.



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 Excel (via Direct Retrieval)

The following list describes the synonym creation parameters for which you can supply values.

File Location

Defines the location of the data file. From the drop-down menu, select:

  • Server side for a file residing on the server.
  • Local machine for a file on your computer.
Workbook

Defines the workbook and its location. Use either an Application directory (baseapp/filename.xls) or an absolute path (c:\ibi\apps\baseapp\filename.xls). You can click the ellipsis (...) to navigate to the file.

Row Scan Limit

Enter a value to indicate how many Worksheet rows to scan to determine the length of the columns. If this parameter is omitted, all of the Worksheet rows are processed to determine the column lengths.

Application

Select an application directory. The default 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.

Number of Header Rows

The number of rows used as a Header in the Worksheet. Set the value to 0 if the Header is not used.


iWay Software