Please support us to improve our service. We would like to use statistics anonymously.

We do not pass on your data! You can find more information in our privacy policy.

Decline

< Back to documentation

Flowy Util

Flowy Util is a Command-Line-based tool which supports the following modes of operation:

• export or import objects
• encrypt or decrypt files

Export or import Flowy objects

The CLI tool provides a simple and efficient way to export or import objects using the following syntax:

$ java -jar flowy-cli.jar
--flowy.show-error-stacktrace=true
--flowy.username=admin@getflowy.io
--flowy.password=admin
--flowy.command=EXPORT_MODULE|IMPORT_MODULE|EXPORT_RESOURCE|INSERT_IMPORT_RESOURCE|UPDATE_IMPORT_RESOURCE
--flowy.base-url=http://localhost:8080/api
--flowy.resource-path=/module
--flowy.resource-name=module_test
--flowy.file=module.json
--flowy.overrides=status=ACTIVE,name=newModuleName

Encrypt or decrypt files

In order to validate or restore encrypted files, the following syntax shall be used:

$ java -jar flowy-cli.jar
--flowy.show-error-stacktrace=true
--flowy.command=ENCRYPT|DECRYPT
--flowy.security.password=pass
--flowy.security.input-file=input.txt
--flowy.security.output-file=output.txt

Export or import libraries

$ java -jar flowy-cli.jar
--flowy.username=admin@getflowy.io
--flowy.password=admin
--flowy.command=EXPORT_RESOURCE
--flowy.base-url=http://localhost:8080/api
--flowy.resource-path=/library
--flowy.resource-name=libraryName
--flowy.file=library.json

$ java -jar flowy-cli.jar
--flowy.username=admin@getflowy.io
--flowy.password=admin
--flowy.command=INSERT_IMPORT_RESOURCE
--flowy.base-url=http://localhost:8080/api
--flowy.resource-path=/library
--flowy.resource-name=libraryName
--flowy.file=library.json

Update frontend setting

$ java -jar flowy-cli.jar
--flowy.username=admin@getflowy.io
--flowy.password=admin
--flowy.command=UPDATE_FRONTEND_SETTING
--flowy.base-url=http://localhost:8080/api
--flowy.frontend-setting-path=/global-setting/frontend
--flowy.file=settings.json

settings.json example:

{
  "baseUrlRest": "https://example.getflowy.io/api/",
  "logServerUrl": "https://example.getflowy.io/logs/",
  "metricServerUrl": "https://example.getflowy.io/metric/",
  "visualisationServerUrl": "https://example.getflowy.io/visual/",
  "setPasswordUrl": "https://example.getflowy.io/set-password/",
  "defaultLocale": "en",
  "environmentName": "qa"
}

Update default SMTP credentials

$ java -jar flowy-cli.jar
--flowy.username=admin@getflowy.io
--flowy.password=admin
--flowy.command=UPDATE_DEFAULT_SMTP_CREDENTIALS
--flowy.base-url=http://localhost:8080/api
--flowy.resource-path=/process-credential
--flowy.file=process-credentials.json

process-credentials.json example:

{
  "status": "ACTIVE",
  "isGdprRelevant": false,
  "values": {
    "senderAddress": "senderAddress",
    "host": "examplesmtp.getflowy.io",
    "port": 587,
    "timeout": 10000,
    "password": "password",
    "username": "newinstallation@getflowy.io",
    "writeTimeout": 10000,
    "connectionTimeout": 10000
  },
  "encryptedFields": [
    {
      "type": "PLAIN",
      "field": "senderAddress"
    },
    {
      "type": "ENCRYPT",
      "field": "password"
    }
  ]
}

Test an HTTP connection

$ java -jar flowy-cli.jar
--flowy.command=TEST_HTTP
--flowy.base-url=http://localhost:8080/api