OpenESQL Assistant - Options

DCLGEN

Use level 49: By default, OpenESQL Assistant generates a host variable as a PIC X(n) field for VARCHAR columns. When data is mapped to the host variable, it is null terminated. However, you can set OpenESQL Assistant to generate the host variable with two level-49 variables; one for the length of the data mapped and one for the actual text data.
Type COBOL Variable: By default, OpenESQL Assistant generates COBOL host variables using COBOL definitions where appropriate. You can set this option to SQL TYPE to enable the SQL precompiler to better determine host variable usage, or set it to OBJECT to provide better performance for .NET applications.
Structure name: By default, OpenESQL Assistant generates the structure name for the copybook as DCLtablename. You can also generate the structure name using just the table name or you can supply your own structure name as long as it is a valid COBOL name. OpenESQL Assistant converts all underscores into hyphens. When you set this option to Other, specify your own structure in the User Defined Structure Name field.
User Defined Structure Name: Specify an 01-level COBOL structure name to use when generating the copybook. Required when Structure Name is set to Other.
Host Variable Prefix: By default, OpenESQL Assistant creates host variables using a combination of the column name and a prefix of the table name, converting all underscores to hyphens to create a valid COBOL name. You can also set OpenESQL Assistant to always generate host variables using only the column name (no prefix) or to use an alphabetic character prefix. Host variables generated with alphabetic character prefixes use "A" for the first table selected, "B" for the second table, etc.
Note: If a generated host variable name would result in a name that is either longer than 31 characters in length or that would contain invalid characters, OpenESQL Assistant generates the host variable name as the column number with a prefix of "FLD" regardless of the method specified.
Indicator Variables: By default, OpenESQL Assistant generates indicator variables at the end of a copybook. You can also set OpenESQL Assistant to generate indicator variables after each host variable instead. Your third option is to set OpenESQL Assistant so that no indicator variables are generated.

General

Automatically catalog data source

OpenESQL under .NET supports both EXEC SQL and EXEC ADO access to managed data sources. There currently exists no common repository for sharing connection information between ADO.NET data providers. However, we provide a common repository that all COBOL applications can use to save connection information. This also allows OpenESQL to be source code compatible when using EXEC SQL CONNECT statements. If you check this option, OpenESQL Assistant automatically transfers the ODBC connection information into the repository when you CONNECT to a data source.

OpenESQL Assistant also includes an ADO.NET Connection Editor which allows you to manually add connection information.

Once you have cataloged all your data sources in the repository you can uncheck this option.

Generate code

By default, OpenESQL Assistant generates SQL queries and copybooks using a combination of upper and lower case. You can also set OpenESQL Assistant to generate in all uppercase or all lowercase.

List items in table name sequence

By default, OpenESQL Assistant lists items in the tree view in the sequence that they are returned from the system catalog. You can also set OpenESQL Assistant to list items in table name sequence instead. When you set OpenESQL Assistant to list items in table name sequence, owner names are not considered.

Mode

Set this option before connecting to a data source.

ADO.NET: Builds the list of data sources using the information maintained by the Connection Editor (32-bit version). Default.
ODBC: Builds the list of data sources maintained by the ODBC Data Source Administrator (32-bit version).
XDB: Builds the list of data sources maintained by SQL Option for DB2.

Output language

By default, OpenESQL Assistant generates COBOL SQL queries. To generate PL/I SQL queries instead, set this option to PLI.

Prompt on disconnect

By default, OpenESQL Assistant does not prompt you when disconnecting from a data source. If you want to be prompted to save a query you have built before disconnecting, set this option to True. Otherwise, you could lose the query.

Start OpenESQL Assistant docked

By default, OpenESQL Assistant is not docked to Visual Studio. Set this option to True if you want OpenESQL Assistant to start docked to Visual Studio.

Logon

User name: The user name used to connect to your data source. If you choose not to specify a user name, OpenESQL Assistant prompts you when connecting to a data source.
Password: The password associated with the user ID in the User name field. Depending on how you define your connection names, you might have the option of saving your login user name and password via the ADO.NET Connection Editor.

Query

Qualify table with owner name

By default, OpenESQL Assistant displays all tables in the tree view and builds all queries unqualified. However, if the data source has multiple tables with the same table name, you can set OpenESQL Assistant to show table names in the tree view with their owner names immediately following in parenthesis. Queries performed also return table names qualified with the owner name.

Quote table and column names

By default, OpenESQL Assistant does not enclose column and table names with the quote identifier associated with the data source unless the column or table name contains embedded blanks, a special character such as $, or DBCS characters. You can set OpenESQL Assistant to enclose all table and column names with the appropriate quote identifier by setting this option to True.

Use SQLSTATE

By default, OpenESQL Assistant generates SQL statements using SQLCODE checking. You change this to set OpenESQL Assistant to generate SQL statements using SQLSTATE checking instead.

Generate Interface Code

By default, OpenESQL Assistant generates SQL statements for use by any application. You can also set OpenESQL to generate SQL statements that can be used as a Web service.

Maximum Result Rows

By default, OpenESQL Assistant only returns the first 50 rows when you run a query. This is to prevent queries from returning huge numbers of rows, potentially crashing your machine or overloading your network. However, you can set the maximum number of rows returned to a number of your choice. Set this value to -1 if you want all rows returned. We recommend that you choose the number based on the amount of data you expect to be returned, or based on your testing needs.

Generate

Select one of three statement types:

EXEC SQL
EXEC ADO - disconnected model
EXEC ADO - connected model

By default, OpenESQL Assistant generates EXEC SQL statements. However, you can change it to build EXEC ADO statements if you have set Mode to ADO.NET and want to build EXEC ADO queries. You can then also generate EXEC ADO Disconnected or Connected statements as auxiliary code.

Restrict Tables

The following applies to Qualifier, Owner, and Table name when using ADO.NET mode:

Wildcard characters are not supported.
The qualifier, owner, and table name are case sensitive for some data providers and not for others. You might need to experiment when setting these restrictions.