GSD NET-Sxp Installation

Requirements

Linux

  • 64 bits version
  • openssl

Running as a service:

Please refer to the REST API Linux installation guide.

Windows

  • 64 bits version

Web Service Configuration

Net-sxp configuration should begin with running file net-sxp.exe. After performing this procedure, application won't start up, but it will create a configuration file api-config.yaml instead. At this point, console window can be closed, and the configuration should be set. It can be done by using any text editor. On Linux machine those files should be already generated

Using quotes in config values

We recommend to miss quotes or use single quotes in config values, because those values are not interpreted. According to YAML specification, values which are surrounded with double quotes are interpreted, so it can cause errors during reading config values.


In the api-config.yml file: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
endpoint: 'http://127.0.0.1:8001/'
sxp:
    endpoints:
        -   host: 172.16.17.31
            ports: [54335]
            enabled: true
            appContext: 1
            clientName: dev_New
            userName: admin
            userPWHash: ''
            maximumSessions: 5
            acquireTimeout: 300000
            executionTimeout: 360000
            parameters:
                - name: webshopid
                  value: 'test'
                  type: 'C'
                - name: mandant
                  value: '1'
                  type: 'C'
            token: valid
jwtPassword: 'H5$o#([)HtDDX3!#8jPqn_JmLi(rfF'
logger:
    logRetentionDays: 5
    paths:
        common: ./logs/application.log
        login: ./logs/login.prof
        execute: ./logs/execute.prof

the following items should be filled:

Field Description
endpoints address bound to NET-sxp service
sxp/endpoints list of SXP server configurations
sxp/endpoints/host address of SXP server
sxp/endpoints/port port of SXP port
sxp/endpoints/enabled enables/disables endpoint configuration
sxp/endpoints/appContext application context value
sxp/endpoints/clientName client name value
sxp/endpoints/userName user name
sxp/endpoints/userPWHash user password in MD5
sxp/endpoints/maximumSessions maximum number of session
sxp/endpoints/acquireTimeout SXP server connection acquire timeout
sxp/endpoints/executionTimeout macro execution timeout
sxp/endpoints/parameters list parameters
sxp/endpoints/parameters/name parameter name
sxp/endpoints/parameters/value parameter value
sxp/endpoints/parameters/type parameter type
sxp/endpoints/token token used to register session for ERPframe, used in api/v1/login/via-token
sxp/endpoints/jwtPassword JWT password used to encrypt/decrypt JWT token

Info

Fields which are shown below are not required and can be left as default.

Field Description
logger logger settings
logger/logRetentionDays logger retention days value
logger/paths logger paths configuration
logger/paths/common logs path
logger/paths/login login logs path
logger/paths/execute execute macro logs path

After configuring net-sxp it can be run again with net-sxp.exe in order to start up the application.

In order to run netframe as a windows service follow instruction: Instruction

Adding additional remote access servers

To add additional sxp server you have to add new object in `endpoints` array.

api-config.yml file: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
sxp:
    endpoints:
        -
            host: 127.0.0.1
            ports:
                - 54335
            ....
        -
            host: 192.168.1.1
            ports:
                - 54335
            ....