Managing Microsoft SQL Server Metadata

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 Microsoft SQL Server data types.

Creating Synonyms

Synonyms define unique names (or aliases) for each Microsoft SQL Server table or view 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 and an Access File, which represent the server metadata.

The adapter supports the creation of metadata for certain types of MS SQL Native Synonyms. This feature is only available for Microsoft SQL Server versions 2005 and higher.

You can create metadata for Native Synonyms under the following conditions:

Native Synonyms must be created from a TABLE or VIEW base object.
The base object (TABLE or VIEW) must exist on the MS SQL Server targeted by the adapter connection string.
Native Synonyms must be created with the base object described by a name consisting of not more than three components. Depending on the location and ownership of the base object within the targeted server, acceptable formats, are:
```
object_name, schema_name.object_name,
```
or
```
database_name.schema_name.object_name.
```

The following types of Native Synonyms are not supported:

Those based on stored procedures.
Those based on objects existing on a linked MS SQL server.
Those based on objects described with a 4-part name, such as:
```
server_name.database_name.schema_name.object_name
```

Note that creating a synonym for a stored procedure is described with reporting against a stored procedure, in Generating a Synonym for a Stored Procedure.

Create a Synonym

Procedure

From the WebFOCUS Reporting Server browser interface Application page, click Get Data.
On the Configured Adapters section of the page, in Simple Mode, right-click an adapter and click Show Connections. Right-click a connection.
Depending on the type of adapter you choose, one of the following options appears on the context menu.
- Show DBMS objects. This option opens the page for selecting synonym objects and properties.
- Create metadata objects. This option opens the page for selecting synonym objects and properties.
- Show files. This option opens a file picker. After you choose a file of the correct type, the page for selecting synonym objects and properties opens.
- Show local files. This option opens a file picker. After you choose a file of the correct type, the page for selecting synonym objects and properties opens.
- Show topics. This option opens the page for selecting synonym objects and properties for topics within the environment.
Enter values for the parameters required by the adapter as described in the chapter for your adapter.
After entering the parameter values, click Add.

This button may be labeled Next, Create Synonym, Create Base Synonyms, Create Cluster Synonym, or Update Base Synonyms.

The synonym creation process for most adapters has been consolidated so that you can enter all necessary parameters on one page. However, for some adapters such as LDAP, continue clicking Next until you get to a page that has a Create Synonym button.

Result

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

Note: When creating a synonym, if you select the Validate checkbox, where available, the server adjusts special characters and checks for reserved words. For more information, see Validation for Special Characters and Reserved Words.

Synonym Creation Parameters for Microsoft SQL Server

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

Restrict Object Type to

Restrict candidates for synonym creation based on the selected object type(s): Tables, Views, External SQL Scripts, and any other supported objects.

Choosing External SQL Scripts from the drop-down list enables you to represent an SQL Query as a synonym for read-only reporting. A Synonym candidate can be any file that contains one (and only one) valid SQL Query and does not contain end-of-statement delimiters (";" or "/") and comments.

Depending on the adapter, you can further restrict your search by choosing checkboxes for listed objects.

Important: If you select Stored Procedures as your object type, the input parameters will be a little different from those described here. For details, refer to Creating a Report Against a Stored Procedure.

Database selection

To specify a database from which you can select a table or other object, do one of the following:

Check Use current database to use the database that has been set as the default database.
Select a database from the Select database drop-down list, which lists all databases in the current DBMS instance.
Before selecting a database, if Use current database is checked, uncheck it.

To specify the intended database, choose from the Select database drop-down menu, which shows all databases on the targeted instance of Microsoft SQL Server. Selecting Default Database will retain the database set during connection configuration. If Default Database was not set during configuration, the database assigned to the active login on the SQL Server will be used as the default.

Filter by Owner/Schema and Object name

Selecting this option adds the Owner/Schema and Object Name parameters to the screen.

Owner/Schema. Type a string for filtering the selection, inserting the wildcard character (%) as needed at the beginning and/or end of the string. For example, enter: ABC% to select tables or views whose owner/schema begin with the letters ABC; %ABC to select tables or views whose owner/schema end with the letters ABC; %ABC% to select tables or views whose owner/schema contain the letters ABC at the beginning, middle, or end.
Object name. Type a string for filtering the object names, inserting the wildcard character (%) as needed at the beginning and/or end of the string. For example, enter: ABC% to select all objects whose names begin with the letters ABC; %ABC to select all whose names end with the letters ABC; %ABC% to select all whose names contain the letters ABC at the beginning, middle, or end.

Location of External SQL Scripts

If you specify External SQL Scripts in the Restrict Object type to field, these additional fields are displayed.

The following standard naming conventions apply for UNIX, IBM i IFS, and z/OS HFS:

In the Base Location field, specify the physical directory location of the file that contains the SQL Query. You can type a directory name or click on the ellipsis. This opens the Select Base Location dialog.
In the Document Name field, enter the file name with or without wild card characters.
In the Document Extension field, enter the extension of the script files to filter the list of candidates.

On IBM i, you can use alternative IFS naming conventions to access library members. The following entry illustrates this method:

In the Base Location field, enter:
```
/QSYS.LIB/MYLIBRARY.LIB/MYSRC.FILE
```
The Document Extension is understood to be MBR. You can enter this value explicitly or leave the input box blank.

During synonym generation, the adapter issues native API calls to obtain a list of elements in the select list and builds the Master File with a field for each element. The generated Access File references the location of the SQL script in the DATASET attribute, which contains the full path, including the name and extension of the file containing the SQL Query. For example,

DATASET=/ul/home2/apps/report3.sql

When a WebFOCUS report is created, the SQL Query is used to access data.

Cardinality

Select the Cardinality checkbox to reflect the current cardinality (number of rows or tuples) in the table during metadata creation. Cardinality is used for equi-joins. The order of retrieval is based on the size (cardinality) of the table. Smaller tables are read first.

If the cardinality of the tables to be used in the application are dynamic, it may not be beneficial to choose this setting.

Build cluster using foreign keys (deprecated)

You can select the Build cluster using foreign keys checkbox to include within this synonym every table related to the current table by a foreign key. However, this option has been deprecated, as the recommended way to create a cluster is by using the Synonym Editor. The resulting multi-table synonym describes all of the foreign key relationships of this table.

For Subquery

Only available when External SQL Scripts is selected from the Restrict objects type to drop-down menu. When selected, a SUBQUERY keyword is added to the Access File of the generated synonym. If the corresponding SQL string has valid syntax that can be used in the FROM statement of the generated SQL (what is known as a Derived Table), then the SQL SCRIPT will be processed as a subquery embedded into a FROM clause. This usage allows for more flexibility. For example, the synonym can be used as a target for a JOIN.

If the SQL SCRIPT has parameter markers, such as ? or :, or the syntax contains constructs that are invalid for a derived table, for example ORDER BY, then this keyword should not be selected. At runtime, if SUBQUERY=Y is present and it is determined that the SQL SCRIPT cannot be used in the FROM statement, the setting will be ignored, and a FOC1782 warning message will be issued. The default is selected (SUBQUERY=Y).

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.

Customize data type mappings

To change the data type mappings from their default settings, select this checkbox. The customizable mappings are displayed.

For information about customizable mappings, see Microsoft SQL Server Data Type Support.

Update or Create Metadata

Select Create to overwrite any existing synonym with the same fully-qualified name, or Update to synchronize the metadata with an existing synonym. If you select Update, the next screen will show a list of attributes from the DBMS catalog that you can check to allow attributes from the DBMS catalog to override attributes from the existing synonym.

Overwrite Existing Synonyms

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

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.

Table name

Is the name of the underlying object.

Select tables

Select tables for which you wish to create synonyms:

To select all tables in the list, select the Select All checkbox.
To select specific tables, select the corresponding checkboxes.

Sample Generated Synonym

An Adapter for Microsoft SQL Server synonym comprises a Master File and an Access File. This is a synonym for the table nf29004.

Generated Master File nf29004.mas

FILE=DIVISION, SUFFIX=SQLMSS ,$
SEGNAME=SEG1_4, SEGTYPE=S0 ,$
FIELD=DIVISION4,    DIVISION4,    I9,  I4,  MISSING=OFF ,$
FIELD=DIVISION_NA4, DIVISION_NA4, A25, A25, MISSING=ON  ,$
FIELD=DIVISION_HE4, DIVISION_HE4, I9,  I4,  MISSING=ON  ,$

Generated Access File nf29004.acx

SEGNAME=SEG1_4,TABLENAME=edaqa.nf29004,
CONNECTION=connmss, KEYS=1, WRITE=YES,$

Mapping Microsoft SQL Table Comments Into a Synonym

When you generate a synonym for a Microsoft SQL table or view, the adapter maps comments as follows:

MS SQL Server table/view comments (if present) are mapped to the REMARKS attribute in the Master File synonym.
MS SQL Server column comments (if present) are mapped to the DESCRIPTION attribute in the Master File synonym.

Both Unicode and non-Unicode comments are supported.

Also, MS SQL Server column title (if present) is mapped to the TITLE attribute in the Master File synonym.

Access File Keywords

This chart describes the keywords in the Access File.

Keyword	Description
SEGNAME	Value must be identical to the SEGNAME value in the Master File.
TABLENAME	Identifies the Microsoft SQL Server table. The table name can be fully qualified as follows: TABLENAME=[[database.]owner.]table
CONNECTION	Indicates a previously declared connection. The syntax is: CONNECTION=connection CONNECTION=' ' indicates access to the local database server. Absence of the CONNECTION attribute indicates access to the default database server.
KEYS	Indicates how many columns constitute the primary key for the table. Corresponds to the first n fields in the Master File segment. This attribute requires the columns that constitute the key to be described first in the Master File. See the KEY attribute below for information about specifying the key fields without having to describe them first in the Master File.
KEY	Specifies the columns that participate in the primary key without having to describe them first in the Master File. The syntax is: KEY=fld1/fld2/.../fldn
WRITE	Specifies whether write operations are allowed against the table.
KEYFLD IXFLD	Supply the names of the primary key and foreign key fields that implement the relationships established by the multi-table Master File. Together, KEYFLD and IXFLD identify the field shared by a related table pair. KEYFLD is the FIELDNAME of the common column from the parent table. IXFLD is the FIELDNAME of the common column from the related table. KEYFLD and IXFLD must have the same data type. It is recommended, but not required, that their lengths also be the same. Note: An RDBMS index on both the KEYFLD and IXFLD columns provides the RDBMS with a greater opportunity to produce efficient joins. The columns must have the same data type. If their length is the same, the RDBMS handles the join more efficiently.
AUTO INCREMENT	When set to Yes, enables the auto increment feature.
START	Initial value in incrementing sequence.
INCREMENT	Increment interval.
INDEX_NAME INDEX_UNIQUE INDEX_COLUMNS INDEX_ORDER	Indicate a name of the index in a database, uniqueness, name, and order of the indexed column(s).

Managing Synonyms

Once you have created a synonym, you can right-click the synonym name in the navigation pane of either the WebFOCUS Reporting Server browser interface or ibi Data Migrator desktop interface to access the available options.

For a list of options, see Synonym Management Options.

Microsoft SQL Server Data Type Support

SQL Data Type mapping options are available in a report available from the WebFOCUS Reporting Server browser interface.

For more information, see Access the Data Type Report.

Controlling the Mapping of Variable-Length Data Types

The SET parameter VARCHAR controls the mapping of the Microsoft SQL Server data type VARCHAR. By default, the server maps these data types as variable character (AnV).

The following table lists data type mappings based on the value of VARCHAR:

Microsoft SQL Server Data Type	Remarks	VARCHAR ON		VARCHAR OFF
Microsoft SQL Server Data Type	Remarks	USAGE	ACTUAL	USAGE	ACTUAL
VARCHAR (n)	n is an integer between 1 and 8000	AnV	AnV	An	An
NVARCHAR (n)	n is an integer between 1 and 4000	AnV	AnV	An	An
VARBINARY (n)	n is an integer between 1 and 8000m = 2 * n	AmV	AmV	Am	Am

Control the Mapping of Variable-Length Data Types

ENGINE SQLMSS SET VARCHAR {ON|OFF}

where:

SQLMSS

Indicates the adapter. You can omit this value if you previously issued the SET SQLENGINE command.

Maps the Microsoft SQL Server data type VARCHAR as variable-length alphanumeric (AnV). This is required for Unicode environments. ON is the default value.

OFF

Maps the Microsoft SQL Server data type VARCHAR as alphanumeric (A).

Enabling National Language Support

The SET parameter NCHAR indicates whether the character set is single-byte, double-byte, or triple-byte. The NCHAR setting affects the mapping of NCHAR and NVARCHAR data types.

The following chart lists data type mappings based on the value of NCHAR.

Microsoft SQL Server Data Type	Remarks	NCHAR SBCS	NCHAR DBCS	NCHAR TBCS
NCHAR (n)	n is an integer between 1 and 4000 d = 2 * n t = 3 * n	An	An	Ad	Ad	At	At
NVARCHAR (n)	n is an integer between 1 and 4000 d = 2 * n t = 3 * n	An	An	Ad	Ad	At	At

Microsoft SQL Server Data Type

Remarks

NCHAR SBCS

NCHAR DBCS

NCHAR TBCS

USAGE

ACTUAL

USAGE

ACTUAL

USAGE

ACTUAL

NCHAR (n)

n is an integer between 1 and 4000

d = 2 * n

t = 3 * n

NVARCHAR (n)

n is an integer between 1 and 4000

d = 2 * n

t = 3 * n

Enable National Language Support

The available parameters are:

ENGINE SQLMSS SET NCHAR {SBCS|DBCS|TBCS}

where:

SQLMSS

Indicates the adapter. You can omit this value if you previously issued the SET SQLENGINE command.

SBCS

Indicates a single-byte character set. SBCS is the default value.

DBCS

Indicates a double-byte character set.

TBCS

Indicates a triple-byte character set.

Trailing Blanks in SQL Expressions

The new SQL Expression generator in the TABLE Adapter by default preserves literal contents, including trailing blanks in string literals and the fractional part and exponential notation in numeric literals. This allows greater control over the generated SQL.

In some rare cases when trailing blanks are not needed, the following syntax

ENGINE SQLMSS SET TRIM_LITERALS ON

is available to ensure backward compatibility.

Changing the Precision and Scale of Numeric Columns

You can alter the length and scale of numeric columns returned by a SELECT request to the server by creating different specifications in your login profile or in a stored procedure. The conversion settings are reflected in the Master File in the USAGE and ACTUAL formats of the fields generated by CREATE SYNONYM. This affects how the fields are processed and formatted by the server.

Tip: You can change this setting manually or from the WebFOCUS Reporting Server browser interface.

For more information, see Override the Default Precision and Scale.

Support of Read-Only Fields

CREATE SYNONYM creates a field description with FIELDTYPE=R for Microsoft SQL Server columns created as TIMESTAMP or columns with the IDENTITY attribute. These fields are read-only. When executing a MAINTAIN or MODIFY procedure, the adapter suppresses all write operations against columns marked in the Master File with FIELDTYPE=R.

Supporting a Read-Only Field

This example creates a table in which the first column has the IDENTITY property and the second column is a timestamp column:

CREATE TABLE TAB1
 (idproptab int IDENTITY (1,1), timstmp timestamp)

CREATE SYNONYM generates the following Master File for this table:

FILE=TAB1, SUFFIX=SQLMSS ,$
SEGNAME=TAB1, SEGTYPE=S0 ,$
FIELD=IDPROPTAB, idproptab, I11, I4,  MISSING=OFF, FIELDTYPE=R ,$
FIELD=TIMSTMP,   timstmp,   A16, A16, MISSING=ON,  FIELDTYPE=R ,$

Did you find this helpful?

Yes No