SMART 1004 Developer s Guide

Embed Size (px)

DESCRIPTION

Smart400 Docs

Citation preview

  • 5/20/2018 SMART 1004 Developer s Guide

    1/276

    f

    SMART

    Developers Guide

  • 5/20/2018 SMART 1004 Developer s Guide

    2/276

    Foreword

    STATEMENT OF CONFIDENTIALITY

    CSC has prepared this document in good faith. Many factors outside CSCs current knowledgeor control affect the recipient's needs and project plans and errors in the document will becorrected once discovered by CSC. The responsibility lies with the recipient to evaluate thedocument for applicability.

    The information in this document is proprietary, confidential and an unpublished work and isprovided upon recipients covenant to keep such information confidential. Personal Datasupplied in this document may not be used for any purpose other than for which it was supplied.

    Personal Data may not be transferred to other parties without the prior consent of CSC. In noevent may this information be supplied to third parties without CSCs consent.

    The following notice shall be reproduced on any copies permitted to be made:

    CSC Corporation Limited 2010 All rights reserved

    Any request for further information concerning this document should be addressed to:

    The Insurance Services Helpdesk

    Midrange Competency Centre

    Royal Pavilion

    Wellesley Road, Aldershot

    Hampshire, GU11 1PZ

    United Kingdom

    Direct Line: +44 (0)1252 536333

    Fax: +44 (0)1252 534022

    Email: [email protected]

    CSC Corporation Limited is registered in England under number 1812179, registeredoffice Royal Pavilion, Wellesley Road, Aldershot, Hampshire, GU11 1PZ

  • 5/20/2018 SMART 1004 Developer s Guide

    3/276

    Purpose of this Document

    The aim of this guide is to document the applications related functions of SMART. Theguide is intended for the use of programmers and analysts responsible for developing thesystem.

    Trademark Acknowledgements

    See http://midrange.csc.com/trademarks.html

    Publication History

    Date Comments

    December 1995 Initial Version

    Revised June 1997, April 1999, March 2000, October 2001, October 2002,April 2003, April 2004, April 2005, July 2005, April 2006

    April 2007 Revised and updated CSC and IBM product names

    May 2007 Amended Batch Processing Data Model Diagram

    September 2007 Amended section 2.11. Subfile lines number.

    April 2008 Revised for SMART 0804

    June 2008 Product Code and Transaction Code ranges changed

    September 2008 Revised for 0810 Release

    April 2009 Revised for 0904 Release

    April 2010 Revised for 1004 Release

  • 5/20/2018 SMART 1004 Developer s Guide

    4/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCEii

    Thispagehasbeenintentionallyleftblank

  • 5/20/2018 SMART 1004 Developer s Guide

    5/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCEii

    Table of Contents

    FOREWORD........................................................................................................................................................ 2

    PURPOSE OF THIS DOCUMENT....................................................................................................................... I

    TRADEMARK ACKNOWLEDGEMENTS........................................................................................................... I

    PUBLICATION HISTORY.................................................................................................................................... I

    TABLE OF CONTENTS...................................................................................................................................... II

    1. INTRODUCTION......................................................................................................................................... 8

    2. DESIGNING A MODIFICATION............................................................................................................... 10

    2.1.

    INTRODUCING NEW FIELDS...........................................................................................................................

    10

    2.1.1. The Field Dictionary Subsystem...................................................................................................... 11

    2.1.2. Checking For Existing Fields........................................................................................................... 12

    2.1.3. Maintaining Fields on the Dictionary............................................................................................... 13

    2.1.4. Windows.............................................................................................................................................. 14

    2.2. DOCUMENTING FIELDS VIA THE HELP SYSTEM............................................................................................ 18

    2.2.1. Help Maintenance Subsystem......................................................................................................... 20

    2.2.2. Field Dictionary Search..................................................................................................................... 21

    2.2.3. Field Help Selection.......................................................................................................................... 22

    2.2.4. Screen Field Help Selection............................................................................................................. 23

    2.2.5. Maintaining Help Details................................................................................................................... 24

    2.3. ERROR CODES.............................................................................................................................................. 25

    2.3.1.

    Error Code Maintenance Subsystem

    ..............................................................................................

    252.3.2. Error Code Creation.......................................................................................................................... 26

    2.3.3. Error Code Enquiry Search.............................................................................................................. 27

    2.3.4. Error Code Maintenance Search..................................................................................................... 28

    2.3.5. Amend Error Codes........................................................................................................................... 29

    2.3.6. Delete Error Codes............................................................................................................................ 30

    2.3.7. Translate Error Codes....................................................................................................................... 31

    2.4. USING A TABLE OR DATA SET TO HOLD DATA............................................................................................. 32

    2.5. CHANGING FIELDS ON A DATA SET.............................................................................................................. 32

    2.5.1. Data Sets Subsystem........................................................................................................................ 32

    2.5.2. Checking for Existing Data Sets...................................................................................................... 33

    2.5.3. Data Sets Maintenance.................................................................................................................... 34

    2.5.4.

    Approach to Deleting Data Set Fields

    ............................................................................................

    35

    2.5.5. Compiling the Physical File.............................................................................................................. 35

    2.5.6. Retaining the Data while Amending the Data Set......................................................................... 36

    2.5.7. Data Set Logging............................................................................................................................... 36

    2.5.8. Summary of the Data Set Maintenance Process.......................................................................... 37

    2.6. CHANGING THE FIELDS ON A TABLE............................................................................................................. 38

    2.6.1. The Compile (CB) Extra Data Screen Command......................................................................... 39

    2.6.2. Validation on the eXtra Data Screen.............................................................................................. 39

    2.7. DELETING A TABLE ITEM............................................................................................................................... 40

    2.7.1. Modifying the Valid Flag................................................................................................................... 40

    2.7.2. Physically Deleting a Table or Item................................................................................................. 43

    2.8. TABLE ITEM HISTORY.................................................................................................................................... 44

    2.8.1. Background......................................................................................................................................... 44

    2.8.2.

    Optional Feature

    ................................................................................................................................

    44

    2.8.3. Functional Overview.......................................................................................................................... 45

  • 5/20/2018 SMART 1004 Developer s Guide

    6/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCEiii

    2.8.4. Online functionality............................................................................................................................ 46

    2.8.5. Batch Reporting Functionality.......................................................................................................... 47

    2.9. WHAT OPTIONS AREAVAILABLE FORACCESSING DATA?........................................................................... 48

    2.9.1. Sequential........................................................................................................................................... 48

    2.9.2. By Key................................................................................................................................................. 48

    2.9.3. Direct................................................................................................................................................... 48

    2.9.4. Performance Considerations........................................................................................................... 48

    2.10.

    WHAT DOES AN ONLINE FUNCTION CONSIST OF?......................................................................................

    49

    2.11. CLIENT/SERVER ENABLEMENT..................................................................................................................... 49

    2.11.1. Business Objects............................................................................................................................... 49

    2.11.2. Client/Server Data Area.................................................................................................................... 50

    2.12. SCREEN TYPES............................................................................................................................................. 50

    2.13. SCREEN HANDLING....................................................................................................................................... 51

    2.13.1. Screen I/O Modules........................................................................................................................... 51

    2.13.2. Screen Control Programs................................................................................................................. 51

    2.13.3. Screen Validation Programs............................................................................................................ 51

    2.14. DOCUMENTING SCREEN LAYOUTS............................................................................................................... 52

    2.15. WHEN SHOULD BUSINESS TRANSACTIONS BE BATCHED?......................................................................... 53

    2.15.1. Batching Financial Online Transactions......................................................................................... 53

    3.

    BUILDING AN ONLINE MOCK-UP

    ..........................................................................................................

    54

    3.1. BUILDING THE MOCK-UP............................................................................................................................... 54

    3.1.1. Designing the Screens...................................................................................................................... 55

    3.1.2. Compiling the Screens...................................................................................................................... 55

    3.1.3. Registering the Subsystem on T1685............................................................................................ 56

    3.1.4. Assigning Transaction Codes.......................................................................................................... 58

    3.1.5. Setting up the Menu Options on Tables......................................................................................... 58

    3.1.6. Secondary Program Switching........................................................................................................ 63

    3.1.7. Connecting the Screens................................................................................................................... 66

    3.1.8. Sanctioning the User......................................................................................................................... 67

    3.2. WHERE MENU DESCRIPTIONS ARE HELD.................................................................................................... 68

    3.3.

    DOCUMENTING THE PROCESSING REQUIRED

    ..............................................................................................

    69

    3.4. DEFERRING PROCESSING TOAT................................................................................................................. 70

    3.4.1. AT Request Job Priority.................................................................................................................... 70

    3.4.2. AT Job Queue Maintenance............................................................................................................ 71

    3.5. WHAT DOES A BATCH FUNCTION CONSIST OF?......................................................................................... 72

    3.6. WHAT OPTIONS AREAVAILABLE FOR REPORTING?..................................................................................... 72

    3.7. DESIGNING REPORT LAYOUTS..................................................................................................................... 72

    3.7.1. Editing the Printer File - DDS........................................................................................................... 73

    3.7.2. The Compile Report Command....................................................................................................... 74

    3.7.3. The Display File Field Description Command - DSPFFD............................................................ 74

    3.7.4. The Report Program.......................................................................................................................... 75

    3.8. USING SCRIBETO PRODUCE A HARD COPY OF DOCUMENTATION........................................................... 77

    3.8.1. Document Library Structure............................................................................................................. 77

    3.8.2.

    Setting up the Documentation

    .........................................................................................................

    77

    3.8.3. Document Format Standards........................................................................................................... 78

    3.8.4. Naming Conventions......................................................................................................................... 78

    3.8.5. Sample Scribe Parameter File......................................................................................................... 79

    3.8.6. Producing the Final Document........................................................................................................ 80

    3.8.7. Promoting Documentation to Release............................................................................................ 80

    4. BUILDING AN ONLINE MODIFICATION................................................................................................ 82

    4.1. LOGICAL FILES.............................................................................................................................................. 82

    4.1.1. Existing View or New View?............................................................................................................. 82

    4.2. CREATING/AMENDING A LOGICAL FILE......................................................................................................... 83

    4.2.1. Logical View Subsystem................................................................................................................... 83

    4.2.2.

    Logical View Database Files

    ............................................................................................................

    91

    4.2.3. Compiling the Logical File................................................................................................................ 91

  • 5/20/2018 SMART 1004 Developer s Guide

    7/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCEiv

    4.3. ACCESSING INFORMATION FROM THE DATABASE........................................................................................ 92

    4.3.1. The I/O Module.................................................................................................................................. 92

    4.4. PASSING INFORMATION BETWEEN SCREENS............................................................................................... 94

    4.4.1. READS, KEEPS and RETRV.......................................................................................................... 94

    4.5. BUILDING THE SCREEN................................................................................................................................. 95

    4.5.1. DSNSCR............................................................................................................................................. 95

    4.5.2. Designing the Screen Image............................................................................................................ 96

    4.5.3.

    Window Screens

    ................................................................................................................................

    974.5.4. Editing the DDS.................................................................................................................................. 98

    4.5.5. Defining Valid Function Keys........................................................................................................... 99

    4.5.6. Flagging Fields for Error Highlighting............................................................................................. 99

    4.5.7. Sorting the Fields............................................................................................................................... 99

    4.6. COMPILING THE SCREEN............................................................................................................................ 100

    4.6.1. Compiling Window Screens........................................................................................................... 101

    4.7. WHAT DOES THE SCREEN I/OMODULE DO?............................................................................................ 102

    4.8. WHAT DOES THE SCREEN CONTROL PROGRAM DO?............................................................................... 102

    4.8.1. Error Processing.............................................................................................................................. 102

    4.8.2. Key Handling.................................................................................................................................... 103

    4.8.3. Processing Associated with Fields................................................................................................ 103

    4.8.4.

    Positioning the Cursor

    .....................................................................................................................

    1044.8.5. Miscellaneous Display Attributes................................................................................................... 104

    4.9. SUBFILES..................................................................................................................................................... 105

    4.9.1. Subfile Control Record Format...................................................................................................... 105

    4.9.2. Subfile Record Format.................................................................................................................... 105

    4.10. SINGLE PAGE VS SELF-EXTENDING SUBFILES.......................................................................................... 105

    4.11. CODING A SUBFILE PAGE........................................................................................................................... 106

    4.12. SUBFILE HANDLING..................................................................................................................................... 107

    4.12.1. Creating Subfile Screens Using DSNSCR................................................................................... 107

    4.12.2. The Subfile Compile Parameter.................................................................................................... 108

    4.12.3. Subfile Programming Notes........................................................................................................... 108

    4.12.4. Design Considerations.................................................................................................................... 109

    4.13.

    CODING AN ONLINE PROGRAM

    ...................................................................................................................

    110

    4.13.1. Introduction....................................................................................................................................... 110

    4.13.2. Skeleton Mainline Programs.......................................................................................................... 110

    4.13.3. OPM and ILE.................................................................................................................................... 110

    4.13.4. Standard Mainline Programs (Non Client/Server)...................................................................... 110

    4.13.5. Client/Server Enabled Mainline Programs................................................................................... 114

    4.13.6. Secondary Switching....................................................................................................................... 120

    4.13.7. Process Access Groups................................................................................................................. 137

    4.13.8. Confirmation Messages.................................................................................................................. 138

    4.13.9. Secured Data Access...................................................................................................................... 140

    5. BUILDING BATCH MODIFICATIONS................................................................................................... 145

    5.1. INTRODUCTION............................................................................................................................................ 145

    5.1.1.

    Multi-Thread

    .....................................................................................................................................

    145

    5.1.2. Schedules......................................................................................................................................... 145

    5.1.3. Processes......................................................................................................................................... 145

    5.1.4. Control Totals................................................................................................................................... 146

    5.1.5. Reconciliation Rules........................................................................................................................ 146

    5.1.6. Transaction Codes.......................................................................................................................... 146

    5.2. BATCH DEFINITION...................................................................................................................................... 146

    5.2.1. Schedule Definition.......................................................................................................................... 146

    5.2.2. Process Definition............................................................................................................................ 146

    5.2.3. Control Totals Definition - T1671................................................................................................... 147

    5.2.4. Reconciliation Rules Definition - T1672....................................................................................... 148

    5.3. THE PARAMETER PROMPT SCREEN........................................................................................................... 149

    5.3.1.

    Designing a Parameter Prompt Screen

    ........................................................................................

    149

    5.3.2. Creating/Compiling the Parameter Prompt Screen.................................................................... 150

  • 5/20/2018 SMART 1004 Developer s Guide

    8/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCEv

    5.4. BATCH STRUCTURE.................................................................................................................................... 151

    5.4.1. Batch Program................................................................................................................................. 151

    5.4.2. Setting up a Process....................................................................................................................... 151

    5.4.3. Error Handling.................................................................................................................................. 153

    5.4.4. Managers.......................................................................................................................................... 153

    5.4.5. Restart a Batch Jobstream............................................................................................................. 155

    5.4.6. Job Control Information................................................................................................................... 155

    5.4.7.

    Commit Points

    ..................................................................................................................................

    1555.4.8. Job Descriptions.............................................................................................................................. 155

    5.4.9. Job Queues...................................................................................................................................... 156

    5.4.10. Debug Mode..................................................................................................................................... 156

    5.5. BATCH DATABASE FILES............................................................................................................................. 157

    5.6. CONTROL LANGUAGE PROGRAM FOR BATCH............................................................................................ 159

    6. SOFTWARE MANAGEMENT................................................................................................................. 161

    6.1. ENVIRONMENT LEVELS............................................................................................................................... 161

    6.2. ENVIRONMENT LEVEL STRUCTURE DIAGRAM............................................................................................ 162

    6.3. ELEMENT TYPE HIERARCHY CONNECTION DIAGRAM................................................................................ 164

    6.4. SOFTWARE DATABASE ENQUIRY SYSTEM................................................................................................. 165

    6.5.

    THE SOFTWARE DICTIONARY FILES...........................................................................................................

    172

    6.5.1. Physical Files................................................................................................................................... 172

    6.5.2. Logical Views................................................................................................................................... 172

    7. LANGUAGE TRANSLATION................................................................................................................. 173

    7.1. SETTING UP LANGUAGES,ENVIRONMENT LEVELS AND USER-IDS........................................................... 173

    7.1.1. Adding a Language to an Existing Environment Level.............................................................. 174

    7.1.2. Creating a New Environment with Multi Language Capability..................................................177

    7.1.3. Deleting a Language....................................................................................................................... 179

    7.1.4. Setting the Sign-on to Work in a Specific Language.................................................................. 180

    7.1.5. Modifying the Language or User-Id of an Existing User............................................................ 180

    7.2. TABLES AND CODES IN MULTI LANGUAGE................................................................................................. 181

    7.2.1.

    Setting up Tables and Codes

    .........................................................................................................

    181

    7.2.2. Adding Functions to the System Menu - S0017.......................................................................... 181

    7.2.3. Adding Functions to the Master Menu - S0018........................................................................... 182

    7.2.4. Translating the Master Menu Submenu Descriptions................................................................ 183

    7.2.5. Translating the Table Header and Item Descriptions................................................................. 184

    7.2.6. Modifying the Language Table - T1680....................................................................................... 184

    7.2.7. Function Key Switching................................................................................................................... 186

    7.3. CREATING SCREENS,ERROR MESSAGES AND HELP IN THE NEW LANGUAGE.........................................187

    7.3.1. Populating the Language Library with Screens........................................................................... 187

    7.3.2. Translating the Screens.................................................................................................................. 188

    7.3.3. Error Messages................................................................................................................................ 188

    7.3.4. Help screens..................................................................................................................................... 188

    8.

    APPENDICES

    ..........................................................................................................................................

    189

    8.1. DATABASE DEVELOPMENT STANDARDS..................................................................................................... 189

    8.1.1. Field Dictionary................................................................................................................................ 189

    8.1.2. Data Sets (physical files)................................................................................................................ 189

    8.1.3. Access Methods (logical files)........................................................................................................ 189

    8.2. DATABASE I/OMODULE FUNCTIONS &STATUSES.................................................................................... 191

    8.2.1. BEGN................................................................................................................................................. 192

    8.2.2. BEGNH.............................................................................................................................................. 193

    8.2.3. DELET............................................................................................................................................... 194

    8.2.4. DELTD............................................................................................................................................... 195

    8.2.5. DELTS............................................................................................................................................... 196

    8.2.6. ENDH................................................................................................................................................. 197

    8.2.7.

    ENDR.................................................................................................................................................

    198

    8.2.8. KEEPS............................................................................................................................................... 199

  • 5/20/2018 SMART 1004 Developer s Guide

    9/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCEvi

    8.2.9. NEXTP............................................................................................................................................... 200

    8.2.10. NEXTR.............................................................................................................................................. 201

    8.2.11. READD.............................................................................................................................................. 202

    8.2.12. READH.............................................................................................................................................. 203

    8.2.13. READR.............................................................................................................................................. 204

    8.2.14. READS.............................................................................................................................................. 205

    8.2.15. RETRV.............................................................................................................................................. 206

    8.2.16.

    REWRT

    .............................................................................................................................................

    2078.2.17. RLSE................................................................................................................................................. 208

    8.2.18. UPDAT.............................................................................................................................................. 209

    8.2.19. WRITD............................................................................................................................................... 210

    8.2.20. WRITR............................................................................................................................................... 211

    8.2.21. WRITS............................................................................................................................................... 212

    8.2.22. What is a Relative Record Number?............................................................................................ 213

    8.2.23. Database I/O Module Return Statuses......................................................................................... 216

    8.3. SCREEN DEVELOPMENT STANDARDS........................................................................................................ 217

    8.4. SCREEN LAYOUT DESIGN CHECKLIST........................................................................................................ 219

    8.5. SCREEN BUILDING CHECKLIST................................................................................................................... 219

    8.6. SCREEN I/OMODULE/SCREEN CONTROL PROGRAM FUNCTIONS &STATUSES.....................................220

    8.6.1.

    Functions

    ...........................................................................................................................................

    2228.6.2. Return Status Values...................................................................................................................... 223

    8.7. SUBSYSTEM MANUAL LAYOUT STANDARDS............................................................................................... 225

    8.7.1. Subsystem Naming Convention.................................................................................................... 225

    8.7.2. Section Standards........................................................................................................................... 225

    8.8. PROGRAM SPECIFICATION STANDARDS..................................................................................................... 227

    8.9. OPMCOBOLPROGRAM STANDARDS...................................................................................................... 228

    8.9.1. Identification Division...................................................................................................................... 228

    8.9.2. Environment Division...................................................................................................................... 229

    8.9.3. Data Division.................................................................................................................................... 229

    8.9.4. Working Storage.............................................................................................................................. 230

    8.9.5. Procedure Division.......................................................................................................................... 231

    8.10.

    ONLINE PROGRAM SECTIONS STANDARDS

    ................................................................................................

    233

    8.10.1. Standard Mainline Programs (Non Client/Server)...................................................................... 233

    8.10.2. Client/Server Enabled Mainline Programs................................................................................... 235

    8.10.3. Coding for the BEGN Function...................................................................................................... 236

    8.11. ONLINE PROGRAM DEVELOPMENT CHECKLIST.......................................................................................... 238

    8.12. BATCH PROGRAM SECTIONS STANDARDS................................................................................................. 239

    8.12.1. Restart Logic.................................................................................................................................... 240

    8.13. BATCH PROGRAM DEVELOPMENT CHECKLIST........................................................................................... 242

    8.14. USING SQL................................................................................................................................................. 243

    8.14.1. Declaring Physical Files.................................................................................................................. 243

    8.14.2. Commitment Control....................................................................................................................... 243

    8.14.3. Linkage.............................................................................................................................................. 243

    8.14.4. Select Statements............................................................................................................................ 244

    8.14.5. Using Interactive SQL..................................................................................................................... 2448.14.6. Ordering Source Statements......................................................................................................... 244

    8.14.7. SQL Anomalies................................................................................................................................ 245

    8.14.8. Performance Considerations......................................................................................................... 245

    8.15. QUERY DEFINITIONS AND QUERY MANAGEMENT QUERIES....................................................................... 246

    8.15.1. Support within SMART.................................................................................................................... 246

    8.16. GRAPHICAL ELEMENT DEVELOPMENT STANDARDS................................................................................... 247

    8.16.1. Java Element Standards................................................................................................................. 247

    8.16.2. HTML Element Standards.............................................................................................................. 249

    8.17. DATE PROCESSING..................................................................................................................................... 250

    8.17.1. DATCON1......................................................................................................................................... 250

    8.17.2. T1696 Alternative Date Format...................................................................................................... 251

    8.17.3.

    T1696 Extra Data Screen

    ...............................................................................................................

    253

    8.17.4. DATCON2......................................................................................................................................... 255

  • 5/20/2018 SMART 1004 Developer s Guide

    10/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCEvii

    8.17.5. DATCON3......................................................................................................................................... 255

    8.17.6. DATCON4......................................................................................................................................... 255

    8.17.7. DATCON5......................................................................................................................................... 255

    8.17.8. DATCON6......................................................................................................................................... 255

    8.18. VARIABLE DECIMAL PLACES IN NUMERIC FIELDS...................................................................................... 256

    8.18.1. Currency Table T1667.................................................................................................................... 256

    8.18.2. AMTCON........................................................................................................................................... 256

    8.19.

    NUMBER RANGES.......................................................................................................................................

    257

    8.19.1. Batch Flag Numbers........................................................................................................................ 259

    8.20. FUNCTION KEYS.......................................................................................................................................... 261

    8.21. LIBRARY STRUCTURE................................................................................................................................. 263

    8.21.1. The Library Naming Convention.................................................................................................... 263

    8.21.2. The IFS Directory Structure........................................................................................................... 265

    9. INDEX...................................................................................................................................................... 272

  • 5/20/2018 SMART 1004 Developer s Guide

    11/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE8

    1. Introduction

    SMART consists of two distinct parts. The first part manages the application and performs thefollowing functions:

    Controlling the environments within the computer where the application runs

    Controlling access to the application

    Managing the tables which control how the application operates

    The second part is an 'applications enabler' and assists the systems developer to:

    Assess the scope of a possible development

    Control the development life cycle of the amendment

    Document the changes and the resulting system

    The major areas covered are designing and building a modification in both the online and batchsystems.

    A chapter is also included on adding an alternative language facility.

    The appendices contain the standards required for developing screens, database files, logicalfiles, programs and documentation.

    Many of the functions described in this guide can be accessed via the traditional IBM i green

    screen command line as well as the graphical interface of SMART. Whichever access route istaken, the underlying principles and processing remain the same. The graphical functions ofSMART are detailed on the on-line facility provided with the graphical interface.

    Related Publications

    SMART Reference Manual.

    SMART Administrator's Guide.

    SMART Installation and Software Management Guide.

    SMART Business Objects Developers Guide.

    SMART SCRIBE User Guide.

    SMART Batch Processing Clerical Guide.

    SMART Release Guides.

  • 5/20/2018 SMART 1004 Developer s Guide

    12/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE9

    Thispagehasbeenintentionallyleftblank

  • 5/20/2018 SMART 1004 Developer s Guide

    13/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE10

    2. Designing a Modification

    When developing a modification to a system, there are certain procedures which must be adheredto. The procedures which make up SMART are designed to ensure the ease and accuracy of amodification and also to ensure standards are maintained.

    This section covers all aspects of modifying a system, from adding new fields to Tables or datasets, designing the screens and reports, through to documenting the change.

    2.1. Introducing New Fields

    All new fields must be added through the Field Dictionary. The Field Dictionary provides acentral point for controlling the development and use of fields within the system.

    Each field is referenced on the database by a field identifier. All field identifiers used by data setsmust first have an entry in the Field Dictionary. This entry defines the field name to be used withinCOBOL programs, the field text description, the type of field, its length and number of decimalplaces, the window facilities available for that field, and default column headings to be used byIBM i utilities. For numeric fields, the display format for the field is also defined. AlternateLanguage descriptions can also be entered if alternate languages are defined in the current Level.

    The information held within the Field Dictionary is used by the Data Sets Maintenance Subsystemto build physical files, and by the Screen I/O Module Generator Subsystem when building I/Omodules. IBM utilities, such as DFU, QUERY and SDA indirectly use the Field Dictionaryinformation when they reference files built by the Data Sets Maintenance Subsystem.

    The Field Dictionary can be accessed via the Field Dictionary Subsystem or the Field

    Maintenance View in graphical SMART.The Field Dictionary Submenu is accessed via the Development Utilities Master Menu, inCompany 0.

  • 5/20/2018 SMART 1004 Developer s Guide

    14/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE11

    2.1.1. The Field Dict ionary Subsystem

    TDEV - SYSTEM Fi el d Di ct i onary Submenu S0214 01

    Mai ntenance A - Cr eat e i t emB - Modi f y i t emC - Del et e i t em

    I nqui r i es D - I nqui r e on i t emE - Data sets whi ch use f i el d

    Fi el d i dent i f i er :Ref er ence f i el d:

    Al t ernat e Wi ndow:

    Act i on: D

    The Field Dictionary Subsystem enables a user to create, modify, delete and enquire upon FieldDictionary items. Enquiry on data sets which use a particular field is also available.

    The Reference Fieldcan be used to copy details of an existing field definition that can then bealtered to the new field's details.

    The Al ternate Window field is used to specify an alternative windowing screen for the field, ifapplicable. Windowing on this field is available to the Alternative Windowing Details windowS0635 which displays existing windowing definitions for a field for selection.

    Warning

    Do not delete a field definition in the Field Dictionary without checking the impact on existingdata sets, screens and reports. Note that it is not possible to delete a field which hasassociated alternative windowing details or which is associated with a Business Object.

    When defining a new field, do not use a field name which ends in a numeric value (e.g.CHAR10), as numeric suffixes are reserved for use with occurring fields.

    When modifying an application, it may not be necessary to define a new field in the Field

    Dictionary as there is often an existing definition.

    If multiple occurrences of a field may be required, the length of the name must not exceed 8characters, in order to allow for the numeric suffix.

  • 5/20/2018 SMART 1004 Developer s Guide

    15/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE12

    2.1.2. Checking For Existing Fields

    Before adding a new field, check it is not already in the system by browsing the existing fields inthe Field Dictionary. This can be done as follows.

    On the initial Field Dictionary Submenu, select the Inquire on Item Action Dand enter ?followedby up to nine of the first characters in the probable Field Identifier. For example, enter ?ACCasthe Field Identifier and the following Field Dictionary Search - S0216 screen is displayed.

    TDEV - SYSTEM Fi el d Di ct i onary sear ch S0216 03

    Fi el d I d Type Len Dec Text descr i pt i onScan ACC

    Sel ectACCTFLAG A 1 ACCOUNTI NG FLAGACCTMNTH N 2 ACCOUNTI NG MONTHACCTMONTH N 2 ACCOUNTI NG MONTH

    ACCTYEAR N 2 ACCTYEARACCTYR N 2 ACCOUNTI NG YEARBPRCACCMTH N 2 ACCOUNTI NG MONTHBPRCACCYR N 2 ACCOUNTI NG YEAR

    BottomF1=Hel p F3=Exi t

    On the above screen, a list of Field Dictionary entries is displayed in alphabetical order of FieldIdentifier, starting with the characters (if any) specified in the Field Identifier on the Submenu.

    Several search criteria are provided to redisplay the screen from a different starting point in the listof fields.

    It is possible to scan the database using any combination of the following search criteria:

    Field Id: Enter all or part of a field identifier to start the display with fields containing thecharacters entered.

    Type: Enter a valid field type. Valid values are:

    A - AlphanumericC - Currency and monetary amountD - DateE - Currency amount

    M - MonetaryN - Unsigned numericS - Signed numericT - TimeV - Variable lengthZ - Date/Time stamp

    Len: Enter a field length.

    Dec: Enter the number of decimal places.

    Text description: Enter all or part of a field text description.

    To display further information on a field, key any character in the Select field and press Enter.

    The Field Dictionary Maintenance screen - S0215 will be displayed.

  • 5/20/2018 SMART 1004 Developer s Guide

    16/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE13

    2.1.3. Maintaining Fields on the Dictionary

    NSDDEV - 0 - E Fi el d Di ct i onar y Mai ntenance S0215 02

    Fi el d i dent i f i er . . . . AXSCODE

    Name i n pr ogr am . . . . AXSCODEType . . . . . . . . . . A Edi t . . . . . . . . .Length . . . . . . . . . 4 Deci mal pl aces . . . .Al l ocated Lengt h . . . . Doubl e Byte Char Set .

    Def aul t Text Descr i pt i on ACCESS CODE - BATCH TRANSACTI ON CODECol umn Headi ng . . . . . ACCESS

    CODE

    Al t . Lang . .

    Wi ndow t ype . . . . . . I - L Conf i rmat i on f i el d .Tabl e . . . . . . . . . T1688 - S Er r or code . . . . . E044Programs . . . . . . . . P0127Addi t i onal F i el ds . . .

    Curr ency Fi el d . . . . .

    F1=Hel p F3=Exi t F4=Pr ompt

    This screen is used to create, modify, delete and enquire on Field Dictionary entries. When a fieldis being deleted, this screen is shown as a confirmation screen. Before deleting a field, ensurethat the field is not used. To remove the field from the system, delete the field in all environments.

    If Work Unit processing is in operation, for the create and modify options, the Register Object toWork Unit screen S0616 is displayed prior to S0215, to prompt the user to register the field to aWork Unit. Detailed information on Work Units is available in the SMART Administrators Guide.

    The Typeand Lengthfields are mandatory for every field definition.

    Al located Length is only applicable to variable length fields (type V).

    The Column Heading field is displayed online when Help is requested for a field and is alsoprinted in documentation. The field must be completed using lower case, initial capitals, andshould, where possible, be the name of the field as displayed on the screen.

    TheAl t. Lang field is used to select an input screen for Alternate Language Text Descriptions andColumn Headings, if Alternate Languages are defined in the current Level. If in Inquiry mode, thefield will be disabled if no Alternate Language descriptions have been defined for the field.

    The fields Window type through to Addi tional Fields inclusive are optional, depending on theextra processing or validation requirements of the field.

    The messageAl ternate Windows exist is displayed if alternative windowing details exist for thefield which is being maintained. These details are accessed via the Submenu.

  • 5/20/2018 SMART 1004 Developer s Guide

    17/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE14

    2.1.3.1. Currency and Monetary Fields

    Monetary and currency fields are identified by a Field Type of M (monetary amount), E(currency amount) or C (combined currency and monetary amount).

    For these field types, a Currency Fieldcan be entered. This field in itself must be an existingfield on the Field Dictionary. This currency field would normally be defined as an alphanumericfield with a field length of 3.

    For field types of M and C, the Decimal places field must be set to 2. For a field type of E, theDecimal places field has a maximum value of 6.

    If the Currency Fieldis specified on a field with a Field Type of M, this currency field must bepresent on any screen where the main field is used. Further information is available in theVariable Decimal Places in Numeric Fields Appendix (section 8.18).

    Fields with a type of E or C are used in conjunction with the Euro function key (PF14).

    2.1.4. WindowsThe SMART Field Dictionary goes further than defining attributes of a field. It also provides thecentral control for windowing and standard validation to be performed whenever data is enteredinto a field on a screen.

    Much of the data entered on transaction screens is in the form of codes. These codes aregenerally held on Tables. The Table window facility enables the user to select a Table code for afield whilst processing a screen transaction. Windowing is also available to enable the user toselect a system value such as a client or agent number. The window facility is initiated bypressing F4 with the cursor on the relevant field or entering ? in the field and pressing Enter.

    In order for a field to be eligible for a window, the window details must be entered against that

    field on the Field Dictionary. Details are held on the Field Dictionary Details file FLDDPF.Window details must be present for the field at the time the screen is compiled for the window tobe available on that screen.

    It is possible to define alternative windowing for a field according to the screen from which thewindow is invoked. This screen specific window processing is defined via the Alternative WindowDetails screen S0636. Where no alternative windowing definition is found for a field on aparticular screen, the details entered on S0215, if any, are used. Screen specific windowprocessing is described below.

    2.1.4.1. Window Types

    The first Window Typefield is used to define the type of windowing required, for example to aTable or to a client scroll program. Valid codes are held on the Window Types Table T1678.

    There may be a Confirmation fieldassociated with a window field, which is used to display adescription to confirm that the required item has been returned to the screen from whichwindowing was invoked. If a Confirmation field is required, the second Window Type field mustcontain a valid code from the Window Types Confirmation Table T1677, for example a longdescription of a table item or the name of a client. The Window Type codes associated with afield must be a valid combination on the Window Type/Sub Type Mixes Table T1676. TheConfirmation field must be unique and must be present on the screen from which windowing isinvoked.

    For Table windowing, the Table Company must also be entered: S (Sign-on), F (FSU) or 0

    (System).

  • 5/20/2018 SMART 1004 Developer s Guide

    18/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE15

    The Error code field must be defined for a field with a table window definition. Windowing isavailable to an Error Code Search screen S0133 for selection of the required code.

    The Programs field holds the program(s) which will perform the windowing. For Tablewindowing, program P0127 must be entered. For non Table windowing, the first program shouldbe the CLTWD module (or a clone of this module), followed by the program(s) required to carry

    out the Confirmation field processing. CLTWD saves the current stack, loads the subsequentprogram(s) for the Confirmation field processing and returns the original stack to the screen I/Omodule/screen control program.

    If specified, theAddi tional Fields field(s) must be present on the screen from which the windowwill be invoked (even if a non display field) and is used to pass a value to the window program, inaddition to the Window field.

    When the screen is generated, the Additional Fields are loaded into the ADDITIONAL-FIELDSfield within the WSSPWINDOW copybook. Note that the maximum combined length of alladditional fields is 200 characters.

    The following lines of working storage should be added to the relevant window programs:

    01 WSSP- WI NDOW- REDEFI NES.03 WSAA- addi t i onal - f i el d- name PI C x( nn)03 WSAA- addi t i onal - f i el d- name PI C x( nn)03 et c. . etc . .

    Within the procedure division of the window program, the following move statement transfers thepassed additional field information to working storage for manipulation within the program:

    MOVE ADDI TONAL- FI ELDS OF WSSP- USER- AREATO WSSP- WI NDOW- REDEFI NES.

    If the linkage data is to be modified and returned, then the move statement should be reversed.

    Please Note, it is no longer necessary to make changes to the WSSPWINDOW Copybook.

  • 5/20/2018 SMART 1004 Developer s Guide

    19/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE16

    2.1.4.2. Screen Specific Window Processing

    Where more than one windowing information definition is required for a field, select Action A -Create on the Field Dictionary Submenu and enter the alternative screen name in the AlternateWindow field. The Alternative Window Details screen S0636 is displayed which allows

    entry/maintenance of the window type information (see below).

    To access existing windowing definitions for a field, use the Prompt Function key on the AlternateWindow field on the Submenu. The Alternative Windowing Details window, S0635, is displayed.

    TSG S0635 01Al t er nati ve Wi ndowi ng Detai l s

    Fi el d I d. . : RFI D

    Sel ect Scr eenS0214

    F1=Hel p F3=Exi t

    To select a definition, enter any character in the Select field. The Screen selected is returned tothe Alternate Window field on the submenu. Select the appropriate Action on the submenu andpress Enter to access the Alternative Window Details screen, S0636.

    TDev Smar t Al t ernat i ve Wi ndow Det ai l s S0636 01

    Fi el d I d . . : RFI D

    Screen Name . . . . S0214

    Wi ndow Type . . . . W - G Conf i r mati on Fi el d .

    Wi ndow Tabl e. . . . - Err or Code . . . . .

    Pr ogr ams. . . . . . P0051

    Addi t i onal F i el ds .

    F1=Hel p F3=Exi t

    Completion of the fields on this screen is as described earlier. Details of the alternative screenand windowing definition are held on the Alternative Screen Windowing Details file SWNDPF.The alternative screen and related program must be recompiled. Whenever a window is invokedfor a field on a screen, the SWND file is checked for an alternative windowing definition for thatscreen. If no details exist on this file, the default details (if any) on the FLDD file are used.

  • 5/20/2018 SMART 1004 Developer s Guide

    20/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE17

    Field Dictionary Standards

    Please refer to the Appendix - Database Development Standards (section 8.1) for information onField Dictionary Standards.

    After defining a field using the Field Dictionary, you must add online documentation via the Help

    System. Help documentation is also used as a primary source of information for the SMARTAutomatic Documentation System, Scribe (see the section in this guide on Using Scribe toProduce a Hard Copy of Documentation).

  • 5/20/2018 SMART 1004 Developer s Guide

    21/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE18

    2.2. Documenting Fields via the Help System

    Documentation for fields is maintained online via the Help System. Several different levels ofHelp are provided to enable subsystems to be fully documented.

    Screen Help Field Help

    Error Help

    F

    F

    F

    S

    E E E

    Screen Help

    Screen Help documents the use of each online transaction screen. It also provides navigationalinformation, for example, the next screen users will expect to see if they press Enter. This level ofHelp should NOT be used to detail individual fields on the screen. This allows fields to be addedor removed from a screen without the screen Help having to be changed. (The use of a screendoes not usually change if some of the fields on it are changed.)

  • 5/20/2018 SMART 1004 Developer s Guide

    22/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE19

    Field Help

    Field Help may be generalised or screen specific. The generalised field Help contains thedefinition and usage of the field. This level of Help is also used to document database fields. Ineffect, it is used as a free format narrative area attached to entries in the Field Dictionary.

    Specific field level Help for a screen is used to override the generalised Help. This enablesspecific usage of that field for the screen in question to be defined. If there is no specific Help fora screen field, the system automatically uses the generalised field Help.

    Note: As the window facility enables a user to see what code entries are currently valid for ascreen field, valid entries should not be 'hard coded' in Field Help.

    Error Help

    Error Help information may be set up by the implementation team as required. Error Help isentered on a screen by screen basis and should provide the user with information on how toresolve the error situation for that specific screen.

    A basic set of Help is provided to enable the implementation team to understand and use thesystem. Facilities are also provided for tailoring the Help information to suit office procedures andpractices.

    For Help to be useful, it must be accurate. The Help Maintenance System allows changes to bemade quickly and easily, and all changes are immediately reflected in the system.

    The Help Maintenance System is accessed from the System Administration Master Menu, in thesign-on Company.

  • 5/20/2018 SMART 1004 Developer s Guide

    23/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE20

    2.2.1. Help Maintenance Subsystem

    NSDDEV - 0 - E Hel p Mai nt enance Submenu S0059 02

    A - Cr eat e hel p l i nesB - Modi f y hel p l i nesC - I nqui r e on hel p l i nesD - Transf er hel p l i nesE - Del et e hel p l i nes

    Hel p Type . . . S=Scr een, F=Fi el d, E=Er r orScreen . . . .Fi el d Name . . Fi el d hel p onl yErr or Number . Er r or hel p onl yLanguage . . . E

    Act i on . . . . C

    F1=Hel p F3=Exi t F4=Pr ompt

    The Help Maintenance Subsystem enables a user to create, modify, enquire upon, copy, translateand delete information. It is only possible to create or maintain Help in the developmentenvironment. The Help information can be entered at four levels; generalised field Help, screenspecific field Help, screen Help and error Help.

    To enter generalised field Help, enter a type of F and the Field Name. To enter screen specificfield Help, enter a type of F and both the Field Name and screen number. To enter screen Help,enter a type of S and the screen number. To enter error Help, enter a type of E and the errornumber.

    Help can also be created for Alternate Languages, if they are defined in the current Level.

    Various search facilities are available from the Help Maintenance Submenu, as described below.

  • 5/20/2018 SMART 1004 Developer s Guide

    24/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE21

    2.2.2. Field Dictionary Search

    To search for Help information on a particular field, on the Submenu enter a valid Field Identifierin the Field Name and a valid Help Type and an Action of C. Alternatively, enter ?followed by upto nine of the first characters in the probable Field Name. For example, enter ?ACC as the Field

    Name and the following Field Dictionary Search - S0216 screen is displayed.

    TDEV - SYSTEM Fi el d Di ct i onary sear ch S0216 03

    Fi el d I d Type Len Dec Text descr i pt i onScan ACC

    Sel ectACCTFLAG A 1 ACCOUNTI NG FLAGACCTMNTH N 2 ACCOUNTI NG MONTHACCTMONTH N 2 ACCOUNTI NG MONTHACCTYEAR N 2 ACCTYEARACCTYR N 2 ACCOUNTI NG YEAR

    BPRCACCMTH N 2 ACCOUNTI NG MONTHBPRCACCYR N 2 ACCOUNTI NG YEAR

    BottomF1=Hel p F3=Exi t

    On the above screen, a list of Field Dictionary entries is displayed in alphabetical order of FieldName, starting with the characters specified in the Field Name on the Submenu. To redisplay thescreen from a different starting point in the list of fields, enter the new search argument in theScan fields.

    To obtain or enter Help details for a field, key any character in the Select field and press Enter.The appropriate Help Maintenance screen will be displayed.

  • 5/20/2018 SMART 1004 Developer s Guide

    25/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE22

    2.2.3. Field Help Selection

    A search facility is available on Field Name in modify, enquire, copy and delete mode. This facilityshows all the defined field Help in the system. At the Submenu, enter a Help Type of F and pressEnter. The following screen is displayed.

    NSDDEV - 0 - E Fi el d Hel p Scrol l Sel ect i on S0062 02

    Language: E Type: F Screen:

    Sel ect Fi el d Fi rst l i ne of hel pABBDESC The descri pt i on of t he busi ness obj ect.ACCTFLAG Thi s f l ag cont r ol s t he r ecor ds whi ch are wr i t t en and t heACCTMONTH The account i ng mont h may or may not be t he same as t heACCTYEAR The account i ng year di f f ers f r omt he cal endar year i n t hatACPTHMAI NT The Access Pat h Mai nt enance Met hod defaul t s t o * I MMEDACTCODE Thi s f i el d di spl ays t he l i t er al ' On' or ' Of f ' , accor di ng t oACTI ON Act i on f i el ds are used on al l submenus and on t r ansact i onACTI VEFLAG Thi s f i el d di spl ays E ( Enabl ed) or D ( Di sabl ed) . I f t he

    ADDF Thi s i s t he name of a f i el d on t he scr een whi ch wi l l beADDRSS The gener al addr ess of t he company.ADMI NUSER The User I d of t he sel ect ed Work Uni t Admi ni st r at or .ALLI T Thi s f i el d di spl ays t he l i t eral for t he al t ernat i ve sequenceALLOCLEN Thi s f i el d i s onl y appl i cabl e t o a var i abl e l engt h f i el dALLOCNO Thi s i s a number whi ch i s gener at ed f or each user and i sALTWI NSCR To cr eat e al t ernat i ve wi ndowi ng detai l s f or a f i el d on aANDOR Thi s f i el d i ndi cat es i f t here i s an AND/ OR condi t i on. T +

    F1=Hel p F3=Exi t F5=Ref r esh

    There is no search argument available for this facility, but the list can be browsed using the PageUp and Page Down keys. To maintain a field's Help details, key any character in the Select fieldand press Enter. The appropriate Help Maintenance Screen will be displayed.

  • 5/20/2018 SMART 1004 Developer s Guide

    26/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE23

    2.2.4. Screen Field Help Selection

    A search facility is available on screen specific field Help details in modify, enquire, copy anddelete mode. This facility shows a list of all the screen specific field Help defined for a particularscreen number. At the Submenu, enter a Help Type of F, the relevant screen number and the

    required language and press Enter. The following screen is displayed.

    NSDDEV - 0 - E Fi el d Hel p Scrol l Sel ect i on S0062 02

    Language: E Type: F Screen: S0018

    Sel ect Fi el d Fi rst l i ne of hel pACCTMONTH Thi s i s t he accounti ng mont h i n whi ch you are worki ng. I t i sACCTYEAR Thi s i s t he account i ng year i n whi ch you are worki ng. I t i sBRANCH The br anch code i s entered on t he syst em menu. I t i sCOMPANY The company was ent ered on t he syst em menu. I t i s di spl ayedDESCRI PT Thi s i s t he name of t he menu whi ch you may r equest .TAB Thi s f i el d i s used t o posi t i on t he cur sor next t o t he opt i on

    F1=Hel p F3=Exi t F5=Ref r esh

    To take the requested action on the required field, key any character in the Select field and pressEnter. The appropriate Help Maintenance Screen will be displayed.

  • 5/20/2018 SMART 1004 Developer s Guide

    27/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE24

    2.2.5. Maintaining Help Details

    NSDDEV - 0 - E Hel p Mai nt enance S0060 02

    Language: E Type: F Screen: Fi el d: ACCTMONTH Err or :

    The account i ng month may or may not be t he same as t hecal endar mont h as i t i s dependent on t he begi nni ng of t hecompany' s f i nanci al year. Account i ng peri od i nf ormati on i shel d on t he Accounti ng Per i ods Tabl e T1698. Thi s Tabl et r ansl ates t he syst em date i nt o t he corr ect account i ngmonth.

    +

    F1=Hel p F3=Exi t F7=I nser t F8=Del et e F10=Par agraph F12=Cancel

    This screen is used to create and modify Help details.

    If Work Unit processing is in operation, the Register Object to Work Unit screen S0616 isdisplayed prior to the Help Maintenance screen, to prompt the user to register the Help to a WorkUnit. Detailed information on Work Units is available in the SMART Administrators Guide.

    The information entered on the Help Maintenance screen will appear exactly as typed. To format

    the information in paragraph format, use F10. A further Help Maintenance screen is displayedwhich allows the entry of a paragraph of Help text. Press Enter to format the text as it will bedisplayed i.e. justified. One paragraph of text should be entered at a time. Each time Enter ispressed, the above screen is re-displayed showing the information input so far.

    F7 is used to insert a blank line. F8 is used to delete a line.

    Help Standards

    Help text should be entered in lower case with initial capitals only.

    Use a blank line to separate logical sections/paragraphs.

    For screen Help, the title of the screen should be in upper case, underlined with the equals (=)

    character and separated from the Help text by one blank line.

  • 5/20/2018 SMART 1004 Developer s Guide

    28/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE25

    2.3. Error Codes

    SMART keeps all errors in a central file where they may be accessed by all programs asnecessary. Error messages are not hard coded in programs. The error file is multi-lingual which

    means that errors will be displayed in the current language of the session without any additionalcoding being required in the mainline program. The error codes are also company independent.

    Error codes are maintained via the Error Codes Subsystem or the Error Code Maintenance Viewin graphical SMART. The Error Code Maintenance Submenu is available from the SystemAdministration Master Menu, in the sign-on company. It is only possible to maintain error codes inthe development environment.

    Several programs may use the same error code. Before creating an error code to generate aparticular error message, check whether or not a suitable error code already exists.

    2.3.1. Error Code Maintenance Subsystem

    NSDDEV - 0 - E Er r or Code Mai nt enance Submenu S0052 02

    Err or Code A - Cr eat e

    B - Modi f y

    C - I nqui r e

    D - Del ete

    E - Transl at e

    ProgramNo . . . . . . . programspeci f i cErr or No . . . .Language . . . . E

    To Language . . . . . . t r ansl at e onl y

    Act i on . . . . . C

    Error codes may be created, modified, deleted, translated or enquired upon from this screen.This screen may also be used to set up alternative language text through the translate option.

    Note:To create an alternate language version of an error code, the code must already exist in thedefault language. The default Language is defined by setting the Function Key Priority of therelevant Language on Table T1680, to a value of 1.

    The program number can be used to directly link an error code to a program, but this is notusually entered as this restricts the use of the error code. The Error Number consists of 4alphanumeric characters.

    If the Error Number is left blank, a list of all error codes is displayed for browsing using the PageUp and Page Down keys. Further search options are available in this facility, as described below.

  • 5/20/2018 SMART 1004 Developer s Guide

    29/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE26

    2.3.2. Error Code Creation

    NSDDEV - 0 - E Err or Code Mai ntenance - Cr eate Err or Code S0053 02

    Program No . . :Er r or No . . . : E111Language . . . : EDescri pt i on . :

    F1=Hel p F3=Exi t F5=Ref r esh F12=Cancel

    Error codes are created using this window by entering the Error Number (and the programnumber, if required) and an Action of A at the Submenu.

    If Work Unit processing is in operation, the Register Object to Work Unit screen S0616 isdisplayed prior to the Error Code Creation screen, to prompt the user to register the Error Code to

    a Work Unit. Detailed information on Work Units is available in the SMART Administrators Guide.

    The Description field on S0053 is mandatory. The description entered here should be in thelanguage to which the user is signed on; any alternative languages can then be set up using theTranslate option.

  • 5/20/2018 SMART 1004 Developer s Guide

    30/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE27

    2.3.3. Error Code Enquiry Search

    NSDDEV - 0 - E Err or Codes mai ntenance - Scrol l sel ect i on S0051 02

    Start i ng posi t i on . . Scan . . .E001

    Sel ect Progr am Er r or Language Descr i pt i onE001 E SUBMENU UNAVAI LABLEE002 E Acct per d outsi de r angeE005 E I nval i d Act i onE006 E + I nval i d CompanyE007 E LANGUAGE UNAVAI LABLEE008 E Br anch not i n T1692E009 E Al r eady booked outE010 E Must be S or O.E011 E Menu not sanct i onedE012 E T1698 not cur r entE013 E T1698 Acct dat a mi ss i ngE015 E I nval i d Acct mont hE017 E Fromdat e > t o dat eE018 E Password not on f i l e

    E019 E I nval i d user +

    F1=Hel p F3=Exi t F5=Ref r esh

    This list of all errors defined is obtained by leaving the Error Number blank on the Submenu,selecting Action C and pressing Enter. A search can then be performed on Program Number,Error Number or text string as required.

    When a + is displayed by the Language value, this indicates that an alternate language versionexists.

    Once an entry has been selected, processing passes to the Error Code Enquiry screen.

    NSDDEV - 0 - E Err or Code Mai ntenance - Er r or Code Enqui r y S0053 02

    Program No . . :Er r or No . . . : A114Language . . . : EDescri pt i on . : See J ob Log f or det ai l s

    Al t . Lang . . +

    F1=Hel p F3=Exi t F5=Ref r esh F12=Cancel

    If an alternate language version has been defined an extra field Al t Lang will be displayed.Once selected, a list of the alternate language versions of the selected error will be displayed.

    NSDDEV - 0 - E Al t ernate l anguage versi ons S0056 01

    Language Descr i pt i onN Zi e J ob Log voor detai l s

    BottomF1=Hel p F3=Exi t F12=Cancel

  • 5/20/2018 SMART 1004 Developer s Guide

    31/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE28

    2.3.4. Error Code Maintenance Search

    NSDDEV - 0 - E Err or Codes mai ntenance - Scrol l sel ect i on S0051 02

    Start i ng posi t i on . . Scan . . .A

    Sel ect Progr am Er r or Language Descr i pt i onA114 E + See J ob Log f or det ai l sA115 E Maxi mum Level s i n SMM001A116 E Key Seq. must st ar t at 1A117 E I ncr ement Key Seq. by 01A118 E Per mi t t ed Val ues; 0, 1A119 E Fi el d i s out put onl y!A120 E Run Type not on T1706A121 E Parm. Pr ompt not Val i dA122 E No Par m. Pr ompt At t achedA123 E No Par amet er s Pr e- LoadedA125 E User Type not on T1712A126 E Use onl i ne Commands

    A127 E No Author i t y t o Act i onA128 E Not Author i sed f or LevelA129 E Use User Secur i t y Menu +

    F1=Hel p F3=Exi t F5=Ref r esh

    This list of all errors defined is obtained by leaving the Error Number blank on the Submenu,selecting the required Option Code and pressing Enter. A search can then be performed onProgram Number, Error Number or text string as required. The Error Numbers that requiremodification, deletion or translation can then be selected by placing any non-blank character inthe Select field. Several Error Numbers can be selected, spread over many pages, to beprocessed consecutively.

    Once an entry has been selected and Enter pressed, processing passes through to the AmendError Code screen, the Delete Error Code screen or the Translate screen, depending on theoption selected at the Submenu.

    Note:When a + is displayed by the Language value, this indicates that an alternate languageversion exists.

  • 5/20/2018 SMART 1004 Developer s Guide

    32/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE29

    2.3.5. Amend Error Codes

    NSDDEV - 0 - E Err or Code Mai nt enance - Amend Er r or Code S0053 02

    Program No . . :Er r or No . . . : A114Language . . . : EDescri pt i on . : See J ob Log f or det ai l s

    F1=Hel p F3=Exi t F5=Ref r esh F12=Cancel

    This window is presented for each Error Number requiring modification, selected from the searchfacility or directly from the Submenu. The only field that can be modified is the Description; allother fields are protected.

    If Work Unit processing is in operation, the Register Object to Work Unit screen S0616 isdisplayed prior to the Amend Error Codes screen, to prompt the user to register the Error Code toa Work Unit. Detailed information on Work Units is available in the SMART Administrators Guide.

  • 5/20/2018 SMART 1004 Developer s Guide

    33/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE30

    2.3.6. Delete Error Codes

    NSDDEV - 0 - E Err or Code Mai ntenance - Del et e Err or Code S0053 02

    Program No . . :Er r or No . . . : A116Language . . . : EDescr i pt i on . : Key Seq. must star t at 1

    Del ete Err or Code ( Y/ N) N

    F1=Hel p F3=Exi t F5=Ref r esh F12=Cancel

    This window is presented for each Error Number to be deleted, selected from the search facility orentered directly on the Submenu. The only field that may be changed is the deletion confirmationfield. If this field is left as N and Enter pressed, no deletion will take place. To delete the Error,change this field to Y and press Enter. Before deleting an Error code, ensure that the code is notused. To remove the Error from the system, delete the Error code in all environments. Ensure,

    also, that the Error code is removed from all programs.Note:All Alternate Language error codes must be deleted, before the default language error codecan be deleted.

  • 5/20/2018 SMART 1004 Developer s Guide

    34/276

    SMART Developer'sGuide

    ThisdocumentissubjecttotheconditionsintheForewordCSCComputerSciencesLimited.AllRightsReserved.

    COMMERCIALINCONFIDENCE31

    2.3.7. Translate Error Codes

    NSDDEV - 0 - E Err or Codes Mai ntenance - Tr ansl at e S0054 02

    Progr am No . . :Er r or No . . . : A116

    Fr om - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - > To

    Language : E Engl i sh Language : D Ot her

    Desc . . : Key Seq. must st art at 1 Desc . . :

    This screen is presented for each Error Number selected for translation from the search facility orentered directly on the Submenu. The error information displayed on the left is as defined for thelanguage to which the user is signed on; the information on the right shows the language selectedon the Submenu. The user is prompted to enter the description in the appropriate language. Thisis the only field that may be modified on this screen and it is mandatory.

  • 5/20/2018 SMART 1004 Developer s Guide

    35/276

    SMART Developer'sGuide

    Thisdocumentissubjec