Modeling Guide for SAP Data Hub

Project Files and Resources

vsolution.json

The vsolution.json desribes the solution and looks as follows:
{
    "name": "vsolution_vflow_my_solution",
    "version": "n.n.n",
    "description": "my Solution",
    "license": "my license"
} 

operator.json

The operator.json specifies the base operator (component), the interface (inports, outports), configuration data, and other details of the operator. See the following example:

Inports and outports can be empty or left out, if the operator does not have any ports. However, port names in either ports must be unique, if there are more than one ports. Moreover, port names should not contain special characters such as white spaces.

The script config must be specified if the script file is not placed in the same root path as the operator.json or is named differently than the operator's. Otherwise it can be left out.

Operator Script

The file script.js is the enrty point of your operator. The following example has been taken from the operator 'Node.js Counter' also available in the SAP Data Hub Modeler:

Operator Documentation

The operator's documentation can be created in a file named README.md in the operator's folder. To create the documentation for the operator Counter, for example, you have to create a new README.md file in the following path:
my_solution/subengines/com/sap/node/operators/com/mydomain/util/counter/README.md

The documentation is written using Markdown syntax (more information see Mastering MarkdownInformation published on non-SAP site).

Operator Icon

You can add a custom icon (file format: svg, .jpg or .png) for your operator. To do this, copy the icon to the operator's folder, for example:
my_solution/subengines/com/sap/node/operators/com/mydomain/util/counter/icon.svg