Skip to content

Administrate the DPF SAAS Configuration

In a SAAS installation, the configuration of workflows and working units is kept in the MongoDB. In an on-premise environment, the configuration is read from filesystem.

The SAAS configuration of a DPF system can be administrated by DPF CLI using the dpf saas command.

Requirements

For the requirements for using DPF CLI, refer to DPF CLI.

Commands

Usage: dpf saas [options] [command]

Options:
  -V, --version                 output the version number
  -h, --help                    display help for command

Commands:
  createjson [options] <jsonfile>  Create new JSON configuration from XML files.

    required arguments:
      jsonfile: the path and name of the resulting configuration file in JSON format
  deployjson [options]             Deploy JSON configuration to database.
  deploypako [options]             Deploy pako configuration to database.
  help [command]                   display help for command

help

help displays the help for the command.

Usage: dpf saas help [command]

createjson

createjson creates new JSON configuration from all found workflow and working unit XML files.

Usage: dpf-saas createjson [options]

Arguments:

  • jsonfile: the path and name of the resulting configuration file in JSON format. Mandatory

Options:

  • --dir <dir...>: base directory of XML files. May be specified multiple times. Mandatory
  • --flavor <flavor>: flavor of created JSON data, e.g. dpf4convert. Mandatory

Example:

  • dpf saas createjson ./dpf4distribute.json --dir /applications --flavor dpf4distribute

    Find all workflow and working unit configuration under /applications and store it with flavor dpf4distribute in the file ./dpf4distribute.json.

deployjson

deployjson deploys JSON configurations to MongoDB.

Usage: dpf-saas deployjson [options]

Options:

  • --json <filename...>: name of JSON configuration file to deploy. May be specified multiple times. Mandatory
  • --mongo <url>: full URL to access MongoDB. Default: "mongodb://localhost:27017/dpf". Optional

Example:

  • dpf saas deployjson --json ./dpf4distribute.json --json ./dpf4convert.json --mongo mongodb://locahost:27017/dpf

    Deploy all workflow and working unit configuration from ./dpf4distribute.json and ./dpf4convert.json into MongoDB.

deploypako

deploypako read all customer specific pako workflow and working unit XML files under a root directory and deploy to MongoDB.

Usage: dpf-saas deploypako [options]

Options:

  • --dir <dir...>: base directory of pako XML files. May be specified multiple times. Mandatory
  • --mongo <url>: full URL to access MongoDB. Default: "mongodb://localhost:27017/dpf". Optional

Example:

  • dpf saas deploypako --dir /customer -mongo mongodb://locahost:27017/dpf

    Find all workflow and working unit configuration under /customer and deploy it into MongoDB.

Back to top