Welcome to the engdax User Manual

Transcription

1 Welcome to the engdax User Manual Version 2.1

2 INDEX 1. General guidelines for the handling of engdax The engdax window Log in on engdax Log out from engdax Automatic Log out from engdax Sending Data Files Sending to companies ODETTE Sending to users (employees) ENGDAT Details of transmitted orders Abortion of orders Receiving Data Files Saving data files Transmission Status Archiving Orders / 23

3 1. General guidelines for the handling of engdax The handling of engdax is carried out via HTML based interfaces. You can use all functions of the software from your web browser. You can start engdax from almost every network computer. The only condition is that the client computer has access to the engdax computer on network level. With an active firewall the ports 80, 1433 and 2710 must be open on the engdax server. To be able to use correctly all engdax functions the Flash Plugins and Microsoft Silverlight should be installed on the client computers. You find them in the folder ISSetupPrerequisites of the set up routine. You access engdax with your web browser. Therefore please start the browser on your computer. Fill in in the address bar of your browser. For example: Your administrator provides you with the exact address (IP Adress/DNS name of the DAXware computer) The engdax window Company and Name of the logged in user Menu bar Main window Logout Button and language selector 3 / 23

4 2. Log on to engdax To log in on the system you need user name and password. Ask your engdax system administrator for them. Now enter them into the according fields of the interface. Then click on. If your entries were correct you are passed on to your personal welcome page. 4 / 23

5 If the log on was incorrect the following window appears: The logon is case-sensitive, this means that upper and lower case of the password are checked. Please check first if you mistyped or if the caps lock is active. If the log in has failed despite the correct entry of your login data, you should consult your engdax system administrator who can check your entries in engdax and overwrite them if necessary. Please note definitely the message, which engdax communicates you under the login window. If you receive a message which you cannot interprete, please contact your engdax system administrator at first! Example for such a message: 5 / 23

6 3. Log out from engdax If you want to log out click the button on the top right corner of the user interface Automatic Log out from engdax If you do not carry out any activities on the system for 20 minutes you are automatically logged out. If you want to carry on you have to log in again with your access data. In this case engdax memorizes the most recently performed action. If you close the explorer window without a correct logout, the session stays active for further 20 minutes. If a Floating Licence is used no other user can use the licence for this period. 6 / 23

7 4. Sending Data Files In order to send data files to your partners you have to change to the tab. In Partner selection you decide if files should be sent via mere ODETTE (company to company) or via ENGDAT standard (user to user). If you select a user (employee), deposited from the administrator, automatically an ENGDAT packet is created. If you choose instead the ODETTE user, the order is sent via ODETTE without ENGDAT support. If you miss an exchange partner or employee, your engdax system administrator has either not registered the according partner yet or you have not yet received a data exchange agreement with this partner. In this case please consult your engdax system administrator who can provide you the according settings. 7 / 23

8 4.1. Sending to companies ODETTE Select at first the partner company from the list to whom you want to send data files. Mark now the user ODETTE-User. On the right side of the main window appears an area where you can select files. Upload files to be sent with the button appears.. By clicking the button the list of files to be selected Click now the button now one file respectively several files.. With your browser you can select the location of your file. Mark 8 / 23

9 Select the files which you want to send and confirm with Open. Now they appear in the list of files to be uploaded. Load the files to the system by clicking to be able to send them. Close the window after the successful uploading with. 9 / 23

10 Now the files are displayed in the list. Create now a send order by clicking. It appears a summary of the order with all information details, parameters and files. If you want to send the same files to another partner, too, click. The order is created in the background and is now listed under the tab. 10 / 23

11 The status of an order and the progress bar show you how far an order has been transferred. The file is being sent. The successful sending of a file is indicated under the tab status flag. with the 11 / 23

12 4.2. Sending to users (employees) ENGDAT First select from the list the partner to whom you want to send your data files. Now mark the user (employee) to whom your files should be sent. On the right side of the main window appears now an area where you can select files. Upload the files to be sent with the button selected appears.. After clicking the button the list with the files to be 12 / 23

13 Click now several files.. With your browser you can select the location of your file. Mark now one or Select the file which you want to send and confirm with Open. It appears now the list of files to be uploaded. Upload the files to the system by clicking to be able to send them. After the successful upload close now the window with. 13 / 23

14 Now the files are displayed in the list. ENGDAT specific information: Package type -> Obligatory The package type indicates the ENGDAT protocol version with which files should be sent. There are the versions V1, V2 and V3 available. At the moment the standard version is V2, which can be processed by any ENGDAT system. If your partner requires another version he will inform you separately. ENGDAT- Compression -> Optional The ENGDAT protocol includes the compression of user data with the format gzip. When you activate the compression for an order, all files of this order are separately packed for the transmission. Therewith the data volume of this order is reduced. The compression is carried out in the background and not visible for the user. Each system which is able to process ENGDAT orders can decompress independently automatically and without effort of the user incoming ENGDAT files, compressed with ENGDAT compression, This is carried out in the background and not visible for the user. The automatic decompressing applies not for transferred zip, tar, or rar formats. Tempoary Exchange Profile -> Obligatory In case of ENGDAT orders you have to indicate the kind of files in the package. Specify the parameter of the generating system, the file format and the character set. This information is obligatory and must be filled in. Your system administrator can adjust and complete the information details. He can summarise the information in a so-called Exchange Profile and deposit it firmly. It spares you the manual selection at each sending order. Contact your system administrator if you want him to deposit it. 14 / 23

15 Exchange Profile -> Optional Usage -> Optional Free Text -> Optional see: Temporary Exchange Profile There are pre-defined values concerning the purpose of files in an ENGDAT package which can be selected from a drop-down menu. This is an optional value, which need not to be selected. The selection parameter cannot be adjusted because they are fixedly deposited in the ENGDAT protocol. To provide the receiver with additional comments, you can use the Free text field. As it is optional you need not necessarily fill it in. When you have indicated respectively selected all parameters you can create the order by clicking the button. 15 / 23

16 It appears a summary: If you want to send the same files to another partner, too, click the button The order is created in the background and is now listed under the tab. engdax creates automatically the Abstract File which is associated with an ENGDAT package containing all information concerning the user data of the order. The order status and the progress bar show you how far the order has already been transferred. 16 / 23

17 The data file is being sent. The status flag under the tab informs you on the successful processing of the order Details of transmitted orders In the details of an order you can see which data files have been transmitted at which time. Here you can verify as well if the data file transfer was successful. In case of an error you can check in the so-called ProcessCard where the problem may be. You can open the details by clicking at the beginning of an order row. They are structured as follows. Virtual file name The partner receives the data file with this name. Status The momentary transmission status of a file. Finished means, the data file has completely been transferred to a partner. If your system administrator has activated this function, you can download the data file once more and save it. In case of errors or problems you can check the cause in the ProcessCard. ODETTE orders: ENGDAT orders: 17 / 23

18 4.4. Abortion of orders Your engdax system administrator can de-activate this function. If you want to abort the transmission of a created and perhaps already sent off order you can do it simply by clicking in ->. Now the channel, which is used for the transmission is closed immediately and the order transmission is completely aborted. Thus the sending of the data files of this order at a later time is no longer possible. The status is now orange, which means the task is aborted manually. If you want to abort an erroneous order you can do this in the section. Here you can abort the order transmission with as well. 18 / 23

19 If the error is known and you could fix it, your administrator can re-activate the order transmission with. This function is only available for your engdax system administrator because only he can correct possible failures (for example missing entries in the master data of a partner). 19 / 23

20 5. Receiving Data Files Received data files are listed under the tab. Here you can see all orders received and determined for you, like in the section. Your engdax system administrator can grant you permission to access OFTP receipts as well as not assignable ENGDAT packets in this list. The list accumulates to a maximum of 20 entries per page. If there are more transmissions, new pages are created which can be selected via the page number at the bottom of the list. The list shows, as already known from the section, all necessary information, such as sender, receiver (employee or ODETTE user), time of reception and status of the order. The order status is structured as follows: - green flag, indicates a successfully received order - yellow flag, indicates an order in the receiving process at the moment - orange flag, indicates a manually aborted order transmission - red flag, indicates an error during the transmission process 5.1. Saving data files In principle engdax saves automatically all incoming data files to a pre-defined directory so that the user only has to look up the directory to be able to use the files. Your engdax system administrator can de-activate this function. If you don`t know which directory is used, you can see this in the process card of the task/file: 20 / 23

21 Do you want /do you have to save data files directly via engdax you can do this in the area. Your engdax system administrator can de-activate this function. There are 2 ways of downloading data files. Download one by one: Go to the Details of an order to download and save data files one by one by clicking. Thereby all directories and disk drives which you have connected in your windows explorer, are available. Container Download: If you want to download all files of a packet with one click (makes sense in case of ENGDAT packets with a great volume of user data) you can use the container download. You find the button for this function in the overview row of the according order. Click and in the background all files of the according order are compressed to a zip packet which you can download. 21 / 23

22 6. Transmission Status In the area transmission status you can observe separately in- and outbound orders. Go to the transmission status via the tab. Your engdax system administrator can limit which orders are visible for you. Consult your engdax system administrator in case you miss the display of in- and outbound orders! 22 / 23

23 7. Archiving Orders Your engdax system administrator has to activate this function before! To keep an overview over and you can move older respectively no longer needed orders into the archive. Mark all orders which should be archived at the beginning of the row. and shift them to the archive by clicking. You can find a selection of all already archived orders under the tab. 23 / 23