EDCS II Programmer's Guide

*HyperReader

  CONTENTS

  Title Page

  Copyright Page

  Preface

  New and Changed Features

  1      Processing EDCS II Commands Through Command Procedures, Shell Scripts, and Batch Files

  1.1     Interactive/Foreground Job Versus Batch Mode/Background Job

  1.2     Running DCL Command Procedures Interactively in VMS

  1.3     Running Command Procedures in Batch Mode in VMS

  1.4     Running C Shell Scripts as Foreground Jobs in UNIX and ULTRIX

  1.5     Running C Shell Scripts as Background Jobs in UNIX and ULTRIX

  1.6     Running Batch Files in MS-DOS

  2      Processing Commands Through the Callable Interface

  2.1     Callable Interface Differences Among Operating Systems

  2.2     Callable Interface Concepts
    2.2.1      Programming Languages Supported
    2.2.2      Routine Arguments
      2.2.2.1      Argument Passing Mechanisms
      2.2.2.2      Argument Access
    2.2.3      EDCS II Constant and Message Files for VMS
    2.2.4      EDCS II Constant and Message Files for UNIX, ULTRIX, and MS-DOS
    2.2.5      Message Handling
    2.2.6      Program Recovery if Connection Between the Client and Server is Severed
    2.2.7      Using the Qualifiers Argument
    2.2.8      Custom Formatting EDCS II SHOW Commands
      2.2.8.1      Step One:  EDCS$SHOW ( edcs_show ) Routine
      2.2.8.2      Step Two: EDCS$GET_SHOW_RECORD ( edcs_get_show_record ) Routine
      2.2.8.3      Step Three:  Get Show Item Routines
      2.2.8.4      Step Four:  EDCS$END_SHOW ( edcs_end_show ) Routine
      2.2.8.5      Custom Formatting the EDCS$SHOW_REVIEW ( edcs_show_review ) Routine

  2.3     Program Flow

  2.4     Compiling, Linking, and Running a Callable Interface Program
    2.4.1      Compiling, Linking, and Running a Program in VMS
    2.4.2      Compiling, Linking, and Running a Program in UNIX and ULTRIX
    2.4.3      Compiling, Linking, and Running a Program in MS-DOS

  2.5     Online Example Programs
    2.5.1      Online Example Programs for VMS
    2.5.2      Online Example Programs for UNIX, ULTRIX, and MS-DOS

  3      Callable Interface Routine Descriptions for VMS

  EDCS$CHECK_LOGIN

  EDCS$CHECK_SYSTEM

  EDCS$CMD

  EDCS$DISP_MSG

  EDCS$EDITOR

  EDCS$END_SHOW

  EDCS$GET_MSG

  EDCS$GET_SHOW_DATE

  EDCS$GET_SHOW_INTEGER

  EDCS$GET_SHOW_RECORD

  EDCS$GET_SHOW_STRING

  EDCS$LOGIN

  EDCS$LOGOUT

  EDCS$SET_ADMINISTRATOR

  EDCS$SET_PASSWORD

  EDCS$SETUP

  EDCS$SHOW_ACCESS_LIST

  EDCS$SHOW_ACCOUNT

  EDCS$SHOW_ATTRIBUTE

  EDCS$SHOW_DATABASE

  EDCS$SHOW_DEPENDENCY

  EDCS$SHOW_ELEMENT

  EDCS$SHOW_GROUP

  EDCS$SHOW_HIERARCHY

  EDCS$SHOW_HISTORY

  EDCS$SHOW_MAILING_LIST

  EDCS$SHOW_PATH

  EDCS$SHOW_PROFILE

  EDCS$SHOW_REQUEST

  EDCS$SHOW_REVIEW

  EDCS$SHOW_SUBSTITUTE

  EDCS$SHOW_TEAM

  EDCS$SHOW_USERS

  EDCS$SHOW_VERSION

  EDCS$VIEWER

  4      Callable Interface Routine Descriptions for UNIX, ULTRIX, and MS-DOS

  edcs_check_login

  edcs_check_system

  edcs_cmd

  edcs_disp_msg

  edcs_editor

  edcs_end_show

  edcs_get_msg

  edcs_get_show_date

  edcs_get_show_integer

  edcs_get_show_record

  edcs_get_show_string

  edcs_login

  edcs_logout

  edcs_set_administrator

  edcs_set_password

  edcs_setup

  edcs_show_access_list

  edcs_show_account

  edcs_show_attribute

  edcs_show_database

  edcs_show_dependency

  edcs_show_element

  edcs_show_group

  edcs_show_hierarchy

  edcs_show_history

  edcs_show_mailing_list

  edcs_show_path

  edcs_show_profile

  edcs_show_review

  edcs_show_substitute

  edcs_show_team

  edcs_show_users

  edcs_show_version

  edcs_viewer

  5      Using Query Languages to Query Data Stored in the Database

  5.1     Three Methods of Querying the Data

  5.2     Using a Query Language to Query the Database
    5.2.1      Writing Queries in Uppercase Characters
    5.2.2      Translating Numeric Coded Fields in the Database
    5.2.3      Multiple Records from Queries Involving Attributes
    5.2.4      Using the Output from Queries Within Your Programs
      5.2.4.1      Character String Field Type
      5.2.4.2      Access List Rules
      5.2.4.3      Structure of SAVESET Field in EDCS$ARCHIVE View
    5.2.5      Future View Changes

  5.3     Using RDO to Query the Database

  5.4     Using VAX SQL to Query the Database

  5.5     Using VAX DATATRIEVE to Query the Database

  5.6     EDCS II Predefined Views of the Rdb/VMS Database

  A   Callable Routine Messages

  A.1     Message Format

  A.2     Message Code and Text of All EDCS II Messages

  A.3     EDCS II Callable Interface Messages
    ACTEVERR . . . INVSTRLEN
    ITEMNOTFOUND . . . WRONUMARG

  EXAMPLES

  1-1        FETCH.COM DCL Command Procedure

  1-2        FETCH.COM Command Procedure Rewritten with Parameter Symbols

  1-3        Error Checking in Batch Mode for DCL

  1-4        DCL Command Procedure for Batch Mode

  1-5        Output from a Command Procedure Run in Batch Mode

  1-6        Batch Mode Command Procedure with Parameter Symbols

  1-7        FETCH ELEMENT C Shell Script

  1-8        FETCH ELEMENT C Shell Script Rewritten with Parameter Symbols

  1-9        Background Job C Shell Script

  1-10       Output from a C Shell Script Run as a Background Job

  1-11       Background Job C Shell Script with Parameter Symbols

  1-12       FETCH.BAT Batch File

  FIGURES

  2-1        Format of Qualifiers Item List

  2-2        Sample Qualifiers Item List

  2-3        Sample Output for EDCS$GET_SHOW_RECORD

  2-4        Buffer Format of SHOW Record

  2-5        Sample Buffer Format of SHOW Record

  2-6        Sample SHOW REVIEW Information for Entity PISTON

  3-1        Format of fao_block Buffer

  TABLES

  2-1        Qualifiers Used in Callable Interface

  2-2        Constant and Message Files for VMS

  2-3        C Constant and Message Files for UNIX, ULTRIX, and MS-DOS

  2-4        Get Show Item Routines

  2-5        Programming Examples for VMS

  3-1        EDCS II Callable Routines

  3-2        EDCS$SET_ADMINISTRATOR Qualifiers

  3-3        EDCS$SET_PASSWORD Qualifiers

  3-4        EDCS$SHOW_ACCESS_LIST Output

  3-5        Constant Values Returned for EDCS$SHOW_ACCESS_LIST Item Codes

  3-6        EDCS$SHOW_ACCESS_LIST Qualifiers

  3-7        EDCS$SHOW_ACCOUNT Output

  3-8        Constant Values Returned for EDCS$SHOW_ACCOUNT Item Codes

  3-9        EDCS$SHOW_ACCOUNT Qualifiers

  3-10       EDCS$SHOW_ATTRIBUTE Output

  3-11       EDCS$SHOW_ATTRIBUTE Qualifiers

  3-12       EDCS$SHOW_DATABASE Output

  3-13       Constant Values Returned for EDCS$SHOW_DATABASE Item Codes

  3-14       EDCS$SHOW_DATABASE Qualifiers

  3-15       EDCS$SHOW_DEPENDENCY Output

  3-16       EDCS$SHOW_DEPENDENCY Qualifiers

  3-17       EDCS$SHOW_ELEMENT Output

  3-18       Constant Values Returned for EDCS$SHOW_ELEMENT Item Codes

  3-19       EDCS$SHOW_ELEMENT Qualifiers

  3-20       EDCS$SHOW_GROUP Output

  3-21       Constant Values Returned for EDCS$SHOW_GROUP Item Codes

  3-22       EDCS$SHOW_GROUP Qualifiers

  3-23       EDCS$SHOW_HIERARCHY Output

  3-24       EDCS$SHOW_HIERARCHY Qualifiers

  3-25       EDCS$SHOW_HISTORY Output

  3-26       Constant Values Returned for EDCS$SHOW_HISTORY Item Codes

  3-27       EDCS$SHOW_HISTORY Qualifiers

  3-28       EDCS$SHOW_MAILING_LIST Output

  3-29       Constant Values Returned for EDCS$SHOW_MAILING_LIST Item Codes

  3-30       EDCS$SHOW_MAILING_LIST Qualifiers

  3-31       EDCS$SHOW_PATH Output

  3-32       EDCS$SHOW_PATH Qualifiers

  3-33       EDCS$SHOW_PROFILE Output

  3-34       Constant Values Returned for EDCS$SHOW_PROFILE Item Codes

  3-35       EDCS$SHOW_REQUEST Output

  3-36       Constant Values Returned for EDCS$SHOW_REQUEST Item Codes

  3-37       EDCS$SHOW_REQUEST Qualifiers

  3-38       EDCS$SHOW_REVIEW Output

  3-39       Constant Values Returned for EDCS$SHOW_REVIEW Item Codes

  3-40       EDCS$SHOW_REVIEW Qualifiers

  3-41       EDCS$SHOW_SUBSTITUTE Output

  3-42       EDCS$SHOW_SUBSTITUTE Qualifiers

  3-43       EDCS$SHOW_TEAM Output

  3-44       EDCS$SHOW_TEAM Qualifiers

  3-45       EDCS$SHOW_USERS Output

  3-46       EDCS$SHOW_USERS Qualifiers

  3-47       EDCS$SHOW_VERSION Output

  3-48       EDCS$SHOW_VERSION Qualifiers

  4-1        EDCS II Callable Routines

  4-2 edcs_set_administrator Qualifiers

  4-3 edcs_set_password Qualifiers

  4-4 edcs_show_access_list Output

  4-5        Constant Values Returned for edcs_show_access_list Item Codes

  4-6 edcs_show_access_list Qualifiers

  4-7 edcs_show_account Output

  4-8        Constant Values Returned for edcs_show_account Item Codes

  4-9 edcs_show_account Qualifiers

  4-10 edcs_show_attribute Output

  4-11 edcs_show_attribute Qualifiers

  4-12 edcs_show_database Output

  4-13       Constant Values Returned for edcs_show_database Item Codes

  4-14 edcs_show_database Qualifiers

  4-15 edcs_show_dependency Output

  4-16 edcs_show_dependency Qualifiers

  4-17 edcs_show_element Output

  4-18       Constant Values Returned for edcs_show_element Item Codes

  4-19 edcs_show_element Qualifiers

  4-20 edcs_show_group Output

  4-21       Constant Values Returned for edcs_show_group Item Codes

  4-22 edcs_show_group Qualifiers

  4-23 edcs_show_hierarchy Output

  4-24 edcs_show_hierarchy Qualifiers

  4-25 edcs_show_history Output

  4-26       Constant Values Returned for edcs_show_history Item Codes

  4-27 edcs_show_history Qualifiers

  4-28 edcs_show_mailing_list Output

  4-29       Constant Values Returned for edcs_show_mailing_list Item Codes

  4-30 edcs_show_mailing_list Qualifiers

  4-31 edcs_show_path Output

  4-32 edcs_show_path Qualifiers

  4-33 edcs_show_review Output

  4-34       Constant Values Returned for edcs_show_review Item Codes

  4-35 edcs_show_review Qualifiers

  4-36 edcs_show_substitute Output

  4-37 edcs_show_substitute Qualifiers

  4-38 edcs_show_team Output

  4-39 edcs_show_team Qualifiers

  4-40 edcs_show_users Output

  4-41 edcs_show_users Qualifiers

  4-42 edcs_show_version Output

  4-43 edcs_show_version Qualifiers

  5-1        Partial Listing of EDCS II Numeric Coded Fields

  5-2        SAVESET Field in the EDCS$ARCHIVE View

  5-3        EDCS II Views

  A-1        Severity of Messages

  A-2        EDCS II Message Text