1. GENERAL INFORMATION V7R1M0...3

Transcription

1 1 of GENERAL INFORMATION DEFINITIONS USED IN THIS DOCUMENT EDIFACT CATALOGUES SUPPORTED OPERATING SYSTEM REQUIREMENTS SOFTWARE LICENSING DATA DEFINITIONS STANDARD APPLICATION INTERFACES SUPPORTED USER MANUAL SYSTEM MAIN MENU WORK WITH TRADING PARTNER INFORMATION CHANGE TRADING PARTNER INFORMATION WORK WITH EXCHANGE INFORMATION CHANGE EXCHANGE INFORMATION (RECEIVE DATA) CHANGE EXCHANGE INFORMATION (SEND DATA) VIEW TRADING PARTNER LOG (EXCHANGES) VIEW TRADING PARTNER LOG (MESSAGES) View log entry details (exchange) View log entry details (messages) View segment details (exchanges/messages) View segment details (in segment mode) View segment contents WORK WITH EDI MAILBOX WORK WITH EDI SESSION LOG VIEW SYSTEM LOG MESSAGES View system log message (details) SYSTEM CONTROL MENU Construct EDIFACT file (EDIFCNST) Receive EDIFACT file (EDIFTRN) Construct XML file (EDIFXMLOUT) Receive XML file (EDIFXMLIN) Generate JSON file (EDIFJSOOUT) Receive JSON file (EDIFJSONIN) Work with backup incoming/outgoing EDI data Set system data area Update system parameters EDIF file status Update parameter file Work with EDIF/400E subsystem jobs Cleanup logs FAQ - THE HOW TO SECTION HOW DO I INSTALL THE EDIF/400E SOFTWARE FROM CD? HOW DO I INSTALL A PTF/UPGRADE TO THE EDIF/400E SOFTWARE FROM CD? HOW DO I INSTALL A PTF/UPGRADE TO THE EDIF/400E SOFTWARE FROM A SAVEFILE? CALLABLE API S ASSIGN SYSTEM COUNTER VIEW EDI DATA of 48

2 2 of UPGRADE INFORMATION APPENDIX FILE NAME REPLACEMENT VALUES of 48

3 3 of 48 General information 1 Edif/400 version is an EDIFACT translation software package for translation of incoming and construction of outgoing EDIFACT, XML and JSON messages. The EDIFACT software package is segment based, I.e. the segments that make up an EDIFACT message is the core of the system. This makes the software easy to use, and the software supports all message types within a catalogue. This documentation is intended for use by personnel responsible for controlling the EDI environment at the installation, and therefore assumes a minimum level of knowledge of EDI, EDIFACT, JSON, XML and the I5/OS (OS400) operating system Definitions used in this document Message=One message type/catalogue IFTMIN S93A IFTMIN 1902 This is counted as 2 messages. Note: CONTRL message is not counted as a message when calculating the number of messages used at an installation. Exchange=A set of messages contained within an EDI envelope (UNB-UNZ segments) 1.2. EDIFACT catalogues supported The following EDIFACT catalogues is supported by this release: 1.901, 1.902, S93A, D93A, D94A, D94B, D96A, D96B, D97A, D97B, D98A, D98B, D99A, D99B, D00A, D00B, D01A, D01B, D02A, D02B, D03A, D03B, D04A, D04B, D05A, D05B, D06A, D06B, D07A, D07B, D08A,D08B,D09A,D09B,D10A. In addition CONTRL message version 3.1 Is supported Operating system requirements The software requires a minimum level of OS400/. It is advised to install the most current level of cumulative PTF package for the operating system before installing and operating the software. 3 of 48

4 of 48 Software licensing A valid software licence must be obtained before operating the software. The software can be licensed to a limited number of messages. If this limit is reached, the function for entering new exchanges is disabled, and a new licence key must be obtained at an additional cost. If your iseries is partitioned, a separate licence is required for each partition you wish to install EDIF400 in. The install screen shows the partition number you are installing in. 4 of 48

5 2 5 of 48 Data definitions Object EDIF400 EDIF400 EDIF400 EDIF400 EDIF400AUT Object type *lib *jobd *sbsd *jobq *jobq PEDIFIHI *file PEDIFIHO *file QSEGWRK sourcefile EDI400CNV sourcefile QSEGWRKSAV *SAVF PEDIFXMLDI *file PEDIFXMLDO *file PEDIFJSONI PEDIJSONO *file *file Description Software library Standard job description for batch jobs Subsystem description Jobq for EDIF/400E jobs Jobq for EDIF/400E autojobs unlimited number of concurrent jobs Standard interface file for incoming EDIFACT data Standard file for outgoing EDIFACT data All structures for supported catalogues Source for conversion of EDI400 data to EDIF/400e Savefile containing sourcefile QSEGWRK Standard interface file for incoming XML data Standard file for outgoing XML data Standard file incoming JSON data Standard file outgoing JSON data 5 of 48

6 3 6 of 48 Standard application interfaces supported The following applications is supported: Visma (This software is now owned by ECP AS renamed ECF400) Visma (This software is now owned by ECP AS as is. 6 of 48 EDIFRAKT and has been EDITRADE and is supported

7 4 7 of 48 User manual This manual is intended for use by personnel familiar with OS/400 operating system and with a basic knowledge of EDI/EDIFACT/XML/JSON standards. 7 of 48

8 4.1. System main menu This menu contains the main functions to monitor the system events. 8 of 48 8 of 48

9 of 48 Work with trading partner information Lists all trading partners active at this installation. Functions for entering new partners, changing, copying and deleting partner information, work with exchange information, and view log data. 9 of 48

10 of 48 Change trading partner information Trading partner information screen. Keep log data number of days log data should be kept in the database. When the housekeeping job is run, log data older than the number of days entered here is deleted from the database. EDI data file prefix When generating EDI files the files are given a name based on the prefix and a system counter. The files are then placed in the library specified in the field EDI data file library. 10 of 48

11 of 48 Work with exchange information Shows the various messages that are exchanged with this trading partner. New exchange types allowed the number of exchanges that your current licence allows you to create. When the limit is reached, you must either buy an additional number of exchanges, or delete obsolete exchanges from your database. 11 of 48

12 of 48 Change exchange information (receive data) For receive exchanges a minimum of data to identify the message is required, the message type and release, and the sender and receiver information. It is also possible to override the file to which the translated data is written. Note that the file does not have to exist before incoming data is received for this exchange. If the file does not exist at that time, the data is sent to the default inhouse file defined on the EDIFTRN command and a message is logged to the system log file. 12 of 48

13 of 48 Change exchange information (send data) The fields in this screen correspond to the EDIFACT definition of the UNB and UNH segment. Please refer to the appropriate EDIFACT documentation for further information. NOTE. The UNH segment data will only be used if the data is NOT present in the inhouse file. UNB prefix: if this partner requires a specific field value in the UNB transmission reference field, this value can be used to set the field prefix and the transmission counter from the exchange is used to ensure an unique reference. The field length of a prefixed UNB reference is 14 bytes. If UNB prefix is set to *NO, a numeric reference is generated from the transmission counter. The field length of the element is then determined by the value of the counter, as leading zeroes will be removed. If this field is left blank, the UNB reference is generated according to the values specified in the system setup screen. Send zeros values: If this value is set to Y, messages generated will send numeric field with the value of zero as a single 0. If the value is N, zero values will not be generated. MOA+22:0:NOK' Send zero values = Y MOA+22::NOK' Send zero values = N Supress leading blanks: If this value is set to Y, leading blanks in alphanumeric data fields in the inhouse file will be removed before the field is inserted in the EDI message. EDI file FMT : R=One record per segment, W=Wrapped file. NOTE, R is only valid when the output file record length is 1024 bytes. EDI file record length : Accepted values are 80,132 and 1024 bytes. 13 of 48

14 14 of 48 If USE IFS for output is Y a pop-up screen with fields for file directory and file name is displayed. If the directory field is left blank the default directory for edi files is used /ECP/edif400/out/edi/<tradingpartner> If the file name field is left blank the systems generates a default file name - <message>*iso*t06.edi e.g. (orders edi). The IFS file is generated with code page 850 and formatting is the same as for the i5/os DB2 file (wrapped/recordformat and record length). 14 of 48

15 of 48 View trading partner log (exchanges) This screen shows the log information for the trading partner. By changing the values in the top of the screen, you can display either incoming or outgoing data, at exchange level or at message level. Status fields shown in the screen has the following meaning: T=Test indicator, value '*' = the message is a test message A=Incoming message requesting CONTRL message (Value = 1) A=Outgoing CONTRL message. 1=CONTRL message sendt S=Status 0=Ok 15 of 48

16 of 48 View trading partner log (messages) This screen shows incoming messages for the trading partner. By selecting a message type or a start date you can limit the search. Selecting function E will display the EDI data of the message. Selecting function L will display the EDI error log for the message (if any errors have been logged). Status fields shown in the screen has the following meaning: T=Test indicator, value '*' = the message is a test message A=Incoming message requesting CONTRL message (Value = 1) I=Outgoing CONTRL message. 1=CONTRL message sendt S=Status 0=Ok 16 of 48

17 17 of View log entry details (exchange) Shows the details for this exchange. UNH count is the number of messages within this exchange. EDI file name is the name of the EDI file that contains the EDIFACT data. F8 displays the archive status for the incoming data. The backup may be retranslated using F24 if the screen indicates that backup data is present. F23 displays the backup file if present. 17 of 48

18 18 of of 48

19 View log entry details (messages) Segment count is the actual number of segments within the message. Link ID is the user field EDLINK from the inhouse file that is the basis for this message. This is used as cross reference between EDIf/400 and the user application. 19 of of 48

20 20 of View segment details (exchanges/messages) Shows the EDIFACT data of the message as sent or received. If display mode S for segment mode is selected, the screen display changes to one line of data pr. Segment to increase readability. A search string can be entered to search for specific data within the message. Use F16 to start the search. If the string is found, the colour of the screen line where the search string occurs is set to white. If F16 is pressed again, the search continues from the next line. The search function gives the best result in segment mode, but can be used in wrapped mode as well. F17 & F18 can be used to go to the to/bottom of the message. 20 of 48

21 21 of View segment details (in segment mode) If the segment data is longer than the screen line, selection 5 will display the full contents of the segment. 21 of 48

22 View segment contents 22 of of 48

23 of 48 Work with EDI mailbox Displays all messages, incoming or outgoing. Messages can be selected by date and message type. 23 of 48

24 of 48 Work with EDI session log Shows the session log entries in descending order by date/time. Incoming sessions are shown in white, and outgoing sessions in green. Selection of date/time, type of session and partner id is available to limit the search. Use selection 5 to view details, and selection M to view the messages within the session. Please refer to the section View partner log for further explanation of the screens. 24 of 48

25 of 48 View system log messages In this log a number of events is logged. Check this log for error messages if something is not working properly. Selection 5 will show the complete log text. F9 changes display mode, fold/unfold subfile. 25 of 48

26 View system log message (details) 26 of of 48

27 of 48 System control menu This menu contains system administration functions, and gives access to interactively run the translation/construction commands. To access this menu the user must be enrolled in the system access directory. Entering option 93 on this menu does this. By default the security officer profile, QSECOFR is enrolled in the directory, and when installing the system this user profile should be used. Note: In the upper left corner of this screen is the current release and displayed is the year and daynumber the PTF was released. 27 of 48

28 28 of Construct EDIFACT file (EDIFCNST) Command for constructing outgoing EDIFACT messages. This command is normally integrated into the user application, but can also be run from the system menu for test purposes. Transmit file library the library name for the generated EDI file. *SYSDFN indicates that the library is the default library from the system data area (Menu ID=90). If *SYSDFN is used and no Default EDI data library is selected in system parameters, the library EDIF400DTA is created and the system parameters are updated with this value. NOTE. If a file name is entered on the command, the record length of that file controls what data is processed in the session. Only exchanges that have a record length that is equal to the record length of the file specified will be processed. See section Change exchange information (send data) Delete inhouse data after construction a Y indicates that the inhouse file data is physically deleted after construction of the message. N indicates that the inhouse data is kept in the file with status fields EDPOS1=X and EDPOS2=99. These records will be deleted in the normal cleanup job. Submit to jobq Y submits the job to jobq EDIF400 in library EDIF400 that runs in Subsystem EDIF400. This is the recommended value. 28 of 48

29 29 of Receive EDIFACT file (EDIFTRN) This command is normally integrated into the user application, but can also be run from the system menu for test purposes. The command accepts data both from the HFS and IFS file system. Archive/delete after xlate The system can archive and/or delete the incoming data after translation. HFS data backup is stored as file members in datafiles in EDIF400. IFS files are stored in the folder /ecp/edif400/in/edi/archive. The data may be retranslated if required from the Work with log function. Y=For HFS input the input file is archived. For IFS input Y has the same function as A. A=File is archived and the original file is deleteted after succsessful translation. D=The file is deleted after translation and NO backup is taken. N=No archive/delete action is taken. Submit to jobq Y submits the job to jobq EDIF400 in library EDIF400 that runs in Subsystem EDIF400. This is the recommended value. NOTE! If QTEMP is the library where the EDIfile is placed, submit to jobq is not allowed. 29 of 48

30 Construct XML file (EDIFXMLOUT) 30 of of 48

31 31 of Receive XML file (EDIFXMLIN) This command is normally integrated into the user application, but can also be run from the system menu for test purposes. The command accepts data both from the HFS and IFS file system. Archive/delete after xlate The system can archive and/or delete the incoming data after translation. HFS data backup is stored as file members in datafiles in EDIF400. IFS files are stored in the folder /ecp/edif400/in/xml/archive. The data may be retranslated if required from the Work with log function. A=File is archived and the original file is deleteted after succsessful translation. D=The file is deleted after translation and NO backup is taken. N=No archive/delete action is taken. Submit to jobq Y submits the job to jobq EDIF400 in library EDIF400 that runs in Subsystem EDIF400. This is the recommended value. NOTE! If QTEMP is the library where the XMLfile is placed, submit to jobq is not allowed. 31 of 48

32 Generate JSON file (EDIFJSOOUT) 32 of of 48

33 33 of Receive JSON file (EDIFJSONIN) This command is normally integrated into the user application, but can also be run from the system menu for test purposes. The command accepts data both from the HFS and IFS file system. Archive/delete after xlate The system can archive and/or delete the incoming data after translation. HFS data backup is stored as file members in datafiles in EDIF400. IFS files are stored in the folder /ecp/edif400/in/json/archive. The data may be retranslated if required from the Work with log function. A=File is archived and the original file is deleteted after succsessful translation. D=The file is deleted after translation and NO backup is taken. N=No archive/delete action is taken. Submit to jobq Y submits the job to jobq EDIF400 in library EDIF400 that runs in Subsystem EDIF400. This is the recommended value. NOTE! If QTEMP is the library where the JSONfile is placed, submit to jobq is not allowed. 33 of 48

34 34 of Work with backup incoming/outgoing EDI data Each Receive incoming EDIFACT/XML/JSON messages session may back up the data file to be processed before any processing takes place. The data file can be viewed by selecting function 5 which call the standard OS/400 DSPPFM command. Incoming EDI/XML/JSON data can be processed again by entering function R for retranslate. The retranslate function copies the data to a temporary work file and calls the standard translation function. 34 of 48

35 Set system data area 35 of of 48

36 36 of 48 This function should only be used by personnel familiar with the OS/400 operating system. The screen displays the current version of the software installed and the of the software. This screen can be used to define a default library for outgoing EDI files, and to set the log level for translation/construction jobs. 36 of 48

37 37 of Update system parameters System name is displayed on the top line of every screen. The address fields are for information only. UNB prefix is defining how a default UNB reference field is generated. If a value is entered the UNB reference field will be generated as unb prefix+numeric value (10 digits) from the UNB counter in file PNBRCNT. The total field length of the element is 14 bytes. 37 of 48

38 38 of 48 If UNB prefix is set to *NO, a numeric reference is generated from the UNB counter in file PNBRCNT. The field length of the element is then determined by the value of the counter, as leading zeroes will be removed. Keep EDI backup data for nnn days. EDIf/400 can keep a backup of all incoming and outgoing EDI messages for a set number of days. If disk space is limited, this value can be reduced. The default value at system installation is 60 days. Keep XML/JSON backup data for nnn days. EDIf/400 can keep a backup of all incoming and outgoing XML/JSON messages for a set number of days. If disk space is limited, this value can be reduced. The default value at system installation is 60 days. New security code. This field should only be changed when a new licence code is required. This is when a serial number change has occurred or a change in the number of exchanges is required. Entering an invalid value in this field followed by F6 will disable the system! After changing the security code, check the data in line 4 of the screen to verify that the serial number, model, expire date, partition and number of exchanges is correct. The usage counters UNB, UNH, segment, log and file counters in/out are for information only and indicates the system usage after installation. 38 of 48

39 of 48 EDIF file status If the delete % is large for some files the cleanup job with reorganization should be run to free space. To run cleanup use menu function 95 on the system menu and select Y for reorganization. No EDIF400 jobs should be active when this job is run. 39 of 48

40 of 48 Update parameter file This file contains multiple parameter values for various functions in the system. SYSACCESS Controls the access to system menu from main menu. At system installation time the QSECOFR user profile is allowed system access. 40 of 48

41 of 48 Work with EDIF/400E subsystem jobs EDIF400LOG is the autojob for compressing incoming and outgoing EDI logdata. 41 of 48

42 of 48 Cleanup logs Submits the cleanup job to jobq EDIF400 in subsystem EDIF400. If reorganization is set to Y, the programme will attempt to run RGZPFM on the log files after deleting log data. This should only be done when there is no other activity involving EDIF/400 files. The command EDIFCLEAN should be included in the installations job scheduling system and run at times with no system activity. 42 of 48

43 5 43 of 48 FAQ - the how to section 5.1. How do I install a PTF/upgrade to the software from a SAVEFILE? Back up the existing software The system savefile must be named EDIF400 and be placed in library QGPL ===> RSTOBJ OBJ(CINSEDIF) SAVLIB(EDIF400) DEV(*SAVF) SAVF(QGPL/EDIF400) MBROPT(*ALL) ALWOBJDIF(*ALL) RSTLIB(QGPL) CALL QGPL/CINSEDIF parm( *SAVF U ) Check joblog for error messages Verify that your data files have been converted by checking Trading Partners, Logs and sessions. 43 of 48

44 6 44 of 48 Callable API s 6.1. Assign system counter CALL EDIFGETCOU parm(&counterid &COUNTER &ALFCOUNT) Parameter IN &COUNTERID *CHAR 10 OUT &COUNTER *DEC 10 OUT &ALFCOUNT *CHAR 10 counter Counter ID Counter Same value as but in character format This api can be used to assign unique counters for various purposes. The following counter ID s are system defined and should not be used: SAVEFILE SYSBUILD UNB UNH BACKUP IN BACKUP_OUT EDIFILE E1KEY LOG 6.2. View EDI data CALL EDIFEAPI parm(&logid &RETURNCODE) Parameter IN &LOGID OUT &RETURNCODE *DEC 10 *CHAR 1 Log ID# Returncode Returncode 0 successful call, 1 Log ID not found in EDIF/400 database 44 of 48

45 7 45 of 48 Upgrade information When upgrading to the segment definitions in file QSEGWRK must be compiled and any interface programmes using these definitions must be recompiled. This is due to field length changes. 8 Appendix 8.1. File name replacement values When constructing file names a number of replacement values are available. *aaa *LNK *DMY *MDY *EUR *ISO *JNB *JOB *JUL *MSK *T04 *T06 *T08 *UD1 *UD2 *UD3 *P01 *xxx If key is found in PEDIFPARMS the value from parameter file will be inserted. Link field from inhouse file (if used). Must be in parameter PAROOT in parameterlist. in ddmmyy format (6 digits) USA format mmddyy (6 digits) European date format (8 digits) ISO date Job number (6 digits) Job name 10 characters Short julian date (5 digits) Milliseconds from timestamp (5 digits) Time value HHMM (4 digits) Time value TTMMSS (6 digits) Time value TTMMSSMM (8digits) Userdata 1 field form exchange Userdata 2 field from exchange Userdata 3 field from exchange P01-P10 will generate a counter from the exchange 1-10 byte long. Any other value than the above will generate a counter for the counterfile with counter key = FileCxxx 45 of 48

46 46 of 48 When combining parameters and text the user must ensure that the generated file name is according to the syntax rules of the file system where the file is to be created. The EDIF400 generated filename has a limit of 128 byte for the IFS file system. File and member name length for i5/os QSYS.LIB is 10 byte Additional software required The library ECPSECLIB must be present for EDIF400 to function. 46 of 48

47 of 48 Receive all files in IFS directory Command EDIFRCIFS receives all EDIFACT, JSON and/or XML files in a given directory or by generic file name. The value entered in IFS folder/generic file name must be found in EDIFACT, XML or JSON receive exchange definitions : If *ALL files are selected on command only files with file extension.edi,.json or.xml are processed. If *EDI, *JSON or *XML is selected, all files matching the generic file name are processed redgardless of extension. For XML and JSON the files in the directory/generic file name must be for the same partner. For EDIFACT the files can be for multiple partners as partner id is decoded from the UNB segment in the file. 47 of 48

48 48 of 48 This command is used by programmers to interface inhouse data with EDIF400 processing and is not included in the EDIF400 menu system. 48 of 48