myOpenFactory-EDI-Connector

Manual of the myOpenFactory-EDI-Connector

Introduction of the myOpenFactory EDI Connector

As a connection client, the myOpenFactory EDI Connector executes the file exchange (EDI-files and, if necessary, attachments such as technical drawings etc.) between your ERP system and the myOpenFactory EDI platform. The connection client is a service that runs on your communication server and allows complete monitoring on your part. As a result, the software also meets strict compliance rules.

The EDI Connector works folder-based, it fetches document-files (e.g. an order) from a defined directory and transfers them to the myOpenFactory platform using a certificate-protected HTTPS connection (method POST).

Every minute our EDI connector checks whether documents (e.g. order confirmations) could be picked up from the myOpenFactory platform. If yes the EDI connector retrieves it using a certificate-protected HTTPS connection (method GET) and stores the file in a designated folder on your system.

If there is a problem with the file dispatch, the documents are moved to an error folder so that no documents can be lost.

The certificate that comes with the EDI connector is valid for 2 years and a new one will be sent by us in good time upon expiration. The old certificate only needs to be replaced by the new one.

The EDI connector generates a log file that logs each of the Connector’s actions. If you have your own mail server, you can be automatically notified when error entries are written to the log.

1. Requirements

One of the following server-OS are required:

• Windows Server 2012 or higher • CentOS 7 or higher with Docker-Container-Software see e.g.: https://docs.docker.com/install/linux/docker-ce/centos/ • Ubuntu 16.04 or higher with Docker-Container-Software see e.g.: https://docs.docker.com/install/linux/docker-ce/ubuntu/

2. Installation

The installation and configuration is carried out by a myOpenFactory employee together with your system administrator using remote control software. Duration: approx. 40 min.

3. Preparing to Install the EDI Connector

3.1 Setting up the directories

A “prod” directory with the following subfolders:

Ein „prod“ Verzeichnis mit folgenden Unterordnern: • A “prod-out” folder for the outgoing productive documents. • A “prod-in” folder in which the incoming productive documents that the EDI Connector fetches from the platform are stored. • An “error” folder for the documents that could not be successfully sent to the platform. if this occurs the EDI-Connector sends an e-mail*. After the connection has been re-established, the document can be moved to the prod-out folder. Then it will be sent to the platform automatically. • If desired, an optional “success” folder can be created in which the EDI connector stores the successfully sent documents as a copy.

A “test” directory with the following subfolders:

• A “test-out” folder for the outgoing productive documents. • A “test-in” folder in which the incoming productive documents that the EDI Connector fetches from the platform are stored. • An “error” folder for the documents that could not be successfully sent to the platform. if this occurs the EDI-Connector sends an e-mail*. After the connection has been re-established, the document can be moved to the prod-out folder. Then it will be sent to the platform automatically.

If possible, put a test message (e.g. an po or oc) in the prod-out or test-out folder so that a connectivity test can be done.

3.2 Network share

You must ensure that a permitted access is configured to access other servers within your network if the above folders are on a different server.

3.3 Internet share

You must ensure that the EDI connector is equipped with the necessary permission to access the Internet. Please allow “myopenfactory.net” and “github.com” in your firewall and proxy. Any virus scanners that may be used can also affect connectivity.

If you need our IP addresses to set up the necessary approvals in your software, please contact us.

3.4 Storage capacity

40 – 50 GB is sufficient, but if you need the Success folder, you should plan for more capacity.

3.5 SMTP accessibility

  • If you want to be notified of errors, the EDI Connector needs the permission to access your SMTP server. After a successful setup, the EDI connector sends an email when an error entry is detected in the logs.

3.6 Download installation file:

Please download the suitable installation file from Github (e.g. myof-client.exe_windows_amd64.zip) and save it on the desired communication server. https://github.com/myopenfactory/client/releases

4. GitHub

Our EDI Connector is available as an open-source project on GitHub and can be validated by you. Our updates are signature-protected. See: https://github.com/myopenfactory/client

5. Update of the EDI-Connector

For all the information in this guide, we assume that the EDI Connector is installed in “C: \Program Files\myOpenFactory\Client”.

5.1 Stopping

Before the EDI Conenctor can be updated, it must first be stopped. To do this, switch to the Windows “Services” (press windows key and search for “Services”).

Windows-Dienste

Now locate the EDI Connector with the name “myof-client” (the naming after “myof-client” may vary slightly depending on the user). Then stop the EDI connector using the context menu (right-click) and the “Stop” selection. Next to the name, the current status of the EDI Connector is displayed in the selected line. At the beginning of the procedure, it should be in the “Running” state and after successful stopping, the “Status” field should be empty.

Client-anhalten

5.2 Updating

The EDI Conenctor has a built-in update mechanism. The EDI connector searches for the latest version and updates itself to the latest version after confirmation by the user.

  • An administrative powershell is required to start the update.
Powershell-aufrufen
  • Then you have to navigate to the EDI Conenctor’s folder with the Powershell. The command “cd (change directory”) is used for this purpose. The default installation of the EDI connector is located at „C:\Program Files\myOpenFactory\Client“, so you can use the „cd ‘C:\Program Files\myOpenFactory\Client‘ “ command to navigate to the installation folder.
  • The update can then be triggered using “.myof-client.exe update”. The EDI connector asks whether the update to the latest version e.g. 1.4.2 should be carried out. This query must be confirmed with a “y” (Yes). If no newer version is available, the EDI Connector reports this with a corresponding message. If a problem occurs when installing the update, please follow the instructions given under point 5.4 and perform a manual update.

Example - Successful Update

Erfolgreiches Update

Example - Failed Update

Fehlerhaftes Update

5.3 Starting

Follow the same steps as described in 5.1 to open the Windows “Services” and locate the myOpenFactory EDI Connector. Then please start the Connector via the context menu (right-click).

If, contrary to expectations, the EDI connector cannot be started, please contact our support – support@myopenfactory.com . For further questions, please keep the log files from the folder „C:\ProgramData\myOpenFactory\Client\logs“ available.

5.4 Optional: Manual update

If the automatic update under 5.2 has resulted in an error, please try to install the update manually.

  • To do this, the Connector must first be stopped as described in 5.1.
  • Please rename the old Connector file under „C:\Program Files\myOpenFactory\Client“ to .myof-client.exe.old before proceeding (please note the dot (.) before the actual name).
  • Then download the latest version of the Connector from https://github.com/myopenfactory/client/releases/latest to the server or an external computer. Usually you´ll need the version “myof-client_windows_amd64.zip”.
  • After successful downloading the file, it must be unpacked and the contained file “myof-client.exe” copied to the folder „C:\Program Files\myOpenFactory\Client“ (Please note that administrative rights may be required for this).
  • Then please follow the instructions under point 5.3 to start the EDI Connector.

5.5 Optional: Undo update

If you encounter problems or errors with the EDI Connector after the update, please contact our support – support@myopenfactory.com.

Sometimes, it may be helpful to reset the EDI connector to the old version. After an update, the previously installed version of the EDI Connector is stored in the program directory („C:\program files\myOpenFactory\client“) with the name .myof-client.exe.old. To install the old version, just delete the new version “myof-client.exe” and rename the old version to “myof-client.exe”. Please note that the EDI Connector must be stopped for this, see 5.2. You can proceed now to point 5.3 to restart the EDI Connector.

5.6 Troubleshooting the update process

  • During the update, the EDi Connector returns an error that your rights are insufficient.

Solution: Please start the update using an administrative powershell.

  • The EDI cannot download the update from GitHub automatically.

Solution: Please perform a manual update using point 5.4.

  • The file .myof-client.exe.old is not displayed.

Solution A: In the settings of Windows Explorer you can activate the display of hidden files (see: https://support.microsoft.com/en-de/help/14201/windows-show-hidden-files)

Solution B: The update was not successful. Please perform a manual update, see 5.4

6. Certificate Change

  • If you receive a new certificate from us, the email contains a zip file.
Zertifikate-Mail
  • If you unzip it, you will see two files: “certificate.pem” and “certificate.p12”. The.p12 file is not relevant for the EDI Connector, just for using the browser. Only the PEM file will be used for the EDI Connector.
Zip-Datei Zertifikate
  • Simply rename it to “client.crt”. Either via context menu by right-clicking / rename or with the F2 key.
Zertifikat umbenennen
  • It should look like this afterwards.
Zertifikat erfolgreich umbenannt
  • Now open the directory of services and search for the myOF-client (may also be named differently). The Connector must now be stopped if it is han´t already stopped. (The latter occurs when the certificate has already expired). See point 5.1
Client-anhalten
  • Then change to the installation folder of the EDI Connector under “ProgramData”. There you will find the expired “client.crt”. Replace it with the new “client.crt” that you have just received and renamed.
Installations-Ordner

  • Finally, verify that the certificate filename in the config.properties file matches the new certificate filename. If not, please rename the configuration in config.properties accordingly so that the certificate can be loaded on restart.

  • After that, restart the Connector. See 5.3

7. Error-handling

If the EDI Connector does not work properly, restarting can help, see point 5.4

If restarting the Connector does’nt solve the problem, you can search the log files. They are usually located in the installation directory of the EDI Connector under ‘ProgramData’.

Log-Datei

Here you open the most recent log file and search for the keyword ‘ERROR’.

Error-Text

If the error message is not ‘speaking’ enough or there is no error message, please contact our support – support@myopenfactory.com. In any case, please send the log files of the last 3 days, we will then take care of the problem immediately.

Last modified November 7, 2024