> 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/open-v5.3-en/windows/instalacion.md). # Installation ## Introduction This document provides the installation manual for the Editran System in environments **Microsoft Windows**. Editran is a communications platform, developed by Indra, over data networks and the Internet that enables direct communication between computer applications running on different machines and operating systems belonging to different companies, organizations, and public or private entities. The document describes the processes that must be carried out to install and configure the Editran System. It also includes the processes needed to upgrade an installation to its next official version. The manual is intended for system administrators, and it is assumed that the reader has the technical knowledge required to carry out the tasks described in it. ### Definitions * **Presentation:** Set of parameters that, in EDITRAN, define each type of transmission. * **EDITRAN/GC:** EDITRAN module for RSA key exchange. ## Prerequisites ### Hardware requirements The hardware characteristics of the equipment will depend on the expected workload level in each product deployment. A guideline configuration is provided by installation type. #### Processor Given the wide variety of different architectures existing for these operating systems, you should consult the equipment manufacturer to determine the one that best suits your needs. In general, product performance improves with: * Higher processor speed. * Higher number of cores/threads. #### HDD space The required disk space depends largely on the maximum size of the transmitted files and the time they remain on the equipment. Since this is not known in advance, only the following factors are taken into account: * Space required for Editran software. It depends on the OS, but does not exceed 30 MB. * Space required for product configuration data. Each defined transmission profile occupies about 35 KB. The total number of transmissions to be configured will depend both on the number of entities we need to communicate with and on the types of information exchanged. Therefore, for a medium installation (250 different profiles), about 10 MB should be considered. * Space for temporary files created by Editran during transmissions. For each transmission, disk space for three times the volume of transferred data will be required. The table gives a recommended sizing according to the intended use of the product, based on the maximum number of concurrent transmissions and the volume of exchanged files. #### HDD sizing | Load | No. of Transmissions | File Size | HDD space | | -------- | -------------------- | --------- | --------- | | Low | 1 - 25 | 50 MB | 20 GB | | Standard | 25 - 100 | 250 MB | 140 GB | | High | > 100 | 1 GB | > 300 GB | #### Communications * Ethernet network card for TCP/IP protocol. #### Scalability and high availability solutions At infrastructure level, for installations with these needs, a virtualization solution is recommended. The implications this would have on the product: * For this solution to provide scalability capabilities, it would need to be associated with the installation of multiple isolated Editran instances, each managing its own group of transmissions. * It is necessary to install the Editran/PX component, which is configured to route incoming traffic to the corresponding instance. ![high availability diagram](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-5bd33feb4560260eb74f676cf5342e35b8882e91%2Fdiagrama-virtualizacion.png?alt=media) ### Software requirements #### Supported Operating Systems Editran software is distributed for 64-bit operating systems and x64-based processors. The supported versions are: | Operating System | Notes | | ------------------- | ------------------------------------------------- | | Windows 10 | Microsoft Windows 10 support ends in October 2025 | | Windows 11 | | | Windows Server 2016 | | | Windows Server 2019 | | | Windows Server 2022 | | | Windows Server 2025 | Supported starting with version 5.2.1.8 | > Microsoft will end support for Windows 10 on 10/14/2025 and will stop providing security patches for this version of the operating system. You can find more information about the end of Microsoft support [here](https://www.microsoft.com/es-es/windows/end-of-support?msockid=1ab3235e9b356f2d2cc736f09a1e6e79\&r=1). From that date onward, in the event of an issue with the Editran product, the team will recommend upgrading the Operating System to a more modern version. #### Additional software * It is necessary that the package ***Microsoft Visual C++ 2015-2022 Redistributable (x86)***is installed, which can be included in the Editran installation process. ## Connectivity EDITRAN is a client/server protocol. To enable remote connections from any other entity, you must have Internet access with a fixed assigned public IP and an open inbound and/or outbound TCP port (by default EDITRAN uses port 7777). > It is recommended that the computer where EDITRAN is installed be on the internal network with a private IP and that the Internet connection be made through the EDITRAN/PX module, developed as a gateway to add more security to TCP/IP communications in public networks. For more information about this component, see its User Manual. ## Onesait Editran Installation ### Installation To carry out the installation, follow the steps below. If you want to perform a version upgrade, go to point [Version Update](#actualizacion-de-version) before installing. Throughout the installation/update process you must use an administrator user and have editing permissions both in the Windows registry and in Task Scheduler. * Run the Editran/Windows installation package. The following screen will appear; you must click the Next button if you want to continue with the Editran installation. ![step 01 - installation](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-840051e74b2ee57b05ce236e2970b096dd8aa3be%2Fimage4.png?alt=media) * A screen will appear with the folder in which the Editran installation directory will be created, and you can choose any folder or the default one proposed; once you have decided on the installation directory, click the Next button: ![step 02 - installation](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-72393a6e856417f2990d2fac6681560a6639e60e%2Fimage5.png?alt=media) * This screen shows the full Editran installation path. The product configuration files and temporary files will be stored in this same location. If you want to configure another path for these files, check the box "Custom configuration data directory" and select the desired folder. Click the Next button: ![step 03 - installation](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-42365058cdc500951042e58afcac1cfe97297e7d%2Fimage6.png?alt=media) * It is necessary that the redistributable package **Microsoft Visual C++**is installed on the computer. If it is not installed, you must select the option offered on the next screen: ![step 04 - installation](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-aa1a8f3f0b8ad2f0ab5cbc5e3574f5abc9ec56c1%2Fimage7.png?alt=media) > If you want to perform the installation later, you must leave the checkbox unchecked and use the executable located in the subdirectory `Editran\bin\vc160\vcredist_x86.exe`. * The next screen asks you to configure the periodicity of the [integrity verification task](#integridad-de-la-instalación) of this installation. ![step 06 - installation](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-8a78baec77ef453207a234c643a6c1cb4e478a1b%2Fimage9.png?alt=media) * The next screen offers the installation of the transmission management service. Its installation is only recommended if you have the specific license for this module. ![step 07 - installation](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-d5816bdd966d0fea40d4604e1dd5c15f263eda6b%2Fimage10.png?alt=media) * This screen shows a summary of the folders where Editran will be installed with the TCP/IP protocol, with the possibility of going back to modify whatever you want. ![step 08 - installation](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-bd3d97dd3e77fa077e907fffabc950bf4ef545e1%2Fimage11.png?alt=media) Click Next to start the installation process. * The screen showing progress during the installation process appears ![progress](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-75f50d06e61b09fc31904cdb4f9c1514d272cc3a%2Fimage12.png?alt=media) * If the option to install the redistributable package had been selected **Microsoft Visual C++** the following screen will appear at this point and you must click the **Install**:\ ![redistributables](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-0d8a622342936b2c6c0dc2d46d543f98f32a7173%2Fimage8.png?alt=media) If your computer already had the package installed, the following screen will appear and you only need to click the **Close** and the button **Yes** in the pop-up window that will be shown below.\ ![redistributables](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-5820f4de7d26902f2da02c05defef702f594ec4b%2Fimage41.png?alt=media)\ ![redistributables](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-eda18b2c20177b3a421527694d6be960385ae062%2Fimage42.png?alt=media) * Once all components of the Editran package have been extracted, it is reported that the installation has finished. ![step 10](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-937b873731522f06db2623cf788c8eb55fe5ea09%2Fimage13.png?alt=media) * If it is necessary to review the installation information, it is recorded in a log file in the %Temp% directory. * Once the Editran installation has finished, you can check its version and other relevant information from the Windows Control Panel. ![step 11 - installation](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-66b03e52c55019871f18b23b3156767ccdc1cdb6%2Fimage14.png?alt=media) * The installation process creates log files that record system activity. These files are cyclic and sized for 20,000 messages. If the client needs a larger history, they can resize them by running the command **makelog** as shown in the image. Just keep in mind that this must be done with the Editran service stopped. ![makelog](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-bd2aa92036649a83357cb12f1a0eb214723dc404%2Fimage15.png?alt=media) From the Editran installation directory, you can also obtain the full version of the product using the command **ediver**: ![ediver](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-717ee64fd272e04b2bd07126353a8ab5b7586e7a%2Fimage16.png?alt=media) ## Security ### Operating system hardening Hardening is a process by which the necessary technical and organizational measures are implemented to reduce vulnerabilities in a system. From Editran, the following is recommended: * Installation of "**Security Compliance Toolkit and Baselines**" and configuration of policies according to the specifications for the type of version provided by Microsoft. * Use of **CCN hardening guides for Windows environments** (Series 500). * Service filtering in the **firewall** Windows. * Disabling unnecessary services, Windows features, PowerShell, etc. * It is recommended to have a partition for temporary use separate from the system. * Updates should be configured so that at least security updates are installed by default. * It is recommended to test and evaluate the deployment in a VM (pre-production, never production). Tools such as [HardeningKitty](https://github.com/scipag/HardeningKitty) can be used to review part of the hardening. * It is recommended to create a non-administrator user for the management and execution of the Editran product. This point is described in more detail in the section [Execution in a secure environment](#ejecución-en-entorno-seguro) ### Execution in a secure environment Editran is an application that only transfers information; it neither processes nor collects the content of the files it transmits. From this point of view, there is no risk of exposing sensitive information. However, it is recommended that resources such as configuration files and logs created during the application's activity not be accessible to any user of the computer. With this goal, recommendations are provided for running the product in a secure environment. The access control proposed for the product installation folder is based on user permissions and is explained in the following steps: 1. Create a new account as a user with the Editran administrator role. In our case, we create a generic one with the product name in the computer domain. If this is not possible in the client's infrastructure, that role should be assigned to a specific user in the organization. 2. It is recommended that this user have write permissions only on the indispensable files and folders. 3. Once the Editran product has been installed, the permissions on the Editran folder will be modified to restrict access. With the folder selected, choose the option **Properties** and select the tab **Security** in the window that opens. In this tab you can see the current permissions of the folder, and by clicking the Edit button a new window similar to the previous one will open, allowing you to add and remove users, as well as configure specific permissions for each user. > An appropriate configuration would be the one shown in the image: only grant full control to the Editran administrator user, and optionally to the computer Administrator or Administrators group.\* ![proper user configuration](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-abe79790a69c6daffa45fb67b866bf792b2f0739%2Fimage17.png?alt=media) 4. The Editran binaries are installed by default with the "read-only" property; this property must not be modified.\* 5. The product installs two services that are configured by default to log on as Local System. Once the permissions have been changed, it will be necessary to modify in **Properties** so that they start with the account of the user who has permissions on the folder.\* ![user services](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-e21c9d33728f16cac0b8dbf757120524179513fc%2Fimage18.png?alt=media) 6. Finally, it is recommended that the user who starts the Editran service does not have Administrator permissions. Failing to comply with this recommendation may mean a security breach, and it will be the client's responsibility to control the integrity of the scripts that can be configured in Editran as User Programs.\* ### Installation integrity After installing Editran, the **Editran Integrity Task** is configured in the Windows Task Scheduler, whose mission is to ensure that the Editran binaries have not changed since installation and, therefore, that their execution is secure. ![task scheduler](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-59aca80f709dd2bd30efd8b5be18e66c7d7b9260%2Fimage19.png?alt=media) If the verification task detects any inconsistency, an event will be generated that can be viewed in the Windows Event Viewer. In this way, these logs can be used and appropriate measures taken if errors are detected. ![event viewer](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-17def742abbe26e7d0efa9ce5c66d3d90f158103%2Fimage20.png?alt=media) ### Code signing All binary code (executables and DLLs) distributed by the Editran application is delivered signed. The purpose is to allow end users and the operating system to verify that the program code comes from the correct owner and has not been accidentally damaged or maliciously altered. The Authenticode signature attaches a digital certificate to the delivered code that identifies Editran as the provider. These certificates are issued by certification authorities or CAs. In our case, the root issuing authority is also product-specific, which means that in signature verification the user must include it as a trusted CA since it is not published in the lists provided by Windows. Ways to verify the signature once the software is installed: By checking the signature of the programs from ***Windows Explorer***. To do this, locate any file in the *"bin"* subfolder of Editran, and right-click it to open the ***Properties***. At the top there is a tab called ***Digital Signatures.*** Click it to see the included signature: ![Signature Properties](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-5db9f4abe4b2808177c5ecd2102cc44a8d363ac2%2Fimage21.png?alt=media) To see a signature in detail and verify whether it is really valid and has not been spoofed, select it and click the "Details" button. This allows us to see all the information related to this digital signature and the certificate that identifies the signer. ![Signature Information](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-34713badefc736444ff10dba54d67461db0e2aa4%2Fimage22.png?alt=media) Explorer allows manual verification, but there are tools that would allow the end user to automate a validation mechanism. If the Windows SDK is installed, you can use a tool called SignTool, which from CMD allows us to verify the signature. ![verify editran](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-b51ae229de6f71b2aa0083e033e013d7eeab508f%2Fimage23.png?alt=media) In our case the verification is performed with the /pa option to indicate that the Default Authentication Verification Policy should be used. If it is not specified, SignTool uses the Windows Driver Verification Policy, and it would fail by requiring the CA to be a recognized issuing authority. If we do not have the SDK installed and do not want to install it on the computer, there are other free tools available. For example, [Digicert Certificate Utility](https://www.digicert.com/es/support/tools/certificate-utility-for-windows). ### License Once properly installed, Editran requires a specific license for each computer depending on a Hostid (unique code for each machine where Editran is installed) to operate. To generate that Hostid you can: 1. Open the shortcuts folder in the Programs section of the Windows Start menu and run **License**. The program will show the new Hostid in Notepad. In addition, it will generate a dated file, in the format **hostid\_DD-MM-YY.txt**, in the directory **bin** of the Editran installation. 2. Open the Editran/P menu, open the File tab, and click on **Generate HostID**. Accept the question it asks and choose a directory to copy the resulting file **hostid.txt** to. 3. If you cannot open the Editran/P menu because you are accessing from a remote computer or a virtual machine, you must go to the **bin** Editran directory in command mode and run the following command: > hostid -a > hostid.txt In any case, the resulting file with the **HostID** must be sent to the email of so that we can generate the corresponding license. You must also send the file **licencia.dat** from the previous version of Editran, if you have it. You will receive an email with 1 attachment that you must download into the directory **bin/SL**. It is the responsibility of the Editran administrator to protect this file so that it cannot be modified, as that would cause the system to stop working. > *\*: License file with extended name. It must be renamed as **licencia.dat** ## Editran/GT Installation To use the Editran/GT service, you must first have a valid license with the editrangt module. During the installation of Editran/Windows, the wizard already offers the option to install the Editran/GT service. If it was not selected at that time and you want to install it later, you can do so by following these instructions. To install it as a service, you must run the following commands from the directory `bin/` of Editran with a Command Prompt (cmd.exe) run as Administrator: ```powershell EDItranGTServ.exe -install reg.exe FLAGS HKLM\SOFTWARE\EDITRAN\EditranGT SET DONT\_VIRTUALIZE /reg:32 ``` A service called **EDItranGTServ**. In the User section, you can choose to start it with the Windows local system account (local system) or define a specific user; this last option is useful when special permissions are needed in handling Editran transmission files (network resources with permissions limited to certain users, etc.). ## Editran System ### Startup and shutdown In Editran Windows environments, the system can be started and stopped in 3 ways: #### As a Windows Service In this way, Editran starts as a Windows service, being able to start on behalf of a specific user and not having to be logged in. The service name is: **Editran Base Service** Editran actually consists of two services: * **Editran Base Service** * **Editran License Service** However, since they are installed with a preconfigured dependency of Base on License, it is enough to start Base for the start of both services to be triggered. If you start it this way, you will not be able to use the traffic light or the Editran command; you must use the corresponding options from the Windows Services window (*services.msc*). In the User section, you can choose to start it with the Windows local system account (Local System) or define a specific user; this last option is useful when special permissions are needed in handling the transmission files (network resources with permissions limited to certain users, etc.). **Shutdown** If you want to stop both services, the License service will be stopped first, choosing whether or not to stop Base when prompted by the dependency requirement. **Installation/Uninstallation** During product installation, the services will be installed automatically. To be able to install or uninstall them later: * Run the corresponding command from the **bin** Editran *Command Prompt* (cmd.exe) run as Administrator * **SvcInstall** or **SvcUninstall**, as appropriate > ***Note**: To remove the service, you will have to close the Windows Services window; otherwise, depending on the Windows version, it will not be removed until you restart the computer.* If you want Editran to recover from any abnormal service failure, you must configure the Editran service in the Recovery section as follows: ![Editran Service Properties](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-9df12d7f8a1b40a8e34d0230acde3d952c55684b%2Fimage24.png?alt=media) #### From the traffic light in menus P and G (or the Start and Stop Editran options in the File tab) In this way Editran starts the processes necessary for its operation on behalf of the user who launched it. Therefore, Editran will use that user's permissions and, furthermore, if the session is closed, Editran will stop. The traffic light in red means Editran is stopped; if it is green, it is started. If Editran is started as a Service, the traffic light cannot be used, and the following message appears: ![Traffic light start error](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-2b07a6259f02a13790f4f5651ebb079c53f0d229%2Fimage25.png?alt=media) #### From the Editran command In this way, Editran starts the processes necessary for its operation from the command line. The command syntax is: ![start command](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-e13c7a0bfdbdd89a64701c274856760194a9b21a%2Fimage26.png?alt=media) As with the previous option, this start method cannot be used if the Service is being used. ## Windows registry configuration settings During the Editran installation process, a new key is created in the Windows registry whose path is *HKLM\SOFTWARE\ WOW6432Node\EDITRAN*. The only value that is always created is ***InstallPath*** with the root directory of Editran. However, there are other values that a user with permissions can create to set some configuration settings that allow the system behavior to be parameterized. These values are: | Variable | Description | Type | Allowed Values | Default value | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | ----------------------------------------------------------------- | --------------------- | | **DataPath** | Directory for EDITRAN data files: configuration and temporary files (buffers, state, etc.). In this version, it is possible to detach them from the product installation path by defining the path where the processes search for and save those files. | REG\_SZ | Existing path with permissions | the InstallPath value | | **LogLevel** | Determines the level of log information recorded during transmissions. | REG\_DWORD |

1(info)
2(trace)
3(debug)

| info | | **GLogPresentacion** | This value will be created if you want Editran to record information in different log files for each *Presentation*. These files are stored in the log subfolder, named as \.log. | REG\_DWORD | If the value is not defined, the log file is unique. | | | **GUpgrade** | It determines the parameters that Editran passes to the previous user programs. If they were developed for versions lower than 5.2.0, and it is not possible to adapt them, this value will be created to continue working in compatible mode. | REG\_DWORD |

0(standard parameters)
1(parameters in compatible mode)

| standard mode | | **Sleep** | If necessary, it allows adjusting the delay time when starting the Base service, since for it to start correctly the License service must be active. | REG\_DWORD | Number of delay seconds | 3 (seconds) | | **ReportPath** | This value activates the optional functionality of creating reports of transmitted files. | REG\_SZ | Existing path with permissions | | | **ReportLevel** | Level of detail in file report generation. | REG\_DWORD |

0(basic)
1(extended)

| basic | | **disableLogBackup** | When Editran starts, a backup of certain log files is made. This registry variable is responsible for disabling this functionality. | REG\_DWORD | 0(log backup active), 1(log backup inactive) | log backup active | It is important to take into account the following: * All values of type REG\_DWORD indicated in this table must be entered in base **decimal**.\ ![decimal](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-af239b0004a8a0eafc3a7079c45cc8b561baa2e6%2Fimage43.png?alt=media) * If any key is not created in the Registry, **Editran** will use its default value. * The value of the keys is applied during the startup of the Windows service **Editran Base Service**. Therefore, any modification made to them requires restarting the service for the changes to take effect. ## License Server configuration settings No adjustment is necessary in the license server configuration unless you want to set listening ports different from those used by default by the server. The configurable parameters are located in `bin\SL\App.conf` and are as follows: * **BASE** The installer already sets this parameter with the path `\bin\SL`. It is the root directory of the license service and its logs, reports, temporary files, etc. will be generated there. ```txt # BASE directory of the application BASE: /opt/editran/bin/SL ``` * **SL.PORTSRV** (optional) Include it if you want to use a license port different from the default one (**50777**). ```txt # SL (License Server) #------------------------- SL.PORTSRV: 50777 ``` If customized, the environment variable should also be included **LICSRV** in the user variables of the user who administers Editran, with the same port as the previous point. ![LICSRV environment variable](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-e34c6f93bd878413fa8ef22123b2cad262de2bf5%2Fimage28.png?alt=media) * **FC.PORTSRV** (optional) Include it if you want to use a billing port different from the default one (**50778**). ```txt # FC (Billing Server) #--------------------------- # Day of the month on which the report is generated #DIAINF: 1 FC.PORTSRV: 50788 ``` If customized, the environment variable should also be included **FACTSRV** in the user variables of the user who administers Editran, with the same port as the previous point. ![FACTSRV environment variable](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-37f30bb6639c3199a5632df0a2c81bdcc4b4a4b7%2Fimage44.png?alt=media) * **DIAINF** (optional, only if the license has billing) It is used to choose the day on which the billing results report is generated. By default it is the first day of the month; only uncomment it if you want another day. ```txt # FC (Billing Server) #--------------------------- # Day of the month on which the report is generated DIAINF: 2 ``` > Note: The ports reserved for Editran must not be used as candidate ports for the license server. ## Version update ### Previous steps To download software and manuals from **Editran 5.3.x** access the [customer portal](https://www.onesait.com/editran/resources). In the **Resources** tab, you will find the latest available version and its manuals. Throughout the installation/update process you must use an administrator user and have editing permissions both in the Windows registry and in Task Scheduler. If you need help, you can contact the support team at: * Support phone. - 91.480.80.80 * Email address.- ### Source version 5.2.1.3 or higher If the previous version is 5.2.1.3 or later, it is no longer necessary to uninstall it first. When you run the installation program, it will detect that a previous version is installed and guide you through the upgrade. To carry out the update in these cases, you must follow the steps below. * Close any Editran software (menup.exe, menug.exe, menugt.exe, editrangc.exe...). * Make a backup copy of the Editran directory from the previous version (without deleting or moving the original folder) * Run the Editran/Windows installation package. The following screen will appear; you must click the Next button if you want to continue with the Editran update. ![update - step 01](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-6889f03f661961a37b132b057143050993494ea4%2Fimage29.png?alt=media) * The following screen shows the data from the previous Editran installation.\ If the update requires a profile migration, a backup folder will be created with the elements necessary to perform this process later.\ You must click the Next button to continue with the version update. ![update - step 02](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-1345bbc7ef858a18e79ced0d1d2a74e696c94183%2Fimage30.png?alt=media) * It is necessary that the redistributable package **Microsoft Visual C++**is installed on the computer. If it is not installed, you must select the option offered on the next screen: ![redistributable](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-aa1a8f3f0b8ad2f0ab5cbc5e3574f5abc9ec56c1%2Fimage7.png?alt=media) > It is recommended to uninstall the redistributables installed in versions prior to Editran 5.2.1.4 (Microsoft Visual C++ 2008 Redistributable). * The next screen asks you to configure the periodicity of the integrity verification task of this installation: ![update - step 05](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-5d2e4bc3d676dcb5dd76dae04623b83bf6fd050e%2Fimage32.png?alt=media) * Next, it is indicated that the software is ready for installation, with the possibility of going back to modify whatever you want: ![update - step 06](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-9787423a5ab4b0ba6ce5bd398dce529a84a0eae2%2Fimage33.png?alt=media) * When you continue with the update, the screen showing the progress of the process will appear: ![update - step 07](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-4bc671f4034b8f94d703a6eaea1cdeb53961db81%2Fimage34.png?alt=media) * If the option to install the redistributable package had been selected **Microsoft Visual C++** the following screen will appear at this point and you must click the **Install**:\ ![redistributables](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-0d8a622342936b2c6c0dc2d46d543f98f32a7173%2Fimage8.png?alt=media) If your computer already had the package installed, the following screen will appear and you only need to click the **Close** and the button **Yes** in the pop-up window that will be shown below.\ ![redistributables](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-5820f4de7d26902f2da02c05defef702f594ec4b%2Fimage41.png?alt=media)\ ![redistributables](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-eda18b2c20177b3a421527694d6be960385ae062%2Fimage42.png?alt=media) * Once all components of the Editran package have been extracted, completion will be notified. ![update - step 08](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-4aeba31224fb99ab8448217e74943f2e6563494c%2Fimage35.png?alt=media) * If it is necessary to review the update information, it is recorded in a log file in the %Temp% directory. > **Note**: If, after an update to version 5.2.1.4 or higher, it is necessary to restore the previous version of Editran, the executable **restore.exe** located in the product installation directory will allow you to do so.\*\*Before running it, you must close any Editran software (menup.exe, menug.exe, menugt.exe, editrangc.exe...) and exit any program that is accessing the product installation directory. > > *It is not recommended to perform this operation except in very specific and critical situations.* ### Source version 5.2.0 or lower If the update is to be performed on the same server where the previous version was installed, you must first perform the following steps: * Stop the **Editran.** * If you have contracted the Editran/GT module, stop the service **EditranGTServ**. * Close any Editran software (menup.exe, menug.exe, menugt.exe, editrangc.exe...). * Make a backup copy of the Editran directory from the previous version (without deleting or moving the original folder) * Uninstall Editran: The uninstallation must be performed from Add or Remove Programs in the Control Panel. Check that the services from the previous version have been removed. If they still appear, from the Windows Command Prompt (cmd.exe) run as administrator, you must use the following commands: ```bash sc delete ediserv # If you have the Editran/GT module: sc delete editrangtserv ``` * Delete the original Editran folder. * Start the **installation** of the product following the [installation section](#instalación) of this manual. * As an important point in that section, place the product license (**licencia.dat**) in the subdirectory **bin/SL** before continuing with the configuration migration. If the new version is to be installed on a different server, the installation process is the same as explained in the [installation section](#instalación). Since this is an update, it will be necessary to copy the configuration files to be migrated to the new server, as explained in the next section. #### Migrate configuration > When you have the licensed product, run **bin/Migrar.exe** as Administrator to migrate all the configuration from the previous version of Editran to the new one. First you must choose: * The ***directory*** where the profiles from the previous version of Editran are located. If the update is being performed on the same server, it will be enough to select the backup folder of the previous version. If it is updated on a different server, you will have to create a folder and copy the following files there: | Source version | Source data folder | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Earlier than 520** |

- editranp.cfg
- editrang.cfg
- ckds.des
- √ with license editrangt
- editrangt.cfg
- √ with license rsa
- controlGC.cfg
- ckds.rsa

| | **520** |

- Folder cfg entirely
- bin/ckds.des

| | **Later than 520** | - Folder **cfg** entirely | > ℹ️ *Note:* If the source installation is 5.2.0, and you were working with a configuration data directory different from the installation one, the source directory you must enter is actually the one defined in the DataPath variable. With one exception: before migrating, you must copy the bin/ckds.des file from the original installation into the DataPath folder.\_ * The ***version*** of Editran from which to migrate (version to which the profiles belong) * In older versions there could be profiles for X25 and X28 networks; if you check the ***TCP sessions only*** box, only those configured for TCP will be migrated (which is the right thing to do). > ℹ️ *Note:* If checked, the migrate.out file will contain WARNING messages for EDITRAN/G presentations that will not have been migrated because they lacked the EDITRAN/P sessions that used X25 or X28).\_ Click the **Migrate** button to begin migration: If the process completes successfully, messages similar to the following will appear: ![Migration of editran profiles](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-2770f173402f12e88ea854c3af8676ea4c8a3f8c%2Fimage36.png?alt=media) Press **Exit** to finish migration. If errors appear, you should consult the log files **migrar.out** and **Migrar.log** (located in the subdirectory **log)**, and contact Editran Technical Support requesting a Windows technician so that these messages can be assessed, since in most cases they are *warning* messages due to validation between versions and that do not affect data consistency in the migration (these are the ones recorded as "WARNING"). **Note**: If the previous installation had profiles with deprecated data in this new version, an informational message will be shown. Once migration is complete, you must adapt the mentioned profiles. ![Migration of editran profiles](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-e52450a4deb6304948bd5bc84f1517199fb6bf9a%2Fimage40.png?alt=media) ### Adaptation of User Programs from previous versions If there are specific User Programs that run as pre- and post-procedures to transfers, you must adapt them taking into account the following changes. * In the pre-transmission programs, the parameter list is: Presentation, direction, local code, remote code and application. * In the post-transmission programs, the parameter list is: Presentation, direction, local code, remote code, application and the absolute path of the file with the list of sent or received files. * Post programs only run when the transfer **ends successfully**. In any other case, including errors in the upload and download process, the **exception**. * program will be run. It is recommended that these scripts be left in **bin/utils**, to differentiate them from the product software. * In the configuration migration, the default Editran User Programs in the pre-transfer ones (U\_PRVEMI and U\_PRVREC) and in the post-transfer ones (U\_PSTEMI and U\_PSTREC) of each presentation are removed, unless you had your own defined. If you had modified those default User Programs, we recommend that you give them a different name, place them in the subdirectory **bin/utils** and configure them in the presentations you want. The following table shows the arguments of each type of User Program: | Variable | Exception | Pre | Post | | -------- | ------------------------------ | ------------------------ | --------------------------------------------------- | | 0 | Program name | Program name | Program name | | 1 | Presentation | Presentation | Presentation | | 2 | Sending (E) or Receiving | Sending (E) or Receiving | Sending (E) or Receiving | | 3 | Transmission result (4 digits) | Local Code | Local Code | | 4 | Local Code | Remote code | Remote code | | 5 | Remote code | Application | Application | | 6 | Application | | Path of the file with the list of transmitted files | In the version update, the production environment is left ready to work with User Programs from previous versions, although adaptation to the new format is recommended. In general terms, the changes to be made in this process are: * If your scripts use the arguments with which Editran invokes them, adapt the necessary values to those of the current version (For example, if you used value 4 to retrieve the local Code in a User Program after receiving, you must change it to 3.). * Delete the Windows Registry value named **GUpgrade** in the key `HKEY_LOCAL_MACHINE\\SOFTWARE\\WOW6432Node\\EDITRAN` * If the Editran service is running, restart it so that the changes take effect. #### User scripts in backward-compatible mode We do not recommend using this option, but it is possible to indicate that scripts expecting input parameters from previous versions will be used. To do this, you must create the DWORD value in the Windows Registry named **GUpgrade** and value 1 in the key `HKEY_LOCAL_MACHINE\\SOFTWARE\\WOW6432Node\\EDITRAN` The following table shows the arguments of each type of user program depending on the presence or absence of GUpgrade: | Variable | Exception |

Pre
WITHOUT GUpgrade

|

Pre
WITH GUpgrade

|

Post
WITHOUT GUpgrade

|

Post
WITH GUpgrade

| | -------- | ------------------------------ | ------------------------------ | ----------------------------- | --------------------------------------------------- | --------------------------------------------------- | | 0 | Program name | Program name | Program name | Program name | Program name | | 1 | Presentation | Presentation | Presentation | Presentation | Presentation | | 2 | Issuance (E) or Reception (R) | Issuance (E) or Reception (R) | Issuance (E) or Reception (R) | Issuance (E) or Reception (R) | Issuance (E) or Reception (R) | | 3 | Transmission result (4 digits) | Local Code | RESULT | Local Code | RESULT | | 4 | Local Code | Remote code | Local Code | Remote code | Local Code | | 5 | Remote code | Application | Remote code | Application | Remote code | | 6 | Application | | Application | Path of the file with the list of transmitted files | Application | | 7 | | | | | Path of the file with the list of transmitted files | ## Common errors ### During Installation #### It has not been possible to create the Editran License Service service This error occurs when the user performing the installation does not have the necessary permissions to create the Editran configuration in the Windows registry. ### During Migration #### The migrated version has not been registered If this error message appears, the problem is due to the migration process not having permission to write a required configuration in the Windows registry. ![erroneous variables](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-70636696bc945a41b0fa636e8f982b3ee8f0342b%2Fimage37.png?alt=media) You could run the migration again by running the process with the Run as Administrator option, although it is enough to create in the Windows registry the entry **GUpgrade** with the value of the migrated version. ![registry error](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-442abe3fe7405f478f0cf8c318a5e2f9b41aeeeb%2Fimage38.png?alt=media) #### There is no **controlgc.cfg** Although it always appears as ERROR, it should be ignored if it did not have a license **rsa** in the migrated version. ![erroneous variables](https://780925830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiQfLim2uDaLOZRkgWkOk%2Fuploads%2Fgit-blob-dd710de5a3c8c45ebe3b69eb2ac0eefed11f486b%2Fimage39.png?alt=media) --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.editran.onesait.com/documentacion-editran/open-v5.3-en/windows/instalacion.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.