> For the complete documentation index, see [llms.txt](https://docs.editran.onesait.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.editran.onesait.com/documentacion-editran/documentacion-editran-editran-sepa-v3-open-en/requisitos-e-instalacion.md). # Requirements and installation ## 3.1 Installation requirements The versions of Editran compatible with the Editran/SEPA module are version 5.0 or higher. One of them must be installed in order to use both products together. In addition, since the new functionality has been developed in Java, Java 6 or higher must also be installed on the machine. If you do not have it, you can download it from Oracle's official website. ## 3.2 Installation instructions The procedure to follow to install the Editran/SEPA module, on any operating system, will be to download the corresponding file from the Editran website and then unzip it, obtaining the following folder structure: ``` |SEPA |--conf |--doc |--lib |--logs |--scripts |---utils ``` In addition, the user environment must be prepared in order to run JAVA applications. The following explains exactly how to proceed depending on the operating system. ### UNIX The client will receive or will download from the Editran website a file `.tar` with the package for their OS and will save the file in the directory where it is to be installed. They may create a new directory or leave it in the directory where Editran is installed. In any case, the product will create the SEPA subdirectory with the new software. Assuming the OS is Solaris and that by default we are going to install it in the same directory as Editran (for example in `/opt/editran`), the following steps will be followed: 1. Leave the file in `/opt/editran` 2. Go to `/opt/editran` and unzip and extract the software, running: ``` tar -xvf sepa-unix.V#.##-YYYY-MM-DD.tar ``` 3. If it is not already defined, include in `.profile` or `.chsrc` (depending on the shell) the environment variables: * `JAVA_HOME` = \[Java installation path] * Add to the `PATH` variable `$(JAVA_HOME)/bin` 4. Edit the file `SEPA/scripts/EntornoSepa` to define: * The path contained in variable `DIR_SEPA` with the location of the SEPA installation directory (without using relative paths). ``` # ----------------------------------------------------------- # ------------ INSTALLATION DEFINITIONS ------------------ # ----------------------------------------------------------- DIR_SEPA=/opt/editran/SEPA ``` * The variable `PATH` with the installation directory of the Editran product and the Java installation directory (without using relative paths). ``` # Editran bin directory and Java installation directory PATH="/opt/editran/bin:/path/to/java:$PATH" # ----------------------------------------------------------- ``` * Edit the scripts: * `checkLic.sh` * `PRVEMISEPA.sh` * `PSTEMISEPA.sh` * `PSTRECSEPA.sh` * `SEPA.sh` To adjust the path of the EntornoSepa file to its location in the installation (without using relative paths). ``` # ------------ INSTALLATION DEFINITIONS ------------------ ENT_SEPA=/opt/editran/SEPA/scripts/EntornoSepa # ----------------------------------------------------------- ``` ### Windows The client will receive or will download from the Editran website the compressed file `.zip` with the distribution for Windows. When unzipped in the desired destination directory, a subdirectory called SEPA will be created with the new software. Once the extraction is finished, the following actions must be performed: 1. Edit the file `SEPA/scripts/EntornoSepa.bat` to define: * The path contained in variable `DIR_SEPA` with the location of the SEPA installation directory (without using relative paths). ``` rem ------------------------------------------------------------- rem INSTALLATION DEFINITIONS rem ------------------------------------------------------------- set DIR_SEPA=C:\SEPA ``` * The variable `PATH` with the bin directory of the Editran product installation and the Java installation directory (without using relative paths). ``` # Editran bin directory and Java installation directory set PATH="C:\editran\bin;\path\to\java;"%PATH% # ----------------------------------------------------------- ``` * Edit the scripts: * `checkLic.bat` * `PRVEMISEPA.bat` * `PSTEMISEPA.bat` * `PSTRECSEPA.bat` * `SEPA.bat` To adjust the path of the EntornoSepa file to its location in the installation (without using relative paths). ``` rem ------------------------------------------------------------- rem INSTALLATION DEFINITIONS rem ------------------------------------------------------------- set FENTORNO=C:\SEPA\scripts\EntornoSepa.bat rem ------------------------------------------------------------- ``` 2. Access: **Control Panel → System and Security → System → Advanced system settings → Advanced options → Environment variables.** In the window displayed, the following environment variables will be defined and modified: * `JAVA_HOME`: You must define `JAVA_HOME` as an environment variable with the path where the Java you want to use is installed and modify the variable `PATH` so that it includes the path where Java is installed. ![Photo](https://620397458-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYRsCBWELAyzw5mj5JFUW%2Fuploads%2Fgit-blob-256085d285dfd4feefac00a421d830958c401872%2Fimage.avif?alt=media) ``` For example, Java is installed in `C:\Program Files\Java\jre1.8.0_25`. The `JAVA_HOME` variable would need to be configured as follows. ![Photo](Instrucciones%20para%20la%20instalacion/images/image.avif1.avif) ``` * `PATH`: Modify the variable `PATH` by adding at the beginning `%JAVA_HOME%\bin`, separating it with a semicolon (`;`). ![Foto](https://620397458-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYRsCBWELAyzw5mj5JFUW%2Fuploads%2Fgit-blob-b4b2f2e70e798fb2c8d96a133a7cb570ea18f3e1%2Fimage%20\(2\).avif?alt=media) ## 3.3 Installed modules The modules that make up the Editran/SEPA product are organized according to the following tree: 1. **SEPA**: Contains the directory tree, the user manual and the file `public.key` necessary for the proper functioning of the Editran/SEPA license. 2. **SEPA/conf**: Contains the configuration of the additional parameters of Editran/SEPA, the log, and the configuration of the entities to be converted. 3. **SEPA/doc**: Contains the Javadoc documentation necessary for, if desired, using the Editran/SEPA module as a library. 4. **SEPA/lib**: Contains the Java libraries that implement the conversion functionality as well as the schemas that the XML formats must comply with. Within this folder there are subfolders distinguishing each Operating System where the corresponding libraries for each one are included. 5. **SEPA/logs**: In this directory the log file generated by the program will be stored. 6. **SEPA/scripts**: Contains example scripts such as those that must be incorporated into the pre-issue or post-receipt user processes when the client wants to use Editran/SEPA from Editran/G and also a script to use Editran/SEPA independently. It includes scripts for each of the Operating Systems on which Editran/SEPA can be used. It also includes scripts for the XML Separate functionality (requires specific license, see chapter [it is essential to have the corresponding license (see section](#9-separador-ficheros-planos-y-xml)). In turn, the subfolder `/utils` includes two procedures: one to pad records with spaces until they reach a fixed length (intended for files with line breaks in which the length of each line is variable) and another to insert line breaks at a fixed length (intended for files that do not have any line breaks). ## 3.4 License file The Editran/SEPA program requires a license file called `licencia.dat`, which must be located in the SEPA root folder. This file must be requested from Editran Support by indicating the hostid and the operating system of the machine. There are two ways to obtain this information: * By running the file `checkLic.bat`/`checkLic.sh` found in the folder `SEPA/scripts` of your operating system. When this file is run from the same folder where it is located, the result of the license check will be returned on screen. If you try to run the Editran/SEPA program without a license, the program will fail due to an incorrect license, leaving the hostid and the machine's operating system in the log. *** --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.editran.onesait.com/documentacion-editran/documentacion-editran-editran-sepa-v3-open-en/requisitos-e-instalacion.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.