TeamRoute Programming Guide

*HyperReader

  CONTENTS

  Title Page

  Copyright Page

  Preface

  1      Overview

  1.1     Routing Package Processing
    1.1.1      Using Video Terminals
    1.1.2      Using ALL-IN-1

  1.2     Client/Server Model

  1.3     Programming Functions

  1.4     Templates

  1.5     Routing Packages
    1.5.1      Roles
    1.5.2      Routing
    1.5.3      Tracking
    1.5.4      Attachments
    1.5.5      Signatures

  2      Designing Applications

  2.1     Initial Considerations

  2.2     Application Domains

  2.3     Information Transfer
    2.3.1      Routing Package Information
    2.3.2      Variables
    2.3.3      Data Files

  2.4     Creating Applications
    2.4.1      New Applications
    2.4.2      Existing Applications

  2.5     Routing Package Dump Utility

  3      Implementing Your Design

  3.1     Implementing Applications

  3.2     Compiling and Linking Applications

  3.3     Defining Applications to TeamRoute for VMS

  4      Designing and Implementing Templates

  4.1     Designing Templates

  4.2     Building Templates

  4.3     Loading New Templates to Your System

  5      Application Programming Interface

  5.1     Using the API

  5.2     Local Symbols
    5.2.1      Using Local Symbols

  5.3     SELECT Function

  TMR SELECT

  5.4     Special Symbols

  5.5     Data Sets

  TMR$DATA_FILE$

  TMR$ROLE$

  TMR$VARIABLE$

  5.6     Defining Applications to TeamRoute for ALL-IN-1

  6      Run-Time Library

  6.1     RTLFILE Module

  tmrrtl_close

  tmrrtl_open

  6.2     RTLRP Module

  tmrrtl_get_routing_package_attr

  tmrrtl_set_routing_package_attr

  6.3     RTLROLE Module

  tmrrtl_get_enforced_role

  tmrrtl_get_role_by_id

  6.4     RTLVAR Module

  tmrrtl_begin_variable_dir

  tmrrtl_end_variable_dir

  tmrrtl_get_first_variable

  tmrrtl_get_next_variable

  tmrrtl_get_variable_by_id

  tmrrtl_get_variable_by_name

  tmrrtl_set_variable_by_id

  tmrrtl_set_variable_by_name

  6.5     RTLDFILE Module

  tmrrtl_begin_data_file_dir

  tmrrtl_end_data_file_dir

  tmrrtl_get_data_file

  tmrrtl_get_first_data_file

  tmrrtl_get_next_data_file

  tmrrtl_set_data_file

  A   Sample Shell Application

  A.1     Passing Data Files from TeamRoute Routing Packages

  A.2     Reading Routing Package Variables

  A.3     Extracting, Displaying, and Changing Data in a TeamRoute Routing Package

  B   Document Dump Utility

  C   File I/O Error Status Returns

  D   Routing Package Handle Integrity Status Returns

  E   Template Creation Utility Status Messages

  E.1     Warning Messages

  E.2     Error Messages

  Glossary

  EXAMPLES

  A-1        Calls to an Existing Application

  A-2        Calls to an Existing Forms Package

  A-3        Calls to a Shareable Image Application

  FIGURES

  1 Conventions

  1-1        TeamRoute Client/Service Agent Domain

  1-2        Physical Template with Work-Item Copies

  2-1        Routing Package/Application Interface with New Application

  2-2        Routing Package/Application Interface with Existing Applications

  TABLES

  2-1        Routing Package Examples Using Different Data-Transfer Methods

  3-1        Access Modes by Function Code

  3-2 TeamRoute RTL Routines That Process Data Files

  3-3 TeamRoute RTL Routines That Process Variables

  4-1        Template Roles and Associated Rights

  5-1        Menu Options That Generate Calls to Applications

  5-2        Special Symbols

  5-3        OA$TMR$STATE Values

  5-4        TMR$DATA_FILE$ Fields

  5-5        Right_x Values

  5-6        Request_x Values

  5-7        Access_Mode Values

  5-8        TMR$VARIABLE$ Fields

  6-1        Routing Package Types

  6-2        Valid Output Item List Entries for tmrrtl_open

  6-3        Valid Output Item List Entries for tmrrtl_get_routing_package_attr

  6-4        Optional Input Item List Elements for tmrrtl_set_routing_package_attr

  6-5        Valid Output Item List Entries for tmrrtl_get_role_by_id

  6-6        Valid Rights Item List Entries for tmrrtl_get_role_by_id

  6-7        Valid Requests Item List Entries for tmrrtl_get_role_by_id

  6-8        Valid Input Item List Entries for tmrrtl_get_first_variable

  6-9        Valid Input Item List Entries for tmrrtl_set_variable_by_id

  6-10       Valid Output Item List Entries for tmrrtl_get_data_file

  6-11       Valid Output Item List Entries for tmrrtl_set_data_file

  C-1        ERRNO Version 3.0 Error Code Definitions

  D-1        Routing Package Handle Integrity Error Code Definitions