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.

seal-dpf-process-manager loads a changed workflow configuration from MongoDB without a restart. Each working unit service loads its own changed configuration from MongoDB without a restart.

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

Caution - mixed operation

Storing the configuration in both MongoDB and filesystem at the same time is possible, but not recommended. Choose one storage location. If both are used, the MongoDB version takes priority.

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.
  createdeployjson [options]       Create and deploy JSON configuration to database.
  deploypako [options]             Deploy pako configuration to database.
                                   The options "--dir" and "--json" are mutually exclusive.
  reload [options]                 Force DPF services to reload configuration in database.
  list [options] [name]            List configuration in 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:

  • -d, --dir <dir...>: base directory of XML files. May be specified multiple times. Mandatory
  • -f, --flavor <flavor>: flavor of created JSON data, e.g. processprint. 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:

  • -j, --json <filename...>: name of JSON configuration file to deploy. May be specified multiple times. Mandatory
  • -m, --mongo <url>: full URL to access MongoDB. Default: mongodb://localhost:27017/dpf. Optional
  • --server <value>: server url (http://localhost:4304) (default: http://localhost:4304). Optional
  • -n, --new-config: create new configuration instead of merging into existing. Optional
  • -r, --reload: trigger reload in DPF after update. Optional

Example:

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

    Deploy all workflow and working unit configuration from ./dpf4distribute.json and ./dpf4convert.json MongoDB, do not merge into an already existing configuration, but create a new one.

createdeployjson

createdeployjson Create and deploy JSON configuration to MongoDB in one step.

Usage: dpf-saas createdeployjson [options]

Options:

Usage: dpf-saas createdeployjson [options]

Create and deploy JSON configuration to database.

Options:

  • -d, --dir <dir...>: base directory of XML files. May be specified multiple times. Mandatory
  • -j, --json <filename>: Name of JSON configuration file to create. Mandatory
  • -f, --flavor <flavor>: flavor of created JSON data, e.g. dpf4convert. Mandatory
  • -m, --mongo <url>: full URL to access MongoDB. Default: mongodb://localhost:27017/dpf. Optional
  • --server <value>: server url (http://localhost:4304) (default: http://localhost:4304). Optional
  • -n, --new-config: create new configuration instead of merging into existing. Optional
  • -r, --reload: trigger reload in DPF after update. Optional

Example:

  • dpf saas createdeployjson -n --json ./dpf4distribute.json --dir ./templates -f dpf4distribute --mongo mongodb://locahost:27017/dpf

    Find all workflow and working unit configuration under ./templates, store it with flavor dpf4distribute in the file ./dpf4distribute.json and deploy it immediately to MongoDB. Do not merge into an already existing configuration, but create a new one.

deploypako

deploypako read all customer specific pako workflow and working unit XML files either from file under a root directory or from a prepared JSON configuration file and deploy to MongoDB. Please note that the options --dir and --json are mutually exclusiv.

Usage: dpf-saas deploypako [options]

Options:

  • -d, --dir <dir...>: base directory of pako XML files. May be specified multiple times.
  • -j, --json <filename...> name of JSON configuration file to deploy. May be specified multiple times.
  • -m, --mongo <url>: full URL to access MongoDB. Default: mongodb://localhost:27017/dpf. Optional
  • --server <value>: server url (http://localhost:4304) (default: http://localhost:4304). Optional
  • -r, --reload: trigger reload in DPF after update. Optional

Example:

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

    Find all workflow and working unit configuration under /customer and deploy it into MongoDB. Trigger reload of new configuration in DPF afterwards.

reload

reload triggers DPF services to reload configuration in database.

Usage: dpf-saas reload [options]

Options:

  • --server <value>: server url (http://localhost:4304) (default: http://localhost:4304). Optional

Example:

  • dpf saas reload --server https://my-dpf-server:4304

    Triggers DPF via seal-dpf-management-api service on host my-dpf-server to reload new configuration.

list

list reads the configuration from MongoDB and prints it on stdout.

Usage: dpf-saas list [options] [name]

Arguments:

  • name: name of a spezific configuration. May of any type. Optional

Options:

  • -m, --mongo <url>: full URL to access MongoDB. Default: mongodb://localhost:27017/dpf. Optional
  • -f, --full: list full information, if not given list only names and types. Optional
  • -s, --silent: suppress TLS warnings for batch usage. Optional
  • -t, --type <type>: configuration type to list. If not set all types are listed. May be specified multiple times. Types are: wu, wf, main. Optional

Example:

  • dpf saas list --silent --type main --mongo mongodb://locahost:27017/dpf

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

Back to top