2.Installation

2.1. Preparation

2.1.1 System requirements

R2EdiViewer is a Java application and requires Java version 8 - 17,
installed on a Windows operating system.

The JRE (Java Runtime Environment) currently installed on the computer is used.
In the case that R2EdiViewer finds a JDK (Java Development Kit), this will be used.

Independent of the JRE/JDK installed on the computer, an own local JRE (e.g. Adoptium JRE)
can be stored in the R2EdiViewer subdirectory private/jre.
This local JRE will then be used explicitly.

2.1.2. Backup program directory

(warning) Better safe than sorry

If you already have installed a version of R2EdiViewer:
  • Backup all files and directories from the program directory
  • Use the Software upgrade manager for an automatic upgrade.

    If you prefer a manual upgrade, start R2EdiViewerUninstall.exe
    for uninstall and then start Setup...exe for the installation of the new version.

 

2.2. Setup

By starting Setup...exe R2EdiViewer is installed in the desired directory.

The following files are installed:

FilenameDescription
SO

R2EdiViewer.exe

The main program



   R2EdiViewerC.exe

Main program with additional console screen.
To be used in unattended batch mode and for troubleshooting.



   R2EdiViewer.bat

Starts main program R2EdiViewer.jar with the standard JRE



       R2EdiViewer.jar

An alternative in unattended batch mode: Main program



R2EdiViewerSD.zip

Syntax directories

23.30

R2EdiViewerSH.cfg

Config file for the syntax-highlighting

23.20

R2EdiViewerGT.cfgConfig file to display the tree with the Goto command9.10

R2EdiViewerSH.cssCascading style sheets for formatting syntax-highlighting23.20

R2EdiViewerSHdark.cssCascading style sheets for formatting syntax-highlighting23.20

R2EdiViewerXL.cfgConfig file for the layout determination of XML files23.30

R2EdiViewer.ini

Storage of program settings

23.10

R2EdiViewer.lic

Freeware licence certificate


R2EdiViewerWL.cssCascading style sheets for formatting the log file7.12

R2EdiViewerDoku_xx.pdf

User Guide DE=German / EN=English



R2EdiViewerLicence.pdf

End User License Agreement

R2EdiViewerExample.edi

Example of an EDI file



R2EdiViewerUninstall.exe

Excelsior-Installer: deinstallation program



install.log

Excelsior-Installer: installation protocol



[libs]

Directory with external JAR files



[layouts]

Directory with default delivered layout templates



[layoutsEdifileChecker]Directory with EDI file checker layout template

[private]Directory for customer customizations (is never deleted)

  R2EdiViewerSD.zipEmpty syntax directories for customer adjustments7.12
  ..ExtensionLibraryXX.jarFive empty JAR files for customer adjustments8.10
  [jre]Empty directory for the installation of an own JRE 10.20

ZBC_R2EdiViewer.abap

ABAP® program to view IDocs from SAP® via R2EdiViewer23.20

After the installation, R2EdiViewer starts automatically and the EDI sample file is displayed.

 

2.2.1. Customer customizations

2.2.1.1. Customer adjustments can be made via customizing in the:

-  user directory
-
"private" directory

The directories are
searched as follows :

SOSearch order

The file is searched in the directories: "private" and program
All found files will be used in the directory order.
The subsequent search strategy of entry: The first match terminates the search.

The file is searched in the directories: user and "private" and program
All found files will be used in the directory order.
The subsequent search strategy of entry: The first match terminates the search.  

The file is searched in the directories: user or "private" or program.
Only the  first found file is used.

The file is searched in the directories: user or "private".
Only the  first found file is used.


2.2.1.2. Customer layout directories are :

- never deleted by an installation/upgrade 
- searched first  in the user directory and then in the program directory

 

2.3. SAP®-integration

2.3.1. ZBC_R2EdiViewer.abap

The ABAP® ZBC_R2EDIVIEWER can be used to select IDocs in the SAP® system,
which are then viewed by the locally installed R2EdiViewer.exe.
If more than one IDoc is found during the selection, an ALV list is displayed.
An IDoc can be selected from the ALV list by double-clicking.
The selected IDoc, or if only one IDoc was found, is saved to the local PC as a flat file
(without status records) or XML file (with status records) and then displayed by R2EdiViewer.

The ABAP® program source is located in the program directory and must be entered/updated manually
in the SAP® system with transaction SE80 in a package of your choice.

2.3.2. WLF_IDOC

The SAP® standard transaction WLF_IDOC is also used to view IDocs.
With a small SAP® modification, it is possible to use the ABAP® ZBC_R2EDIVIEWER to display the IDoc
instead of the SAP® standard view.

To do this, proceed as follows:
- Adapt the sub-program "uc_idoc_display" in the ABAP® "WLF_IDOC_NEW_F01" accordingly
- Enter the value "ZBC_R2EDIVIEWER" in the SU3 user parameter "RWLFIDOC_NEW_EXPERT"

form uc_idoc_display using i_docnum type edidc-docnum
                  changing c_refresh type slis_selfield-refresh.

  check i_docnum is not initial.
*{   REPLACE                                        1
*\  submit idoc_tree_control with docnum = i_docnum
*\              and return.
* For IDOC display use locally installed R2EdiViewer.exe
* if SU3 parameter RWLFIDOC_NEW_EXPERT = ZBC_R2EDIVIEWER
  data: lv_su3parm(15) type c.
  get parameter id 'RWLFIDOC_NEW_EXPERT' field lv_su3parm.
  if lv_su3parm = 'ZBC_R2EDIVIEWER'.
    submit ZBC_R2EdiViewer with sidocnum = i_docnum
              and return.
  else.
    submit idoc_tree_control with docnum = i_docnum
              and return.
  endif.
*}   REPLACE
  perform refresh_single using i_docnum
                      changing c_refresh.
  if c_refresh is not initial.
    message s023 with i_docnum.
  endif.

endform.                    "uc_idoc_display