UNISYS. Business Information Server. MRI Administration and User s Guide. Printed in USA May

Transcription

1 Business Information Server MRI Administration and User s Guide UNISYS 2004 Unisys Corporation. All rights reserved. Printed in USA May

2 NO WARRANTIES OF ANY NATURE ARE EXTENDED BY THIS DOCUMENT. Any product or related information described herein is only furnished pursuant and subject to the terms and conditions of a duly executed agreement to purchase or lease equipment or to license software. The only warranties made by Unisys, if any, with respect to the products described in this document are set forth in such agreement. Unisys cannot accept any financial or other responsibility that may be the result of your use of the information in this document or software material, including direct, special, or consequential damages. You should be very careful to ensure that the use of this information and/or software material complies with the laws, rules, and regulations of the jurisdictions with respect to which it is used. The information contained herein is subject to change without notice. Revisions may be issued to advise of such changes and/or additions. Notice to U.S. Government End Users: This is commercial computer software or hardware documentation developed at private expense. Use, reproduction, or disclosure by the Government is subject to the terms of Unisys standard commercial license for the products, and where applicable, the restricted/limited rights provisions of the contract data rights clauses. Correspondence regarding this publication can be ed to [email protected]. Unisys is a registered trademark of Unisys Corporation in the United States and other countries. All other brands and products referenced in this document are acknowledged to be the trademarks or registered trademarks of their respective holders.

3 Table of Contents ABOUT THIS GUIDE PLATFORM-SPECIFIC INFORMATION NOTATION CONVENTIONS INTRODUCING MRI MRI OVERVIEW MRI COMPONENTS RELATIONAL INTERFACE MANAGER (MRIM) MRI STATEMENTS LOG ON TO RELATIONAL DATABASE (LGN) DATA DEFINITION INFORMATION (DDI) RELATIONAL AGGREGATE FETCH (FCH) RELATIONAL AGGREGATE MODIFY (RAM) SUBMIT SQL (SQL) TRACE RELATIONAL SYNTAX (TRC) LOG OFF RELATIONAL DATABASE (LGF) STORED PROCEDURE INTERFACE (SPI) RELATIONAL DATABASE INTERFACE (RDI) MRI DATABASE ADMINISTRATION (MRIDBA) ACCESSING DATABASES THROUGH MRI LOCAL DATABASE CONNECTIONS REMOTE DATABASE CONNECTIONS CONFIGURING MRI WITH MRIDBA STARTING MRIDBA OBTAINING SYSTEM SETUP INSTRUCTIONS REGISTERING DATABASE NAMES REGISTERING A NAME FOR A LOCAL DATABASE

4 ENTERING A DATABASE NAME FOR A LOCAL DATABASE CHOOSING A LOCAL DATABASE TYPE PROVIDING LOCAL DATABASE REGISTRATION INFORMATION REGISTERING A DATABASE NAME FOR A REMOTE DATABASE ENTERING A REMOTE DATABASE NAME CHOOSING A REMOTE DATABASE TYPE FILLING IN THE COMMUNICATIONS TYPE MENU PROVIDING REMOTE DATABASE REGISTRATION INFORMATION UTILIZING DOMAIN NAMES FOR REMOTE 2200 MRI ACCESS DATABASE REGISTRATION AND CONFIGURATION EXAMPLES REGISTERING A LOCAL ORACLE DATABASE EXAMPLE REGISTERING A LOCAL ODBC DATABASE EXAMPLE REGISTERING A REMOTE INFORMIX DATABASE EXAMPLE SETTING UP APPLICATION GROUPS CONFIGURING SETUP PARAMETERS CREATING STORAGE AREAS CREATING DEMONSTRATION TABLES SETTING PUBLIC DEFAULTS SETTING RDI PRIVILEGES SETTING USER DEFAULTS REGISTERING LOCAL SUBROUTINES CLEANING UP ADMINISTRATION REPORTS DISPLAYING ACTIVE THREADS STATUS SETTING UP MRI FILES SETTING UP A REMOTE CONFIGURATION FILE EXAMPLE OF SETTING UP A REMOTE FILE SETTING UP A LOCAL OR REMOTE PARAMETER FILE CREATING STORAGE SPACE

5 OBTAINING DETAILED HELP SETTING UP ODBC DATA SOURCE NAMES CONFIGURING AND REGISTERING AN ODBC DATA SOURCE NAME VALID ODBC SUBTYPES SPECIFYING A PATH TO A REMOTE DATABASE FILE SETTING UP THE NORTHWIND DATA SOURCE NAME MANAGING OLE DB DATA SOURCES OLE DB PROVIDERS ACCESSING DATABASE THROUGH RDI INTRODUCING RDI ADVANTAGES OF USING RDI ACCESSING RDI FROM THE CONTROL LINE ACCESSING RDI FROM THE MENU USING THE RDI COMMANDS RETRIEVING DATA USING SELECT TABLE NAME COLUMN NAMES WHERE CLAUSE RETRIEVE ALL ROWS IF NO, HOW MANY NUMBER OF ROWS TO SKIP NULL SYMBOL EXTRA OPTIONS USING THE SELECT COMMAND SPECIAL OPTIONS MENU EXPLAIN SELECT CLAUSE DO THIS REQUEST IN THE BACKGROUND USING THE SELECT OPTIONS MENU ORDER BY

6 GROUP BY WOULD YOU LIKE DISTINCT COLUMNS WRAP ROWS IF THEY EXCEED REPORT WIDTH SIZE OF BLANK FIELDS BETWEEN EACH COLUMN DISPLAY INFORMATION VERTICALLY? (ONE LINE PER COLUMN) JUSTIFY COLUMN NAMES FOR VERTICAL DISPLAY LOCAL CODE BEFORE LOCAL CODE AFTER REPORT TEMPLATE (FROM REPORT WRITER) SAVING SQL SYNTAX IN A REPORT RETRIEVING DATA USING JOIN TABLE NAMES COLUMN NAMES WHERE CLAUSE RETRIEVE ALL ROWS? IF NO, HOW MANY NUMBER OF ROWS TO SKIP NULL SYMBOL EXTRA OPTIONS SPECIAL OPTIONS MENU USING THE JOIN OPTIONS MENU ORDER BY GROUP BY WOULD YOU LIKE DISTINCT COLUMNS? WRAP ROWS IF THEY EXCEED REPORT WIDTH SIZE OF BLANK FIELDS BETWEEN EACH COLUMN DISPLAY INFORMATION VERTICALLY (ONE LINE PER COLUMN) JUSTIFY COLUMN NAMES FOR VERTICAL DISPLAY

7 LOCAL CODE BEFORE LOCAL CODE AFTER REPORT TEMPLATE (FROM REPORT WRITER) ADDING NEW TABLE ROWS USING INSERT TABLE NAME NULL SYMBOL REMOVING DATA WITH DELETE TABLE NAME WHERE CLAUSE NULL SYMBOL CHANGING DATA USING UPDATE TABLE NAME COLUMN NAMES NEW VALUES WHERE CLAUSE NULL SYMBOL DEFINING NEW TABLES USING CREATE TABLE NAME STORAGE SPACE CREATE FROM REPORT AND DRAWER FREEFORM CREATE INSERT DATA LINES INCREASE INTEGER FIELDS NULL SYMBOL EXTRA OPTIONS SUBMITTING SQL WITH THE SQL COMMAND REPORT SQL REQUEST

8 PROCESS REQUEST IMMEDIATELY ACCESSING THE RDI UTILITIES MENU USING ALTER TABLE CHANGE COLUMNS ADD COLUMNS DROP COLUMNS ADD INDEX DROP INDEX ADD FOREIGN KEY DROP FOREIGN KEY USING RESTRICT TABLE GRANT USERS ACCESS TO A TABLE REVOKE ACCESS FROM A RESTRICTED TABLE RESTRICT AN EXISTING TABLE UNRESTRICT A RESTRICTED TABLE USING DESTROY TABLE USING CREATE VIEW NEW VIEW NAME TABLE NAMES COLUMN NAMES WHERE CLAUSE TEST ALL ROWS IF NO, ENTER MAXIMUM QUANTITY EXTRA OPTIONS USING CREATE VIEW OPTIONS GROUP BY WOULD YOU LIKE DISTINCT COLUMNS? WOULD YOU LIKE CHECKING WITH INSERTS AND UPDATES?

9 SHOULD ACCESS CONTROL BE TURNED ON? USING DROP VIEW USING MRI STATEMENTS TO ACCESS RELATIONAL DATA CREATING TABLES CREATING A TABLE WITH RAM CREATING A TABLE AND INSERTING DATA WITH RAM CREATING A TABLE WITH SQL INSERTING DATA INTO A RELATIONAL TABLE INSERTING DATA FROM A REPORT USING RAM IN CONJUNCTION WITH FCH INSERTING DATA WITH SQL RETRIEVING DATA WITH FCH RETRIEVING DATA FROM A SINGLE TABLE JOINING TABLES WITH FCH UPDATING DATA WITH FCH AND RAM USING FCH FOR DATA RETRIEVAL INSERTING UPDATED DATA WITH RAM DELETING DATA WITH FCH AND RAM RETRIEVING DATA WITH FCH DELETING DATA WITH RAM USING THE WHERE CLAUSE WITH RAM DROPPING TABLES WITH RAM RETRIEVING DATA INTO SCRIPT VARIABLES WITH SQL EXECUTING STORED PROCEDURES WITH SPI EXECUTING A STORED PROCEDURE EXAMPLE EXECUTING A STORED PROCEDURE EXAMPLE EXECUTING A STORED PROCEDURE EXAMPLE TROUBLESHOOTING

10 GUIDELINES FOR ACCESSING INFORMATION THROUGH DATABASE MANAGERS MRI INTERFACE TO ODBC DATABASE MANAGERS MODIFYING A RELATIONAL DATABASE CREATING TABLES WITH ODBC ACCESSING LISTS OF USER TABLES, VIEWS, AND SYSTEM TABLES RETRIEVING COLUMNS OF DATA WITH ODBC USING THE WHERE CLAUSE IN ODBC ALTERING TABLES WITH ODBC USING DATABASE DATA TYPES WITH ODBC UNDERSTANDING CASE SENSITIVITY IN ODBC MAKING DATA COMMITS AND RECOVERY IN ODBC ADJUSTING DECIMAL FIELDS IN ODBC RETRIEVING DATA WITH THE SQL STATEMENT IN ODBC UNDERSTANDING DATABASE ACCESS AND SECURITY IN ODBC INTERPRETING ODBC ERROR STATUS ORACLE INTERFACE CONSIDERATIONS CREATING AND CHANGING TABLES WITH ORACLE USING THE WHERE CLAUSE IN ORACLE ADDITIONAL OPERATORS ADDITIONAL FUNCTIONS CREATING DATA DEFINITIONS IN ORACLE MAKING DATA COMMITS AND RECOVERY IN ORACLE ADJUSTING DECIMAL FIELDS IN ORACLE USING SQL*NET WITH ORACLE USING ORACLE WITH THE RAM STATEMENT RETRIEVING DATA FROM ORACLE USING THE SQL STATEMENT UNDERSTANDING DATABASE ACCESS AND SECURITY IN ORACLE USING EXTRA OPTIONS FOR ORACLE

11 RELATIONAL DATABASE SERVER INTERFACE CREATING DATA DEFINITIONS IN RELATIONAL DATABASE SERVER MAKING DATA COMMITS AND RECOVERY IN RELATIONAL DATABASE SERVER ADJUSTING DECIMAL FIELDS IN RELATIONAL DATABASE SERVER USING RELATIONAL DATABASE SERVER WITH THE RAM STATEMENT RETRIEVING DATA FROM RELATIONAL DATABASE SERVER USING THE SQL STATEMENT CREATING AND CHANGING TABLES WITH RELATIONAL DATABASE SERVER UNDERSTANDING DATABASE ACCESS AND SECURITY IN RELATIONAL DATABASE SERVER PASSWORD SECURITY RECOVERY OPTIONS SECURITY INFORMIX INTERFACE CREATING AND CHANGING TABLES WITH INFORMIX USING THE WHERE CLAUSE IN INFORMIX ADDITIONAL OPERATORS ADDITIONAL FUNCTIONS CREATING DATA DEFINITIONS IN INFORMIX MAKING DATA COMMITS AND RECOVERY IN INFORMIX ADJUSTING DECIMAL FIELDS IN INFORMIX RETRIEVING DATA FROM INFORMIX USING THE SQL STATEMENT UNDERSTANDING DATABASE ACCESS AND SECURITY IN INFORMIX SYBASE INTERFACE CREATING AND CHANGING TABLES WITH SYBASE USING THE WHERE CLAUSE IN SYBASE ADDITIONAL OPERATORS ADDITIONAL FUNCTIONS CREATING DATA DEFINITIONS IN SYBASE MAKING DATA COMMITS AND RECOVERY IN SYBASE

12 USING SYBASE WITH THE RAM STATEMENT RETRIEVING DATA FROM SYBASE USING THE SQL STATEMENT ADJUSTING DECIMAL FIELDS IN SYBASE USING THE CASE-SENSITIVE FEATURE WITH SYBASE UNDERSTANDING DATABASE ACCESS AND SECURITY IN SYBASE MRI AND RELATIONAL DATABASE NETWORKING NETWORKING OPTIONS WITH RELATIONAL DATABASES NETWORKING WITH ORACLE COMMUNICATING WITH A SINGLE REMOTE DATABASE COMMUNICATING WITH DISTRIBUTED DATABASES NETWORK CONFIGURATION REPORT NETWORKING WITH ODBC NETWORKING WITH OLEDB NETWORKING WITH INFORMIX INFORMIX-NET INFORMIX-STAR NETWORKING WITH SYBASE MRI CONFIGURATION PARAMETER FILES CONFIGURATION PARAMETER DESCRIPTIONS SETTING UP THE MRI PARAMETER FILE SETTING UP THE MRI CONFIGURATION FILE CONFIGURING DATABASE ACCESS CONNECTION POOLING DATABASE ACCESS CONNECTION POOLING OVERVIEW SETTING UP A LOCAL PARAMETER CONFIGURATION FILE CONFIGURING AND VIEWING AN MRIM POOL PROCESS CONFIGURING THE NUMBER OF MRIM PROCESSES IN THE MRI PROCESS POOL STARTING THE CONFIGURED MRIM PROCESSES VIEWING THE STATUS OF CONFIGURED MRIM PROCESSES

13 MRIM PROCESS CONTROL SCREEN CONFIGURATION EXAMPLE REGISTERING BUSINESS INFORMATION SERVER SERVICES TO WORK WITH ODBC USING A WINDOWS SERVICE UNDER A USER ACCOUNT CONSIDERATIONS FOR USING ODBC WITH A WINDOWS SERVICE GLOSSARY A-E GLOSSARY F-L GLOSSARY M-R GLOSSARY S-W

14 About This Guide Copyright 2004 Unisys Corporation. All rights reserved. NO WARRANTIES OF ANY NATURE ARE EXTENDED BY THIS DOCUMENT. Any product or related information described herein is only furnished pursuant and subject to the terms and conditions of a duly executed agreement to purchase or lease equipment or to license software. The only warranties made by Unisys, if any, with respect to the products described in this document are set forth in such agreement. Unisys cannot accept any financial or other responsibility that may be the result of your use of the information in this document or software material, including direct, special, or consequential damages. You should be very careful to ensure that the use of this information and/or software material complies with the laws, rules, and regulations of the jurisdictions with respect to which it is used. The information contained herein is subject to change without notice. Revisions may be issued to advise of such changes and/or additions. RESTRICTED-Notice to Government End Users: This is commercial computer software or hardware documentation developed at private expense. Use, reproduction, or disclosure by the Government is subject to the terms of Unisys standard commercial license for the products, and where applicable, the restricted/limited rights provisions of the contract data rights clauses. Comments about documentation can also be sent through to [email protected]. Unisys is a registered trademark of Unisys Corporation in the United States and other countries. TRADEMARKS-All other brands and products referenced in this document are acknowledged to be the trademarks or registered trademarks of their respective holders Release Levels: Business Information Server Platform UNIX OS Windows Server Windows Client 2200 Release 8R R1 14

15 Platform-Specific Information This Help provides information on the following platforms: Windows Server UNIX OS 2200 Windows Client Some functions on the Business Information Server may produce different results depending on the platform you are using. These platform-specific differences for the Windows Server, UNIX operating system, Windows Client, and OS 2200 platforms appear as follows: Windows Server UNIX OS AUX sn[sl report f] Windows Server UNIX OS Windows Client AUX sn [report f] Windows Client 2200 AUX

16 Notation Conventions This source uses certain style conventions that aid you in understanding both the software and the Help. Following is a description of how syntax, special characters, system-specific information, examples, screen illustrations, italics, and bold type are used. Syntax The format of a command consists of these conventions: The call is in uppercase letters (for example, CHG). However, you can type it in either uppercase or lowercase letters. Fields and subfields are italicized whenever they call for variable data. Variable data is information you supply according to the explanation that follows the command format. Fields or subfields enclosed in brackets are optional. In this example, field2, subfield1, and subfield2 are optional: field1 [field2 subfield1,subfield2] Whenever you make an entry in an optional subfield, you must type all intervening commas. For Braces around items separated by a vertical bar mean that you are to choose from among the items listed. For example: {item1 item2} Special Characters The following characters have special meanings in this guide: [ ] Used around optional entries. If you select the entry, do not type the brackets, just the character or characters inside them. { } Used to show a selection of required fields. In formats, delimits items enclosed in brackets or braces. You choose one of the items to enter, but you do not enter the brackets, braces, or vertical bars. In examples, represents a tab character ( ). > Represents the SOE character in examples and in-report-line formats such as the Add Line format. Examples The examples in this guide are shown in lowercase letters. Unless otherwise specified, you can type them in lowercase or uppercase letters. Whenever possible, examples are created and tested against the demonstration database that come with your system. You can try these examples yourself and receive the same results as shown in this guide. Caution! Be careful when trying examples that update the demonstration database. Do not use functions that add, delete, or change lines while working with report 2B0, 1C0, or 1D0. Use duplicate reports so other users start with the same basic information and get the same results as shown in this guide. Screen Illustrations To help you understand concepts and procedures, this guide uses screen illustrations that closely resemble actual screen displays. However, you may encounter some differences between the illustrations and screen displays. These differences are due to variations among systems, among terminal types, and among characteristics of the databases of each system. These are some of the differences you might find: Symbols shown in screen illustrations may not match your terminal. For example, the SOE character and cursor may be displayed as different symbols on your screen, function key bars may contain different key names, or vertical bars between fields may not display. Key names within screen text may be different. For example, a screen illustration might mention the Transmit key; on the actual screen, it is displayed as XMIT, F5, or whichever key is applicable to your terminal. 16

17 Title lines and date lines may be positioned differently and contain different information. For example, on a Business Information Server for ClearPath OS 2200, the title line might begin with an indicator called a save flag (such in the heading); save flags are not shown on the screen illustrations in this guide. Report numbers, dates, times, and user-ids shown on screen illustrations may be different from those you actually see on your screen. Italics Italics indicate the following values that you supply: The italicized letter N (n or N) stands for a numeral (nn stands for two digits, nnn for three, and so on). Other italicized letters (for example, x and y) indicate user-supplied variables. Bold Type Text in bold type is used for key names, menu or input screen fields, and information you are instructed to type. Example: To start the ICAL run, type ical on the control line and press Transmit. 17

18 Introducing MRI This topic introduces the MRI and its components. It discusses the following: MRI Overview MRI Components Accessing Databases through MRI 18

19 MRI Overview The Relational Interface (MRI) is a feature of Business Information Server that gives users access to external data managers such as OLEDB, ODBC, MS SQL Server, Oracle, INFORMIX, and Sybase. MRI lets you do the following: Retrieve data from an external data manager and bring it into the Business Information Server. The full set of Business Information Server software functions and commands are available for processing the retrieved data. Insert, update, and delete data from tables stored in external data managers, without having to know anything about how the data is actually stored. Create or delete entire tables in external data managers. Together, the Business Information Server and MRI provide a seamless connection to external data. Using MRI, you can access local databases, remote databases using networking between two MRI systems, and remote databases using the database vendor's networking capabilities. 19

20 MRI Components MRI consists of four major components: Relational Interface Manager (MRIM) MRI Statements Relational Database Interface (RDI) MRI Database Administration (MRIDBA) 20

21 Relational Interface Manager (MRIM) The Business Information Server communicates with a low-level server program called the Relational Interface Manager (MRIM). The MRIM program provides the connection between the software system and the relational database management systems supported by MRI. MRIM does the following: 1. Takes a request from the RAM and FCH statements and automatically generates Structured Query Language (SQL) syntax specific to the data manager being called. (The Business Information Server and MRI deal with the idiosyncrasies of the different data managers so you do not need to consider them.) 2. Submits SQL syntax through the application program interface (API) of the data manager. This is the same API that third-generation language (3GL) applications, such as C programs, use. 3. Sends the response (either data or a status value) from the data manager back to the Business Information Server. 21

22 MRI Statements The MRI statements let you perform the full range of relational operations in a system script. These statements instruct software scripts to open sessions with external data managers and to retrieve, create, or modify data. Sites can rapidly develop their own database applications without using 3GLs like COBOL or C. The following statements are available: Log On to Relational Database (LGN) Submit SQL (SQL) Data Definition Information (DDI) Trace Relational Syntax (TRC) Relational Aggregate Fetch (FCH) Log Off Relational Database (LGF) Relational Aggregate Modify (RAM) Stored Procedure Interface (SPI) Relational Database Interface (RDI) Related Topics See Using MRI Statements to Access Relational Data for guidelines on using these statements in Business Information Server scripts. See Guidelines for Accessing Information through Database Managers for guidelines on using MRI statements in scripts that access specific data managers. 22

23 Log On to Relational Database (LGN) The LGN statement begins a session and establishes communications with the relational database management system. After the log-on procedure is complete, the script can Transfer data between a Business Information Server system and the relational database. Turn off the search for Primary Keys for ODBC databases Specify a translation report to translate data between Business Information Server and MRI Related Topic See the Command Reference for the format and description of this statement. 23

24 Data Definition Information (DDI) The DDI statement retrieves a table definition from the relational database. The table definition lists table columns, data types, and column sizes. It also identifies the primary keys and the columns that allow null values. Related Topic See the Command Reference for the format and description of this statement. 24

25 Relational Aggregate Fetch (FCH) The FCH statement retrieves data from the relational database and places it in a temporary report. You can use the FCH statement to Retrieve data from a single table Perform a Join query Retrieve large amounts of data from a relational database and display this data in a temporary report You can manipulate the report and then enter a RAM statement to update the database. Related Topic See the Command Reference for the format and description of the FCH statement. 25

26 Relational Aggregate Modify (RAM) The RAM statement lets you define or manipulate relational data using reports. The RAM statement performs the following relational operations: Creates a table using the headings in a report as columns Inserts the data lines in a report into a relational table Changes or delete rows in a relational table based on data stored in a report Drops a table definition from the relational database does not support Delete and Update for Text and Excel ODBC Databases. Related Topic See the Command Reference for the format and description of the RAM statement. 26

27 Submit SQL (SQL) The SQL statement submits SQL syntax directly to the relational database management system. You can use it to perform tasks that cannot be accomplished with other statements, such as indexing a relational table to improve performance under certain conditions. You can include the SQL syntax in the Business Information Server run statement or store it in a report. Related Topic See the Command Reference for the format and description of the SQL statement. 27

28 Trace Relational Syntax (TRC) The TRC statement stores SQL code generated during a relational session in a report. You can use the SQL code for debug purposes, or you can save it and use it with SQL or FCH statements. Related Topic See the Command Reference for the format and description of the TRC statement. 28

29 Log Off Relational Database (LGF) The LGF statement terminates the connection with the relational database. Related Topic See the Command Reference for the format and description of this statement. 29

30 Stored Procedure Interface (SPI) Windows Server Windows Client The SPI statement provides the ability to execute a specified stored procedure and return the results. It also provides a method to query and return meta-data about stored procedures in a database catalog. Related Topic See the Command Reference for the format and description of this statement. Note: For ODBC and OLEDB databases only. Windows Server Windows Client 30

31 Relational Database Interface (RDI) The Relational Database Interface (RDI) is an application that lets you access relational databases through MRI. With this program, you can access MRI statements indirectly by specifying a relational operation and selecting or supplying a table name along with supporting information. The application then submits the information to the relational database using the appropriate MRI statement, and returns data to the RDI application for display. RDI lets you perform the full range of relational operations without extensive knowledge of Structured Query Language (SQL). Related Topic See Accessing Databases through RDI for information on how to use RDI to access relational databases through MRI to a local or remote database. 31

32 MRI Database Administration (MRIDBA) MRIDBA performs administration and configuration tasks for MRI. Using this menu-driven program, you can easily configure, administer, and manage MRI relationships with the different data managers as well as communications between two MRI systems on different hosts. You use the MRIDBA script to Set up MRI configurations to access remote and local databases. Register database names. Set up user defaults. Establish RDI script security. Related Topic See Configuring MRI with MRIDBA for information on how to use MRIDBA to configure MRI. 32

33 Accessing Databases through MRI MRI lets you configure access to relational databases on both your own host system and other host systems. In addition, you can configure MRI to allow remote systems to access your local relational databases. For example, from a Windows system, you can Access a local Oracle database Connect to a remote Relational Database Server database on an OS 2200 system Allow a remote MRI session from another system to access an ODBC data source on your local Windows system To the user, the Business Information Server itself looks the same on all hosts. You can script the Business Information Server and MRI on the hardware platform that best suits your particular needs, and still access all of your stored data. You have access to the data regardless of where the data is physically stored. Notes: When you configure connections to a database through MRI, you must set up a local configuration. If you enable remote access to a data manager, configure the same logical database name on both the local and remote systems. To actually access the remote database from your local host, the other host must be configured for a remote connection. To properly configure a remote configuration on your local system, you must use the same database names on both the local and remote host. You only need to know the logical database name regardless of whether the connection is local or remote. Related Topics Local Database Connections Remote Database Connections 33

34 Local Database Connections Access to a database is local when MRI and the database reside on the same system. Access is also considered local when MRI resides on the same machine as the client software (system A) used to access the server (system B). Notes: The Com Type column in report 1C2 is dir for local databases. The database (for example, Oracle, Sybase, or Informix) does not need to reside on the same system as the Business Information Server to be considered local (dir). Windows Server Windows Client You can configure local database connections to the following systems on a Windows system: Business Information Server database MQL Oracle (local or SQL*Net) Microsoft SQL Server Sybase ODBC (CORE level-32-bit driver, callable from a Windows service) OLEDB Windows Server Windows Client UNIX OS You can configure local database connections to the following systems on a UNIX system: Business Information Server database MQL Oracle (local or SQL*Net) Sybase UNIX OS 34

35 2200 You can configure local database connections to Relational Database Server on a 2200 system You can register the logical database names and information about the database using MRIDBA, as described in Registering Database Names. Related Topics Oracle Interface Considerations MRI Interface to ODBC Database Managers 35

36 Remote Database Connections Access to a database is remote when MRI on one system (system A) must communicate with MRI on another system (system B) in order to access a database on system B. All Business Information Server to Business Information Server or MRI to MRI accesses are considered to be remote. Note: The Com Type in report 1C2 is eth for remote databases. Windows Server For example, you can establish connections to the following remote databases on a Windows system: MCP/A-series DMSII database INFORMIX ODBC (CORE level-32 bit driver) OLEDB Oracle Relational Database Server Sybase Ingres Microsoft SQL Server Windows Server You can register the logical database names and information about the database using MRIDBA, as described in Registering Database Names. You also need to register information about the database and the communications path on each host. After you properly configure MRI on both hosts, all networking is transparent to users. Using the Business Information Server and MRI, you can access data on any platform, from any platform. Related Topics INFORMIX Interface MRI Interface to ODBC Database Managers Oracle Interface Considerations 36

37 Relational Database Server Interface Sybase Interface 37

38 Configuring MRI with MRIDBA Use MRIDBA to configure MRI and administer the Relational Database Interface (RDI). Before users begin working with RDI, you can change the available defaults and privileges to meet user s needs. This topic describes how to configure MRI using MRIDBA, presents what options to set on your host system, and what to consider when setting up network connections. Starting MRIDBA Obtaining System Setup Instructions Setting User Defaults Registering Database Names Registering Local Subroutines Cleaning Up Administration Reports Setting Public Defaults Displaying Active Threads Status Setting RDI Privileges Setting Up MRI Files Obtaining Detailed Help Windows Server UNIX OS Windows Client Creating Storage Space Windows Server UNIX OS Windows Client Setting Up Application Groups Update MRI.Tables 38

39 Starting MRIDBA To display the DBA Menu 1. Enter mridba at the control line and press NumEnter. The DBA Menu appears. DBA Menu Tab to your choice and press NumEnter: System set-up -> Register database names -> Application group set-up -> Set public defaults -> Set RDI privileges -> Set user defaults -> Register local subroutines -> Clean up admin. reports -> Update MRI.TABLES -> Active Threads -> Set up MRI files -> Create storage space -> Detailed help -> 2. Tab to a selection on the DBA Menu and press NumEnter. 3. Each selection on the DBA Menu displays one or more menus. The following topics describe these menu selections. Note: DBA Menu selections that are not available on your platform appear in a different color. For example, the Application group set-up selection is not available in a Windows environment. This selection, therefore, appears in a different color. Caution! Be careful when trying examples that update the demonstration database. Do not use functions that add, delete, or change lines while working with report 2B0, 1C0, or 1D0. Use duplicate reports so other users start with the same basic information and get the same results as shown in this guide. 39

40 Obtaining System Setup Instructions 2200 Use the System set-up menu to display a result that contains instructions for setting up the MRI system. To display system setup instructions 1. Tab to System set-up on the DBA Menu, and press NumEnter. 2. As an option, you can print out the system setup instructions

41 Registering Database Names Use the Register database names menu to configure and register local and remote databases for use with the RDI script or your own scripts. Perform the steps in one of the following procedures: Registering a Name for a Local Database Registering a Database Name for a Remote Database 41

42 Registering a Name for a Local Database Do the following procedures to register a name for a local database: Entering a Database Name for a Local Database Choosing a Local Database Type Providing Local Database Registration Information For more information, see Local Database Connections. 42

43 Entering a Database Name for a Local Database To configure a local database name 1. After executing mridba from the command line, tab to Register database names on the DBA Menu, and press NumEnter. The Database configuration menu appears. Database configuration Enter the database name. Database Name -> Local or Remote MRIM (L or R)? -> L Place cursor here and press NumEnter -> 2. Enter a database name that identifies the database. MRI registers the database access information with this name. This name can be any name you wish, with a maximum length of 18 characters. For example, the name can be the database management system (such as Oracle, FoxPro, or ODBC), or a logical database name (such as PAYROLL). 3. Ensure that L appears in the Local or Remote? field. The default value of L is already filled in when the menu appears. 4. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to display the Choose a database type menu. 43

44 Choosing a Local Database Type To choose a local database type 1. Perform the procedure in Entering a Database Name for a Local Database to display the Choose a database type menu. 2. MRIDBA displays all the local database types that the local and remote system supports on your platform. For example, if you are creating database configurations on a Windows platform, MRIDBA displays the following local database types. Locate: DBMS Type MQL ODBC OLEDB msql orac7 sybs Choose a database type DBMS Description MAPPER database (MQL) ODBC (CORE level - 32bit Driver) OLEDB Data Source MS SQL Server ORACLE 7.0 and above Sybase 3. Tab to a database type, and press NumEnter to display the specific Register a database source menu for your selected platform. 44

45 Providing Local Database Registration Information To provide local database registration information 1. Select your database configuration and database type as described in Entering a Database Name for a Local Database and Choosing a Local Database Type. The Register <your database source> menu appears. The fields displayed in the Register <your database source> menu depend on the database source previously selected. Register <your database source> Enter the following information. Database Name -> your database name Database Type -> your database type Communication Type -> dir Max Threads -> 5... (Depending on the database, specific fields are displayed) Place cursor here and press NumEnter -> MRIDBA fills in the Database Name, Database Type, Communication Type, and Max Threads fields. You cannot change the Database Name, Database Type, or Communication Type fields on this menu. The Communication Type field for a local database is always dir. The Communication Type field for a remote database is always eth. 2. Change the Max Threads value if desired. This value is the maximum number of users that can access the database using the network name in 1C2. 3. Fill in the remaining information depending on your database type as shown in the following table. Database Type Menu Fields Relational Database Server 2200 Max Threads -> Application Group -> MRIM Id -> Oracle Max Threads -> Oracle SID -> Oracle HOME path -> INFORMIX Max Threads -> For INFORMIX-SE enter SQLEXEC, or for INFORMIX-ONLINE enter the name of your ONCONFIG file -> For INFORMIX-SE enter the location of your database files or for INFORMIX-ONLINE enter the name of your database -> Location of INFORMIX -> Sybase or Microsoft SQL Server Max Threads -> Sybase/ MS SQL Server Database Name -> Sybase/ MS SQL Server Server Name -> ODBC Max Threads -> ODBC Data Source Name -> 45

46 OLEDB Max Threads -> OLEDB UDL filename -> 4. Move your cursor to Place cursor here and press NumEnter. Press NumEnter. MRIDBA registers the database and returns you to the Database configuration menu. The following message appears at the top of the menu: *** Database <your database name> has been entered *** 5. You can register another database, or press Resume (F1) to return to the DBA Menu. 46

47 Registering a Database Name for a Remote Database Do the following procedures to register a name for a remote database: Entering a Remote Database Name Choosing a Remote Database Type Filling in the Communications Type Menu Providing Remote Database Registration Information Utilizing Domain Names for Remote 2200 MRI Access 47

48 Entering a Remote Database Name To register a remote database 1. After executing mridba from the command line, tab to Register database names on the DBA Menu, and press NumEnter. The Database configuration menu appears. Database configuration Enter the database name. Database Name -> Local or Remote MRIM (L or R)? -> r Place cursor here and press NumEnter -> 2. Enter a database name that identifies the database. MRI registers the database access information with this name. This name can be any name you like, with a maximum length of 18 characters. For example, the name can be the database management system (such as Oracle, FoxPro, or ODBC), or a logical database name (such as PAYROLL). This name must also be registered on the remote system. 3. Type r for a remote database. 4. Move your cursor to the Place cursor here and press NumEnter. Press NumEnter to display the Choose a database type menu. 48

49 Choosing a Remote Database Type To choose a remote database type 1. Perform the procedure in Entering a Remote Database Name to display the Choose a database type menu. MRIDBA displays all the remote database types that the remote or local system supports on your platform. For example, if you are creating database configurations on a Windows system, MRIDBA displays the following remote database types: Choose a database type Locate: DBMS Type DBMS Description ASQL A series database INFX Informix ing Ingres 6.4/05 and above msql MS SQL Server ODBC ODBC (CORE level - 32Bit Driver) OLEDB OLEDB Data Source orac5 ORACLE 5.0 orac6 ORACLE 6.0 orac7 ORACLE 7.0 and above rdms4 RDMS 4R1 rdms5 RDMS 5R1 rdms6 RDMS 6R2 and above sybs Sybase 2. Tab to a database type selection and press NumEnter to select a database type. If the database type you select has more than one communications type, MRIDBA displays the Choose a communications type menu. Go to Filling in the Communications Type Menu to select a communications type. If you choose a database type that has only one type of available communications protocol, the MRIDBA script fills in the communications type on the database registration menu. Go to Providing Remote Database Registration Information to complete the database registration. 49

50 Filling in the Communications Type Menu 2200 If you choose a database manager that permits more than one communications protocol, you must select a communications method from a list of possible methods. For example, on an OS 2200 system accessing a remote database, the list includes ddp - DDP 1100 tsn - TSAM (TCP/IP) If you choose a database manager that only has one type of available communications protocol, MRIDBA fills in the communications type, and this menu does not appear. To select a communications type 1. Perform the procedure in Entering a Remote Database Name and Choosing a Remote Database Type to display the Choose a communications type menu. MRIDBA displays all the communications types that the system supports on your platform. For example, if you are creating an INFORMIX database configuration on a UNIX for the Business Information Server operating system, MRIDBA displays the following communications types: Choose a communications type Comm Type Comm Description - eth MRIM Uses Ethernet 2. Tab to the appropriate communications type, and press NumEnter to select a communications type

51 Providing Remote Database Registration Information To provide remote database registration information 1. Select your database configuration and database source as described in Entering a Remote Database Name and Choosing a Remote Database Type. The Register a database source menu appears. Register a remote database with Ethernet Enter the following information. Database Name -> your database name Database Type -> your database type Communication Type -> eth Max Threads -> 5 Ethernet node name -> Place cursor here and press NumEnter -> MRIDBA fills in the Database Name, Database Type, Communication Type, and Max Threads fields. You cannot change the Database Name, Database Type, or Communication Type fields on this menu. 2. Change the Max Threads value if desired. This value is the maximum number of users that can access the database using the network name in 1C2. 3. Enter the IP address or IP alias address of the machine you are accessing. The MRIDBA script registers the database and returns you to the Database Configuration menu. The following message appears at the top of the menu: *** Database <your database name> has been entered *** 4. You can register another database, or press Resume (F1) to return to the DBA Menu. Notes: To complete the registration of an ODBC database on a Windows system, you must also configure a Data Source Name (DSN) as described in Setting Up ODBC Data Source Names. UNIX OS When Business Information Server on one system (system A) calls a remote system (system B), the remote system (system B) utilizes a file called /user/bin/mrim to activate an mrim on system B. This file then points to the location of the mrim executable. Ensure that the mrim executable referenced in the "exec" line exists on system B. For example exec/map6r1/lbin/mrim-sa zarth $3$4$5 Where map6r1 is the location of the mrim executable. For incoming remote requests, the Business Information Server that last executed the menus features and connections and was built with the mrim parameter changing from an N to a Y, is the mrim that is executed. This changes the /user/bin/mrim file. UNIX OS 51

52 Utilizing Domain Names for Remote 2200 MRI Access 2200 Users can modify the Network Configuration Report (1C202) to specify a domain name instead of an IP address by replacing the IP address in the Network Configuration report, which resides in the Network Path Name field, with either an 18 character free form domain name or the keyword *dnr. This keyword tells MRI that the free form domain name is in the Additional Network Information field. If the first character of this field is a backslash (\), this indicates that there is an asterisk type line following this entry that contains a free form domain name of the site, starting in column 2. If the name is longer than 18 characters then the user must manually modify this report to place *dnr in the Network Path Name field and then place the free form domain name in the Additional Network Information Field. Example Network Configuration Report *.S..S.Com. * Network Name.L.Network Path Name.L.Type. Additional Network Information *==================.=.==================.=.====.================================== == odbc-txt xxx.xx.xxx.xxx tsm odbc-txt XXXX tsm odbc-txt *dnr tsm usmnjohndoe.us.cor.corporation.com odbc-txt *dnr tsm 3985*usmnjohndoe.us.cor.corporation.com odbc-txt *dnr tsm \ *3095*usmn-johndoe.us.cor.corporation.com odbc-txt xxx.xx.xxx.xxx tsm getname Notes: 2200 odbc-txt 1 If you have improper or invalid user created entries, then the error message <Error in MRI remote communications> is displayed. Be sure to enter in the correct IP address, because currently, there is no method to detect parsing errors in the IP address or domain name and relay that information back to the end user. This entry is an example of the current method of supplying a connection address. It can be created by manually modifying the Network Configuration Report. odbc-txt 2 This entry is an example of using a short domain name (18 characters or less). Both of these entries can be created using the current MRIDBA functionality. It can be created by manually modifying the Network Configuration Report. odbc-txt 3 This entry is an example of how to specify a long domain name (greater than 18 characters) using *dnr and then the Additional Network Information field. It can be created by manually modifying the Network Configuration Report. odbc-txt 4 This entry is an example of how to specify the optional port number along with a long domain name (greater than 18 characters). It can only be created by manual modification of the Network Configuration Report. odbc-txt 5 This entry is the same as the one above except it shows how to specify the long domain name (greater than 18 characters) on a supplemental line in the report. It can only be created by manual modification of the Network Configuration Report. 52

53 odbc-txt 6 This entry is an example of how to utilize the getname optional functionality, which causes the Internet Name for the specified IP address to be placed in the MRI print file. It is a debug/help tool only that can only be created by manual modification of the Network Configuration Report. 53

54 Database Registration and Configuration Examples The following three examples show how to register and configure database names using the MRIDBA script: Registering a Local Oracle Database Example Registering a Local ODBC Database Example Registering a Remote INFORMIX Database Example Note: The menus in these examples may differ slightly from those on your system. 54

55 Registering a Local Oracle Database Example To register a local Oracle database 1. After executing mridba from the command line, on the DBA Menu, tab to Register database names, and press NumEnter. The Database Configuration menu appears. 2. For this example, enter oracle-s2 for the database name, and an l in the second field, indicating that the database is local. Database configuration Enter the database name. Database Name -> oracle-s2 Local or Remote MRIM (L or R) -> l Place cursor here and press NumEnter -> The Choose a database type menu appears. Tab to the database type needed, and press NumEnter. 3. For this example, tab to orac7 (ORACLE 7.0 and above) and press NumEnter. Locate: DBMS Type MQL ODBC OLEDB msql orac7 sybs Choose a database type DBMS Description MAPPER database (MQL) ODBC (CORE level - 32bit Driver) OLEDB Data Source MS SQL Server ORACLE 7.0 and above Sybase The next menu, Register an Oracle database, shows fields required to register a local Oracle database. All fields except Max Threads, Oracle SID, and Oracle HOME path are filled in, based on information entered on preceding menus. 4. On the Register an Oracle database menu, enter 6 for the Max Threads (users that can access the local database), ORCL for the Oracle SID, and c:\orant for the Oracle HOME path directory. Register an Oracle database Enter the following information. Database Name -> oracle-s2 Database Type -> orac7 Communication Type -> dir Max Threads -> 6 Oracle SID -> ORCL Oracle HOME path -> (enter on next line) c:\orant Place cursor here and press NumEnter -> 5. Press NumEnter to finish registering the current database. 55

56 Registering a Local ODBC Database Example To register a local ODBC database 1. After executing mridba from the command line, on the DBA Menu, tab to Register database names, and press NumEnter. 2. To register a remote ODBC database, fill in the fields, and press NumEnter. For this example, enter ODBC-s2 for the database name and an l (for local) in the second field. Press NumEnter. The Choose a database type menu appears. Database configuration Enter the database name. Database Name -> ODBC-s2 Local or Remote MRIM (L or R) -> l Place cursor here and press NumEnter -> 3. Tab to the database type needed and press NumEnter. For this example, select ODBC ODBC (CORE level - 32-bit Driver). Locate: DBMS Type MQL ODBC OLEDB msql orac7 sybs Choose a database type DBMS Description MAPPER database (MQL) ODBC (CORE level - 32bit Driver) OLEDB Data Source MS SQL Server Oracle 7.0 and above Sybase 4. The Register an ODBC Data Source menu appears. The following menu shows the required fields. Register an ODBC Data Source Enter the following information. Database Name -> ODBC-S2 Database Type -> ODBC Communication Type -> dir Max Threads -> 6 ODBC Data Source Name -> odbc-fox Place cursor here and press NumEnter -> 5. Move your cursor to Place cursor here and press NumEnter. Press NumEnter. 56

57 Registering a Remote INFORMIX Database Example To register a remote INFORMIX database 1. After executing mridba from the command line, on the DBA Menu, tab to Register database names, and press NumEnter. The Database configuration menu appears. 2. Fill in all the fields and press NumEnter. In this example, the database name in the first field is informix-s1, and the r in the second field indicates that the database is remote. Database configuration Enter the database name. Database Name -> informix-s1 Local or Remote MRIM (L or R) -> r Place cursor here and press NumEnter -> 3. The Choose a database type menu appears. For this example, tab to INFX (Informix) for the database type and press NumEnter. Choose a database type Locate: DBMS Type DBMS Description ASQL A series database INFX Informix ing Ingres 6.4/05 and above msql MS SQL Server ODBC ODBC (CORE level - 32Bit Driver) OLEDB OLEDB Data Source orac5 Oracle 5.0 orac6 Oracle 6.0 orac7 Oracle 7.x and above rdms4 RDMS 4R1 rdms5 RDMS 5R1 rdms6 RDMS 6R2 and above sybs Sybase 4. The next menu, Register a remote database with Ethernet, shows the fields required to register the remote database INFORMIX. MRIDBA fills in all fields except Max Threads and Ethernet node name, based on information entered on preceding menus. For this example, enter 4 for the Max Threads (users that can access the remote database) and system1 for the Ethernet node name. Register a remote database with Ethernet Enter the following information. Database Name -> informix-s1 Database Type -> INFX Communication Type -> eth Max Threads -> 4 Ethernet node name -> system1 Place cursor here and press NumEnter -> 57

58 5. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to complete this registration procedure. 58

59 Setting Up Application Groups 2200 Use the Application Group set-up menu to display a result that contains instructions for setting up an application group. To display application group setup instructions 1. Enter the application group name. 2. Tab to the transmit field and press NumEnter. The following menu appears: Application Group Setup Application Group Tab to your choice and press NumEnter Set up parameters -> Create storage areas -> Create Demonstration tables -> 2200 Use each of the selections to set up the application group. 59

60 Configuring Setup Parameters 2200 The parameters on the Set up parameters menu are used for batch scripts. Batch scripts are required in order to access the Data Dictionary. To configure set up parameters 1. After executing mridba from the command line, on the DBA Menu, tab to Set up parameters on the Application Group Setup menu. The Register parameters menu appears. Register parameters Enter the following information Batch port name -> MAPPER Demand Acct. number -> 0 MAPPER User-id -> BPT MAPPER Department -> 104 MAPPER Password -> xyz DD Qualifier -> sys$lib$ DD File -> urep Storage area Qualifier -> uds$$src Place cursor here and press NumEnter -> 2. Fill in the menu fields where Batch port name Is the name of your batch port. Demand Acct. number Is the demand account number used for starting a batch job. User-id Department Password Are log-in information for the batch job. (BPT,104,XYZ is the default user-id on the release tape.) DD Qualifier Is the qualifier for the Data Dictionary. DD File Is the file name containing the Data Dictionary. If the application group applies to SB3Rx products, then the Data Dictionary is DDS. If the application group applies to SB4Rx products, then use UREP. Storage area Qualifier Is the file qualifier used for creating the storage areas. You will need a permanent file for the storage areas. 3. Fill in all required fields, and then press NumEnter to continue

61 Creating Storage Areas 2200 Use the Create storage areas menu to start a batch script containing the Data Dictionary commands necessary to create four storage areas required by RDI for the demonstration database. To create a storage area 1. Select Create Storage Areas; the batch script is displayed. You can refer to this to get file names for the storage area. 2. Press Start to begin the job. After a few minutes the terminal beeps, indicating that the job is done. 3. To continue, press Msg Wait; then acknowledge the message by typing OK. PressNumEnter

62 Creating Demonstration Tables 2200 Use the Create Demonstration tables menu to link to the RDI RESTORE function to create the demonstration tables. When the restore process is complete, a menu appears. Press NumEnter to return to the DBA Menu

63 Setting Public Defaults Use the Set public defaults menu to establish a default database name and database user-id for a public user-id (PUBLIC). The Database Defaults report contains the default values that you specify with this submenu. The RDI script uses information in this report. To set public defaults 1. After executing mridba from the command line, on the DBA Menu, tab to Set public defaults and press NumEnter. The Set public defaults menu appears. Set public defaults Enter an optional department number Department number -> Place cursor here and press NumEnter -> 2. Enter a valid department number in the Department number field, if necessary. The defaults apply to PUBLIC in this department only. If this field is blank, the public defaults apply to all departments. 3. Move your cursor to Place cursor here and press NumEnter. Press NumEnter. The Add public defaults menu appears. 4. Fill in the fields as follows, and press NumEnter to add the information to the Database Defaults report: Department number Type the same department number you entered on the Set public defaults menu. Database name Type the default database name for PUBLIC. The database name typed in this field appears as the default on the RDI DBMS menu for any user-id for which no other default exists. Default database? Type Y or N. If the value of this field is Y, RDI uses this database name as the default database for PUBLIC. Database user-id Type the default database user-id. This database user-id appears as the default on the DBMS menu for any user-id for which no other default value exists. Default qualifier Type the default table qualifier for Relational Database Server Default version Type the default table version name for Relational Database Server Default cabinet Type a default cabinet for results. If a default cabinet is not registered for a user, RDI places the results in the current cabinet. Default drawer Type a default drawer for results. If no default is registered for a user and a drawer is not entered through fast access RDI, RDI places these results in drawer A. Trace SQL syntax? Type N to disable tracing of SQL syntax on the Insert, Delete, Update, and Create commands. Disabling this option improves performance, but prevents capture and display of SQL syntax generated by these commands. Multiple logons? Type N if RDI logs on to a database manager once. Type Y to give RDI the capability to log on and log off a database before and after each relational operation. 63

64 Setting RDI Privileges Use the Set RDI privileges menu to establish privileges by user-id for the RDI script. To set RDI privileges 1. After executing mridba from the command line, on the DBA Menu, tab to Set RDI privileges and press NumEnter. The Set RDI privileges menu appears. Set RDI privileges Enter the MAPPER user-id, department number, and database name MAPPER user-id -> Department number -> Database name -> Place cursor here and press NumEnter -> 2. Fill in the fields as follows, and press NumEnter: MAPPER user-id Type the user-id to which the privileges apply. Department number Type the department number associated with the user-id. If you leave this field blank, the privileges apply to all departments. Database name Type the database name to which the privileges apply. If the field is blank, the privileges apply to all database names. 3. On the next screen, fill in the fields as follows. When all required fields are filled in, press NumEnter to add the data to the RDI security report. All privileges? Type Y in this field to extend privileges to all RDI functions. Select,...,Drop view Type Y for all functions for which the user has access privilege. Leave blank any selections to which the user should not have access. Type s for the SQL function to restrict the user-id to SELECT statements only. Maximum rows to retrieve Type the maximum number of rows that can be retrieved by the user through the Select, Join, and SQL commands executed through RDI. If the field is blank, the user can retrieve any number of rows. Access Special Options menu on Select, Join, and SQL? Type Y to enable the user to access the Special Options menu in RDI. If n is entered, the next two fields do not require a response. Explain Type Y to enable the user to display online explanations of Select statements. These explanations are accessed through the Special Options menu. Background script Type Y to enable the user to process requests with a background script. 4. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to complete this task. 64

65 To check user access The RDI script determines privileges based on specific information entered in the RDI Security report. RDI checks the report in the following order: 1. user-id/department number/database name 2. user-id/department number 3. user-id/database name 4. user-id 5. PUBLIC/department number/database name 6. PUBLIC/department number 7. PUBLIC/database name 8. PUBLIC 65

66 Setting User Defaults Use the Set user defaults menu to specify a default database name and database user-id by user-id. The data entered on the menu is stored in the Database Defaults report. The information in this report applies only to the RDI script. To set user defaults 1. After executing mridba from the command line, on the DBA Menu, tab to Set user defaults and press NumEnter. The Set user defaults menu appears. Set user defaults Enter the MAPPER user-id and optional department number MAPPER user-id -> Department number -> Place cursor here and press NumEnter -> 2. Fill in the fields as follows and press NumEnter: MAPPER user-id Type the user-id for which a default database name and database user-id is to be entered. This is a required field. Department number Type the department number associated with the user-id. If this field is left blank, the default database name applies to all department numbers for which no default was established. 3. The Add user defaults menu appears. Fill in the fields as follows. When all required fields are filled in, press NumEnter to add the information to the Database Defaults report. MAPPER user-id Type the user-id entered on the Set user defaults menu. Department number Type the department number associated with the user-id. The default value is the department number entered on the Set user defaults menu. Database name Type the default database name for the user-id. The database name typed in this field is provided as the default on the DBMS menu for this user-id. Default database? Type Y or N. If the value of this field is Y, the database name is provided as the default database for this user-id in RDI. Database user-id Type the default database user-id for this user-id. This database user-id is provided as the default on the DBMS menu for this user-id and database name. Default qualifier Type the default table qualifier for Relational Database Server Default version Type the default table version name for Relational Database Server Default cabinet Type a default cabinet for results. If no default is registered for a user, RDI places the results in the current cabinet. 66

67 Default drawer Type a default drawer for results. If no default is registered for a user and a drawer is not entered through fast-access RDI, RDI places the results in drawer A. Trace SQL syntax? Type N to disable tracing of SQL syntax on the Insert, Delete, Update, and Create commands. Disabling this option improves performance, but prevents capture and display of SQL syntax generated by these commands. Multiple logons? Type N if RDI logs on to a database manager once. Type Y to give RDI the capability to log on and log off a database before and after each relational operation. 4. Move your cursor to Place cursor here and press NumEnter. Press NumEnter. 67

68 Registering Local Subroutines Use the Register local subroutines menu to register local subroutines used in RDI data retrieval operations. The information is stored in the RDI Local Code report. For more information about local subroutines, see the Command Reference. To register local subroutines 1. After executing mridba from the command line, on the DBA Menu, tab to Register local subroutines and press NumEnter. The Register local subroutines menu appears. Register local subroutines Enter the following information. Routine Name -> MAPPER User-id -> Department number -> Place cursor here and press NumEnter -> 2. Fill in the fields as follows and press NumEnter: Routine Name Type the name assigned to the local subroutine. The routine is registered under this name in the RDI Local Code report. MAPPER User-id Type the user-id for access to the local subroutine. The default value for this field is PUBLIC. Department number Type the department number associated with the user-id. If this field is blank, the routine can be accessed by all departments with the user-id. 3. On the next screen, fill in the fields as follows. When all required fields are filled in, press NumEnter to add the information to the RDI Local Code report. Routine Name Type the name assigned to the routine in the preceding menu. Database Name Type the name of the database where the local routine will be used. If no value is entered in this field, the routine can be used in all databases. Select or join? Type s to use the routine with the Select command. Type j to use the routine with the Join command. Before or after data retrieval? Type b if the routine is executed before data is retrieved by the Select or Join commands. Type a if the routine is executed after the data is retrieved. Cabinet Type the cabinet containing the local subroutine. Drawer Type the drawer containing the local subroutine. Report Type the report number for the local subroutine. Label Type the report label for the local subroutine. User-id 68

69 Type the user-id entered on the previous menu. Department number Type the department number entered on the preceding menu. Comments Type a description of the routine or other information. 4. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to complete the procedure. 69

70 Cleaning Up Administration Reports Use the Clean up admin. reports menu to check the RDI Administration reports for invalid entries and to delete unnecessary entries. To clean up administration reports 1. After executing mridba from the command line, on the DBA Menu, tab to Clean up admin. reports and press NumEnter. The Clean up menu appears. Clean up menu Tab to your choice and press NumEnter RDI Database Defaults report -> Database configuration report -> RDI Security report -> SQL Requests report -> Local code report -> Parameters report -> 2. Tab to the report you want to clean up and press NumEnter. The Clean up defaults menu appears. 3. Tab to one of the items and press NumEnter. Clean up defaults Tab to your choice and press NumEnter Delete unnecessary entries -> Check report for invalid data -> Notes: When you select Delete unnecessary entries, a list of entries appears as a temporary report. Mark entries to be deleted by typing a d in the X field, and then press Resume (F1) to delete the marked entries. When you select Check report for invalid data, MRI verifies data in the report for validity. Examples of invalid data are as follows: Character data in a numeric field Duplicate entries Reference to a report that does not exist After the system checks the report, it displays invalid data rows. In the spaces provided, type d to delete the entries. Click Help to display a list of possible errors. If the system finds no invalid data, it displays a message indicating that invalid data does not exist. 70

71 Displaying Active Threads Status Use the Active Threads menu to display a report containing information about all active threads. An active thread is the period of time a user is logged on to a relational database. To display information about active threads 1. After executing mridba from the command line, on the DBA Menu, tab to Active Threads and press NumEnter. A report appears that displays the following information: Station and host Logon time and date Active time if an operation is actually being performed 2. Press Repeat (F1) to redisplay the report and view an updated thread status report. 71

72 Setting Up MRI Files Use the Set up MRI files menu to set up remote configuration and remote parameter files as well as the local parameter file. MRI uses the files to store information. The files contain information used by local and remote databases. Note: The default location for both remote configuration and parameter files is MSWSITES\MRI_REM. The default location for the local parameter file is MSWSITES\<site letter>. Windows Server Windows Client To set up MRI configuration files on a Business Information Server for the Windows Operating System, you must perform one of the following actions: Specify an Administrator user-id and password in the Windows Login and Password parameter fields of the Graphical Interface for Business Information Server connection script. You can then update any parameter file without having to provide additional user-ids and passwords. After you set up the desired configurations, the Business Information Server displays a screen that requests an authorized user-id and password. Enter the Administrator user-id and password and press NumEnter. Windows Server Windows Client UNIX OS To set up MRI configuration files on a Business Information Server for the UNIX Operating System, you must perform one of the following actions: Log in to the UNIX operating system as super user and then sign onto the Business Information Server. You can then update any parameter file without entering additional user-ids and passwords. After you set up the desired configurations, the Business Information Server displays a screen that requests an authorized user-id and password (super user). Enter the proper user-id and password and press NumEnter. UNIX OS To set up MRI files 1. After executing mridba from the command line, on the DBA Menu, tab to Set up MRI files and press NumEnter. The Set up MRI files screen appears. Set up MRI files Set up remote configuration file -> Set up local parameter file -> Set up remote parameter file -> 2. Tab to the selection you want and press NumEnter. The following text describes the possible selections: Set up remote configuration file Contains a list of databases that remote systems can access. For a remote system to do this, you must have a configuration file set up with the database names. The configuration file contains information similar to the network configuration report. The database name that the remote database uses must match a name in the remote configuration file. Note: The remote configuration file is built from the 1C2 report. The configuration files are sys$lib$*mri.mrim/config 72

73 Windows Server Windows Client mswsites\mri_rem\mrimcfg Windows Server Windows Client UNIX OS map6r1/mri_remote/mrimcfg UNIX OS Set up remote parameter file Updates MRI parameters for access by a remote system. Depending on which selection you choose, refer to the following topics, as appropriate: Setting Up a Remote Configuration File Example of Setting Up a Remote File Setting Up a Local or Remote Parameter File 73

74 Setting Up a Remote Configuration File To set up a remote configuration file 1. When you choose Set up remote configuration file, a list of databases registered in the network configuration report appears. 2. Type an x in the first field next to each database to be entered in the remote file, and press NumEnter. 3. Press Resume (F1) to update the file. Windows Server Windows Client The remote configuration file name is mrimcfg. The file resides in the mri_rem subdirectory of the Business Information Server Sites directory. For example: c:\mswsites\mri_rem\mrimcfg. Windows Server Windows Client 2200 After updating the remote configuration file, the 2200 MRIM script must be restarted

75 Example of Setting Up a Remote File To set up a remote mrimcfg file 1. After executing mridba from the command line, on the DBA Menu, tab to Set up MRI files and press NumEnter. 2. On the Set up MRI files menu, tab to the selection you want and press NumEnter. For this example, select Set up remote configuration file. Set up MRI files Set up remote configuration file -> Set up local parameter file -> Set up remote parameter file -> 3. The network configuration report appears. Tab to the X field and type an x next to each database that can be accessed from remote systems. Press NumEnter, and then press Resume (F1)..DATE 29 DEC 98 14:03:29 REPORT GENERATION CARYN.Choose the databases that can be accessed from remote systems by entering an X in the X field. Press the Resume key to continue....com...thr. *X.DB Name.Network Path Name.Type..DMSType.Cnt. *=.========.=================.====.===.=======.====. x ODBC-s2 dir ODBC 5 informix-s1 system1 eth INFX 5 x oracle-s2 orcl dir orac7 5 *Reserved =======================. ODBC-FOX c:\orant 4. After pressing Resume (F1), a file called mrimcfg is written out to the Mri_rem directory. For example: C:\Mswsites\Mri_rem\Mrimcfg (for Windows) or /map6r1/mri_remote/mrimcfg (for UNIX). 5. The mrimcfg file is column sensitive (loosely based on the 1C2 report). When parsing the mrimcfg file, each column placeholder is important. It is also important to note that the mrimcfg file just has the contents of a column and not the actual column itself. The number of spaces between columns is not relevant, as long as there is at least one space separating each column. The following is a sample mrimcfg file and corresponding column name in the 1C2 report: any_name N/A dir sybs 5 \ syb_db_name@syb_server_name any_name2 oracle_sid dir sybs 5 \ oracle_home_dir any_name3 N/A dir sybs 5 \ MS_db_name@Ms_server_name any_name4 N/A dir sybs 5 \ DSN_name Column1 = Network Name Column2 = Network Path Name Column3 = Com Type Column4 = DBMS Type Column5 = Thread Count 75

76 Column6 = Additional Network Information Note: The "\"character is the linewrap character. 76

77 Setting Up a Local or Remote Parameter File MRI uses parameter files to set capacity limits and defaults for database environment information. Each Business Information Server site has its own MRI parameter file. Another MRI parameter file is for requests from remote systems. Usually, you do not use the default configuration values. Although you can edit the parameter file and add the appropriate parameter values, it is more convenient and safer to use MRIDBA to create entries in the local or remote parameter files. See Configuration Parameter Descriptions for a description of each of the possible parameters included in a parameter file. To set up a local or a remote parameter file 1. After executing mridba from the command line, on the DBA Menu, tab to Set up MRI files and press NumEnter. 2. On the MRI files menu, tab to Set up local parameter file or Set up remote parameter file and press NumEnter. 3. The system retrieves the appropriate parameter file and displays the Set up parameter file menu. 4. Fill in the fields as follows: Default database Windows Server (Optional) Type the default database for MRI access. If you configure a default database for MRI, it must also be registered through MRIDBA in the Network Configuration report (1C2). Windows Server Maximum users per database Maximum users per system Maximum active databases 2200 (Optional) Type the default database for MRI access. If you configure a default database for MRI, it must also be registered through MRIDBA in the Network Configuration report (1C202) UNIX OS Windows Client Windows Server Enter the maximum number of active MRI users allowed per database name for your site. The default is 10. Enter the maximum number of active MRI users allowed per system for your site. This value should equal or exceed the maximum active users per database parameter. The default is 50. It is not recommended that this number exceed 200, as doing so could cut into system resources, which may lead to undesired results. Enter the maximum number of active MRI database names for your site. The default is 10. Local/remote MRI access? Oracle SID Oracle home If you are setting up a local file, type Y to allow users on your site to access MRI. If you are setting up a remote file, type Y to allow users on remote systems to access MRI. Typing N prevents users from accessing MRI on both local and remote systems. (Optional) Type the default Oracle database system identifier (SID). You only use this parameter if you did not provide an Oracle SID when the database name was registered. (Optional) Type the full path name to the default directory where Oracle is installed. You only use this parameter if you did not provide an Oracle_Home when the database name was registered. 77

78 Oracle DLL MS SQL DLL Sybase DLL UNIX OS Windows Client Windows Server (Optional) Enter the specific Oracle dynamically linked library (DLL) for the Oracle level installed on your system. MRI currently looks for oci.dll. (Optional) Enter the specific MS SQL dynamically linked library (DLL) for the MS SQL level installed on your system. MRI currently looks for NTWDBLIB.dll. (Optional) Enter the specific Sybase dynamically linked library (DLL) for the Sybase level installed on your system. MRI currently looks for LIBSYB.dll. Windows Server UDL Location Maximum ODBC disconnects before MRIM restarts Maximum ODBC connections to keep open (Optional) Disconnect Pooled ODBC Connection if ODBC Error occurs? Enter the directory location of the UDL files if different than the default location. The default location is system drive:\program files\common files\system\ole db\data links\. (Optional) For local databases, enter the maximum number of allowed disconnects before MRIM restarts. Once the number of disconnects exceeds this value, the pooled MRIM frees all of its resources, restarts itself, and exits. Exiting is the only way to get rid of the driver memory leaks that accumulate with every disconnect when one of a few specific versions of some ODBC drivers are being used. See Configuring Database Access Connection Pooling for additional information about pooled MRIMs. For example, if you set this value to 125 and you connect to MRI from an Access database through an ODBC driver, each prestarted MRIM accumulates 1 MB of lost memory before exiting the system. If the ODBC driver is for a FoxPro or DBase database, the accumulated memory loss is 0.5 MB. The default is 0. For a local database, enter the maximum number of unique ODBC connections (restarted or pooled MRIMs) to keep open. Keeping multiple ODBC connections open provides the following benefits: Improves system performance. Reduces memory loss if your ODBC driver has a memory leak on connect/disconnect cycles (for example, Access, FoxPro, or DBase databases). Because your system can lose available memory each time ODBC disconnects from a database, you should minimize the number of times you connect and disconnect from an ODBC data source. For example, one version of the Microsoft Access ODBC Driver loses 8 K of memory each time you disconnect. The ODBC DSN, user-id, and password are compared to determine unique database connections. You can specify 0 to 20 open connections. The default is 0. To mark a pooled ODBC connection to disconnect when an error occurs, enter Y in this field. The actual connection will not be disconnected until is executed on this data source. Enter N if the connection should remain open regardless of what type of error is returned from the ODBC driver. 78

79 The default is N. Justification for A, F, and I variables on command. Windows Server This parameter sets the justification of numeric data fetched into A, F, and I type Business Information Server variables via command. R = Right justify data. N = No change to the justification. L = Left Justify the data. The default is N. 79

80 Creating Storage Space UNIX OS Windows Client Windows Server Use the Create storage space menu on the DBA Menu to create storage or table space. To create a storage space 1. After executing mridba from the command line, on the DBA Menu, tab to Create storage space and press NumEnter. The Create storage space menu appears. Create storage space Enter the following information. Database Name -> Database user-id -> Password -> Storage Space -> Place cursor here and press NumEnter -> 2. To create storage or table space, fill in the fields as follows and press NumEnter. Database Name Type the database in which the storage or table space is to be created. Database User-id Type a valid database user-id. Password Type the database password. Storage Space Type the storage or table space name. 3. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to complete this procedure. UNIX OS Windows Client Windows Server 80

81 Obtaining Detailed Help Use the Detailed help menu of the MRIDBA Menu to display online help for the MRIDBA script. 81

82 Setting Up ODBC Data Source Names Windows Client Windows Server This topic describes how to configure and register an ODBC data source name on a Windows system. This name must match the database name you provide when setting up an ODBC connection through MRIDBA, as described in Registering Database Names. Topics covered include Configuring and Registering an ODBC Data Source Name Valid ODBC Subtypes Specifying a Path to a Remote Database File SettingUptheNorthwindDataSourceName Windows Client Windows Server Note: For setting up Business Information Server services to work with ODBC on IBM platforms, see Registering Business Information Server Services to Work with ODBC. 82

83 Configuring and Registering an ODBC Data Source Name Windows Client Windows Server To configure and register an ODBC data source name 1. Sign on to Windows. 2. Go to the Main menu Settings option and select Control Panel. 3. Double-click Administrative Tools. 4. Select the Data Sources (ODBC) icon. The ODBC Data Source Administrator menu appears. 5. Click the System DSN tab to display a list of system data sources that already exist on your Windows system. 6. To configure a new data source name, click the Add button. The Create New Data Source menu appears. 7. Select the ODBC driver from the list. For example, Microsoft Access Driver (*.mdb) Microsoft dbase Driver (*.dbf) Microsoft Excel Driver (*.xls) Microsoft FoxPro Driver (*.dbf) Microsoft ODBC for Oracle Microsoft Paradox Driver (*.dbf) Microsoft Text Driver (*.txt; *.csv) SQL Server UniAccess UnisDB32 Unisys Data Access 8. Click Finish. The setup menu for the selected driver appears on your screen. Each ODBC server driver has a unique setup menu with applicable fields. For example, if you select the ODBC SQL driver, the ODBC SQL Server Setup menu appears. 9. Fill in the fields as described in the Help for this system. At a minimum, you must supply the Data Source Name and Description fields on the setup menu. 10. Refer to the Windows Help associated with the setup menu for additional information about filling in the remaining fields. 11. Click OK to complete adding a new data source. 12. Repeat steps 2 through 9 for each data source that uses the ODBC interface. Windows Client Windows Server 83

84 84

85 Valid ODBC Subtypes Subtypes MS SQL Server 7.0 MS SQL Server 2000 Oracle Oracle DB2 RDMS DMS Drivers SQL Server SQL Server Oracle ODBC Driver Oracle ODBC Driver IBM DB2 ODBC Driver UniAccess Unisys ODBC Access 8R2 DMSII Unisys ODBC Access 8.2 Access Excel Paradox Text Informix PostgreSQL Sybase 12.0 MySQL Microsoft Access Driver Microsoft Excel Driver Intersolv Bit Paradox File Microsoft Text Driver Informix bit PostgreSQL Sybase ASE ODBC MySQL does not support Delete and Update for Text and Excel Databases. 85

86 Specifying a Path to a Remote Database File Windows Client Windows Server Follow this procedure if you need to connect to a remote database file. As part of defining the data source name, you must specify a path name to the remote site database file. One method of specifying a remote path name is to map a drive to the remote database file. In this case, you should not map to a drive because drive mappings require that the user who mapped the drive be logged onto the server console. If not, the drive mapping becomes unavailable. To solve this drive mapping problem, enter a path name that follows the Uniform Naming Convention (UNC). Specifying the UNC makes this path name independent of what user is logged onto a system. To enter a UNC file path name in a data source name 1. Sign on to Windows. 2. Go to the Main menu Settings option and select Control Panel. 3. Double-click Administrative Tools. 4. Select the Data Sources (ODBC) icon. The ODBC Data Source Administrator menu appears. 5. Click the System DSN tab to display a list of system data sources that already exist on your Windows system. 6. To configure a new data source name, click the Add button. The Create New Data Source menu appears. 7. Select the ODBC driver from the list. For example, Microsoft Access Driver (*.mdb). 8. Fill in the fields and select the database. For an Access database, click Select. The Select Database screen appears. Enter the UNC path name in the Database Name field. 9. Click OK to complete selecting the database file. 10. Click OK to finish adding the new data source name for the remote database file. Windows Client Windows Server 86

87 Setting Up the Northwind Data Source Name Windows Client Windows Server The following steps present an example of configuring and registering the Northwind data source name for a local site. This data source is an Access database. To set up the Northwind Data Source Name 1. Sign on to Windows. 2. Go to the Main menu Settings option and select Control Panel. 3. Double-click Administrative Tools. 4. Select the Data Sources (ODBC) icon. The ODBC Data Source Administrator menu appears. 5. Click the System DSN tab to display a list of system data sources that already exist on your Windows system. 6. Click the Add button. The Create New Data Source menu appears. 7. Select the Microsoft Access Driver (*.mdb) driver from the list. 8. Click Finish. The ODBC Microsoft Access Setup screen appears. 87

88 9. Enter Northwind for the Data Source Name and Northwind Database for the Description. 10. Click Select to choose the Northwind data base file. The Select Database screen appears. Select the Northwind.mdb from the c:\ directory. 88

89 11. Click OK. The ODBC Microsoft Access Setup screen appears again. Note that the path to the Northwind.mdb file appears in the Database field. 12. Click OK to complete adding a new data source. The ODBC Data Source Administrator screen appears. Note that the Northwind data source name now appears in the list of system data source names. 13. Click OK to complete the procedure. Windows Client Windows Server 89

90 Managing OLE DB Data Sources Creating and Managing UDL Files Using OLE DB Administration Windows Client Windows Server The OLE DB Administration tool lets you create and manage UDL files. These files contain a connection string with the initialization properties needed to connect to a data source. The default location of UDL files created by this tool is system drive:\program files\common files\system\ole db\data links\. Windows Client Windows Server Related Topic For more information on creating and managing UDL files, see the Business Information Server OLE DB Administration Help. 90

91 OLE DB Providers Check with your database vendor for the minimum version required to support OLE DB access. For example, Oracle recommends Oracle8i client release or higher to be able to use the Oracle OLE DB provider. 91

92 Accessing Database through RDI MRI gives you the option of updating databases and accessing data through an interactive script known as the Relational Database Interface (RDI). This topic describes how to access data through RDI. It discusses the following: Introducing RDI Accessing RDI from the Menu Advantages of Using RDI Using the RDI Commands Accessing RDI from the Control Line Accessing the RDI Utilities Menu 92

93 Introducing RDI The Relational Database Interface (RDI) is a Business Information Server script. This script provides access through MRI to data stored in a relational database. With this script, you can access MRI statements indirectly by specifying a relational operation and selecting or supplying a table name along with supporting information. The script then submits the information to the relational database using the appropriate MRI statement, and returns data to the RDI script for display. Notes: RDI is a general-purpose tool that may not be suitable for specific application needs. To handle specific application needs, you must develop customized Business Information Server scripts. RDI supports the use of 998 character length fields. When specifying relational operations, you are actually directing RDI to create Structured Query Language (SQL) commands. These SQL commands let you perform the following operations: Create and alter relational tables Retrieve data from single or multiple tables Insert, change, or delete data stored in relational tables To access RDI You can use RDI through a menu-driven interface or by presenting an RDI command string on the MPC control line. See the following topics for more information: Accessing RDI from the Control Line Accessing RDI from the Menu 93

94 Advantages of Using RDI Using RDI to access relational data gives you the following advantages: Access to data without requiring in-depth knowledge of SQL The small amount of SQL knowledge you do need works the same way for all supported data managers, shielding you from the specifics of any particular data manager. Ability to reuse SQL syntax You can capture the SQL syntax generated from queries and save the syntax in a report for later reuse. To access the saved SQL syntax, you simply enter RDI and the report name on the control line. Support of free form, user-written SQL If you are already familiar with SQL, you can write your own queries and use RDI to submit these queries to the data manager. 94

95 Accessing RDI from the Control Line To access RDI from the control line Type the following command: RDI[,command,drawer,db,user-id,psw] For details on the RDI control line format, including valid commands, see the Command Reference. As an alternative to the control line format, you can simply enter RDI and the command name to display an RDI command screen. This guide refers to this method of accessing RDI commands as the fast-access method. Note: In order to see results wider than 80 characters, you must access RDI from the control line and specify a drawer that is capable of holding a result wider than 80 characters. 95

96 Accessing RDI from the Menu To access an RDI command from the RDI menu Notes: 1. Type rdi on the control line and press NumEnter. The DBMS menu, which contains the default database name and user-id, appears. 2. To change the database name and user-id from the default name and user-id, do the following: a. Move the cursor into these fields and enter the new information. To select a different database, enter a? in the Database name field to display a list of available databases. b. Move the cursor to the Database password and enter the password. c. Press the Tab key to advance to the next field. 3. Press NumEnter. The program accesses the database with the user-id and password entered on the menu and displays the RDI menu. 4. Select an RDI command from the menu as described in Using the RDI Commands. If your default database does not require a password (for example, Relational Database Server or INFORMIX), the DBMS menu is not displayed, and you advance directly to the RDI main menu. To display the DBMS menu, click DBMS. If any of the information on the menu is incorrect, a message is displayed indicating the error. If the DBMS menu is still displayed, type the information again and press NumEnter. If the menu is not displayed, click Return to display the DBMS menu and enter the information again. If the selected DBMS does not support some RDI functions, those functions are not accessible. 96

97 Using the RDI Commands RDI lets you access seven RDI commands through the RDI menu interface. In addition, the RDI menu includes a utilities and help selection. From the RDI menu, you can make the following selections: Retrieving Data Using Select Retrieves data from a single relational table or view and displays the data in a report. Retrieving Data Using Join Retrieves data from two or more tables or views in the database. Adding New Table Rows Using Insert Adds rows to a relational table. You can enter rows in a blank report or use an existing report containing data lines. Removing Data with Delete Removes rows from tables in a relational database. Changing Data Using Update Changes data in relational tables. Defining New Tables Using Create Adds new tables to a relational database. You can create tables using an existing report or by entering information on an assistance screen. Submitting SQL with the SQL Command Submits SQL syntax directly to a relational database. You can enter SQL syntax directly or save syntax statements in a report. In addition, SQL syntax generated by other RDI commands can be saved in a report and submitted to the database using the SQL command. 97

98 Retrieving Data Using Select Use the Select command to retrieve rows from a single relational table into a report. To use the Select command 1. Choose the Select options from the RDI menu, or use the fast-access method to display the RDI Select command menu. This menu lets you Specify the table name that contains the data. Enter the columns in the table. Include an optional Where clause stating one or more conditions. 2. Fill in the following fields on the Select command screen: Table Name Column Names Where Clause Retrieve All Rows If No, How Many Number of Rows to Skip Null Symbol Extra Options 3. When you have filled in the fields, move your cursor to Place cursor here and press NumEnter. Press NumEnter to execute the query or display the Select Options menu. 98

99 Table Name You can use Table Name to specify the table from which data is retrieved, generate a list of tables, or describe a table. Enter one of the following options: A table name and the remaining information required to retrieve data from the database A table name with the remaining fields blank, or accept the default values to obtain a description of the table A question mark to display a list of available tables 99

100 Column Names You can use Column Names to specify the column names for a report, or to display a list of columns. Enter one of the following options: An asterisk to select all columns in the table A question mark to display a list of available columns One or more column names to be displayed in the result (separate columns with a comma) Column names and built-in functions Column names and arithmetic expression 100

101 Where Clause You can use the Where clause to state one or more conditions that are to be evaluated as true or false for each row in the table. The result contains only the rows for which the condition is true. Enter one of the following options: A field of names and conditions for evaluation. A question mark to display a report in which the Where clause can be entered. (Use this option when the Where clause exceeds the length of the field on the screen.) 101

102 Retrieve All Rows You can use Retrieve all rows? to further restrict the number of rows you retrieve with the Select command. Change the value of this field to N if you want to retrieve only the number of rows specified in the next field. The default is to select all retrieved rows. If you do not enter a value, the report displays all rows retrieved by the statement. If your user-id is restricted to a fixed number of rows for data retrieval, the number of rows retrieved cannot exceed this number. 102

103 If No, How Many You can use If no, how many? to enter the number of rows for retrieval if you set the value of the previous field to N. If the value of Retrieve all rows? is N and you accept the default value of If no, how many?, only one row is retrieved for the report. 103

104 Number of Rows to Skip You can use Number of rows to skip to specify how many rows to skip in the table. For example, to skip the first nine rows in the table, enter a 9 in this field. 104

105 Null Symbol You can use the Null symbol to specify the null value symbol used in the character type columns in the table. If a character value in the table contains a null value, RDI fills this field in the report with the character you enter for this field. The default null value symbol is the asterisk (*). You can change the value to any non-alphanumeric character except a double quotation mark ("). Null decimal-type fields are always blank. 105

106 Extra Options You can use Extra options to choose the Select options screen before the query is executed. Enter a Y to set this option. If you set this option, the Select options menu appears when you press NumEnter at the bottom of this menu. Using the Select Options Menu describes what to enter for this menu. 106

107 Using the Select Command Special Options Menu As an option, you can use the Special Options menu (F6) to Obtain an explanation of the syntax generated by RDI and a description of the access path used to retrieve data from the table. Execute the Select command as a background run and write the result in a report. Select an option. After you select an option, the RDI Select command menu reappears so that you can enter a Structured Query Language (SQL) request. To select a special option 1. To access the Special Options menu, press the Specl key on the RDI menu bar. The Special Options menu appears. 2. Fill in the following fields: Explain Select Clause Do This Request in the Background 3. When you complete entering information on this menu, move your cursor to Place cursor here and press NumEnter. Press NumEnter to execute the query or display the Select Options menu. 107

108 Explain Select Clause You can use Explain select clause to display an explanation of the Select clause. If you enter Y, an explanation of the Select clause appears. 108

109 Do This Request in the Background You can use Do this request in the background to specify background processing. If you enter Y, RDI processes your request as a background run. In addition, you must enter information in the following fields: Place results in cabinet Enter the cabinet number in which to store a result. Place results in drawer Enter the drawer (A-I) in which to store a result. Place results in report Enter a report number in which to store a result, or leave this field blank if you want a new report added. Exit RDI after the request is issued? Enter Y to exit RDI after starting the background run. Notify when request is finished? Enter Y to receive notification of background run completion. A message indicates that your RDI request is finished and identifies the report that contains the results. Enter R to receive notification when the background run is finished. With this option, the message displayed is the result of the RDI request. The word MSG appears in the lower or upper right corner of your screen when a script has been completed. To receive the message, press the MSG WAIT key or enter MSG and press NumEnter. 109

110 Using the Select Options Menu Use the Select Options menu to specify The order in which data appears on the report The arrangement of data by groups for built-in functions The elimination of duplicate rows in a result To select an option 1. To access the Select Options menu, enter a Y for Extra options on the Select Command menu. 2. Move your cursor to Place cursor here and press NumEnter. Press NumEnter. The Select Options menu appears. 3. Fill in the following fields on the Select Options menu: Order By Group By Would You Like Distinct Columns Wrap Rows if They Exceed Report Width Size of Blank Fields between Each Column Display Information Vertically? (One Line per Column) Justify Column Names for Vertical Display Local Code Before Local Code After Report Template (from Report Writer) 4. When you complete entering information on this screen, move your cursor to the Place cursor here and press NumEnter field. Press NumEnter to execute the query or display the Select Options screen. Note: The Select Options screen appears only if you set the Extra options on the Select command screen to Y. 110

111 Order By You can use Order by to add one or more column names to sort data in the result. Enter one of the following options: A list of one or more column names. Separate column names with a comma. If the column is a character type, the result appears in descending ASCII collating sequence. If the column is a decimal type, the result is arranged numerically in ascending order. A reserved word. Desc can follow a column name to sort the result by column in descending order. If the column is a character type, the result appears in ascending ASCII collating sequence. If the column is a decimal type, the result is arranged numerically in descending order. When the clause contains multiple columns, you can enter the reserved word Asc for some and Desc for others. A question mark. To display a list of available columns, enter a question mark. 111

112 Group By You can use Group by to add a list of one or more columns to sort data into groups. You must specify built-in functions in the Column names field on the Select command menu, as described in Using the RDI Commands. Enter one of the following options: A list of one or more column names. Rows are grouped by this column and data is calculated by the built-in functions. Column name. Enter the column name followed by the reserved word Having and one or more conditions. A question mark. To display a report for entering a Group By clause, enter a question mark. Use this option when the Group By clause exceeds the length of the field on the screen. 112

113 Would You Like Distinct Columns You can use Would you like distinct columns to eliminate duplicate rows in the result if you set this field to Y. 113

114 Wrap Rows if They Exceed Report Width You can use Wrap rows if they exceed report width to wrap to the next line any displayed data lines that exceed the maximum length. To wrap rows, set this field to Y. If you use the default value of N, RDI truncates the data lines. 114

115 Size of Blank Fields between Each Column You can use Size of blank fields between each column to specify how many blank spaces you want between columns. Enter up to 18 blank spaces between columns in the result. RDI ignores this field value if truncation would result from adding the specified number of blank spaces. 115

116 Display Information Vertically? (One Line per Column) You can use Display information vertically? (One line per column) to display column names at the top of the result on separate lines. Data lines are displayed below the header line, one line per column value. Rows are numbered in the display. To display information vertically, set this field to Y. 116

117 Justify Column Names for Vertical Display You can use Justify column names for vertical display to display justified column names that are included on the same line as the data. Enter r to right-justify column names. Enter l to left-justify column names. If you use the default value N, RDI eliminates column names from data lines in the result. 117

118 Local Code Before You can use Local code before to identify a routine to be executed before RDI submits the Select statement for processing. Enter one of the following options: Thenameofthelocalroutinetobeexecuted A question mark to display a list of available routines 118

119 Local Code After You can use Local code after to identify a routine to be executed after RDI submits the Select statement for processing. Enter one of the following options: Thenameofthelocalroutinetobeexecuted A question mark to select a routine from a list 119

120 Report Template (from Report Writer) You can use Report Template (from Report Writer) to identify the cabinet, drawer, and report containing the template in the RRRRDCCCC format, or enter a question mark to display a list of report templates registered in the Application Power Tools (APT). After data is retrieved, RDI accesses the Report Writer and creates the report. 120

121 Saving SQL Syntax in a Report You can save SQL syntax while using the Select command, or any RDI command in a report. When required, you can execute these commands using the RDI SQL command. To save an SQL command in a report 1. Select the desired SQL task from the RDI menu and respond to the series of prompts on the assistance screen. 2. After you enter information, the RDI script translates this information into an SQL command and submits it to the database. 3. The data selected by the SQL command is then returned as a report, or the relational operation is performed. 4. Press ShwSQL to see the SQL statement generated by RDI. 5. Press SveSQL to save the SQL statement in a report. Pressing SveSQL lets you give a name to the saved SQL syntax, as described in Submitting SQL with the SQL Command. 121

122 Retrieving Data Using Join Use the Join command to retrieve rows from two or more relational tables into a report. To use the Join command 1. Select Join from the RDI menu, or use the fast-access method to display the Join command menu. This menu lets you Specify the table names from which data is retrieved. Specify the columns in the table. Include a Where clause stating the join conditions. 2. Fill in the following fields on the Join command screen: Table Names Column Names Where Clause Retrieve All Rows? If No, How Many Number of Rows to Skip Null Symbol Extra Options 3. When you complete entering information on this screen, move your cursor to the Place cursor here and press NumEnter field. Press NumEnter to execute the query or display the Join Options screen. 122

123 Table Names You can use Table names to specify the tables that are to be joined. Use one of the following options: Enter two or more table names and the remaining information required to retrieve data from the database. Separate table names with a comma. Enter table names and leave the remaining fields blank, or accept the default values to obtain a description of the table. Enter a question mark and leave remaining fields blank, or accept default values to generate a list of tables in the database. To establish a table name alias To prevent column name confusion, you can establish an alias for a table by entering the following statement: Tablename1 T1 Tablename2 T2 When you have duplicate or ambiguous column names, you can qualify these names using the alias. For example: SELECT * FROM Tablename1 T1, Tablename2 T2 WHERE T1.ColumnName = T2.ColumnName ; 123

124 Column Names You can use Column names to specify column names for a report, or to display a list of columns. Select one of the following options: Enter an asterisk to select all columns in the table. Enter a question mark to display a list of column names from which to select. Enter one or more column names to be displayed in the result. Separate column names with a comma. 124

125 Where Clause You can use the Where clause to state the conditions for the join. Select one of the following options: Enter field names and conditions to be evaluated. Enter a question mark to display a report in which the Where clause can be entered. Use this option when the Where clause exceeds the length of the field on the screen. 125

126 Retrieve All Rows? You can use Retrieve all rows? to further restrict the number of rows you retrieve with the Join command. Change the value of this field to N if you want to retrieve only the number of rows specified in the next field. The default is to select all retrieved rows. If you do not enter a value, the report displays all rows retrieved by the statement. 126

127 If No, How Many You can use If no, how many to enter the numbers of rows you want to retrieve if the value of the Retrieve all rows? field is N. If the value of the Retrieve all rows? field is N and the default value of this field is accepted, only one row is retrieved for the report. 127

128 Number of Rows to Skip You can use Number of rows to skip to skip rows in the table. For example, to skip the first nine rows in the table, enter a 9 in this field. 128

129 Null Symbol You can use the Null symbol to specify the null value symbol used in the character type columns in the table. If a character value in the table contains a null value symbol, that field in the report is filled with the character specified in null symbol. The default null value indicator is the asterisk. You can change the value to any non-alphanumeric character except a double quotation mark. Null decimal-type fields are always blank. 129

130 Extra Options You can use Extra options to display the Join Options menu before RDI executes the query. To do so, set this field to Y. See Special Options Menu for a description of the fields on this menu. 130

131 Special Options Menu You can use the Special Options menu to Obtain an explanation of the syntax generated by RDI and a description of the access path used to retrieve data from the table. Execute the Join command as a background run and write the result in a report. To access the Special Options screen 1. Press Specl from the RDI screen bar. 2. Press Help for additional information about Special Options, or see Using the Select Options Menu. 131

132 Using the Join Options Menu Use the Join Options menu to Specify the order in which data is displayed on a report. Arrange data with built-in functions by groups. Eliminate duplicate rows in a result. Note: The Join Options menu appears only if you set the Extra options field on the Join Command menu to Y. To select a Join option 1. To access the Join Options menu, enter a Y for Extra options on the Join Command menu as described in Extra Options. 2. Move your cursor to Place cursor here and press NumEnter. Press NumEnter. The Join Options menu appears. 3. Fill in the following fields on the Join Options menu: Order By Group By Would You Like Distinct Columns? Wrap Rows if They Exceed Report Width Size of Blank Fields between Each Column Display Information Vertically (One Line per Column) Justify Column Names for Vertical Display Local Code Before Local Code After Report Template (from Report Writer) 4. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to execute the Join query. 132

133 Order By You can use Order by to add one or more column names to sort data in the result. Enter one of the following options in this field: A list of one or more column names. Separate column names with a comma. If the column is a character type, the result appears in ascending ASCII collating sequence. If the column is a decimal type, RDI arranges the result numerically in ascending order. A reserved word. You can insert Asc or Desc after the column name to sort the result in ascending or descending order. If the column is a character type and sorted by descending order, the result appears in ascending collating sequence. If the column is a decimal type, then the result is arranged numerically in descending order. When the clause contains multiple columns, you can specify Asc for some and Desc for others. A question mark. You can insert a question mark to select one or more columns from a list. 133

134 Group By You can use Group by to add one or more column names for sorting data into groups when you use built-in functions. Enter one of the following options in this field: A list of one or more column names. RDI groups rows by this column and calculates the data using the built-in functions. A column name. Enter a column name followed by the reserved word Having and one or more conditions. A question mark. You can insert a question mark to display a report for entering the Group by clause. 134

135 Would You Like Distinct Columns? You can use Would you like distinct columns? to eliminate duplicate rows in the result if you set this field to Y. 135

136 Wrap Rows if They Exceed Report Width You can use Wrap rows if they exceed report width to wrap to the next line any data lines that exceed the maximum length. To do this, set this field to Y. If you use the default value N, RDI truncates the data lines. 136

137 Size of Blank Fields between Each Column Enter a value up to 18 as the number of blank spaces between columns in the result. RDI ignores the value of this field if adding the specified number of blank spaces would truncate data in that column. 137

138 Display Information Vertically (One Line per Column) If you set this field to Y, RDI displays column names at the top of the result on separate lines. Data lines are displayed below the period line, one line per column value. Records are numbered in the display. 138

139 Justify Column Names for Vertical Display If information is displayed vertically, RDI justifies the column names and includes the names on the same line as the data. If you use the default value, RDI eliminates column names from data lines in the result. You can also use one of the following options: Enter r to right-justify column names. Enter l to left-justify column names. 139

140 Local Code Before This field identifies a routine to be executed before the Join is executed. 140

141 Local Code After This field identifies a routine to be executed after the Join is executed. 141

142 Report Template (from Report Writer) If you created a report template for the data, identify the cabinet, drawer, and report containing the template in the RRRRDCCCC format, or enter a question mark to select from a list of report templates registered in APT. After retrieving data, RDI accesses the Report Writer and generates the report. 142

143 Adding New Table Rows Using Insert Use the Insert command to add new rows to a relational table. To use the Insert command 1. Select Insert from the RDI menu, or use the fast-access method to display the Insert command menu. This menu lets you specify a table name, and RDI generates a report containing column names as headers. Rows are then entered into the report and inserted in the table. 2. Fill in the following fields on the Insert command menu: Table Name Null Symbol 3. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to display a table description. 4. Insert the table rows as needed. You are actually updating a temporary report. 5. Press NumEnter and Resume (F1). RDI saves the data in the result and inserts these rows in the table. 143

144 Table Name You can use Table name to generate a report containing the column names in the table. If you enter a question mark, RDI displays a list of tables. Select the table into which you want to insert the new rows and press Resume (F1). 144

145 Null Symbol You can use the Null symbol to specify the null value symbol used in the table column. The default value is the asterisk. 145

146 Removing Data with Delete Use the Delete command to remove rows of information from a table. To use the Delete command 1. Select Delete from the RDI menu, or use the fast-access method to display the Delete command menu. This menu lets you specify the table from which rows are to be deleted and a Where clause to identify rows that are to be removed. 2. Fill in the following fields on the Delete command menu: Table Name Where Clause Null Symbol 3. Move your cursor to Place cursor here and press NumEnter. Press NumEnter. RDI displays a result that includes the rows you selected for deletion. 4. Update this information, as needed. 5. Press Resume (F1). RDI displays the rows you deleted. 6. Press Delmnu to return to the Delete command menu or, press Quit (F10) to return to the main RDI menu. 146

147 Table Name You can use Table name to name the table from which rows will be deleted, or enter a question mark to generate a list of tables in the database. 147

148 Where Clause You can use the Where clause to identify the row or rows that are to be deleted from the table, or a question mark to enter the clause in a report. Enter all to delete all rows from the table. 148

149 Null Symbol You can use the Null symbol to specify which null value symbol you want to use in the table column. The default symbol is the asterisk. 149

150 Changing Data Using Update Use the Update command to change data in relational tables. You can perform updates using the following methods: Change data in a temporary report containing columns and data lines. This method of changing data only works for tables that have primary keys or unique indexes. Enter column names and new values on the Update command menu to perform a global update of rows in the table. To change data in a temporary report 1. Select Update from the RDI menu, or use the fast-access method to display the Update command menu. This menu lets you specify the table and columns to be updated, new data values, and a Where clause to identify the rows to be changed. 2. Fill in the following fields on the Update command menu: Table Name Where Clause Column Names Null Symbol New Values Note: If you enter an actual value in the "New Value" field, then you do not need to follow steps 4, 5, and 6. However, if you enter a question mark as a value, then you need to follow all of these steps. 3. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to display a result that contains the data. 4. Modify the data in the result as needed. 5. Press Enter to save the changes. 6. Press Resume F1 to insert the changes. 150

151 Table Name You can use Table name to name a table to be updated, or enter a question mark to display a list of available tables. 151

152 Column Names You can use Column names to enter names to be changed, or enter a question mark to display a list of available columns. 152

153 New Values You can use New values to enter data values corresponding to the column names specified in the previous field, or enter a question mark to display selected rows in a result. 153

154 Where Clause You can use the Where clause to identify rows in the table for updating, or enter a question mark to display a report in which to enter a Where clause that is larger than the Where clause field provided on this menu. 154

155 Null Symbol You can use the Null symbol to specify which null value symbol you want to use in the table column. The default symbol is the asterisk. 155

156 Defining New Tables Using Create Use the Create command to define new tables in the database. You can create new tables using the following methods: Freeform method Report method Note: There are some differences in creating tables for various relational databases. To display online Help for specific relational database information, type rdi,help,database and press NumEnter. To use the Create command 1. Select Create from the RDI menu, or use the fast-access method to display the Create command menu. This menu lets you generate a report in which column names and other information required to create the table are entered, or to identify a report containing the information. 2. Fill in the following fields on the Create command menu: Table Name Storage Space Create from Report and Drawer Freeform Create Insert Data Lines Increase Integer Fields Null Symbol Extra Options 3. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to accept data on the Create command menu and create the new table. 156

157 Table Name You can use Table name to identify the new table. The name must differ from names given to existing tables and must be a legal table name for the database in use. 157

158 Storage Space You can use Storage space to name a storage space or table space. Some relational databases require this field; others use a default value. 158

159 Create from Report and Drawer You can use Create from report and drawer to identify the report to be used to create the table. Use the RRRRDCCCC format. 159

160 Freeform Create You can use Freeform create to display a report in which column names, data types, and other information are entered. To do this, enter a Y in this field. If you set this field to Y, RDI ignores the next three fields. 160

161 Insert Data Lines You can use Insert data lines to insert the data lines in the report, identified in the previous field, as rows in the new table. To do this, enter a Y in this field. 161

162 Increase Integer Fields You can use Increase integer fields to increase the size of integer-type columns by one or two over the number of positions assigned to the field in the report. To do this, enter a Y in this field. 162

163 Null Symbol You can use the Null symbol to specify which null value symbol you want to use in the table column. The default symbol is the asterisk. 163

164 Extra Options You can use Extra options to specify optional information specific to the database in use for creating the table by entering a Y in this field. 164

165 Submitting SQL with the SQL Command Use the SQL command to submit SQL syntax directly to the database. SQL syntax that you create while using any RDI command can also be saved in a report and executed at any time with this command. To use the SQL command Notes: 1. Select SQL from the RDI menu, or use the fast-access method to display the SQL command menu. 2. Fill in the following fields on the SQL command menu: Report SQL Request Process Request Immediately 3. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to display a blank report to enter syntax. 4. If you identify a report or SQL request name on the SQL command menu, RDI displays a result containing the syntax, unless you set Process request immediately to Y (which processes the syntax immediately). If you specify that the result containing your syntax is to be displayed, you can update the displayed result before processing. 5. Press Resume (F1) to execute the SQL syntax. 6. Press SQLmnu to return to the SQL command menu, or press Quit (F10) to return to the RDI menu. If you enter a Select statement, the data is retrieved and displayed in a report. When a report contains a Select statement, it cannot contain other SQL statements. If the report contains an SQL statement other than Select, RDI displays a report that either indicates the completion of the operation or displays an error message. A report that does not contain a Select statement can include more than one statement. The statements are executed in the order in which they appear in the report. You must terminate each statement with a semicolon. 165

166 Report Enter the number of the report containing the SQL syntax. Leave this field blank for freeform entry. 166

167 SQL Request Enter a request name identifying the SQL syntax or a question mark to select from a list of request names. Leave this field blank for freeform entry. Saving SQL Syntax in a Report describes how to save this SQL syntax. 167

168 Process Request Immediately Change the value of this field to Y to execute the statement immediately after pressing NumEnter, instead of first displaying the syntax. 168

169 Accessing the RDI Utilities Menu Use the RDI Utilities menu to perform the following tasks: Change the definition of existing tables. Restrict access to tables. Delete tables from the database. Create and destroy relational views. Commands available from this utility include ALTER, RESTRICT, DESTROY, CVIEW, and DVIEW. To use the RDI Utilities menu 1. Select Utilities menu from the RDI menu, or use the fast-access method to display the Utilities menu. 2. From the Utilities menu, you can make these selections: Using Alter Table Using Restrict Table Using Destroy Table Using Create View Using Drop View 169

170 Using Alter Table Use Alter Table to change the definition of existing tables. To use the Alter Table utility 1. Select Alter Table from the Utilities menu, or use the fast-access method and enter rdi,alter. 2. Enter a valid table name or a question mark to display a list of available tables. 3. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to display the Alter Table Options menu. 4. From the Alter Table Options menu, select an option by placing the cursor beside your selection and pressing NumEnter. Change Columns Add Columns Drop Columns Add Index Drop Index Add Foreign Key Drop Foreign Key 170

171 Change Columns You can use Change columns to alter the data type and column size and modify the null flag. 171

172 Add Columns You can use Add columns to add new columns to existing tables in the database. 172

173 Drop Columns You can use Drop columns to remove columns from an existing table. 173

174 Add Index You can use Add index to create up to five indexes on a table. Each index can use any column in the table, in ascending or descending order. 174

175 Drop Index You can use Drop index to drop indexes from the table definition. 175

176 Add Foreign Key You can use Add foreign key to define a foreign key for an existing table. 176

177 Drop Foreign Key You can use Drop foreign key to remove a foreign key definition from an existing table. 177

178 Using Restrict Table Use Restrict Table to control which user-ids can access information in relational tables. To use the Restrict Table utility 1. Select Restrict table from the Utilities menu, or use the fast-access method and enter rdi,restrict. This menu lets you control access to tables and views in the database. This utility enables the owner of a table to grant, revoke, and restore access to tables and views by user-id and RDI command. 2. Fill in the following fields on the Restrict table menu: Grant Users Access to a Table Restrict an Existing Table Revoke Access from a Restricted Table Unrestrict a Restricted Table 3. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to return to the RDI menu. 178

179 Grant Users Access to a Table You can use Grant users access to a table to grant access to a table by user-id and SQL command. 179

180 Revoke Access from a Restricted Table You can use Revoke access from a restricted table to revoke access to a table by user-id and SQL command. 180

181 Restrict an Existing Table You can use Restrict an existing table to establish ownership of a table for your user-id and enable data access checking. This option is not available for Oracle, INFORMIX, Sybase, or MS SQL Server data managers. 181

182 Unrestrict a Restricted Table You can use Unrestrict a restricted table to remove data access checking previously entered for a table. This option is not available for Oracle, INFORMIX, Sybase, or MS SQL Server data managers. 182

183 Using Destroy Table Use Destroy Table to eliminate the table definition and all information in the table. To use the Destroy Table utility 1. Select Destroy Table utility from the Utilities menu, or use the fast-access method and enter rdi,destroy. This menu lets you permanently remove the table definition and any data rows in the table. 2. Enter a valid table name in Table name on the Destroy table menu. The Destroy Table utility deletes all data rows and removes the table definition from the database. 3. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to continue. After RDI locates the table, RDI displays the table and asks for confirmation before deleting the table. Note: Because RDI lets you decide whether to destroy a table, pressing NumEnter does not destroy a table immediately; RDI prompts you to verify your decision to destroy a table. 183

184 Using Create View Use Create View to create a temporary view of a table or several tables. To use the Create View utility 1. Select Create view from the Utilities menu, or use the fast-access method and enter rdi,cview. This menu lets you specify table and column names for the view. You can also enter an optional Where clause. 2. Fill in the following fields on the Create view menu: NewViewName Table Names Column Names Where Clause Test All Rows If No, Enter Maximum Quantity Extra Options 3. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to select column names and rows for the view, or to display the Create View options menu. 184

185 New View Name You can use New view name to name the new view. The name must not be identical to any other table or view name in the database. 185

186 Table Names You can use Table names to name the table or tables used to define the view. Separate table names with a comma. Enter a question mark in this field to display a list of available tables. 186

187 Column Names You can use Column names to name the column or columns for the view. Enter a question mark to display a list of available column names. 187

188 Where Clause You can use the Where clause to enter the condition or conditions to be evaluated for data in the table. Enter a question mark to display a report on which to enter the Where clause. 188

189 Test All Rows You can use Test all rows to review all rows in the view after it has been created. Change the default value to N and enter a quantity in the next field to retrieve only a specified number of rows. 189

190 If No, Enter Maximum Quantity You can use If no, enter maximum quantity to enter the maximum number of rows to be included in the view. 190

191 Extra Options You can use Extra Options to display the Create View options menu by entering a Y in this field. 191

192 Using Create View Options Using Create View options allows you to group data in the view, as well as eliminate data from the result. You can do this by supplying information and specifying view options. To use the Create View options menu 1. From the Create View menu, enter Y and press NumEnter. 2. The Create View options menu appears. Use this menu to specify a Group by clause and eliminate duplicate data from the result. Supply the following information on the Create View options menu: Group By Would You Like Checking with Inserts and Updates? Would You Like Distinct Columns? Should Access Control Be Turned On? 3. Move your cursor to Place cursor here and press NumEnter. Press NumEnter to create the view. 192

193 Group By You can use Group by to enter a column name for grouping of data rows. You can use the reserved word Having to state conditions to be evaluated for each group. 193

194 Would You Like Distinct Columns? You can use Would you like distinct columns? to eliminate duplicate rows in the result. 194

195 Would You Like Checking with Inserts and Updates? You can use Would you like checking with inserts and updates? to restrict inserts or updates of the view to rows that can be retrieved with the view. 195

196 Should Access Control Be Turned On? You can use Should access control be turned on? to restrict a view. Enter N if you want all users to access a view. (This option is valid only for Relational Database Server databases; other relational databases automatically restrict access to views.) 196

197 UsingDropView Use Drop View to eliminate a table view from the database. To use the Drop View utility 1. Select Drop view from the Utilities menu, or use the fast-access method and enter rdi,dview. This menu lets you remove existing views from the database. 2. Enter the name of the view to be removed, or place a question mark in this field to display a list of available views. 3. Move your cursor to Place cursor here and press NumEnter. Press NumEnter. 197

198 Using MRI Statements to Access Relational Data You can use MRI to access and modify relational databases through scripts. To do this, you create scripts that include MRI statements. This topic describes some of the ways you can use MRI statements to update and access relational databases. It discusses the following: Creating Tables Inserting Data into a Relational Table Updating Data with FCH and RAM Deleting Data with FCH and RAM Using the Where Clause with RAM Dropping Tables with RAM Retrieving Data into Script Variables with SQL Executing Stored Procedure with SPI Troubleshooting 198

199 Creating Tables You can use the RAM and SQL statements to create tables in a relational database. Note: The RAM statement does not support the CREATE option for access through the Open Database Connectivity (ODBC) interface. You must use the SQL statement to create tables through the ODBC interface. 199

200 Creating a Table with RAM To create an empty table, use the RAM statement with the C option. The RAM statement in the following example specifies a table name and identifies a report that contains column names and information lines. agency 'houses,storage.area' <error>a6. Explanation 0,a,599 c,,,, y,,, agency houses storage.area <error>a6 Report Create the table from the field headings and information lines in report 599A. Create a table. Commas to account for fields not used in this statement. Create an error report if necessary. Commas to account for fields not used in this statement. Specify the database name. Create a table named houses in the database. Specify the schema and storage area for the table (required only for Relational Database Server). Load <error> with the status of the action performed. The following report identified in the statement contains the information required to create the table. For more information, see the Command Reference. 200

201 Line> 1 Roll> - 599A.DATE 29 JUN 98 13:01:10 RID 599A 20 JUN 98 *HOUS... *E_NO.LOCATION.PRICE.HOUSES_DESCRIPTION *====.===============.=====.===================== *c c d c *p *... END REPORT

202 Creating a Table and Inserting Data with RAM You can use a single RAM statement to create a table and insert the data lines contained in the report as rows in the new table. The following RAM statement identifies a report containing the information lines required to create the table and data lines. After it creates the table, the statement inserts the data lines from the report into the table. agency 'customers,storage.area' <error>a6. Explanation 0,a, b,,,, y,,, agency customers storage.area <error>a6 Report Create the table from the field headings and information lines in report 308A and insert the data from report 308A. Go to label 99 in case of an error. Create a table and insert data. Commas to account for fields not used in this statement. Create an error report if necessary. Commas to account for fields not used in this statement. Specify the database name. Create a table named customers in the database. Specify the schema and storage area for the table (required only for Relational Database Server). Load <error> with the status of the action performed. The following is a portion of the report identified in the statement that contains the column names, information lines, and data: 202

203 Line> 1 Roll> - 308A.DATE 20 JUN 98 10:06:52 RID 308A 20 JUN 98 *CUST... *_NO.CNAME.PRICE.LOCATION_DESIRED *====.============.=======.================ *C C D C *P * C101 Thompson 150 Edina C103 King 50 Harper's Ferry C104 Owen 90 Roseville C105 Zisler 70 Edina C106 Mortag 100 Fridley C108 Smith 120 Minneapolis 203

204 Creating a Table with SQL You can use the SQL statement to submit a create table command. Include the SQL syntax in the statement or store it in a report. The statement in the example identifies a report containing SQL syntax for creating the locations table. '',0,a,350 <error>a6, <column>a6. Explanation 099,y,0,a,, agency '' 0,a,350 <error>a6 <column>a6 Report Go to label 99 in case of an error, create a -0 result containing error information, and place it in cabinet 0, drawer A. Commas to account for subfields not used in the statement. Specify the database name. Field to contain the SQL syntax. Since the statement identifies a report, the syntax is omitted. Identify the report containing the SQL syntax. Load <error> with the status of the action performed. Load <column> with the column number where an error occurred. The following is the report identified in the statement that contains the SQL. (The following create table statement is valid only for an Relational Database Server database.) CREATE TABLE locations IN storage.area COLUMNS ARE LOCATION_DESIRED: CHAR(16) NOT NULL PRIMARY KEY K1 IS LOCATION_DESIRED ASC OWNER IS NEWUSER 204

205 Inserting Data into a Relational Table You can use the RAM and SQL statements to insert data into a relational table. Use the RAM statement when multiple rows contained in a report are to be added to a relational table. You may use the SQL statement to insert data solicited from application programs. 205

206 Inserting Data from a Report Use the RAM statement to insert the data lines in a report as rows in a relational table. The following statement identifies a report containing data rows that are to be inserted in the houses table: 'houses' <error>a6. Explanation 0,a,262 Use the field headings and information lines in report 262A for the Insert operation. 099 Go to label 99 in case of an error. i Insert data into a table.,,,, Commas to account for fields not used in this statement. y Create an error report if necessary.,,, Commas to account for fields not used in this statement. agency Specify the database name. houses Insert data into the table named houses. <error>a6 Load <error> with the status of the action performed. Report The report identified in the statement contains field headings matching the column names in the table and data lines. 206

207 Using RAM in Conjunction with FCH You can also use the RAM statement in conjunction with the FCH statement to build a report containing data and insert the data into the table. The FCH statement in the following example retrieves column names from the houses table and displays them as headings in a report. 'a * houses'. You can save the result created by the FCH statement as a report and enter data in it as shown here. You can then use the RAM statement to insert the data into the database. Report Here is the report Line> 1 Roll> - 412A.DATE 28 MAR 98 12:19:50 RID 412A 28 MAR 98 *HOUS... *E_NO.LOCATION.PRICE.HOUSES_DESCRIPTION *====.===============.=====.================== H999 Andover 165 Lakeside 3sn Porch... END REPORT... The following RAM statement returns this data to the houses 'houses'. 207

208 Inserting Data with SQL You can use the SQL statement to insert data entered on an input screen into a relational table. In the following example, variables capture input using INVAR$. Then, at label 10, the SQL statement passes data from those variables to the houses chg invar$ <inputa>a4,<inputb>a15,<inputc>i5,\ <inputd>s25. MENU REQUESTING INPUT FOR HOUSES Capture House_No = <inputa> Location = <inputb> Price = <inputc> House_Description = <inputd> '',,rdms,rdms 'insert into houses \ values('<tic><inputa><tic>','<tic><inputb><tic>',' 208

209 Retrieving Data with FCH You can use the FCH statement to retrieve data from one or more relational tables and place the data in a result. The examples in this section demonstrate how to use the FCH statement to retrieve data from a single table or join two or more tables. 209

210 Retrieving Data from a Single Table You can retrieve data from a single table with the FCH statement. The statement in the following example retrieves all columns and rows from the houses table. 'c * houses'. Explanation 0,a 099 l,,,, y a,,,,,,, agency 'c * houses' Hold the result in cabinet 0, drawer A. Go to label 99 in case of an error. Retrieve data and left-justify decimal fields. Commas to account for fields not used in this statement. Create an error report if necessary. Truncate the record and place the remainder on trailer lines if the record is longer than the report width (wrap option A). Commas to account for fields not used in this statement. Specify the database name. Specify the cursor, column, and table name for the retrieval operation. The asterisk indicates all columns are to be included in the result. 210

211 Joining Tables with FCH A powerful and distinctive feature of relational database management systems and SQL is the ability to join data in two or more tables. Use a Where clause in Join operations to compare one or more common data elements in the tables that are to be joined. Use the FCH statement to perform a Join operation and retrieve data into a temporary report. You can include the syntax in the statement or store it in a report. Example The following FCH statement accesses a report containing the SQL statement for joining the houses and customers tables. The syntax portion of the statement contains only a cursor name (C). The remaining syntax resides in the 'c',0,a,262. Report The following report contains the SQL syntax for the Join operation: Line> 1 Roll> - 262A.DATE 11:23:13 RID 262A 29 MAR 98.================================================= SELECT CNAME,HOUSE_NO,LOCATION,T1.PRICE,HOUSES_DESCRIPTION FROM MRI.HOUSES T1,MRI.CUSTOMERS T2 WHERE location = location_desired and T2.price between T1.price*0.8 and T1.price*1.2 ORDER BY cname;... END REPORT

212 Updating Data with FCH and RAM You can use the FCH and RAM statements to retrieve data from a relational table into a temporary report, change the data in the temporary report, and then return the data to the table. The following example prompts you for a table name. The FCH statement then retrieves the table and places it in a temporary report. After you make changes to the table and press Resume (F1), the RAM statement returns the data to the relational chg invar$ <table>h10. Menu asking for tablename = <table> Updates to result will be inserted into '',,rdms,rdms 'c * '<table> -1 dsp,-1,,,,,,'result OF FETCH. F-1 TO <table> 212

213 Using FCH for Data Retrieval You can pass data from a relational table into a temporary report with the FCH statement. The statement in the following example retrieves data from the table contained in the variable [table] and places it in a -0 temporary report. agency 'c1 * '<table> <error>a6. Explanation 0,a 099,,,, y,,,,,,, agency c1 * <table> <error>a6 Place the result in cabinet 0, drawer A. Go to label 99 in case of an error. Commas to account for fields not used in the statement. Create an error result if necessary. Commas to account for fields not used in the statement. Specify the database name. Specify the cursor and column name for the retrieval operation. The asterisk (*) indicates all columns are to be included in the result. Specify the table name, captured from the input screen. Load <error> with the status of the action performed. 213

214 Inserting Updated Data with RAM After the script retrieves the data and displays it in a result, you can make changes to nonprimary key columns. The statement in the following example returns the updated data to the table. <table> <error>a6. Explanation u,,,, y,,, agency <table> <error>a6 Specify the location of the updated data (-1 renamed result). Go to label 99 in case of an error. Update all columns other than primary keys using data in the report. The statement matches data lines in the report and rows in the table by primary key. Commas to account for fields not used in the statement. Create an error result if necessary. Commas to account for fields not used in the statement. Specify the database name. Specify the table name. Load <error> with the status of the action performed. 214

215 Deleting Data with FCH and RAM You can use the RAM statement to delete the rows in a table. The example does the following: The script prompts the user for a table name and Where clause. The FCH statement extracts the data meeting the condition specified in the Where clause and displays it in a result. The RAM statement then deletes the rows from the chg invar$ <table>h10,<clause>s50. Menu asking for tablename = <table> and Where clause = <clause> Explain that these lines will be deleted from table. '',,rdms,rdms 'c1 * '<table>' '\ <clause> <error>a6 rnm OF FETCH. F-1 TO <table> agency 'c1 * OF FETCH. F-1 TO CONTINUE.'. 215

216 Retrieving Data with FCH The following statement includes a table name and Where clause for retrieving data and displaying it in a result. 'c1 * '<table>' '\ <clause> <error>a6. Explanation 0,a 099,,,, y,,,,,,, agency c1 * <table> <clause> <error>a6 Place the result in cabinet 0, drawer A. Go to label 99 in case of an error. Commas to account for fields not used in the statement. Create an error result if necessary. Commas to account for fields not used in the statement. Specify the database name. Specify the cursor name and column name for the retrieval operation. The asterisk (*) indicates all columns are to be included in the result. Specify the table name. Specify the Where clause. Load <error> with the status of the action performed. 216

217 Deleting Data with RAM After the script retrieves the data and displays it in a result, the RAM statement in the following example deletes the data rows from the table. <table> <error>a6. Explanation r,,,, y,,, agency <table> <error>a6 Specify the location of the updated data (-1 renamed result). Go to label 99 in case of an error. Remove all rows retrieved by the FCH statement from the table. The statement matches data lines in the report and rows in the table by primary key. Commas to account for fields not used in the statement. Create an error result if necessary. Commas to account for fields not used in the statement. Specify the database name. Specify the table name. Load <error> with the status of the action performed. 217

218 Using the Where Clause with RAM When using the E option with the RAM statement, you can include a Where clause to indicate rows to be deleted. The following statement deletes rows from the specified table that meet the condition stated in the clause: agency 'houses, where price = 150' <error>a6. Explanation,,,, e,,,, y,,, agency houses where... <error>a6 Commas to account for the c,d,r,lab subfields. When you use the E option with a Where clause, these subfields can be blank. Delete rows in the table that meet the condition statement in the Where clause. Commas to account for fields not used in the statement. Create an error result if necessary. Commas to account for fields not used in the statement. Specify the database name. Delete rows from a table named houses. Specify the conditions for deletion. Load <error> with the status of the action performed. 218

219 Dropping Tables with RAM To remove the table definition from the database and delete rows in the table, use the D option with the RAM statement. The statement in the following example deletes the locations table from the database. 'locations' <error>a6. Explanation,,,, Commas to account for the c,d,r,lab subfields. When you use the D option, these subfields can be blank. d Drop the table definition and remove all rows from the database.,,,, Commas to account for fields not used in the statement. y Create an error result if necessary.,,, Commas to account for fields not used in the statement. agency Specify the database name. 'locations' Drop the table named locations from the database. <error>a6 Load <error> with the status of the action performed. 219

220 Retrieving Data into Script Variables with SQL You can use an SQL statement to retrieve data into Business Information Server on the variables, grouped either singly or in pairs. The statement returns an error code on an End of Select. This is considered a normal completion. Each Fetch statement that follows the Select statement retrieves one row of data. If you do not want the SQL statement to return an error label on an End of Select, place 6001 in the CSTAT field of the SQL statement as shown in the following example. In the Fetch statement, the first variable holds the first column of data. If there is a second variable in a group, it contains the NULL indicator for that column. The second variable can have the following values: 0 If the value for the first variable is not NULL and fits into the space provided. >0 If the value for the first variable was truncated. The value is the actual size in bytes needed to hold the value for the first variable without truncation. -1 If the value for the first variable is NULL. Example Following is an example of retrieving data using the SQL 'select house no,location,price from houses;' 'fetch next into :1 :2, :3 :4, :5, :6;' \ <error> NE 0 If <error> NE 6001, (90). Explanation :1 is the value for the first column. :2 is the NULL indicator for the first column. :3 is the value for the second column. :4 is the NULL indicator for the second column. :5 is the value for the third column. :6 is the value for the fourth column. v1-v6 are the values of :1 through :6. Notes: The values :1 :2 :3 are fine for most database managers. The Relational Database Server data manager requires a $P1 $P2...$Px format, as described in Retrieving Data from Relational Database Server Using the SQL Statement. For more detailed examples of singleton selects, see the Command Reference. 220

221 Executing Stored Procedures with SPI Windows Server Windows Client The Stored Procedures Interface (SPI) command has two primary modes of operation. First, it provides the ability to execute a specified stored procedure and return results. Second, it provides a method to query and return meta-data about stored procedures in a database catalog. The SPI command supports the following operations: Executing a single stored procedure. Retrieving a list of stored procedures for a specified database. Retrieving a list of columns with their definitions for a specified stored procedure. Retrieving a list of parameters with their definitions for a specified stored procedure. Note: Some database providers do not return column and parameter information for all stored procedures. Refer to the following examples to see SPI usage and results: Example 1: Executing a stored procedure with one input parameter and one row set returned. Example 2: Retrieving definition information about the stored procedure. Example 3: Using multiple parameters, including an output parameter. Note: For ODBC and OLEDB databases only. Windows Server Windows Client 221

222 Executing a Stored Procedure Example 1 Windows Server Windows Client The following is an example of executing a stored procedure with one input parameter and one row set returned. In this example, the stored procedure, CustOrderHist, found in the Northwind database on an SQL Server is used, it has one input parameter called CustomerID, and the procedure syntax is: PROCEDURE nchar(5) AS SELECT ProductName, Total=SUM(Quantity) FROM Products P, [Order Details] OD, Orders O, Customers C WHERE C.CustomerID AND C.CustomerID = O.CustomerID AND O.OrderID = OD.OrderID AND OD.ProductID = P.ProductID GROUP BY ProductName The procedure returns the following results: Running dbo."custorderhist" = OCEAN ). ProductName Total Chef Anton's Gumbo Mix 20 Konbu 5 Lakkalikööri 10 Mozzarella di Giovanni 5 Original Frankfurter grüne Soße 15 Queso Cabrales 30 Raclette Courdavault 2 Sir Rodney's Marmalade 15 Sir Rodney's Scones 12 Tofu 12 Uncle Bob's Organic Dried Pears 6 No more results. (11 row(s) returned) RETURN_VALUE = 0 The following Business Information Server script code shows how this procedure is executed and the results returned:.spi Sample Code Freeform Reports ldv,p <uid>s20='sa',<psw>s20=''. Setup ldv,p <db>s20='northwind'. ldv,p <par1>s5='ocean'. CustomerID (input ldv,p lgn,,y,0,a,<db> '',,<uid>,<psw>. Logon to the spi,0,i,020,<db>,y,e <spn> <par1> i. Execute lgf,,,<db>. log off the dsp,

223 The following data is in the results report: Note: The title line includes the procedure name.. Results of Procedure: {call custorderhist(?)} *ProductName.Total *========================================.============ Chef Anton's Gumbo Mix 20 Konbu 5 Lakkalikööri 10 Mozzarella di Giovanni 5 Original Frankfurter grüne Soße 15 Queso Cabrales 30 Raclette Courdavault 2 Sir Rodney's Marmalade 15 Sir Rodney's Scones 12 Tofu 12 Uncle Bob's Organic Dried Pears 6 Windows Server Windows Client 223

224 Executing a Stored Procedure Example 2 Windows Server Windows Client The following is an example of retrieving definition information about the stored procedure. In this example, the S, C, and P options are used to retrieve information about the stored procedures in the Northwind database. The list of stored procedures is retrieved first, and then the column and parameter information is retrieved for the Sales By Year procedure..spi Sample Code Freeform Reports ldv,p <uid>s20='sa',<psw>s20=''. Setup ldv,p <db>s20='northwind'. ldv,p <spname>s40= [Sales By Year]. Name of lgn,020,y,0,a,<db> '',,<uid>,<psw>. Logon to spi,0,i,0020,<db>,y,s. Get list of dsp,-0. Display list spi,0,i,0020,<db>,y,c <spname>. Get column info for this dsp,-0. spi,0,i,0020,<db>,y,p <spname>. Get parameter info for this dsp,-0. lgf,,,<db>. log off the database The results of the commands are shown below.. Procedure List for Database: northwind *Type.SP Name *====.=========================================================================== =======... FN CUSTORDERHIST;1 FN CUSTORDERSDETAIL;1 FN CUSTORDERSORDERS;1 FN DT_ADDTOSOURCECONTROL;1.... Column Description for Procedure: [Sales By Year] *Column Name.Type.Size.DecPt.NF.Length.Precision *=============================.================.=======.=====.=====.==========.== ======== ShippedDate DBTIMESTAMP 23 3 True OrderID I4 11 False 4 10 Subtotal CY 21 True 8 19 Year WSTR 30 True 30. Parameter Description for Procedure: [Sales By Year] 224

225 *Parameter Name.Type.Size.DecPt.NF.PType.Length.Precision *========================.================.=======.=====.=====.=====.==========.= ======== RETURN_VALUE I4 11 False RV DBTIMESTAMP 0 True DBTIMESTAMP 0 True IN Explanations of the fields are as follows: The column sizes for the metadata are fixed sizes. It is possible that databases return information that exceeds these column sizes. However, this is not likely to occur, except for possibly the Name fields. In these cases, an error message is returned if the truncation option is not set. Many of the fields (Type, NF, and PType) are converted from their numeric form to an alpha form. The definition of the size field is the maximum length of any character-based data or the precision of numeric data. Precision is defined as the maximum number of digits required to hold a number. It does not include punctuation marks. The user of this information must allow space for any punctuation marks returned in the data. The data types represent the data type of the provider and not the data type of the underlying database. Note: Providing metadata for stored procedures is dependent on the ability of the provider to return the data. While the SPI command may try multiple methods to retrieve the data, if the data cannot be retrieved, an error may result. For example, a complex stored procedure with multiple select statements may not be able to determine the columns in the returning row set. Executing the SPI command with the C action would result in an error, because the column information could not be determined. Windows Server Windows Client 225

226 Executing a Stored Procedure Example 3 Windows Server Windows Client The following is an example of using multiple parameters, including an output parameter. In this example, the SalesByCategory stored procedure (see the Northwind data base for this example), which passes two input parameters and one output parameter (the return value), is executed. The following Business Information Server script shows how this procedure is called and the parameters that are passed:.spi Sample Code Freeform Reports ldv,p <uid>s20='sa',<psw>s20=''. Setup ldv,p <db>s20='northwind'. ldv,p <cat>s8='seafood'. Category (input ldv,p <yr>s4='1998'. Year (input ldv,p <rv>i6=0. Return ldv,p lgn,030,y,0,a,<db> '',,<uid>,<psw>. Logon to the spi,0,i,030,<db>,y,e <spn> <rv>,<cat>,<yr> r,i,i. Execute if <rv> eq 0 gto Check the return value Return Value is dsp,-0. lgf,,,<db>. log off the database The results are as follows:. Results of Procedure: {?=call [salesbycategory](?,?)} *ProductName.TotalPurchase *========================================.======================================= = Boston Crab Meat 5318 Carnarvon Tigers 8497 Escargots de Bourgogne 2427 Gravad lax 1456 Ikura 9002 Inlagd Sill 3938 Jack's New England Clam Chowder 2916 Konbu 3725 Nord-Ost Matjeshering 4744 Röd Kaviar 226

227 180 Rogede sild 891 Spegesild 1817 Return Value is 0 Windows Server Windows Client 227

228 Troubleshooting The following interface error may occur: Interface error detected Syntax follows: (Error detected during logon) Error message follows: <An error has occurred in MRI. Contact coordinator> If you receive this error, ensure that the Business Information Server is properly configured to access the database and that the database server is running. If this message persists, check the Business Information Server/Internet Commerce Enabler sites directory to determine if an mri trace file exists. The file will appear in the following format mri_mm_dd, where mm=month and dd=day the file was created. The trace file may indicate the symptoms of the problem, but does not always indicate why a problem is occurring. 228

229 Guidelines for Accessing Information Through Database Managers An advantage of MRI is its ability to create scripts that access a number of database managers on different hardware platforms. Each of these database managers has slightly different MRI statement requirements as well as other data access considerations. This topic discusses how to create scripts that access the following database managers through MRI: MRI Interface to ODBC Database Managers Oracle Interface Considerations Relational Database Server Interface INFORMIX Interface Sybase Interface 229

230 MRI Interface to ODBC Database Managers When creating Business Information Server for Windows applications, you can use MRI to access relational and nonrelational databases through the Open Database Connectivity (ODBC) interface. The ODBC interface is a comprehensive standard for data access in heterogeneous client/server database environments. It serves as an open, vendor-neutral programming interface. You can, for example, access a FoxPro or an SQLServer database through ODBC using MRI statements from the same script. In the Business Information Server, you can create scripts that access multiple database managers through the ODBC interface provided with Windows without needing detailed knowledge of those database managers. The ODBC interface works with the underlying database manager to access and update the relational databases. MRI currently uses only those features and capabilities that are defined for a CORE conformance-level ODBC database. Topics discussed include Modifying a Relational Database Creating Tables with ODBC Accessing Lists of User Tables, Views, and System Tables Retrieving Columns of Data with ODBC Using the Where Clause in ODBC Altering Tables with ODBC Using Database Data Types with ODBC Understanding Case Sensitivity in ODBC Making Data Commits and Recovery in ODBC Adjusting Decimal Fields in ODBC Retrieving Data with the SQL Statement in ODBC Understanding Database Access and Security in ODBC Interpreting ODBC Error Status 230

231 Modifying a Relational Database Utilize RAM or SQL statements to Insert, Update, or Delete records from an ODBC Database. Your statements must supply any information for specific underlying databases such as data types, primary keys, and null flags. In addition, some operations through the ODBC interface require information specific to the underlying database manager. For example, the Create Table command requires that you use the underlying data types recognized by the underlying database manager. You cannot use the more generic ODBC data names. Refer to the underlying database documentation such as Oracle, Sybase, or FoxPro. does not support Delete and Update for Text and Excel Databases. 231

232 Creating Tables with ODBC Your applications must use the SQL statement with 'CREATE TABLE...' syntax to create relational tables. Table names must start with a letter and can contain only letters (a-z, A-Z) and digits (0-9). Rules for table name qualification depend on the underlying database. Note: You must have access to the underlying database documentation if you want to create or alter tables. 232

233 Accessing Lists of User Tables, Views, and System Tables To retrieve a list of user tables, views, or system tables in a particular database to the database 2. execute one of the following SELECT statements Statement Description SELECT*FROM ODBC$API$SQLTABLES SELECT VIEW FROM ODBC$API$SQLTABLES SELECT TABLE FROM ODBC$APISQLTABLES SELECT SYSTEM TABLE FROM ODBC$API$SQLTABLES Retrieves a list of every type of table that exists on the database. Retrieves a list of views that exist on the database. Retrieves a list of user tables that exist on the database. Retrieves a list of system tables that exist on the database. MRI recognizes the keyword ODBC$API$SQLTABLES and submits the ODBC API call SQLTables() to the datasource with the column name equal to the table type to be retrieved. 233

234 Retrieving Columns of Data with ODBC You can retrieve up to 255 columns of data from the ODBC databases with the FCH statement. The SQL statement retrieves a maximum of 38 columns. 234

235 Using the Where Clause in ODBC Consult the specific database documentation for a complete list of operators supported by that database. 235

236 Altering Tables with ODBC Use the SQL statement with "ALTER TABLE..." syntax. Refer to the ODBC and database documentation for supported forms of the syntax. Note: You must have access to the underlying database documentation if you want to create or alter tables. 236

237 Using Database Data Types with ODBC ODBC can return the following data types when your script asks for a table description: CHAR NUMERIC DECIMAL INTEGER SMALLINT FLOAT REAL DOUBLE DATE TIME TIMESTAMP VARCHAR LONGVARCHAR BINARY VARBINARY LONGVARBINARY BIGINT TINYINT BIT INT_YEAR INT_MONTH INT_YR_TO_MON INT_DAY INT_HOUR INT_MINUTE INT_SECOND INT_DAY_TO_HR INT_DAY_TO_MIN INT_DAY_TO_SEC INT_HR_TO_MIN INT_HR_TO_SEC INT_MIN_TO_SEC UNICODE These data types may map to different data types in the underlying database. Refer to your underlying database documentation (Oracle, Sybase, FoxPro, and so on) to determine what data types are applicable for creating and altering tables. Note: You must have access to the underlying database documentation if you want to create or alter tables. 237

238 Understanding Case Sensitivity in ODBC Case sensitivity for table names and column names depends on the underlying database. Some databases, for example, Oracle or FoxPro, accept table and column names in either uppercase or lowercase and treat these names the same. In contrast, some databases, for example, SQLServer, require the correct case sensitivity to reference table names and column names. (In this case, MRI.HOUSES is not the same as mri.houses.) 238

239 Making Data Commits and Recovery in ODBC Database recovery is a function of the underlying database manager. Whether operations that modify the database can be undone or rolled back depends on the database manager. The LGF statement issues a SQL_ROLLBACK if you set the rb subfield to Y (yes); otherwise, the statement issues a SQL_COMMIT. What a given database manager does when it receives ROLLBACK or COMMIT syntax with a SQL statement depends on the database manager. Refer to the documentation for the particular database manager for further details pertaining to committing, rolling back, and recovering data. 239

240 Adjusting Decimal Fields in ODBC Use the FCH statement adj subfield to increase the column width in a temporary report. If the value of the subfield is I or B, the width of numeric fields without a fractional part in the column description increases by one character. If the value of the subfield is F or B, the width of numeric fields with a fractional part in the column description increases by one character. ODBC data managers treat the following data types as numeric: NUMERIC DECIMAL INTEGERSMALLINT FLOAT REAL DOUBLE BIGINT TINYINT BIT 240

241 Retrieving Data with the SQL Statement in ODBC When you use the SQL statement to retrieve data from an ODBC database, assign variables :a, :b, and so on. After sending a Select statement using SQL, you can retrieve data with the following 'fetch into :a :b, :c;' v1a6,v2i5,v3i6,v4i5,v5s30. where :a Contains the value for the first column. :b Contains the null indicator for the first column. This is optional. :c Contains the value for the second column. v3,v4,v5 Are variables to which results of the Fetch variables :a, :b, and :c are returned. 241

242 Understanding Database Access and Security in ODBC MRI passes the user-id and password supplied on the LGN statement to ODBC and then on to the database manager. How the database manager uses the user-id and password depends on the specific database manager. 242

243 Interpreting ODBC Error Status The ODBC interface does not return a numeric error status upon detecting an error. Instead, the interface returns a character string mnemonic status. For some of the errors, the underlying database also returns to ODBC a nonzero error status, known as a native error, which can be examined internally by MRI. Here is how ODBC passes a numeric error status to MRI: 1. Certain ODBC mnemonic errors (SQLSTATE) map to unique numeric values. These are all in the range of -1 to -99, as described in the following table. 2. If the error was not one of the identified SQLSTATE errors listed here, and the native error value is nonzero, ODBC passes the native error back to the local database system. These errors are generally greater than 100 or less than Error numbers depend on the underlying database. 3. If the error was not one of the mapped SQLSTATE errors and the native error was 0, ODBC returns an internal error value that depends on the type of action. These errors are in the range of +10 to +69. The errors indicate that ODBC detected an error, which was not one of the common (mapped) SQLSTATE errors and the underlying database returned a native error value of 0. Refer to the error display text for an explanation of the error. In all cases, MRI inserts the actual SQLSTATE value and error message text into any local or remote system error result. System Status SQLSTATE Value Description -1 S0001 Base table or view already exists (actual returned text may be different). -2 S0002 Base table not found. -3 S0011 Index already exists. -4 S0012 Index not found. -5 S0021 Column already exists. -6 S0022 Column not found. -7 S0023 No default for column. -8 S1002 Column number invalid. -9 S1003 Program type out of range. -10 S1004 SQL data type out of range. -11 S1008 Operation canceled. -12 S1009 Argument value invalid. -13 S1010 Function sequence error. -97 function not supported. -98 ** Cannot obtain ODBC ENV handle. -99 S1C00 Driver not capable *** End of data, End of file, Data not found. Legend *There is no SQLSTATE value for this error since it is detected without calling an ODBC routine. **There is no SQLSTATE value for this error since it is detected when attempting to connect to ODBC. ***This is not necessarily an error. It is used to indicate the end of data and is examined internally by MRI and the relational functions. It can also be used within an SQL statement 'fetch...' loop to detect when the end of data has been reached. 243

244 Oracle Interface Considerations Oracle is a relational database management system that runs on several kinds of hardware. This topic discusses the following: Creating and Changing Tables with Oracle Using the Where Clause in Oracle Creating Data Definitions in Oracle Making Data Commits and Recovery in Oracle Adjusting Decimal Fields in Oracle Using SQL*Net with Oracle UsingOraclewiththeRAMStatement Retrieving Data from Oracle Using the SQL Statement Understanding Database Access and Security in Oracle Using Extra Options for Oracle 244

245 Creating and Changing Tables with Oracle When creating tables with Oracle, begin table names with a letter. Table names can contain alphabetic characters, numbers, and underscore characters ( _ ). The table name can include a maximum of 30 characters. Table names are qualified by user-id. You can retrieve up to 255 columns of data from the Oracle database with the FCH statement. The SQL statement retrieves only 38 columns. Oracle allows the following RDI script Alter Table commands: Add a column Columns of any valid data type can be added to a table. If the table does not contain rows, then the column can be specified as NOT NULL; otherwise, the column must allow null values. Change a column Oracle lets you change a column type, a column size, and the null specification. There are three restrictions for changing columns: You can change the column type only if all values in a column are NULL. You can decrease the column size only if all values in the column are NULL. You can change the null specification from NULL to NOT NULL only if the column does not contain NULL values. Add an index Index names in Oracle must be unique and can include up to 30 characters. Each name must begin with a letter and can consist of alphabetic characters, numbers, and underscore characters ( _ ). Oracle automatically issues a COMMIT command after the index is created. Drop an index Deletes an index. 245

246 Using the Where Clause in Oracle See topics for information about additional operators and functions you can use in Where clauses with Oracle. These topics include Additional Operators Additional Functions 246

247 Additional Operators Here is a partial list of additional operators you can use in Where clauses with Oracle. Consult your Oracle documentation for a complete list of operators. ll Use concatenation. (+) Make the preceding column the outer join column. IN or ANY Search a set of items in a list. The list can be searched as in the following statement: Select * from houses where price in (10,50,100). Or the list can be a subquery: Select location from houses where price in (select price from houses where location = 'Edina'). NOT IN Opposite of IN. ALL Compareavaluetoeveryvalueinalist. EXISTS Set to TRUE if the result of a subquery is at least one row. UNION Combine two queries (similar to ADON and ADTO commands). INTERSECT Result contains all rows that are in both queries. MINUS Result contains all rows that are in the first query but not in the second. 247

248 Additional Functions Here is a partial list of additional functions you can use in Where clauses with Oracle. Consult Oracle documentation for a complete list of functions. ABS(n) Specifies an absolute value. CEIL(n) Specifies the smallest integer greater than or equal to n. FLOOR(n) Specifies the largest integer equal to or less than n. ROUND(n[,m]) Specifies n rounded to m decimal places. LENGTH(c) Specifies the length of characters specified by c. LOWER(c) Specifies that c is forced to lowercase. SOUNDEX(c) Specifies the character value representing the sound of the words in c. SUBSTR(c,m[,n]) Specifies the substring of c, beginning at character m, for n characters. UPPER(c) Specifies that c is forced to uppercase. STDDEV(x) Specifies that standard deviation is used, and null values are ignored. VARIANCE(x) Specifies that variance is used, and null values are ignored. 248

249 Creating Data Definitions in Oracle When your script issues a RAM statement to create a table in the Oracle database, the report contains three information lines. These lines contain the data required to create the table in the Oracle database, column names, data formats, primary keys, and null value indicators. MRI supports the following Oracle data types: Type Code Size CHAR(n) C Defined by user DATE DT Defined by system DECIMAL(sz[,dec]) D Defined by user FLOAT F, R, P Defined by system INTEGER I Defined by system LONG L, N Defined by system NUMBER B Defined by system SMALLINT S Defined by system VARCHAR2(n) V, VT Defined by user You can use the FCH statement to fetch long raw and long text. Related Topic For information on using RAM to create tables, see the Command Reference. 249

250 Making Data Commits and Recovery in Oracle The Oracle database determines recovery points. Data updates in Oracle are considered temporary until a transaction is complete. Oracle then commits the changes to its database. If a transaction is not completed, changes are not committed and the database is restored to its last recovery point condition. You can use the COMMIT and ROLLBACK commands in the following MRI statements: LGF statement If rb = Y, the database is restored to its last commit condition. SQL statement Place the COMMIT or ROLLBACK command in the syntax portion. RAM statement If o = J, a COMMIT command is issued to the database and all changes become permanent. If cqty has a value specified for it, a recovery point is defined each time the specified number of rows are inserted or updated. 250

251 Adjusting Decimal Fields in Oracle Use the FCH statement adj subfield to increase the column width in a temporary report. If you set this subfield value to I, F, orb, the width of the field increases by two characters. The decimal point and size are not included in the column width. 251

252 Using SQL*Net with Oracle Use SQL*Net to access an Oracle database on a system that does not have Business Information Server software and MRI. Consult your Oracle administrator or administrator manuals to set-up SQL*Net to access the Oracle database. Note: SQL*Net refers to Net Manager as well as all prior versions of SQL*Net. 252

253 UsingOraclewiththeRAMStatement Consider the following points when using RAM statements to update or create Oracle tables: The RAM statement does not support the RAW data type. Use the Storage Area table option in the RAM statement to specify a table space name. If no table space is identified, the default table space name is used. Use the Additional Create clause when creating a table or when adding more information about data access to a table. Use this clause in the RAM statement table options for including additional syntax for the PCTFREE and Create Cluster statements. If you do not use the C or B operation options, the Additional Create clause is ignored. 253

254 Retrieving Data from Oracle Using the SQL Statement When using a SQL statement to retrieve data from the Oracle database, assign variables :a, :b, and so on. After sending a Select statement using SQL, you can retrieve data with the following 'fetch next into :a :b, :c;' v1a6,\ v2i5,v3i6,v4i5,v5s30. where: :a Contains the value for the first column. :b Contains the NULL indicator for the first column. v3,v4,v5 Are variables to which results of the Fetch variables :a, :b, and :c are returned. 254

255 Understanding Database Access and Security in Oracle Consider the following points in understanding database access and security: Use the user and pw subfields in the LGN statement to specify the authorization-id and password for users accessing Oracle. Oracle returns a system message to the user who does not have authority to use the database. Authorization-ids with database administrator authority cannot use the FCH, DDI, and RAM statements. 255

256 Using Extra Options for Oracle The Extra Options menu contains three fields, summarized here. Consult your Oracle documentation for additional information. PCTFREE Specifies the percentage of space to keep free for updates. CLUSTER NAME Identifies a cluster name. CLUSTER COLS Identifies cluster columns. 256

257 Relational Database Server Interface Relational Database Server is a relational database management system that runs on the OS 2200 system. The Business Information Server to Relational Database Server interface supports access to the Relational Database Server databases on both local and remote systems. This topic discusses the following: Creating Data Definitions in Relational Database Server Making Data Commits and Recovery in Relational Database Server Adjusting Decimal Fields in Relational Database Server Using Relational Database Server with the RAM Statement Retrieving Data from Relational Database Server Using the SQL Statement Creating and Changing Tables with Relational Database Server Understanding Database Access and Security in Relational Database Server 257

258 Creating Data Definitions in Relational Database Server Use the RAM statement to create a table in the Relational Database Server database based on a report. The report should contain three information lines. These lines contain the data required to create the table in the Relational Database Server database. The lines contain column names, data formats, primary keys, and null value indicators. The numeric data type defaults to decimal if it is not user defined. If the float data type is an internal float, then the data type is the same as using double precision. MRI supports the following Relational Database Server data types. Type Code Size CHARACTER(n) C Defined by user DECIMAL(sz[,dec]) D Defined by user DOUBLE PRECISION P Defined by system FLOAT F Defined by system INTEGER I Defined by system LONG CHAR(n) L Defined by user NUMERIC(sz[,dec]) B Defined by user REAL R Defined by system SMALLINT S Defined by system Related Topic For information on using RAM to create tables, see the Command Reference. 258

259 Making Data Commits and Recovery in Relational Database Server When the script starts a thread in update mode with the LGN statement, Relational Database Server tracks changes made to tables or data in the database. The database is not permanently changed until Relational Database Server issues a COMMIT command when the LGF statement terminates the thread. If you set the rollback (rb) subfield in the LGF statement to Y, Relational Database Server issues a ROLLBACK command when the LGF script terminates the thread. This command discards any changes to the database since the last COMMIT command. If you do not issue any COMMIT commands while using RAM or SQL statements during the session, the Relational Database Server ROLLBACK command discards all changes to the database made during the session and terminates the thread. If one or more COMMIT commands are issued during a session, the ROLLBACK command discards any changes since the last COMMIT command and terminates the thread. 259

260 Adjusting Decimal Fields in Relational Database Server Use the FCH statement adj subfield to increase the column width in a temporary report. If the value of this subfield is set to I, F, or B, the width of the field increases by one character. The decimal point and size are not included in the column width. Also use the RAM statement adj subfield to increase column width, which is defined in the RAM Create Table command. Decimal- and numeric-type columns, in which the data size is derived from the headings, are affected by this subfield. Decimal and numeric fields that have a user-defined size are not affected by this subfield. 260

261 Using Relational Database Server with the RAM Statement The Storage Area table option in the RAM statement option must contain the name of the schema and storage area in the format schema.storage when operation options B or C are used. Use the Additional Create clause in the RAM statement table options to include additional syntax when creating a table or adding more information about data access to a table. You can use this clause when you are creating a foreign key, secondary index clause, or a data access control clause. 261

262 Retrieving Data from Relational Database Server UsingtheSQLStatement When you use the SQL statement to retrieve data from the Relational Database Server database, assign variables $p1, $p2, and so on. After sending a Select statement using SQL, you can retrieve data with the following 'fetch next into $p1 $p2,$p3' v1a6,\ v2i5,v3i6,v4i5,v5s30. where: $p1 Contains the value for the first column. $p2 Contains the NULL indicator for the first column. $p3 Contains the value for the second column. v3,v4,v5 Are variables to which results of the Fetch variables $p1, $p2, and $p3 are returned. 262

263 Creating and Changing Tables with Relational Database Server On the RDI Create menu input screen, the following fields apply to Relational Database Server: Table Name The qualifier and table name can be up to 30 characters. If you omit the qualifier, the default qualifier is used. Storage Space The name of the storage area definition associated with the table must be entered in this field. Data Types A data type must be entered. Extra Options Menu Fields on the Relational Database Server Extra Options menu enable you to establish ownership of a table and extend access privileges to other users. Table Ownership Enter Y in this field to own a table. Tables are accessed only by your user-id unless you extend privileges to other users. Data Access Enter Y in this field to activate data access checking on a table. Users are prevented from accessing a table unless you grant access privileges. You can retrieve up to 126 columns of data from the Relational Database Server database with the FCH statement. The SQL statement retrieves only 38 columns. You can use all options on the RDI script Alter commands menu with Relational Database Server. 263

264 Understanding Database Access and Security in Relational Database Server Relational Database Server makes special use of the option (o), lang, and user subfields in the LGN statement. These are briefly described in the paragraphs that follow. The LGN statement issues a BEGIN THREAD command to the database. The o subfield in the LGN statement specifies a thread type for the session. Valid thread types are Read, Retrieve, and Update. Use the Read or Retrieve options when no updates to the database are to be performed during the session. These options enable the DDI, FCH, or SQL statements to perform data retrieval operations. Related Topics Password Security Recovery Options Security 264

265 Password Security The password (pw) field in the LGN statement is not used for Relational Database Server. The default thread type is Read. You must, however, use apostrophes (') if the lang and id fields in the LGN statement are blank, as ''. You can use a space to indicate the default option when the subsequent fields contain values, as 265

266 Recovery Options Security You must use the Update thread type in the o subfield when using the RAM or SQL statements to create tables or perform updates in tables. You must specify a recovery option with the Update thread type. Use the following format for this option: UPDATE(recovery-option) where recovery-option is one of the following: Deferred Quicklooks Commandlooks None Use the user subfield to identify an alternate user-id for data access checking. If the field is left blank, the Business Information Server user-id is assumed. This field is valid only if the Business Information Server LGNUID configuration parameter is set to 1. If this parameter is not set to 1, values in this subfield are ignored. 266

267 INFORMIX Interface INFORMIX is a relational database management system that runs on several kinds of hardware systems. You can access INFORMIX through MRI. Note: To utilize databases through MPC, the INFORMIXSERVER environment variable must be set on the system running the ws_ethd daemon prior to the daemon being started. This topic discusses the following: Creating and Changing Tables with INFORMIX Using the Where Clause in INFORMIX Creating Data Definitions in INFORMIX Making Data Commits and Recovery in INFORMIX Adjusting Decimal Fields in INFORMIX Retrieving Data from INFORMIX Using the SQL Statement Understanding Database Access and Security in INFORMIX 267

268 Creating and Changing Tables with INFORMIX Table names in INFORMIX must begin with a letter. Table names can contain alphabetic characters, numbers, and underscore characters ( _ ). The table name can contain a maximum of 18 characters. The first 10 characters must be unique. Table names are qualified by user-id. You can retrieve up to 255 columns of data from the INFORMIX database with the FCH statement. The SQL statement retrieves only 38 columns. INFORMIX enables you to use the following RDI script Alter Table commands: Add a column You can add serial columns when the table is empty. All new columns are NULL. Columns of any valid data type can be added to a table. Change a column INFORMIX lets you change Data type of a column Column from NOT NULL to NULL Column from NULL to NOT NULL if the column does not contain NULL values Add an index Index names in INFORMIX must be unique and can contain up to 18 characters. Each name must begin with a letter and can consist of alphabetic characters, numbers, and underscore characters ( _ ). INFORMIX automatically issues a COMMIT command after it creates an index. Dropacolumn Drop an index 268

269 Using the Where Clause in INFORMIX See the following topics for information about additional operators and functions you can use in Where clauses with INFORMIX: Additional Operators Additional Functions 269

270 Additional Operators Here is a partial list of additional operators you can use in Where clauses with INFORMIX. Consult INFORMIX documentation for a complete list of operators. IN or ANY Specifies a set of items to be searched in a list. The list can be searched as in the following statement: select * from houses where price in (10,50,100) Or the list can be a subquery: select location from houses where price in (select price from houses where location = 'Edina') NOT IN Specifies the opposite of IN. ALL Compares a value to every value in a list. EXISTS Set to TRUE if the result of a subquery is at least one row. UNION Combines two queries (similar to the commands ADON and ADTO). SOME Same as IN. 270

271 Additional Functions Here is a partial list of additional functions you can use in Where clauses with INFORMIX. Consult INFORMIX documentation for a complete list of functions. DATE (date) Converts an expression to a date. DAY (date) Returns the day of the month. MONTH (date) Returns the numeric month. YEAR (date) Returns the integer year. 271

272 Creating Data Definitions in INFORMIX When the script issues a RAM statement to create a table in the INFORMIX database, the report contains three information lines. These lines contain data formats, primary keys, and null value indicators. MRI supports the following INFORMIX data types. Type Code Size CHAR(n) C Defined by user DATE DT Defined by system DECIMAL(s,d) D Defined by user FLOAT F Defined by system INTEGER I Defined by system MONEY(s,d) M Defined by user; default = 16,2 SERIAL SN Defined by system SMALLINT S Defined by system You can use the FCH statement to retrieve text and byte INFORMIX data types. Related Topic For information on using RAM to create tables, see the Command Reference. 272

273 Making Data Commits and Recovery in INFORMIX You can modify database recovery options after executing the Start Database command. Begin Work Statement During logon, the INFORMIX handler issues a Begin Work statement. This statement causes all subsequent SQL commands designed to alter the database to be handled as a single unit of work. These commands are not a part of the database until you send a Commit Work statement. On completion of a COMMIT or ROLLBACK command, the Begin Work operation is ended. This causes all subsequent commands designed to alter the database to be applied immediately to the database, not when the next COMMIT command is issued. This sequence of events causes a transparent Begin Work statement to be issued by the INFORMIX handler whenever the COMMIT or ROLLBACK commands have finished processing. If you create a database without transactions, all changes to a database are applied when they are processed, not when a COMMIT command is issued. This means that changes to the database cannot be reversed using the ROLLBACK command. A transaction operation includes the Begin Work, Commit, and Rollback commands. The RAM statement ignores the return status and sets it to zero if all the following conditions exist: Your database was created without transactions. You entered a COMMIT or ROLLBACK command with the RAM statement. A -256 error message was returned. If your database was created without transactions, and you enter a COMMIT or ROLLBACK command with the SQL statement, you receive a -256 error. This error means that the system cannot perform the transaction operations on the database because a transaction log was never created. Statements You can use the COMMIT and ROLLBACK commands in the following statements: LGF statement If rb = Y, the database is restored to its last commit condition. SQL statement Place the COMMIT or ROLLBACK command in the syntax portion. RAM statement If o = J, a COMMIT command is issued to the database and all changes become permanent. If cqty has a value specified for it, a recovery point is defined each time the specified number of rows are inserted or updated. 273

274 Adjusting Decimal Fields in INFORMIX Consider the following points when adjusting decimal fields in INFORMIX: Use the FCH statement adj subfield to increase the column width in a temporary report. If you set the value of this subfield to I, F, or B, the field width increases by two characters. The decimal point and size are not included in the column width. The RAM subfield adj also increases column width. You define this subfield in the RAM Create Table command. Decimal-type columns, in which the data format is user defined, are not affected by this subfield. 274

275 Retrieving Data from INFORMIX Using the SQL Statement When you use the SQL statement to retrieve data from the INFORMIX database, assign variables :a, :b, and so on. After sending a Select statement using SQL, you can retrieve data with the following 'fetch next into :a :b, :c;' v1a6,\ v2i5,v3i6,v4i5,v5s30. where: :a Contains the value for the first column. :b Contains the NULL indicator for the first column. :c Contains the value for the second column. v1 Status of the statement. v2 Erring column number. v3,v4,v5 Are variables to which results of the Fetch variables :a, :b, and :c are returned. 275

276 Understanding Database Access and Security in INFORMIX Use the UNIX ID to access INFORMIX. If you do not specify a user-id in the LGN statement, the default user-id is the UNIX ID used for starting the remote system. 276

277 Sybase Interface Sybase is a relational database management system that runs on several kinds of hardware. You can access Sybase through MRI. Note: To utilize databases through MPC, the Sybase environment variable must be set on the system running the ws_ethd daemon prior to the daemon being started. This topic discusses the following: Creating and Changing Tables with Sybase Using the Where Clause in Sybase Creating Data Definitions in Sybase Making Data Commits and Recovery in Sybase Using Sybase with the RAM Statement Retrieving Data from Sybase Using the SQL Statement Adjusting Decimal Fields in Sybase Using the Case-Sensitive Feature with Sybase Understanding Database Access and Security in Sybase 277

278 Creating and Changing Tables with Sybase Table names in Sybase must begin with a letter, the pound sign (#), or an underscore ( _ ) character. A table name beginning with # means that the table is temporary. The remaining characters of the table name can include letters, numbers, dollar sign ($), pound sign (#), and underscore ( _ ) characters. Spaces and SQL reserved words are not valid. The table name can contain a maximum of 30 characters. You can retrieve up to 255 columns of data from the Sybase database with any MRI statement. The exception is the SQL statement, which retrieves only 38 columns. Sybase lets you add a column and add an index with the following RDI script Alter Table commands: Add a column You can add columns of any valid data type to a table, except for columns whose data type is bit data. Create an index Index names in Sybase must be unique and can contain up to 30 characters. Index names in Sybase must begin with a letter or the pound sign (#) or underscore ( _ ) characters. The remaining characters of the index name can include letters, numbers, and dollar sign ($), pound sign (#), and underscore ( _ ) characters. Spaces and SQL reserved words are not valid. You cannot create an index for columns whose data type is bit data. 278

279 Using the Where Clause in Sybase See the following topics for information about additional operators and functions you can use in Where clauses with Sybase: Additional Operators Additional Functions 279

280 Additional Operators Here is a partial list of additional operators you can use in Where clauses with Sybase. Consult Sybase documentation for a complete list of operators. IN or ANY Specifies a set of items to be searched in a list. The list can be searched as in the following statement: select * from houses where price in (10,50,100) or the list can be a subquery: select location from houses where price in (select price from houses where location = 'Edina') NOT IN Specifies the opposite of IN. ALL Compares a value to every value in a list. EXISTS Set to TRUE if the result of a subquery is at least one row. UNION Combines two queries (similar to commands ADON and ADTO). SOME Same as IN. 280

281 Additional Functions Here is a partial list of additional functions you can use in Where clauses with Sybase. Consult Sybase documentation for a complete list of functions. ABS(n) Specifies an absolute value. CEILING(n) Specifies the smallest integer greater than or equal to n. FLOOR(n) Specifies the largest integer equal to or less than n. ROUND(n[,m]) Specifies n rounded to m decimal places. DATA LENGTH(c) Specifies the length of characters specified by c. LOWER(c) Specifies that c is forced to lowercase. SOUNDEX(c) Specifies the character value representing the sound of the words in c. SUBSTRING(c,m[,n]) Specifies the substring of c, beginning at character m, for n characters. UPPER(c) Specifies that c is forced to uppercase. 281

282 Creating Data Definitions in Sybase When your script creates a table in the Sybase database with a RAM statement, the report contains three information lines. These lines contain data formats, primary keys, and null value indicators. MRI supports the following Sybase data types: Type Code Size BIT B Defined by system CHAR C Defined by user DATETIME DT Defined by system FLOAT F Defined by system INTEGER I Defined by system MONEY M Defined by system SMALLINT S Defined by system TEXT TX Defined by system TINYINTEGER TI Defined by system TIMESTAMP TS Defined by system VARCHAR V Defined by user Related Topic For information on using the RAM statement to create tables, see the Command Reference. 282

283 Making Data Commits and Recovery in Sybase Use the Begin Trans statement in the SQL statement to process a series of SQL statements when changing the database. Any statements that follow the Begin Trans statement are not permanently issued to the database until a Commit Trans statement is issued. When the Commit Trans statement is issued, the database stops handling transactions. You must issue another Begin Trans statement to start another transaction. When the system processes transactions, you cannot change tables with RDI script commands such as Create, Create View, Destroy, and Drop View. See Using Sybase with the RAM Statement for more information about handling database transactions. You can use the COMMIT and ROLLBACK commands in the following statements: LGF statement If rb = Y, the database is restored to its last commit condition. SQL statement Place the COMMIT or ROLLBACK command in the syntax portion. RAM statement If o = J, Sybase issues a COMMIT command to the database, and all changes become permanent. If cqty has a value specified for it, a recovery point is defined each time the specified number of rows are inserted or updated. 283

284 Using Sybase with the RAM Statement Consider the following points when using RAM statements to update or create Sybase tables: The information provided under Making Data Commits and Recovery in Sybase introduces you to how the database processes the Begin Trans and Commit Trans statements. The following information describes how the database handler corrects errors while updating tables. If you are updating a table using the RAM statement and an error occurs because another transaction is being processed, the database handler does the following: o o o Issues a Commit Trans statement. This updates all changes made to the database. At that point, you can no longer make transactions to the database. Issues another Begin Trans statement to start processing your RAM statement again. The system makes all changes specified in the RAM statement. However, no changes are made until all RDI script commands, such as Insert, Update, or Delete, are processed. After the Commit Trans statement is executed, the remote system starts the RAM statement transaction by issuing the Begin Trans statement. When using the RAM statement to update a table or delete information from a table, you must assign a primary key to the table. The RAM statement creates a clustered unique index to build the Where clause used for updating or deleting information from the table. The timestamp value specified in a RAM statement logs the time and date during which a transaction was processed. When a RAM statement updates a table, the timestamp value matches the timestamp value set in the database. If the values do not match, a message is returned to you indicating that another user updated the table while you were updating the table. When the Timestamp values match, the table is updated and the Timestamp values record the time and date during which the table was updated. Notes: If you process a RAM statement with transaction handling turned off, any changes to a database are made immediately. If a Commit Trans statement is issued in a RAM statement and the database handler detects an error because a Begin Trans statement was not previously issued, Sybase displays a message indicating this situation. 284

285 Retrieving Data from Sybase Using the SQL Statement When you use the SQL statement to retrieve data from the Sybase database, assign variables :a, :b, and so on. After sending a Select statement using SQL, you can retrieve data with the following 'fetch next into :a :b, :c;' v1a6,\ v2i5, v3i6,v4i5,v5s30. where: :a Contains the value for the first column. :b Contains the NULL indicator for the first column. :c Contains a value for the second column. v1 Status of the statement. v2 Erring column number. v3,v4,v5 Are variables to which results of the Fetch variables :a, :b, and :c are returned. 285

286 Adjusting Decimal Fields in Sybase Since Sybase has no fixed-size number, the adj subfield does not apply. 286

287 Using the Case-Sensitive Feature with Sybase You can turn the case-sensitive feature on or off during Sybase installation. Unisys generally recommends that you turn the case-sensitive feature off. Some users, however, require it for security reasons. When you turn the case-sensitive feature on, all data retrieved from the database must be specified in the exact case format used when it was entered into the database. Example 1 If you named a file My File and sent it to the database, you must retrieve the file as My File, not MY FILE or my file, or any other variation of the file name. Object names, such as table and view names, must also conform to the same casesensitive standards. When you turn the case-sensitive feature off, you can send and retrieve data without regard to case sensitivity. Example 2 If you named a file MY FILE and sent it to the database, you can retrieve the file as My File, or my file, or any other variation of the file name. The same is true for object names, such as table and view names. 287

288 Understanding Database Access and Security in Sybase Users access Sybase by entering their server user-id and password in the LGN statement. A user must be given authority to use the database by the database owner. 288

289 MRI and Relational Database Networking The MRI software supports several networking products provided by third-party relational databases. This topic explains the networking tasks that can be performed through those databases, and details the changes (if any) that must be made to the network configuration report. Networking Options with Relational Databases Networking with ODBC Networking with Oracle Networking with INFORMIX Network Configuration Report Networking with Sybase 289

290 Networking Options with Relational Databases The MRI software supports several networking products provided by the following third-party relational databases: INFORMIX Oracle Sybase ODBC MRI supports the following networking products: SQL*Net; networking product of Oracle Any network access supplied by the ODBC driver Some of the networking products just listed support communications with distributed databases. However, when you use the distributed database access feature, many processing capabilities allowed for nondistributed database access are restricted. Refer to the manuals of the specific database to determine which restrictions apply. In general, MRI/Business Information Server networking can be used for all of your networking needs. However, if your hardware or software configuration does not support MRI/ Business Information Server networking, you can consider accessing relational data with the third-party relational database networking products. Related Topics Networking with Oracle Networking with ODBC Networking with INFORMIX Networking with Sybase 290

291 Networking with Oracle The Oracle product, SQL*Net, lets you perform the following two types of networking tasks: Communicating with a Single Remote Database Communicating with Distributed Databases Once you establish a connection to a remote database, MRI sends all SQL statements to the remote database for processing. When Oracle communicates to distributed databases, you can access tables from several databases residing on different systems with a single SQL statement. When you communicate with distributed databases, you are restricted to fewer SQL statement functions. See the appropriate Oracle manuals for more information on using SQL statements for distributed database communications. 291

292 Communicating with a Single Remote Database When accessing a single remote database using SQL*Net, you add an at (@) sign to the password in the Log On to Relational Database (LGN) statement. For example, with SQL*NET Version 2, the syntax for the Oracle sign-on entered in the DBMS RDI menu and the Log On (LGN) statement uses the following syntax: password@service name In this case, service name is your tnsnames.ora file. 292

293 Communicating with Distributed Databases When accessing distributed databases for querying tables, you add a database link (@dblink) to the table name in a From clause or a For clause in an SQL statement. For example: select * from emp@dblink; This example selects all columns from the table named emp that resides on the database specified by dblink. Dblink must be predefined in Oracle. The dblink definition in Oracle for this example is T:chicago:Demo The T specifies that you are using the TCP/IP network driver. The network name of the remote host is chicago. The SID of the Oracle database on the remote host is Demo. You can use the syntax with MRI by specifying the dblink (@database_link) with the table name. 293

294 Network Configuration Report Generally, you can use the Oracle SQL*Net product without modifying the network configuration report. However, the following two situations require you to change it: 2200 If you are accessing a database that does not have standard Oracle system tables, you must modify the network configuration report. This situation occurs when the remote database is not an Oracle database, such as when you are accessing the Relational Database Server 2200 database or any database other than Oracle with the Oracle SQL*Connect product. If MRI cannot determine the host system on which the specified table exists, it cannot access the correct Oracle system tables. This situation occurs when the remote table name that you are specifying is already a synonym on a remote system other than the one you are attempting to access. In this case, you must change the network configuration report, described later in this topic, for accessing a database without standard Oracle system tables. Note: On a 2200 Business Information Server, the network configuration report is located in drawer 1C Windows Server Windows Client UNIX OS Note: On all other Business Information Servers, the network configuration report is located in drawer 1C2. Windows Server Windows Client UNIX OS Changing the Network Configuration Report When changing the network configuration report for accessing a database without standard Oracle system tables, you must specify the reserved word Net followed by a space before the Oracle home name. This enables access to your database tables without using the Oracle system tables. Using the reserved word Net has the following restrictions: The following dictionary information is not returned by the Relational Aggregate Fetch (FCH) and the Data Definition Information (DDI) statements: Table name Primary key Nulls allowed Decimal size Column types specified for numbers use only the Oracle default size rather than the user-defined size. 294

295 Networking with ODBC MRI accesses ODBC databases through a data source name that you configure in the Windows system. Any networking provided by the ODBC driver is transparent to MRI. Refer to your ODBC and ODBC driver documentation for information about configuring an ODBC driver for network access. 295

296 Networking with OLEDB MRI accesses OLEDB databases through a data source name that you configure in the Windows system. Any networking provided by the OLEDB driver is transparent to MRI. Refer to your OLEDB and OLEDB driver documentation for information about configuring an OLEDB driver for network access. 296

297 Networking with INFORMIX You can use the INFORMIX products, INFORMIX-NET and INFORMIX-STAR, to work with the INFORMIX relational database across a network. A client system processes the relational database tools while the server system processes the relational database application. INFORMIX-NET provides connectivity to the INFORMIX-SE relational database. INFORMIX-STAR provides connectivity to the INFORMIX Online relational database. INFORMIX-STAR also provides distributed database capabilities, such as querying or joining information from several INFORMIX Online database servers. You can do this with a single SQL statement. 297

298 INFORMIX-NET INFORMIX-NET enables you to add a prefix to the database name that is the same name as the host on which the database resides. For example, the following local database name specified as /usr/informix/stores can be changed to //chicago/usr/informix/stores to access the database located on the path named /usr/informix/stores on the remote system named chicago. INFORMIX interprets the double slants (//) to mean that the first field is the network name of the system where the remote database resides. To use INFORMIX-NET with MRI, place the remote database name in the Additional Network Information field of the Network Configuration report. This is the same field used for the local INFORMIX-SE database name, which is also accessed with MRI. The difference is that the host name is specified before the database name. 298

299 INFORMIX-STAR INFORMIX-STAR enables you to specify a database name in two ways. You can specify the local database name with the following prefix or suffix format: Prefix //hostname For example, the following local database name specified as stores can be changed to //chicago/stores or stores@chicago INFORMIX interprets the double slants (//) and at (@) sign to mean that the following field is the network name of the system on which the database resides. To use INFORMIX-STAR with MRI, place the remote database name in the Additional Network Information field of the Network Configuration report. This is the same field used for the local INFORMIX Online database name, which is also accessed with MRI. The difference is that the host name is specified before the database name when using double slants (//) or specified after the database name when the at (@) sign is specified. INFORMIX-STAR also enables you to specify tables that reside on different hosts in an SQL statement. The host on which a table resides is specified using the following format: dbname@hostname:tableowner.tablename For example: select who, num from stores@chicago:contacts The Select statement retrieves the who and num fields from the table named contacts that resides on the database named stores. The database is located on the system whose network name is chicago. With INFORMIX, tables appear as if they are all coming from a single database. INFORMIX-STAR enables you to query INFORMIX tables on distributed databases only. You cannot use the other SQL statements that are normally allowed for non-distributed database networks. See the appropriate INFORMIX manuals for more information on using SQL statements for distributed database communication. 299

300 Networking with Sybase The Sybase database supports remote database access by using specified servers. Each Sybase server is given a unique name. To specify a server on which a Sybase database resides, add the server name (@servername) to the database name. For example, specify pubs to cause Sybase to search for the local database named pubs. Use the following syntax to specify a server that is located in a remote host named chicago that has the database named pubs residing on it: pubs@chicago The syntax instructs Sybase to use the server named chicago to access the database named pubs. The server named chicago can be either local or remote, depending on how the database administrator defined the server. The server named chicago searches the information on its host for a database named pubs. To specify a Sybase server using MRI, place the database name and server name (databasename@servername) in the Additional Network Information field of the Network Configuration report. 300

301 MRI Configuration Parameter Files The following topics describe the MRI configuration parameter files and list the parameters in these files. Initially, you set the configuration files and parameter values through MRIDBA. Although it is more convenient to modify parameter values with MRIDBA as described in Setting Up a Local or Remote Parameter File, you can edit both the remote and local configuration parameter files using these topics as a reference: Configuration Parameter Descriptions Setting Up the MRI Parameter File Setting Up the MRI Configuration File 301

302 Configuration Parameter Descriptions The following table describes the MRI configuration parameters and lists their default values: Parameter Default Value Description ASIAN N Used for character manipulation. N = non ASIAN mode JAPAN = Japan mode KOREA = Korea mode TAIWAN = Taiwan mode CHINA = China mode DEFDB <blank> The default database for MRI access. If you configure a default database for MRI, it must also be registered with the MRIDBA script. MAXDM 10 Maximum number of active MRI database names. MAXTHRD 50 The maximum number of active MRI users system-wide. This value should equal or exceed the maximum active users per database parameter. It is not recommended that this number exceed 200, as doing so could cut into system resources, which may lead to undesired results. DEFTC 10 The maximum number of active MRI users allowed per database name. UNIX OS Windows Client Windows Server LOCSTRT Y Local access enabled. Determines whether local site users can access MRI. Y = local access allowed; N = local access denied. REMSTRT Y Remote access enabled. Determines whether a remote site can access MRI. Y = remote access allowed; N = remote access denied. ORASID <blank> (Optional) Oracle database system identifier (SID). Only required when not specified in Network Configuration report 1C2. 302

303 ORAHOM <blank> (Optional) Full UNIX operating system path name to the directory where Oracle is installed. Only required when not specified in Network Configuration report 1C2. IMXHOM <blank> (Optional) Full UNIX operating system path name to the directory where INFORMIX is installed. Only required when not specified in Network Configuration report 1C2. IMXDLL <blank> (Optional) Full UNIX operating system path name to the directory where INFORMIX is installed. Only required when not specified in Network Configuration report 1C2. SHMADR <blank> Shared memory address. UNIX OS Windows Client Windows Server Windows Server ODBCPOOL 0 Sets the maximum number of database connections to keep open. (Applies to pooled MRIMs only.) ODBCLEAK 0 Sets the maximum number of disconnects before the pooled MRIM process restarts itself to eliminate any memory leaks caused by the ODBC drivers. Windows Server 303

304 Setting Up the MRI Parameter File The MRIDBA Business Information Server script configures the mrimparm file. The file name for both local and remote parameters is mrimparm. Notes: The local parameter file is located in the Business Information Server site sub directory. The remote parameter file is located in the Business Information Server sub directory as follows: UNIX OS /< Business Information Server Installation>/mri_remote UNIX OS Windows Client Windows Server \<site directory>\mri_rem Windows Client Windows Server 2200 sys$lib$*mri.mrim/parameters

305 Setting Up the MRI Configuration File The remote configuration file contains a list of databases that remote systems can access. To access these databases, a remote system must have a configuration file set up with the database names. The database name that the remote database uses must match a name in the remote configuration file. Notes: The configuration file is built from the network configuration report and is configured by the MRIDBA script. See Setting Up a Local or Remote Parameter File Any change to the mrimcfg file requires stopping and restarting the mrim process The configuration files are as follows: 2200 sys$lib$*mri.mrim/config 2200 Windows Client Windows Server bissites\mri_rem\mrimcfg Windows Client Windows Server UNIX OS maproot/mri_remote/mrimcfg UNIX OS 305

306 Configuring Database Access Connection Pooling The following topics describe database access connection pooling through MRIM and describes how to configure these connections using MapAdmin and MRIDBA: Database Access Connection Pooling Overview Configuring and Viewing an MRIM Pool Process Setting Up a Local Parameter Configuration File Configuration Example 306

307 Database Access Connection Pooling Overview The MRI process pooling feature enables you to specify a pool of MRIM processes (mrim.exe) that wait for a connection from the local Business Information Server site. One of the available MRIM processes in the pool logs onto the database when Business Information Server connects to it and logs off when the Business Information Server disconnects. The MRIM process pooling is available only for Business Information Server sites on the local machine. Requests from remote Business Information Server sites continue to use MRI to MRI networking (that is, mapethd starts a standard MRIM process). Pooling MRIM processes improves the performance of scripts, or services that access ODBC or other relational database management systems through MRI. If you are accessing an ODBC database through a pooled MRIM, you can configure the MRIM to keep a specified number of ODBC connections open for reuse by subsequent Business Information Server services. It eliminates the overhead required to create and load a Windows process. You can configure MRIM so all Business Information Server requests from a given site go through a pool of MRIM processes and wait if a pooled MRIM is currently unavailable. This may be best in a highly used system because starting a standard MRIM uses system resources to start the MRIM. Waiting for a pooled MRIM process to become available doesn't increase the load on the system; the Windows system can actually perform more work. To configure a pool of MRIM processes, do the following: Set up a local configuration parameter file. Configure the number of MRIM processes in the MRI process pool. Start the configured MRIM process. View the status of the configured sites. Notes: If pooled MRIM processes are unavailable, MRI starts a standard MRIM process. The pooled MRIM processes are only available for requests initiated from the local Business Information Server site. Requests from remote Business Information Server sites using MRI to MRI networking use standard MRIM processes. If you access databases through some versions of the Microsoft Access ODBC Driver, the winnt directory or temp directory may include RMS*.tmp files after you stop the Business Information Server and the MRIM processes terminate. The FOXPRO and DBASE drivers delete the JET*.tmp files they create even when the process connecting to them terminates, but Microsoft Access does not. These RMS*.tmp files are created only if the Business Information Server is shutdown while a thread is active, or the ODBC driver has control. 307

308 Setting Up a Local Parameter Configuration File As described in Setting Up a Local or Remote Parameter File, MRI uses parameter files to determine default system settings. There are two MRI configuration parameters that you must configure through MRIDBA to control the resources used by the pooled MRIM processes. To configure the resources used by the pooled MRIM processes 1. On the MRI files menu, tab to Set up local parameter file and press NumEnter. The system retrieves the parameter file and displays the Set up parameter file menu. 2. Tab to the Maximum ODBC disconnects before MRIM restarts field. This field lets you configure the ODBCLEAK parameter. Increasing this field causes each pooled MRIM process to keep track of the number of disconnects. Once the number of disconnects exceeds the set value, the pooled MRIM process restarts itself by freeing all its resources and starts a new instance of itself. Exiting is the only way to get rid of the memory leaks that may accumulate with every disconnect, depending on your driver versions. For example, if you set this value to 125 and use the version of the Microsoft Access ODBC Driver that loses 8KB per disconnect, each pooled MRIM process accumulates 1 MB of lost memory before it exits. 3. Tab to the Maximum ODBC connections to keep open and press NumEnter. This field lets you configure the ODBCPOOL parameter. Increasing this value speeds up database access because it reduces the resources needed to execute a connection to MRI. In addition, an increased value reduces or eliminates the number of times you connect and disconnect from an ODBC data source. This is important because some Microsoft ODBC drivers lose available memory each time they disconnect from a database. The maximum value for ODBCPOOL is 20. MRI compares the ODBC DSN, user-id, and password to determine unique database connections. For example if you enter a 3, each pooled MRIM process keep the last 3 unique ODBC database connections. 308

309 Configuring and Viewing an MRIM Pool Process You can use the MapAdmin tool to do the following tasks to configure and view an MRIM pool process: Configuring the Number of MRIM Processes in the MRI Process Pool Starting the Configured MRIM Processes Viewing the Status of Configured MRIM Processes Note: Refer to the MapAdmin Help and the MRI for additional information about the MapAdmin tool. 309

310 Configuring the Number of MRIM Processes in the MRI Process Pool To configure the number of MRIM processes in the MRI process pool From MapAdmin 1. Highlight the site in the server tree (left side) of the main window. 2. Click the right mouse button or press Shift-F10. A context menu appears. 3. Select Properties. The Site Properties dialog box appears. 4. Choose the Capacity tab. The Capacity property page is displayed. 5. In the Number of pooled MRIM processes field, enter the number of MRIM processes you want in the MRI process pool. The default is 0. The maximum is 1/4 of the value specified for the maximum number of active users. MapAdmin determines the maximum value and does not allow you to enter a value greater than that number. This field will automatically be lowered at any time to keep it within the correct range. Note: The maximum number of MRIM processes in the MRIM pool is Click OK. MapAdmin creates the MRI process pool with the specified number of processes. 310

311 Starting the Configured MRIM Processes If you configured a pool of MRIM processes, you can automatically start the processes each time you start the site. To automatically start the configured MRIM processes From MapAdmin 1. Highlight the site in the server tree (left side) of the main window. 2. Click the right mouse button or press Shift-F10. A context menu appears. 3. Select Properties. The Site Properties dialog box appears. 4. Choose the Start-up tab. The Start-up page is displayed. 5. Check Start MRIM processes during site startup to automatically start all the processes in the MRI process pool when you start the site. This option is disabled if you did not configure a process pool on the Capacity property page. 6. Click OK. Note: Any change in this setting does not take effect until you restart the site. 311

312 Viewing the Status of Configured MRIM Processes If you configured a pool of MRIM processes, you can use MapAdmin to view the status of the configured processes. To view the status of configured MRI processes From MapAdmin 1. Highlight the site in the server tree (left side) of the main window. 2. Click the right mouse button or press Shift-F10. A context menu appears. 3. Select MRI Status. The MRI Process Control dialog box appears. 4. The colored circles in the dialog box indicate the status of each configured MRIM process. Green-The process is up and running. Yellow-A Business Information Server session is currently using the process. Red-The process terminated (or was never started) and is not available for use. 312

313 MRIM Process Control Screen The MRIM Process Control displays the current status of each pooled MRIM process. The status of each process is indicated by the colored icon next to the process as well as in the Status column. Note: Utilize MRIDBA s "Active Thread" screen to extract detailed information concerning specific MRIM slots and their associated stations. Green (Available) The process is up and available for the request. Yellow (In Use) The process is up and currently being used by a Business Information Server or Internet Commerce Enabler session. Red (Stopped) The process terminated (or was never started) and is not available for use. In addition to viewing the status, a user can use the control buttons to perform the following tasks: Stop all processes that are currently Available or In Use. Start all processes that are currently Stopped. Select individual processes with a checkmark and then Stop or Start the checked processes depending on their current state. Update the status of all pooled processes. The following is a list of the button definitions: Start All-Starts all the currently Stopped processes. Any process that is currently Available or In Use will be unaltered. Stop All-Stops all the currently Available or In Use processes. Any process that is currently stopped will be unaltered. Toggle Checked-Scans all processes that have been selected with a checkmark and stops the process if it is currently Available or In Use, or starts the process if it is currently Stopped. Refresh-Updates the status of all the pooled processes. Close-Closes the MRIM Process Control screen. Help-Displays the Administration Help for the MRIM Process Control screen. 313

314 Configuration Example To limit all Business Information Server Services to a pool of 35 MRIM processes, take the following steps: 1. Use the MapAdmin program to set up a pool of 35 pooled MRIM processes, as described in Configuring the Number of MRIM Processes in the MRI Process Pool. 2. Enter mridba, tab to Set up MRI files, then Set up local parameter file menu selections. Set Maximum users per database to 35 Set Maximum users per system to Make sure that the thread count for each database is registered through the Administration, Database Access, Database Registration menu have Thread Count set to 35. RefertotheAdmin Help for additional information. If you set Thread Count less than 35, that particular database is limited to that number of concurrent connections. If you have five different databases and want to share the connections equally between databases, you could set Thread Count to 7 for each of the five registered databases using ICE Admin. As an alternative, enter mridba, select Setup MRI files, select Set up local parameter file, and set Maximum users per database to 7. This limits any registered database to a maximum of seven concurrent connections. 4. Start the MapAdmin program and connect to the site. Once you are connected to the site, right click on the site letter and select properties from the list that appears. Check the Start MRIM processes during site startup. 5. Highlight the Capacity tab. 6. In the Other limits section, enter the number of MRIM processes you want to pool in the Number of pooled MRIM processes box. When you start the Business Information Server, that number of pooled MRIM processes is now started. 314

315 Registering Business Information Server Services to Work with ODBC Windows provides a special class of programs called services. Services run in a different environment than desktop applications and can be started at system startup. Service programs can run even when there is no user signed on to the desktop. Network servers are typically written as services. The list of available services can be found in Start Settings Control Panel Services. This will cause a list of services to appear. Services that are not currently running will appear as well. By selecting a service and pressing the startup button, you can view the startup properties of that service. The property of interest to Client Access ODBC users is the "Log On As" value. A series may run under either the "System Account" or a "User Account." Some programs only allow running under "System Account." The reason this property is important for Client Access ODBC, is that when a connection is attempted, Client Access looks for the connection information in the registry of the logged on user. Normally when a user signs on to the Windows desktop and uses the Client Access connection program to create a connection, the information is stored in the registry associated with the signed on user. 315

316 Using a Windows Service Under a User Account To run a program as a Windows service and have the "Log On As" property set to a user account 1. Sign on to your Windows desktop using the account that the service will use. 2. Create a connection using the Client Access connection program. 3. Start regedit or regedt32 by selecting the run option from the Start menu and entering either regedit or reged From the next display, find the following key: HKEY_CURRENT_USER\Software\IBM\Client\Access\CurrentVersion \Internal_Components\Communication\Environments\Primary Environment \systemname. Where systemname is the name of your machine. You should see several entries such as IP Address, Stack ID, and so on. You need to add a value called ServiceConfig as type DWORD and set its value to 0x01. If you use REGEDT32, use the following steps: a. Select Add value from the Edit menu. b. Use the name ServiceConfig as the Value Name. c. Set the data type to REG_DWORD and press OK. d. In the DWORD Editor window type 1 and press OK. If you use REGEDIT, use the following steps: a. From the Edit menu Select New DWORD Value. b. Change the name of the newly created value form NewValue#1 to ServiceConfig. c. Double-click on the ServiceConfig entry and change the value from 0 to 1. After this is done the service can be started and the Client Access ODBC will be able to find the connection information. 316

317 Considerations for Using ODBC with a Windows Service Only TCP/IP connections will work User-id and Password must be provided by the application on the SQL_CONNECT call. Since there is no desktop, the user cannot be prompted You must use Client Access for Windows The data source must be created as a System Data Source No other Client Access APIs can be used under the service 317

318 Glossary A-E A abort routine A subroutine to be executed if a user aborts the run during execution. It can be an internal or external subroutine. See also external subroutine, internal subroutine, subroutine. accesscode An identification code subordinate to a usercode. An accesscode can further establish a user's identity, control security, and restrict access to disk files. accounting log Administrator version: A summary of data containing a record of every transaction that takes place on the user's system. It is used by the Log List (LOGL) and Log Summary (LOGS) commands if they apply to that user's system. User version: A summary of data containing a record of every transaction compiled while a manual function or run executes. The Log for Analysis (LOG) statement produces an entry in the accounting log for each function executed in the run. active screen The screen that shows the user has signed on. Although the active screen looks like the sign-on screen, the user-id takes the place of the word Idle, and the bottom line indicates which cabinet is being accessed. Contrast with sign-on screen. See also caret, sign on. administrator The person who configures the database system, registers new users and new or updated runs, and manages the system user group. administrator department The department in which the administrator and other users with administrator privileges are registered. alphanumeric variable A variable that contains one or more alphabetic, numeric, and special characters, such as the tab character. See also variable, variable type. American Standard Code for Information Interchange (ASCII) A set of numeric codes that define a character set used in the United States; referred to as the full character set (FCS). Contrast with Fieldata, limited character set. See also character set, full character set. apostrophe A special character ( ' ) used in statements to delimit literal data that contains spaces, slants, or commas. application A set of related tasks accomplished by one or more runs and the database processed, for example, an inventory system. argument An item of data passed to a computer program. See also parameter. arithmetic expression A single numeric value or a combination of two or more values and one or more arithmetic operators. arithmetic operator A special character (such as +, -, *, and =) that specifies a mathematical relationship between two values. See also expression. 318

319 ASCII See American Standard Code for Information Interchange. asterisk line A line beginning with an asterisk (*) in column 1; it can be used as a comment line. It is not controlled by the tab positions and input edit codes of report 0. It has these characteristics: it can be shifted, it can extend up to the maximum size of a string variable, and it can be displayed and processed in different formats. See also line type, line type designator. auxiliary device A peripheral device connected to a terminal, such as a printer. See also peripheral device. B background run A run that frees the terminal for other uses while it executes. Background runs require special run registration. backup The process of copying a database to media. bar chart A chart that uses parallel bars whose lengths are proportional to values in a set of data. basic format The unshifted columns of a report as defined in report 0 from left to right. On 80-character screens, the basic format contains the left most 80 characters of a report; on 132-character screens, the basic format includes the leftmost 132 characters of a report. binary find process A method of finding an item quickly in a sorted list. Instead of scanning data line by line, a binary find process samples the data at midpoint and continues dividing and sampling the data until it finds the target item. binary synchronous communications (BSC) A communications protocol for sending data to an IBM host computer. block diagram chart A chart that presents a flowchart of icons connected by lines to show step-by-step progression. Boolean logic A system of logical comparisons named after mathematician George Boole. Boolean logic uses relational operators to evaluate expressions as true or false. See also conditional statement, IF/THEN/ELSE statement, relational expression, relational operator. Boolean operator See operator. branch To bypass the usual sequence of statements and jump forward or backward from the current location in a run. See also conditional branching, label. breakpoint A place in a run, specified by a Run Debug command, at which the run execution is interrupted for debugging purposes. 319

320 BSC See binary synchronous communications. bullet character One or more characters used to set off indented paragraphs. Characters such as brackets ( [ ] ) can be used as bullet characters, and one or more meaningful words that describe the indented paragraph can also be used, as long as there is enough room for the bullet characters between the left margin ( [ ) and the first tab set (T) in the tab rack. C cabinet A group of eight drawers (B through I), referred to by number and usually used by a department. Each user signs on into a specific cabinet, assigned by the administrator. Users in a particular department may have one or more cabinets to work in. See also department, drawer. cabinet owner The user responsible for defining the group of users who are permitted access to a specific cabinet. See also cabinet. cabinet pair A set of two cabinets, such as 0/1. Each cabinet in the pair holds exactly the same data. Traditionally, the even-numbered cabinet allows reading and updating of reports, while the odd-numbered cabinet allows read access only. See also cabinet. cabinet password See password. cabinet table of contents The screen produced by the Cabinet Table of Contents (T) command that lists what is contained in drawers B through I of the current cabinet. calculator A feature of the Arithmetic command that enables users to perform calculations. It can be used either with a report containing predefined equations or independently. call An instruction to transfer program execution, usually to a subroutine. caret A special character (^) that releases a displayed report or message, then displays the active screen. See also active screen. case sensitivity Pertaining to the differentiation between uppercase and lowercase letters. For example, in certain commands, when the user selects the option that determines case sensitivity, the system treats an uppercase letter as a different character than its lowercase letter. character set The characters allowed in the reports in a drawer. See also Fieldata, full character set, full character set upper, limited character set. CMS 1100 See Communications Management System. COBOL See Common Business-Oriented Language. 320

321 column A component of a relational table where like data is stored. A vertical line of information in a relational table. A character position in a report; for example, the first character position on the left side of a report is column 1. column name The name of a column in a relational table. It can also be used as an operand in an arithmetic or Boolean expression. column-characters (cc) field The part of a statement that specifies which fields in a report are used by that statement. For example, column-characters field 15-9 is the field that starts in column 15 and is nine characters long. Note that field names can be used in place of the column-characters field of a statement. See also field name. column-formatted report A report having a layout identical to other reports in the same drawer. The fields are separated by tab characters. Contrast with freeform report. command An instruction entered into a report to carry out operations with a manual function, such as GOC commands processed by the Generate Organization Chart manual function and statement, or data control commands used with the Create File manual function and statement. A selection from the RDI menu that is used to perform a relational operation, for example the Select command. comment The part of a statement that follows the space-period-space sequence and summarizes what the statement or subroutine is doing at that point in the run. It documents the run for later reference. A GOC or GS command that allows additional documentation within the report being processed. commit A command that makes a permanent change to one or more tables in a database. Common Business-Oriented Language (COBOL) A high-level computer language used mainly in the business environment. Communications Management System (CMS 1100) The communications software product that provides the structure for all communications and network capabilities for OS 2200 systems. CMS 1100 software enables a site to establish remote connections from an OS 2200 system to other hosts, terminals, and networks. communications output printer (COP) Any type of printing device connected to a terminal. composite key A primary key comprising more than one column. conditional branching A method of controlling the sequence in which statements are executed. At the branching point, a specific factor (such as the value of a variable or reserved word) determines which statement is executed next. See also branch. conditional statement A statement that sets up a condition to determine the subsequent functions a run performs. A statement of the Calculate (CAL) statement that tests expressions and controls processing of individual equations, depending on whether a specified condition is true or false. The four conditional statements are IF:, THEN:, ELSE:, and FIRST:. See also Boolean logic, IF/THEN/ELSE statement. 321

322 configuration A particular set of connections between devices, such as terminals and printers, that enables them to function as a unit. The selection of parameters that determines how software operates. constant label A value label that has a predefined value, such as PI. It is used in mathematical commands such as the Calculate command. See also field label, value label. control characters A set of characters that control the format of text in word processing reports. Control characters consist of a tilde (~) and another specified character. control line The top line of the screen containing control positions. See also control position. control parameter A key word that establishes the format of the text on a page in word processing reports. control position The position on the top line of the screen following the SOE character after the Line and Roll fields. See also control line, start-of-entry character. control sequence A keystroke that includes pressing the Ctrl key. For example, the keystroke Ctrl-I means to hold down the Ctrl key while pressing the I key. COP See communications output printer. counter A tally number, generated by a run, that records the number of times an event occurs. It is commonly used to escape a loop after a certain value is reached. cumulation The process of adding a quantity to a total and saving the new total in another field, repeated a number of times. For example, the Totalize (TOT) commands can be used to cumulate a field. See also subcumulation. current position The point on the screen from which the next command originates when using graphics primitive code and expanded syntax commands. See also expanded syntax commands, graphics primitive code. current result The most recent result, called -0 (minus zero), when using statements. See also renamed result, result. cursor The character on the screen that can be moved anywhere to show where to enter data. The cursor shows the current location on the screen. D data item The intersection of a column and a row in a table. For example, if the column name is LOCATION and the row contains data for a customer named John Doe, then the intersection is John Doe's city. See also data value. 322

323 data line In a column-formatted report, any line below the heading divider line. In a word processing report, any text or formatting line that follows the header lines. See also line type. data model A means of representing information in an organized way. See also relational model. data name The name of a cabinet, drawer, or report that was defined using the NAME command. This name is stored in the system directory. See also system directory. data record Another name for a row. A horizontal line of information in a relational table. Data Transfer Module (DTM) A software package that provides a fast, flexible method of transferring data between applications on OS 2200 computers. data type A code that restricts the type of data that is stored in a column. For example, the data type "character" permits entry of alphabetic characters or numbers. The data types "number" or "integer" restrict entry to numbers only. A specific set of data types is used by each relational database management system. data unit A unit of related information consisting of a tab line and the following lines up to the next tab line. A data unit can start with other line types when using the Search command with the U option. See also paragraph. data value The specific value of a data item. For example, if the data item is John Doe's city, then the data value could be Elmsville. database The cabinets, drawers, and reports maintained in files by a system. date format A format that defines how a date is to be displayed. For example, DD MMM YY displays a date as 01 NOV 98. date input specification The code to specify the format of a date to process. date line The first line (line 1) of each report, showing the date and time of the last update, report number, report creation date, and user-id of the last person to update the report. The date line is a period line and is counted as one of the heading lines. Synonym for line 1. date output specification The code used to represent the format of a result date. DCP See distributed communications processor. DDP See distributed data processing. debug To test a run and solve errors in the statements or in the logic of the run. 323

324 decode To translate an encoded report into a readable report, using the Decode Report (DECODE, DCR) commands. See also encode. default A preset value or condition that the system uses whenever the user does not make a specific selection. default site The first site installed on a host computer. The administrator can designate any existing site as the default for a server. See also site. delimiter A character placed on each side of a character string to indicate the beginning and ending of the character string. The delimiter can be any character other than those in the character string. demand program A program executed in demand mode, which processes data as quickly as it becomes available or ready. demonstration database The reports, usually in cabinet 0, in which users can practice commands. The relational database containing the tables HOUSES, CUSTOMERS, and LOCATIONS used by MRI. See also MRI. department A group of system users specified by a number. Users specify their department number when they sign on to the system. See also user registration. disk pack A disk that consists of multiple platters stacked vertically on a central spindle. Data on a disk pack are accessed by movable read/write heads. Some disk packs are removable. Synonym for pack. See also pack family. display The terminal screen the user views while using the software. To present data on the screen. DISTINCT columns A SELECT and JOIN option that eliminates duplicate data items from a table. distributed communications processor (DCP) A computer specifically designed to interconnect networks. It is used as a front end to OS 2200 systems or as a connection between networks of OS 2200 systems and other computers. distributed data processing (DDP) A network consisting of two or more computers at different locations. These computers are connected by data communications and are capable of interfacing with each other to perform a job, task, or application. document A report or set of reports that can contain a title page, a table of contents, a body with numbered sections, and an index. documentation report A report in a drawer, usually report 1, that documents information about that drawer, such as the field definitions. The person who designs the new drawer should create the documentation report. double function mask A screen with the issuing report headings on the upper mask and the receiving report headings on the lower mask. See also function mask, issuing report, receiving report. 324

325 downline load To copy a file or other information from a computer system to the user's own terminal. drawer A group of reports in a cabinet. All reports within a drawer have the same line length. Each drawer of a cabinet is identified by a letter from B to I. Drawer A is accessible to all cabinets in a system. See also cabinet, freeform drawer, report 0. drawer definition The process of designing a drawer: defining fields, data formats, edit code descriptions, report organization, display formats, and any special use rules. drawer letter A letter (A through I) used to identify a drawer in a cabinet. See also cabinet, drawer. drawer number The octal number that identifies the drawer and cabinet within the system. Each drawer has a unique number, such as 0010 for drawer E in cabinet 0. See also cabinet, drawer. drawer password See password. drawer table of contents See cabinet table of contents. DTM See Data Transfer Module. E ECL See Executive Control Language. edit code See input edit code. edit command A command, such as SOE Update and Add Line, used to alter report lines. empty report A report that contains headings but no data. encode To transform a report into code using the Encode Report (ENCODE, ECR) commands, making it unreadable unless the correct key is specified. See also decode. end report line The last line of a displayed report or result. enter To type information and press Transmit, sending the information from the terminal to the host computer. 325

326 Enterprise Output Manager A comprehensive print management software system that delivers information to a variety of output delivery systems. equation Two arithmetic expressions separated by an equal sign (=). equation operator See operator. equation set The function mask and equations used with the Iterative Calculate run. See also function mask. error message See system messages. error routine A subroutine to be executed if a run encounters an error. It can be an internal or external subroutine. See also external subroutine, internal subroutine, subroutine. Exec A program that controls the execution of other routines on 2200 operating systems. Exec is the principal interface between the user and the system as a whole. See also Executive Control Language. execute To process a particular instruction or task. Manual functions, runs, and statements can be executed. Executive Control Language (ECL) The computer language used to communicate with the Exec. expanded syntax commands A set of graphics commands translated by the Graphics Scaler command into graphics primitive code to create charts or modify existing charts. See also graphics primitive code. experimental report A freeform report used to generate a new drawer. It contains the title, headings, input edit codes, formats, and predefined lines that will reside in report 0 for the new drawer. See also freeform report, input edit code, predefined lines. expression A series of one or more field labels, values, or operators that produces a single arithmetic or logical value. For example, in the Calculate (CAL) commands, an expression is the sequence of field labels and arithmetic operators (+,-,*, or /) that completes an equation. See also arithmetic expression, relational expression, relational operator. external subroutine A subroutine in another run control report to which the user's run temporarily transfers control. Contrast with internal subroutine. See also abort routine, error routine, subroutine. 326

327 Glossary F-L F FCC See field control characters. FCS See full character set. FCSU See full character set upper. field A series of one or more columns of a report that are defined as an entity, such as a status code or a shipping date. A selection from a menu or a position in an input screen or system message where data is entered (for example, the Report field in an input screen). See also menu. A defined part of a statement format. Fields are separated from one another by a space. See also subfield. field control characters (FCC) The characters that control the type of data that the user enters in fields of the screen presented by the run. field headings The column headings for report fields. These titles are displayed above each field at the beginning of a report, immediately preceding the heading divider line. Synonym for headings. See also heading divider line. field label A single alphabetic character that identifies a single field or several fields for equations in mathematical functions. See also constant label, value label. field name A name that identifies a field of a report. The name is derived either from the two heading lines preceding the heading divider line of the report or from report 0 if the entire drawer is being processed. See also heading divider line, report 0. Fieldata A set of codes that define a character set. The Fieldata character set used in the software is called limited character set (LCS). Contrast with full character set. See also character set, limited character set. five-to-one output Screen output produced by lines in a run that use control characters and emphasis characters to control special editing and presentation effects. Five lines in the run are used to define one line of output. Five-to-one output is used with color displays; four-to-one output is used with monochrome displays. See also control characters, four-to-one output. floating-point numbers Numbers with movable decimal points. When processed, the decimal point is not necessarily placed in the same position for each number. flowchart A diagram of procedures, subroutines, and branches used to plan a run. 327

328 foreign key A column (or combination of columns) in one table whose values must also be stored in the primary key of another table. Used to restrict the acceptable values for a column in one table to the primary key values in another table. form A report containing screen control commands. See also screen control commands. format One of several variations of a report within a drawer (for example, basic format, format 1, format 2, and so on), each of which displays a different selection of columns of data in the report. The formats are defined in the report 0 of that drawer. The number of formats allowed depends on the type of system. See also report 0. format lines The lines in report 0 of a drawer that specify the report columns displayed in different report formats. See also drawer, format, report 0. format sensitive Pertaining to a run that processes a displayed report in a specific format. The run must be registered as format sensitive. See also format. four-to-one output Screen output produced by lines in a run that use control characters and emphasis characters for special editing and presentation effects. Four lines in the run are used to define one line of output. Four-to-one output is used with monochrome displays; five-to-one output is used with color displays. See also control characters, five-to-one output. freeform drawer A drawer used for freeform reports. Drawer A is a freeform drawer accessible from all cabinets in the system. See also drawer, freeform report. freeform report A report without a columnar structure determined by the report 0 of its drawer. The user can create freeform reports for memos, bulletins, run control reports, or informal columnar reports. Contrast with column-formatted report. See also report 0. frozen Pertaining to lines in a report that remain in the same position as typed. These lines are not affected by adjusting the report using the ADJ command. full character set (FCS) The character set that allows uppercase and lowercase letters, stored internally as ASCII characters. Contrast with Fieldata, limited character set. See also character set, full character set upper. full character set upper (FCSU) The set of ASCII codes in uppercase only. See also character set, full character set. function An operation performed on one or more reports or results, such as the Search or Sort manual function. A mathematical calculation, date or time conversion, or character expression used with math commands such as Calculate. A selection from the Relational Database Interface menu that is used to perform a relational operation, for example the Select function. See also Relational Database Interface. function call See manual function call, run function call. 328

329 function key bar An information bar at the bottom of the active screen. The 10 key names correspond to the F1 through F10 function keys. See also function keys. function keys The set of keys on a terminal keyboard (for example, F1 or F2) programmed to perform operations when they are pressed. See also function key bar. function mask A screen of field headings for a report; users enter options above the field headings and parameters below the headings as instructions for a manual function. See also parameter. G global glossary A standard report residing in a secure cabinet and containing glossary items. The global glossary is maintained by the administrator. glossary item A block of text defined in a glossary report that can easily be inserted in word processing reports. Glossary items are identified by a tab character in column 1 followed by an item name. granularity A measurement used when allocating storage space to a mass storage file. For example, the Element command assigns a file with a maximum granularity of 262,143 tracks. See also mass storage, mass storage file. graphics primitive code A set of commands that enables the system to display charts on different types of output devices. Users can design their own graphics by entering graphics primitive code in a freeform report. Graphics primitive code can be stored in reports. See also expanded syntax commands, packed graphics primitive code, unpacked graphics primitive code. H heading divider line The line beginning with an asterisk and made up of equal signs and periods that separates the field headings from the data; counted as one of the heading lines. Many manual functions rely on the heading divider line to determine where field headings end and data begins. See also field headings, field name, heading lines. heading lines The lines including and following the date line that show the drawer letter and report number, the names of fields, and the heading divider line. Synonym for report headings. headings Synonym for field headings. Hollerith variable A variable that can hold alphabetic, numeric, or special characters. See also variable, variable type. home position The upper left corner of the screen. 329

330 horizontal operation A computation performed in one or more fields across each data line in a report. See also vertical operation. host computer The computer that holds the database and software of a particular site. See also site configuration. I I/O See input/output. I/O request A request for input from or output to system storage. Synonym for I/O. IF/THEN/ELSE statement A conditional statement that controls further processing based on the value of the expression in the IF: statement. If that expression is true, the expression in the THEN: statement is processed. If the expression is false, then the ELSE: expression is processed. See also Boolean logic, conditional statement. index list report A report created by the DISPLAY command to list the charts that have been created. The index list report can also be used with the DISPLAY command to display the charts sequentially. initialize Administrator version: To read a tape containing an entire database and store it on disk. (This is similar to load except initialization is done to add the database to a system just installed). To assign a type, size, and initial value to a variable. User version: To assign a type, size, and initial value to a variable. See also variable. input edit code A numeric code (0 through 9) in report 0 of each drawer specifying what kind of data is allowed in each character position of the report. The person designing the drawer enters the input edit codes on the input edit line of the experimental report. See also experimental report, input edit line, report 0. input edit line Line 32 in report 0 of a drawer that is composed of input edit codes and blanks, specifying what kind of data is permitted in each character position of the report. See also input edit code, report 0. input/output (I/O) Information coming from or going to system storage. An operation in which the system reads data from or writes data to a peripheral device such as a disk drive. See also rep rate. input parameters The variables, literal data, reserved words, or any combination of these, to be processed in a run. See also literal representation, reserved word, variable. interactive Pertaining to a process that can take place during another process. interactive word processing A mode of operation in which word processing commands handle both the entries made in the control line and the 330

331 updates made to the report when the user transmits. This gives users an extensive range of commands for greater versatility and speed in processing text. interim display Information displayed on the screen for a given length of time; the run then continues automatically. internal subroutine A subroutine within a run control report to which the run temporarily transfers control. Contrast with external subroutine. See also abort routine, error routine, subroutine. issuing report The report from which data is taken when using a command that processes two reports, such as the Add On or Match commands. The issuing report is the upper mask of a double function mask. Contrast with receiving report. See also double function mask. J jellyware See liveware. job A group of one or more tasks, usually processed from and under the control of a single program. A job is assigned a number by the system and treated as a discrete unit of work by the computer. join operation A relational operation that combines rows from two or more reports or relational tables. justify To position data within a field, variable, or report. For example, if data in a field is left-justified, it begins in the leftmost column of that field. K kanji characters A character set used by several Asian languages, including Japanese and Chinese. known trailing substring A substring in which the user specifies the starting character position and use the remaining characters in the field. For example, V1(2-0) specifies the substring beginning with the second character and extending through to the end of V1. Contrast with unknown trailing substring. L label A number, preceded by an at sign (@) and followed by a colon ( : ), used to identify a statement line. Labels organize sections within a run, allowing branching. A name for a data value in an arithmetic expression. See also branch, label table definition lines. label table definition lines The lines at the beginning of a run that indicate the location of each label in the run. See also label. 331

332 LCS See limited character set. limited character set (LCS) The character set that allows uppercase letters only, stored internally as Fieldata characters. Contrast with full character set. See also character set, Fieldata. line 0 The first line of a report, never visible on the screen, containing system information about the report: the drawer letter, report number, write password, read password, number of heading lines, language of the report, and number of lines of the report. This information is stored with the report and can be displayed with the Line Zero command. line 1 Synonym for date line. line chart A chart that consists of lines of data drawn to correspond to values in a set of data. line modification command See edit command. line type A type of data line in the database, specified by a line type designator in column 1. See also data line, line type designator. line type designator The character in column 1 of a report line. There are four line type designators: tabcolumn-formatted, edited line; asterisk (*) column-formatted, nonedited line; period (. ) comment, nonedited line; and special (any valid character) columnformatted edited line. See also line type. literal representation The explicit and actual value of an item; information is interpreted exactly as it appears. For example, the literal representation of variable V11 is the characters V11, not the value that the variable holds. liveware Slang for people. Also called wetware or jellyware, as opposed to hardware, software, and firmware. LLP See logic lines processed. load To place information from storage into memory for processing (if it is data) or for execution (if it is program code). log list Synonym for accounting log. logic lines processed (LLP) The lines in a run control report processed during run execution. Each scan of a line counts as one LLP. See also run control report. logic scan The processing of each statement line by the system during execution of a run. See also statement line. logo See active screen, sign-on screen. 332

333 loop A sequence of statements that execute repeatedly until a specified condition is met. 333

334 Glossary M-R M manual function A function, such as Search or Totalize. manual function call The abbreviation used to request a manual function (for example, LOC for the Locate manual function). MAPER files OS 2200 mass storage files that make up the system database. mask line The line of asterisks just below the heading lines in a function mask. It divides the fields for use by the manual function. See also function mask, heading lines. mass storage Peripheral devices that can store large amounts of data. See also peripheral device. mass storage file A file used as a secondary storage device that provides current report information on a specific program segment. menu A list of items on a screen from which one item can be selected, either by tabbing to the selection and transmitting, or by typing a letter, number, or character string, and then transmitting. menu path The sequence of menu selections chosen in requesting a command. message An exchange of information or data with another program. Message Control Bank (MCB) A message handling mechanism for scheduling TIP programs or passing data to programs registered with the operating system. message log A record of the messages sent but not yet delivered. mixed chart A chart that uses both bars and lines to represent data. modem A communications device that enables computer data to be transmitted over telephone lines. See also peripheral device. MRI The relational interface to data stored in relational tables. MRI consists of seven statements designed to perform specific relational tasks, the Relational Database Interface, and software programs that manage the communication between the database system and the relational database. See also Relational Interface Manager, Relational Database Interface (RDI) command. 334

335 MRIM See Relational Interface Manager. multiple field label A label that identifies more than one report field when using mathematical functions. Contrast with single field label. N named report A report that was named using the NAME command. For example, report 6B0 could have a name of Inventory. named variable A variable that is designated by a name rather than by a number. Greater-than and less-than characters are placed before and after the name, as in <sum>. Contrast with numbered variable. See also variable. nested statement A statement contained within another statement. See also statement. nested subroutine An internal subroutine referenced by another subroutine. Note that external subroutines cannot be nested. See also external subroutine, internal subroutine, subroutine. network To link multiple systems together to enable data transfer. network registration The process by which the administrator sets up the host identification and connection paths for each remote site. See also network. nonbreaking space A typed character, representing a space, that prevents two words from being separated onto different lines. For example, a nonbreaking space is used with a two-word city name so that the name is displayed on one line. nontab line Synonym for special line. null A blank character (not 0 and not a space) used to fill data lines. null value A value that is unknown or not applicable. For example, if a table contains addresses, the apartment number column would contain a null value if the addressee lives in a house. numbered variable A variable that is designated by the letter V followed by a number (for example, v1). Contrast with named variable. See also variable. 335

336 O object cache A Graphical Interface for Business Information Server database that reduces download requests by storing report objects on the workstation. The object cache uses version control to maintain the coherency of cached objects. object code file The executable code produced by a compiler. ODBC See Open Database Connectivity (ODBC) interface. offline storage A mass storage device used to hold backup data from the system. Open Database Connectivity (ODBC) interface A comprehensive standard for data access in heterogeneous client/server database environments. It serves as an open, vendor-neutral programming interface. In the Business Information Server for Microsoft Windows Operating System, you can create runs that access multiple database managers through the ODBC interface without needing detailed knowledge of those database managers. operator A system operator. A symbol that specifies a calculation or comparison to be performed in a command such as Calculate. A special character used to compare values, such as equal to ( = ), greater than ( > ), less than ( < ), less than or equal to ( <= ), greater than or equal to ( >= ), or not equal to ( <> ). These comparisons produce a value of 1 if the comparison is true or 0 if the comparison is false. See also arithmetic operator, relational operation. option A selection that the user can make for special operation of a command. If the user does not select an option, the default operation occurs. option field The leftmost position on the second screen line of a function mask where characters are entered to indicate selected variations in manual functions. See also function mask. ordinal number A number designating the place of an item in an ordered sequence, for example, first, second, or third. originating system The system (Business Information Server system or SCHDLR) that initiates a message exchange. output area A scratchpad or storage area used in a run that temporarily stores data collected during run execution. See also output lines. output lines The lines in a run control report that do not start with at signs (@) or colons ( : ). Output lines are placed in the output area and can be displayed when the run terminates. They can also be placed in a result by using the Break (BRK) or Break Graphics (BRG) statement and can be displayed or processed at any time during the run. See also output area, result. 336

337 P pack Administrator version (2200): The process of condensing or "packing" the entries on an audit cycle. It is convenient for keeping a complete version of updated reports on a single audit cycle. Many sites use periodic packing to provide regular recovery points and reduce necessary recovery time. A process that produces a recovery tape and writes all reports from the MAPER0 file or MUPER file to a recovery tape. User version: To eliminate leading and trailing spaces from a value held by a variable. See also disk pack, pack family. pack cycle Specifies multiple, audited updates of a report to be condensed into a single report. pack family A disk pack or a collection of disk packs on which physical files are stored. It is given a name of up to 17 alphanumeric characters assigned during installation and is generally designated for specific applications and users. See also disk pack. packed graphics primitive code One format for graphics primitive code in a result or report. In this format, the commands are strung together, not separated by spaces or other characters. Contrast unpacked graphics primitive code. See also graphics primitive code. packed variable A variable in which the leading and trailing spaces have been deleted. See variable. page break The location on a page where control characters are inserted by the system (~*) or by the user (~/) to indicate where new pages start when the report is printed. paint To refresh the screen as it was immediately after the last SOE update by selecting Paint. paragraph A group of data lines starting at either the type of line being processed or the type of line specified with the Search U option. This includes subsequent lines up to, but not including, the next occurrence of the type of line processed or specified. See also data unit, line type. parameter An item of information supplied to a command that directs the processing of that command. It can also indicate system or device settings, fields to process, key items to process, and so on. pareto chart A chart that combines a bar and line chart on which the line represents the sum of the bar values. password A character string used as a security feature to prevent unauthorized access to information on a system. There are five kinds of passwords: the sign-on password restricts access to the system; the write password restricts updates to reports; the read password restricts users from reading a report; the drawer password restricts access to specific drawers within a cabinet; and the cabinet password restricts access to a specific cabinet. See also user registration. path The logical course or line of direction taken by the system in the execution of a run or part of a run. path name The complete operating system file identifier, including all directories, subdirectories, and the file name. 337

338 period line A line beginning with a period in column 1; it can be used as a comment line. It is not controlled by the tab positions and input edit codes of report 0. It cannot be shifted, it is limited to the screen display size, and it cannot be displayed or processed in different formats. See also line type, save flag. peripheral device Any data communications or input device attached to a terminal or host computer. For example, an AUX printer is a peripheral device attached to a terminal; a modem is a peripheral device attached to the host computer. See also auxiliary device, modem. pie chart A chart that consists of a circle divided like a sliced pie, each slice proportional to a value. predefined equation A formula stored in a report that can be displayed so you can fill in the values without retyping the equation. It is used with the Arithmetic command. predefined lines The lines in report 0 that contain tab positions, preset data, or reserved words. Each report 0 can have multiple predefined lines for which users can specify data or values that are automatically displayed when a new line is added to a report. These are data lines that have certain fields already filled in for permanent unchanged data and other fields left blank for entering changeable data. See also report 0. primary key A column (or combination of columns) used to uniquely identify each row in a table. A primary key that consists of more than one column is a composite key. primary key value The specific value of a primary key that uniquely identifies a row in a table. printer registration The process by which the Business Information Server system administrator defines the names of all system print models available to software and how the data sent to those printers should be built. protected field An area of a display terminal screen where no input is accepted; the user cannot place the cursor within the area. Protected fields are defined by control characters using the Output (OUT) statement. See also control characters. purge See backup. Q queue To send output to an auxiliary device. For example, a report can be queued to a printer. See also requeue. A group of items waiting to be processed. With Data Transfer Module (DTM), the user sends messages to a destination queue, which processes the message when it is received. See also Data Transfer Module. R radar chart A chart that consists of spokes radiating from a center point, and lines corresponding to values in a set of data. 338

339 RDI command See Relational Database Interface (RDI) command. read password See password. real-time processing A type of processing in which tasks are processed immediately by the system. Real-time tasks have a higher priority than ordinary batch or demand tasks. receiving label A name or alphabetic field label into which the result of an operation is stored. For example, a generated count of records in a report could be assigned to the COUNT receiving label. receiving report The report to which data is sent when using a command that processes two reports, such as the Add On or Match commands. The receiving report is the lower mask of a double function mask. Contrast with issuing report. See also double function mask. receiving variable The first variable in an equation and the variable that contains the result of a calculation. record See data record. recovery Administrator version (2200): The process of loading the database from the most recent backup tapes and the audit tapes. Recovery restores the database as it was before any deletion or damage. User version: The process of restoring the database to its condition before the last commit point. registration A procedure done by the administrator to add new users or runs to the system, and to enable networking. See also run registration, start interface, station registration, user registration. Relational Database Interface (RDI) command A command that provides interactive access to relational tables through use of a limited number of relational commands. relational expression A sequence of operands and relational operators used to compare values or character strings. When evaluated, it produces a value of 1 if the comparison is true or 0 if the comparison is false. See also Boolean logic, expression, relational operator. Relational Interface Manager (MRIM) A set of programs used to manage the communications between the database system and the relational database management system. MRIM consists of the Request Manager, which submits the code generated by the MRI statements to the database manager and returns data to the database system, and a database handler for each database supported by MRI. In addition, a remote communications handler is employed to access data stored on a remote host. relational model The model that represents data in the simple form of two-dimensional tables called relational tables. relational operation The action specified by a relational command. 339

340 relational operator A special character used to compare values, such as equal to ( = ), greater than ( > ), less than ( < ), less than or equal to ( <= ), greater than or equal to ( >= ), or not equal to ( <> ). See also Boolean logic, expression, relational expression. relational table A two-dimensional table that has rows and columns. The relational model represents data in the simple form of relational tables, or simply "tables." See also relational table definition. relational table definition An entry in the Data Dictionary that symbolically describes the characteristics (table name, schema name, and so on) of one or more relational tables. See also relational table. relative line number A line number specified by indicating the number of lines following or preceding the current line in a run control report. See also run control report. remote run A run that starts a run on another system. renamed result A temporary name created using the Rename (RNM) statement to rename the current result (-0); for example, result -0 can be renamed to -1. These results are lost when the run ends or the terminal is released. See also current result, result. report The set of data that the user works with in the system. Reports are identified either by a unique report number or by a meaningful name the user gave the report using the NAME command. See also report name. report 0 A report that resides in each existing drawer in the system. It serves as a template for the reports in its drawer when the Add Report command is used. It is also used by any manual function that uses a function mask. See also drawer, format, function mask, input edit code. report headings Synonym for heading lines. report identifier (RID) A specific report identified by a unique report number and drawer letter. For example, RID 2B refers to report 2 in drawer B. report name The characters used to refer to a report: either the report number and drawer letter or a meaningful name the user gave the report using the NAME command. See also report. repository See object cache. rep rate The average access time per I/O unit, determined by dividing the active time (in seconds) by the number of I/O units. The rep rate indicates the volume of activity on a system. See also input/output. requeue To send output already queued to an auxiliary device that failed to print the first time. See also queue. reserved word A character string reserved for specific use. The system supplies the information stored in the reserved word. For example, DATE1$ is a reserved word that supplies the current date in the format YYMMDD. 340

341 restricted access function A manual function requiring special permission from the administrator before it can be used. Applies to manual functions that require advanced knowledge of the software or operating system. result A temporary copy of data obtained by executing a command. It is held in scratch storage until released, duplicated, or replaced into a permanent report. See also current result, renamed result. resumable function A manual function that repeats or continues when the user selects Resume. resume To continue a command that was halted by a display. Select Resume to resume an operation. retrieve To bring a report that was filed into an operating system file back into the database. On Business Information Server for ClearPath OS 2200, to bring an earlier version of a report back into the database. reverse slant A special character ( \ ) used to indicate that a statement continues on the next line. reverse video Pertaining to highlighting on a screen where the background and character colors are reversed. RID See report identifier. rollback A command used to restore the database to its condition before the last commit point. row Another name for a record or data record. A horizontal line of information in a relational table. run A series of instructions (statements) stored in a run control report that the system interprets to produce a report or perform other tasks, such as updating reports. See also script, run control report, statement. run control report A report containing sequential statements of step-by-step instructions for processing reports, results, or other data. run function call An abbreviation used to request a statement (for example, SRH for Search). See also statement. run name A name assigned to a run; used to access the run and execute it (for example, FCC). run registration The process used by the administrator to authorize and enable a run. The administrator specifies in the run registration report the run name, the location of the run control report, and the person responsible for the run. See also department, run control report. running footers One or two lines of information such as page numbers, dates, and times that are displayed at the bottom of each page after creating word processing reports with the Print (PRT) command. 341

342 running headers One to three lines of information such as page numbers, dates, and times that are displayed at the top of each page after creating word processing reports with the Print (PRT) command. runstream A sequence of Executive Control Language (ECL) statements and data that execute a series of tasks. See also Executive Control Language. 342

343 Glossary S-W S save flag A date the user places on line 2 starting at column 2 of a report to prevent the report from being deleted before or on the date specified. Line 2 must be a period line in order to contain a save flag. Use the See also period line. scatter chart A chart that depicts variable points graphed according to numeric x and y scales. SCHDLR A set of common banks that schedules TIP programs through the MCB pass-off mechanism. See also Message Control Bank, Transaction Processing. screen control commands A set of commands, used with the Screen Control (SC) statement, that perform basic screen operations, which include positioning the cursor, clearing the screen, defining fields, and defining screen attributes. These screen commands can also be used to design reports that define fields, box data in a specified area, and map function keys. See also form. script A series of statements or commands that are interpreted rather than compiled. See also run. SDF file See System Data Format file. search information lines The lines displayed at the top of a result, showing how many lines were found by the search, the total number of lines searched, and the search parameters. semicolon A special character ( ; ) used in statements as field delimiters. A special character used in Arithmetic and Calculate commands to separate expressions. A special character used in IF: statements to control more than one decision on the same line. shell The user interface to the UNIX operating system that accepts and interprets commands. sign off To terminate a software program at the terminal. The sign-on screen is displayed on the screen. Contrast with sign on. See also sign-on screen. sign on To initiate a software program at the terminal by entering data that identifies the user to the system. This data includes the user-id, department number, and password (if applicable). The active screen is displayed on the user's screen. Contrast with sign off. See also active screen. sign-on cabinet The cabinet a user enters automatically when signing on to the system and in which the user primarily works. It is set by the administrator as part of user registration. See also user registration. sign-on password 343

344 See password. sign-on screen The screen that is displayed before signing on to the system. It shows the system name, station number, and software level. The word Idle in the user's sign-on screen shows that the station is inactive. Contrast with active screen. See also sign off. single field label A label that identifies one report field when the user incorporates equations in mathematical functions and statements. Contrast with multiple field label. site A system that has its own database, list of users, and general operations. A site can exist on the same host system as another site. See also default site. site configuration The devices (terminals, printers, or other systems) connected to the host computer. See also host computer. site letter An alphabetic designator assigned to each system. slant A special character ( / ) used to separate multiple parameters in a statement. SNA See system network architecture. SOE See start-of-entry character. special characters The set of characters on the keyboard, such as ] and *, that are not alphabetic or numeric characters. special line A line starting with any character except tab, asterisk, or period. Synonym for nontab line. See also line type, line type designator, tab line. SQL See Structured Query Language. stack A data structure that stores variables on a last-in/first-out basis. As data is added, the stack moves down, with the last item added taking the top position. start interface An external program called through the Start function. Start interfaces enable users to run batch programs without exiting the system. See also registration, run registration, station registration, user registration. start-of-entry (SOE) character A character represented on the screen that is used with the SOE Update command and other edit commands. See also edit command. statement A string composed of a run function call, subfields, and fields used to format an instruction that can be processed in a run. When the statement is executed from a run control report, it processes functions and other operations. See also run, run control report, run function call. 344

345 statement format See format. statement line A line that contains one or more statements, beginning with an at sign (@) and ending with a period. See also statement. station A terminal or PC on the host system. See also workstation. station number The unique identifier for a specific user's terminal on the host system. station registration The process by which the Business Information Server system administrator assigns a station number to a terminal-id. station sign-on screen See sign-on screen. string variable A run variable that may contain alphabetic, numeric, and special characters. See also variable, variable type. Structured Query Language (SQL) An industry-standard set of relational commands that let a user create, retrieve, and update data in a relational database. subcumulation To cumulate, using the Totalize command, until a key field value changes so that the result yields two result fields. See also cumulation. subfield A part of a statement field. For example, ltyp is a subfield of the ltyp,p field. Subfields are separated by a comma. See also field. subroutine A subset of a run that contains statements performing a specific task within the run. See also abort routine, external subroutine, internal subroutine. subtotal A sum of data for groups of related lines. System Data Format (SDF) file A file in OS 2200 standard data format. system directory Reports that contain data names for cabinets, drawers, and reports. These are updated using the NAME command when adding, changing, or deleting a data name. See also data name. system messages The messages displayed on the top line of the screen to alert the user to a possible or actual problem. system network architecture (SNA) The communications architecture that addresses functions such as layered communications protocols, enabling communication among diverse units. 345

346 T tab character A special character in reports used to separate columns. A tab character on the screen is usually represented by a vertical bar, center dot, or an arrow but may be configured for the terminal as another character. tab line A line beginning with a tab character. See also input edit code, line type, line type designator, report 0. tab rack A line in a word processing report immediately following the heading divider line. It begins with a tilde and period (~.) and contains brackets ( [ ] ), with which the user specifies left and right margins, and the letter T, with which the user specifies tab sets. table definition See relational table definition. table name The name of a relational table. table space A logical address space on secondary storage containing one or more stored tables. target chart A chart that consists of a bulls-eye, showing data in relation to the center point. target list A list of target words in an issuing report or list of words specified when the user executes the Word Locate and Word Change commands. See also issuing report. TCP/IP A communications protocol that connects a variety of computer equipment on a network. thread A sequence of data operations from one user. A session of work. Any command submitted to a database must be part of a thread. 3D bar chart A chart that consists of three-dimensional boxes with sizes proportional to values in a set of data. time A system for keeping everything from happening at once. time format A format that defines how a time is to be displayed; for example, HHMMSS displays a time as time input specifications The codes used to define the format of a time to process. time line chart A chart that represents chronological data. 346

347 time output specifications The codes used to define the output format of a time. TIP See Transaction Processing. toggle To switch between two modes of operation using the same key. For example, pressing the key activates one mode; pressing the key again returns to the original mode. trailer line A line automatically attached to a data line when certain commands, such as the Totalize command, are used. In the Search command, asterisk and period type lines are trailer lines to tab lines. See also asterisk line, line type, period line, tab line. Transaction Processing (TIP) A part of the Executive system (Exec) used for real-time transaction processing. transfer To copy, exchange, read, record, store, transmit, transport, or write data. transparent character A character that occupies a position in a string. When the string is compared to another character string, the transparent character allows all characters in that position to be accepted. For example, the $ in the character string A$C allows ABC and A1C to be accepted. truncate To cut off or shorten. For example, when using the Add On command to add a report that has lines longer than those of the receiving report, the new lines are truncated. To shorten data exceeding the field length. MRI truncates data in a result unless a wrap option is specified. tuple variable A different name for a table. A tuple variable can be used in place of the table name in describing which table a particular column is to come from. U unknown trailing substring A substring in which the user specifies the number of ending characters to use, regardless of the specific starting character position. For example, V1(0-2) specifies the last two characters of V1. Contrast with known trailing substring. unpacked graphics primitive code One format for graphics primitive code in a result or report. In this format, each command is on a separate line. Contrast with packed graphics primitive code. See also graphics primitive code. update control The ability of software to guarantee that only one user at a time can be updating a given report. update password See password. update result A result that can be used to replace or delete lines in the original report from which it was produced. See also result. 347

348 user-id A unique code assigned to each software user for security reasons. User-ids are set up by the administrator to allow access to certain commands. See also user registration. user input Any information the user is instructed to type. user registration The process by which the administrator specifies the privileges users have on the system. User registration enables administrators to control user access to cabinets and commands, thus providing system security. See also department, password. V value label A name of up to six characters that identifies a single numeric or text value in mathematical functions. See also constant label, field label. variable A labeled entity (for example, V11 or <finds>) that can assume different values. Values can be assigned by the user or by the software. See also variable type. variable table A table created at the end of a run control report displaying the location of all variables in a run control report. The user creates a variable table with the Build Variable Table (BVT) command. See also run control report. variable type One of five types of variables. Each variable type specifies the kind of data the variable can hold. See also alphanumeric variable, Hollerith variable, string variable, variable. version One of a number of different sets of table data for a single table definition. Each version of the table is associated with the same storage area name, and has the same column names, primary key, and secondary indexes as other versions. Each version can contain different data. vertical bar A special character ( ) that represents a tab character in reports. On some terminals, the tab character is displayed as a space. See also tab character. vertical operation A summary calculation (for example, sum or average) performed on a single field across all data lines. See also horizontal operation. vertical operator A special character (such as + or /) that identifies the type of arithmetic operation to be performed on all values in a specified field. vertical summation The process of adding fields of data in a report and listing the totals at the end of the result. It is used with the Totalize command. view A virtual table that acts as a window into selected rows and columns of one or more underlying tables. 348

349 W word processing A group of commands that process text to create documents, memos, and other kinds of reports containing textual data. word processing command See command. word processing control characters See control characters. word processing control parameters See control parameter. workstation A microcomputer or terminal connected to a network. See also station. write password See password. 349