Options
|
Description
|
Data Type
|
---|---|---|
--help
|
Displays the help.
|
[boolean]
|
--parentDir, -d
|
The parent directory for the project.
|
[default: “.”]
|
--logLevel, -1
|
Sets the log level.
|
[default: “info”]
|
package.json
|
---|
Property
|
Description
|
---|---|
name
|
Consists of any character that is valid in filenames. Preferably the name should be the name of the service to which connector interacts. The suffix should be –connector to indicate that it is a ThingWorx Flow connector. The name should be in the following format:
<ptc-servicename-connector>
The servicename cannot contain special characters other than an underscore (_).
For example, the name of ThingWorx Flow connector must be ptc-thingworx-connector in the package name.
|
description
|
Provide an appropriate description for the package as it is listed in the search results.
|
scripts
|
This is a dictionary containing script commands that are run at various times in the connector lifecycle.
• To run test scripts, execute the following command:
npm test
• To run custom scripts, execute the following command:
npm run <script name>
For more information on scripts, refer npm scripts website
|
dependencies
|
Other NPM packages that the connector uses in its code when the artifacts are started at runtime.
ptc-flow-sdk is a required dependency.
Do not remove the ptc-flow-sdk dependency because ThingWorx Flow may not be able to load the connector.
For more information on dependencies, refer to the dependencies section on the npm website.
|
devDependencies
|
Used during the development phase. You can map additional npm packages that are only used in testing the connector in the devDependencies.
For more information, refer to the devDependencies section on the npmjs website.
|