Administrate the Flows¶
The flows are used to configure the processing of the jobs. They are kept in the MongoDB and can be administrated via PLOSSYS CLI.
Requirements¶
For the requirements for using PLOSSYS CLI, refer to PLOSSYS CLI.
Options¶
Specific Output Engine Server¶
For administrating the flows of a specific Output Engine server, specify the --server <plossys_server> option. Default is https://localhost:8080.
plossys flow <command> --server https://<plossys_server>:8080
Example - list all flows of the plossys.server1.com server
plossys flow list --server https://plossys.server1.com:8080
Self-Signed Certificates¶
Specifying the --insecure option, you avoid that the certificate will be checked by the client.
plossys flow <command> --insecure
User Authentication¶
Depending on the type of user authentication activated for the seal-rest service, you have to specify the user and the password with PLOSSYS CLI. By default, the specified user is first checked via OpenID Connect and via basic authentication as fallback.
plossys flow <command> --auth <auth_type> --user <user> --pass <password>
Example - list all flows as user test authenticated via OpenID Connect
plossys flow list --auth oidc --user test --pass test
Using OpenID Connect, you can alternatively specify a JSON Web token (JWT) instead of a user and his password.
plossys flow <command> --auth oidc --bearer <jwt>
Example - list all flows as a user authenticated via JSON Web token
plossys flow list --auth oidc --bearer eyJ0eXAiOiJKV1QiLCJhbG...
The credentials, that means user and password or the token, can also be contained in a credential file which is specified with PLOSSYS CLI.
plossys flow <command> --auth oidc --credential <credential_file>
Commands¶
List All (Standard or Customized) Flows¶
plossys flow list [--type standard|custom]
Without specifying --type, all flows will be listed.
Example - list all customized flows
plossys flow list --type custom
Import a Flow from a File¶
plossys flow import <file_name> --flowname <flow_name>
Only customized flows can be imported by the user. New flows will be added and existent flows will be overwritten. The flows already stored in PLOSSYS Output Engine will not be deleted. If you import a flow with the same name as a standard flow, it will override the standard flow.
Example - import a customized main flow
plossys flow import custom_main_flow.js --flowname main
Hint - restart service
After the import, the seal-convert-dispatcher service has to be restarted in order to enable the new flow.
Export a Flow to a File¶
plossys flow export <file_name> --flowname <flow_name> [--type standard|custom]
With --type, you specify the type of the flow to be exported if both a standard and a customized flow exist with the same name. Without --type, the customized flow will be exported in this case.
Example - list the customized main flow to a file
plossys flow export custom_main_flow.js --flowname main --type custom
Delete a Flow¶
plossys flow remove <flow_name>
Only customized flows can be removed. If you remove a customzed flow that has the same name as a standard flow, the standard flow will be used again.