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

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.json** 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


In the netframe-config.json 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
48
49
50
51
52
53
54
{
  "host": "127.0.0.1",
  "http": {
    "port": 8083,
    "enabled": false
  },
  "https": {
      "port": 8446,
      "serverKey": "cert/key.pem",
      "serverCert": "cert/cert.pem"
      "enabled": true
  },
  "dfRASConfig": [
    {
      "host": "127.0.0.1", 
      "port": 54335
    }
  ],
  "erpRASConfig": [
    {
      "host": "127.0.0.1", 
      "port": 54336
    }
  ],
  "registerGSDServiceRoute": true,
  "registerWebserviceASMXRoute" : true,
  "loggerConfig": {
    "severity": 0,
    "targetConfigs": [
      {
        "name": "console-target",
        "enabled": true
      },
      {
        "name": "file-target",
        "enabled": true,
        "logFileLocation": "log"
      }
    ],
    "truncate": true,
    "truncateSize": 500
  },
  "limitterConfig": {
    "enabled": false,
    "limitDBOpen": true,
    "limitDBExecute": false,
    "maxRequest": 5,
    "timeFrameMS": 360000
  },
  "proxyConfig": {
    "proxyServerAddressWS": "ws://127.0.0.1:8081",
    "enabled": false
  }
}

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

Info

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

Field Description
http/enabled true / false
http/port port on which Web Service listens
https/enabled true / false
https/port port on which Web Service listens
https/serverKey key for server in *.pem file
https/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
loggerConfig/severity
loggerConfig/targetConfigs array with target configurations
loggerConfig/truncate/ false / true
loggerConfig/truncateSize
limitterConfig/enabled false / true
limitterConfig/limitDBOpen false / true
limitterConfig/limitDBExecute false / true
limitterConfig/maxRequest maximum number of requests
clusterConfig/maxWorkers maximum number of workers
clusterConfig/timeFrameMS
proxyConfig/proxyServerAddressWS address of the proxy server
proxyConfig/enabled false / true

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.json file: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "host": "127.0.0.1",
  "port": 8083,
  "dfRASConfig": [
    {
      "host": "127.0.0.1"
    }
    {
      "host": "second remote access server address"
    }
  ],
  ...

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.