Configuration

@feathersjs/configuration

It is a wrapper for node-config which allows to configure a server side Feathers application.

By default this implementation will look in config/* for default.json which retains convention. It will be merged with other configuration files in the config/ folder using the NODE_ENV environment variable. So setting NODE_ENV=production will merge config/default.json with config/production.json.

As per the config docs you can organize "hierarchical configurations for your app deployments".

.env

The .env file must be located at the root of the project, if it is missing, then it must be created based on the example file .env.example, otherwise the application will throw an error. The .env file sets environment variables. Environment variables usually contain user secrets, such as user_id, user_secret, etc.

Example for .env.example.

### SERVER ###
#-------------#
HOST="localhost"
PORT=3030
BASE_URL="http://localhost:3030"

...

### AUTH ###
#----------#
# External accounts to login
EXTERNAL_ACCOUNTS="google;github"
# yes | no; true | false; 1 | 0
MY_LOCALHOST_TO_IP=0
# yes | no; true | false; 1 | 0
IS_AUTH_MANAGER=0

# yes | no; true | false; 1 | 0
SET_USER_ACTIVE=1

...

### OPC-UA ###
#------------#
# localUpdate|localAdd|remoteUpdate|remoteAdd|no
DEFAULT_OPCUA_SAVEMODE_TODB="no"
# client|server|asyncServer
DEFAULT_EXECUTE_METHODS_FROM="client"
# http://localhost:3131
DEFAULT_OPCUA_REMOTE_DB_URL="http://localhost:3131"
# yes | no; true | false; 1 | 0
OPCUA_BOOTSTRAP_ENABLE=1
# -1(no limits) | 1..n(n limit)
OPCUA_VALUES_MAXROWS=10
# AuthenticatedUser, Supervisor, Administrator
OPCUA_USER_LOGIN="xxxxxxxxxxxxxx"
OPCUA_USER_PASS="xxxxxxxxxxxxxx"
OPCUA_ADMIN_LOGIN="xxxxxxxxxxxxxx"
OPCUA_ADMIN_PASS="xxxxxxxxxxxxxx"
OPCUA_KEP_LOGIN="xxxxxxxxxxxxxx"
OPCUA_KEP_PASS="xxxxxxxxxxxxxx"

### LOG ###
#----------#
# yes | no; true | false; 1 | 0
LOGMSG_ENABLE=1
# -1(no limits) | 1..n(n limit)
LOGMSG_MAXROWS=100

### SECRET DATA ###
#-----------------#
GITHUB_ID="xxxxxxxxxxxxxxxxxxxxxxxx"
GITHUB_SECRET="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

GOOGLE_ID="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com"
GOOGLE_SECRET="xxxxxxxxxxxxxxxxxxxxxxxxxxx"

### DATA-BASE ###
#-----------------#

# MSSQL
MSSQL_ASODU_TEST_ID="OGMT-MZTP.FIRST.dbBSA"
MSSQL_ASODU_TEST_USER="xxxxxxxxxxxxxxx"
MSSQL_ASODU_TEST_PASS="xxxxxxxxxxxxxxx"

MSSQL_BSAHOME_TEST_ID="BSA-HOME.SQLEXPRESS.Feathers_test"
MSSQL_BSAHOME_TEST_USER="xxxx"
MSSQL_BSAHOME_TEST_PASS="xxxxxxxxxxxxx"

# DEFAULT TYPE DB (mongodb | nedb)
DEFAULT_TYPE_DB="nedb"

# MONGODB
MONGODB_DEV_URL="mongodb://localhost:27017/feathers_opcua_devserver"
MONGODB_TEST_URL="mongodb://localhost:27017/feathers_opcua_testserver"
MONGODB_PROD_URL="mongodb://localhost:27017/feathers_opcua_prodserver"

# NEDB
NEDB_DEV_PATH="nedb://../data/nedb/dev"
NEDB_TEST_PATH="nedb://../data/nedb/test"
NEDB_PROD_PATH="nedb://../data/nedb/prod"

Note: To have real keys to access the API of various services, you need to register your application in these services. Examples of registering an application and obtaining API keys in different services can be found here.

Main sections of the environment variable file .env:

• SERVER - used in configuration files \config\default.json, \config\development.json, \config\production.json, \config\test.json.
• AUTH - used to authenticate and authorize users to access application resources.
• OPC-UA - used to set the parameters of the library NodeOPCUA.
• LOG - used for logging events.
• SECRET DATA - secret data for services (GOOGLE, GITHUB).
• DATA-BASE - database information (MSSQL, MONGODB, NEDB).

feathers-specs

This configuration file is located in the folder \config\feathers-specs.json. Main sections of feathers-specs:

• envTestModeName - the value is set to a variable NODE_ENV for the test mode.

{
  "app": {
    "envTestModeName": "test",
    ...
  },
  ...
}

• envAllowingSeedData - modes for which it is allowed to change data in the database with \seeds\fake-data.json.

{
  "app": {
    ...
    "envAllowingSeedData": ["test"],
    ...
  },
  ...
}

• providers - transport types used to transfer data.

{
  "app": {
    ...
    "providers": [
      "rest",
      "socketio"
    ]
    ...
  },
  ...
}

• services - service properties such as name, path, etc.

{
  "services": {
    "users": {
      "name": "users",
      "nameSingular": "user",
      "subFolder": "",
      "fileName": "users",
      "adapter": "nedb",
      "path": "/users",
      "isAuthEntity": true,
      "requiresAuth": true,
      "overriddenAuth": {
        "create": "noauth",
        "get": "auth",
        "find": "auth",
        "update": "auth",
        "patch": "auth",
        "remove": "auth"
      }
    },
  },
  ...
}

• hooks - hook properties such as fileName, ifMulti, etc.

{
  "hooks": {
    "normalize": {
      "fileName": "normalize",
      "camelName": "normalize",
      "ifMulti": "y",
      "multiServices": [
        "*app"
      ],
      "singleService": ""
    },
    ...
  },
  ...
}

OPCUA Config

An application is configured for its host on which it is installed using a configuration file src\api\opcua\config\OPCUA_Config.json. In doing so, you can define separate configurations for this host. Each configuration has its own unique number, for example ua-cherkassy-azot-asutp_dev1 , you can also define the server and client and what tags they will work with. Also in the configuration, you can determine which database to work with and in which mode, which data transfer protection mode to use, and how to authenticate the user.

Main sections of the config file OPCUA_Config:

• id - unique configuration code.
• name - unique configuration name.
• endpointUrl - opcua server endpoint url.
• endpointPort - opcua server endpoint port.
• srvServiceUrl - features framework host url for opcua-servers service.
• clientServiceUrl - features framework host url for opcua-clients service.
• clientScript - the name of the function to initialize the subscription on the client at startup src\plugins\opcua\opcua-bootstrap.js.
• executeMethodsFrom - the place where the method should be executed, possible values: client|server|asyncServer.
• hostTypeDB - the type of database the application will work with, possible values: (mongodb|nedb).
• opcuaSaveModeToDB - database operation mode, working or not, local or remote database, updating or adding current opcua-values, possible values: localUpdate|localAdd|remoteUpdate|remoteAdd|no.
• opcuaRemoteDbUrl - the url of the database where we will store the opcua-tags or opcua-values data.
• opcuaBootstrapParams - parameters at startup of src\plugins\opcua\opcua-bootstrap.js.
• security - opcua data transfer security settings and user authentication.
• NodeId - parameters for the client to receive specific values NodeId from the server. e.g. nodeName.
• include tests - what tests will we run on this host e.g. ["mssql-tedious.test.js","mssql-datasets.test.js", "http-operations.test.js"].
• paths['base-options'] - base tag paths.
• paths['options'] - path to tags for a specific configuration, tags that override tag values from base paths.

[
  ...
  {
    "isEnable": true,
    "id": "ua-cherkassy-azot-asutp_dev1",
    "name": "380-472-00203826-asutp_dev1",
    "description": "Opcua server and client for `azot-m5`, `azot-ogmtmztp` tags from `opc.tcp://M5-0095488.OSTCHEM.COM.UA:26570`",
    "endpointUrl": "opc.tcp://M5-0095488.OSTCHEM.COM.UA:26570",
    "endpointPort": 26570,
    "srvServiceUrl": "http://10.60.0.220:3030",
    "clientServiceUrl": "http://10.60.0.220:3030",
    "clientScript": "startSubscriptionMonitor",
    "executeMethodsFrom": "client",
    "hostTypeDB": "mongodb",
    "opcuaSaveModeToDB": "localUpdate",
    "opcuaRemoteDbUrl": "http://M5-0095488.OSTCHEM.COM.UA:3131",
    "opcuaBootstrapParams": {
      "clearHistoryAtStartup": false,
      "syncHistoryAtStartup": { 
        "active": false,
        "methodName": "methodAcmDayReportsDataGet"
      },
      "syncReportAtStartup": {
        "active": false,
        "methodName": "methodAcmYearReportUpdate"
      }
    },
    "security": {
      "mode": "SignAndEncrypt",
      "policy": "Basic256Sha256",
      "userName": "OPCUA_ADMIN_LOGIN",
      "password": "OPCUA_ADMIN_PASS"
    },
    "NodeId": {
      "namespaceIndex": 2,
      "identifierType": "displayName",
      "identifierPrefix": "Channel1.Device1",
      "addObjectItem": true
    },
    "include": {
      "tests": [
        "mssql-tedious.test.js",
        "mssql-datasets.test.js",
        "http-operations.test.js"
      ]
    },
    "paths": {
      "base-options": [
        "/src/api/opcua/tags/ua-cherkassy-azot-m5_prod1",
        "/src/api/opcua/tags/ua-cherkassy-azot-ogmttsd_prod1"
      ],
      "options": "/src/api/opcua/tags/ua-cherkassy-azot-asutp_dev1/AddressSpaceOptions.json",
      "getters": "",
      "methods": "",
      "subscriptions": "",
      "client-scripts": ""
    }
  }
  ...
]

OPCUA Tags

An application is configured for its host on which it is installed using a configuration file src\api\opcua\config\OPCUA_Config.json. In doing so, you can define separate configurations for this host. Each configuration has its own unique number, for example ua-cherkassy-azot-asutp_dev1, you can also define the server and client and what tags they will work with. The configuration specifies the base paths paths['base-options'] to the tag files and the config path paths['options'] to the tag file, which overrides the values of the base tags.

Example of base path tags:

{
  "objects": [
    {
      "isEnable": true,
      "browseName": "CH_M5",
      "displayName": "Workshop M5 Cherkasy `AZOT`",
      "type": "object"
    },
    {
      "isEnable": true,
      "browseName": "CH_M51",
      "displayName": "Workshop M5 dep.1 Cherkassy `AZOT`",
      "type": "object"
    }
  ],
  "variables": [
    {
      "browseName": "CH_M51::ValueFromFile",
      "displayName": "Values from file for CH_M51",
      "ownerName": "CH_M51",
      "type": "variable.simple",
      "dataType": "String",
      "hist": 1,
      "group": true,
      "subscription": "onChangedGroupHandlerForDB",
      "variableGetType": "valueFromSource",
      "getter": "getterHistValueFromPath",
      "getterParams": {
        "path": "//192.168.3.5/www_m5/m5_data2"
      }
    }
  ],
  "groups": [
    {
      "browseName": "CH_M51::01AMIAK:01T4",
      "aliasName": "01NH3_T4",
      "displayName": "01NH3_T4",
      "ownerName": "CH_M51",
      "ownerGroup": "CH_M51::ValueFromFile",
      "type": "variable.analog",
      "dataType": "Double",
      "hist": 1,
      "variableGetType": "valueFromSource",
      "getter": "getterPlugForVariable",
      "valueParams": {
        "engineeringUnitsRange": {
          "low": 0,
          "high": 200
        },
        "engineeringUnits": "degree_celsius"
      },
      "description": "Ammonia gas temperature NH3 (T4)"
    },
  ],
  "methods": [
    {
      "browseName": "CH_M5::YearTemplateCreate",
      "displayName": "Create an annual report template",
      "ownerName": "CH_M5",
      "type": "method",
      "bindMethod": "methodAcmYearTemplateCreate",
      "inputArguments": [
        {
          "name": "methodParameters",
          "description": {
            "text": "Method parameters"
          },
          "dataType": "String"
        }
      ],
      "outputArguments": [
        {
          "name": "methodExecutionResult",
          "description": {
            "text": "Method execution result"
          },
          "dataType": "String",
          "valueRank": 1
        }
      ],
      "userAccessLevel": {
        "inputArguments": "CurrentRead",
        "outputArguments": "CurrentRead"
      }
    }
  ]
}

Example of config path tags:

{
  "objects": [
    {
      "isEnable": false,
      "browseName": "CH_M5",
      "displayName": "Workshop M5 Cherkasy `AZOT`",
      "type": "object"
    },
    {
      "isEnable": true,
      "browseName": "CH_M51",
      "displayName": "Workshop M5 dep.1 Cherkassy `AZOT`",
      "type": "object"
    }
  ],
  "variables": [
    {
      "browseName": "CH_M51::ValueFromFile",
      "displayName": "Values from file for CH_M51",
      "ownerName": "CH_M51",
      "type": "variable.simple",
      "dataType": "String",
      "hist": 1,
      "group": true,
      "subscription": "onChangedGroupHandlerForDB",
      "variableGetType": "valueFromSource",
      "getter": "getterHistValueFromHttpPath",
      "getterParams": {
        "path": "http://192.168.3.5/www_m5/m5_data2/",
        "interval": 20000
      }
    }
  ]
}

Main sections of the tag file:

• objects - set of object tags. All tags ("variables", "groups", "methods") belong to some object tag through the ownerName field (e.g. "ownerName": "CH_M51").
• variables - set of variable tags. If the "group" field is set to true, then this tag is the owner of the tag group (e.g. "group": true).
• groups - set of group tags. These are tags that belong to a tag group. The name of the owner of this group is indicated in the ownerGroup field (e.g. "ownerGroup": "CH_M51::ValueFromFile").
• methods - set of method tags.
• browseName - browse name (e.g. "browseName": "CH_M51::ValueFromFile").
• displayName - display name (e.g. "displayName": "Values from file for CH_M51").
• ownerName - name of owner (e.g. "ownerName": "CH_M51").
• type - variable type (e.g. "type": "variable.simple").
• dataType - data type (e.g. "dataType": "Double").
• hist - story size (e.g. "hist": 1).
• group - group tag (e.g. "group": true).
• ownerGroup - owner tag name (e.g. "ownerGroup": "CH_M51::ValueFromFile").
• variableGetType - data source for a variable (e.g. "variableGetType": "valueFromSource").
• subscription - variable change event handler function name (e.g. "subscription": "onChangedGroupHandlerForDB").
• getter - the name of the get data function for the variable (e.g. "getter": "getterHistValueFromHttpPath").
• getterParams - parameters for the get data function for a variable (e.g. "getterParams": { "path": "http://192.168.3.5/www_m5/m5_data2/", "interval": 20000 }).
• valueParams.engineeringUnitsRange - engineering units range (e.g. valueParams.engineeringUnitsRange: { "low": 0, "high": 200 }).
• valueParams.engineeringUnits - engineering units (e.g. valueParams.engineeringUnits: "degree_celsius").
• description - tag description (e.g. "description": "Ammonia gas temperature NH3 (T4)").
• bindMethod - bind method (e.g. "bindMethod": "methodAcmYearTemplateCreate").
• inputArguments - input arguments for the method.
• outputArguments - output arguments for the method.