Installation

The NETframe is available to download from a netframe folder.

Requirements

Linux

  • 64 bits version
  • openssl

Running as a service:

Please refer to the guide here: https://docs.gsd.pl/restapi/information/installation/ under Linux/MacOS section.

Windows

  • 64 bits version
  • openssl

Web Service Configuration

NETframe configuration should begin with running file **net-frame.exe**. After performing this procedure, application won't start up, but it will create a configuration file **netframe-config.yml** 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 netframe-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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
host: 127.0.0.1
name: RestAPI
registerGSDServiceRoute: true
registerWebserviceASMXRoute: true
resolveHostNames: false
remoteURL: 'http://127.0.0.1:8083'
sessionTimeoutInSeconds: 700
logger:
    trimLogs: false
    maximumLogCharacters: 1000
    ansiColoring: true
listeners:
    -
        type: HttpListener
        enabled: true
        port: 8080
    -
        type: HttpsListener
        enabled: false
        port: 8334
        serverKey: cert/key.pem
        serverCert: cert/cert.pem
dfRasSetting:
    -
        host: 127.0.0.1
        ports:
            - 54332
    -
        host: gsdpl-dev-01
        ports:
            - 54332 
erpRasSetting: 
    -
        host: 127.0.0.1
        ports:
            - 54335
    -
        host: 192.168.2.32
        ports:
            - 54335
connection:
    idleTimeoutMilliseconds: 10000
    acquireTimeoutMilliseconds: 10000
    minimumActiveConnections: 0
    maximumActiveConnections: 10
statistics:
    enabled: true

the following items should be filled:

Field Description
host address bound to NETframe service
dfRASConfig list of DOCUframe remote access server addresses
dfRASConfig/host address of DOCUframe remote access server
dfRASConfig/port port on which DOCUframe remote access server listens
erpRASConfig list of ERPframe remote access server addresses
dfRASConfig/host address of ERPframe remote access server
dfRASConfig/port port on which ERPframe remote access server listens
registerWebserviceASMXRoute name of the client/partner
registerGSDServiceRoute name of the client/partner

Info

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

Field Description
listeners array with listeners
listeners/type type of listener, Available listeners: HttpListener, HttpsListener
listeners/enabled false / true
listeners/port port on which listener listens
listeners/serverKey key for server in *.pem file
listeners/serverCert certificate for server in *.pem file
registerGSDServiceRoute turns on SOAP paths that are compatible with an old IIS Web Service
registerWebserviceASMXRoute turns on SOAP paths that are compatible with an old Java Web Service
logger/trimLogs false / true
logger/ansiColoring false / true
connection/ connection pool settings
statistics stats settings
clientName name of the client/partner
resolveHostNames allows to use IP address only in the configuration file.
remoteURL specifies where the soap client should send the responses
sessionTimeoutInSeconds session timeout.

After configuring net-frame it can be run again with net-frame.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 remote access servers you have to add new object in `dfRASConfig` array.

netframe-config.yml file: 

1
2
3
4
5
6
7
8
9
dfRasSetting:
    -
        host: 127.0.0.1
        ports:
            - 54332
    -
        host: 192.168.1.1
        ports:
            - 54332

Connecting to more than one database

In order to connect with more than one database, you should make a login request for each database and store sessionIDs respectively, for each database.