Skip to content

Keys

The key value store of Consul administrates the SEAL Operator configuration.

You can change the key via the Consul Web interface, refer to Consul, or via SEAL Operator CLI, refer to Administrate the System Configuration.

Hint - error messages

Consul has been updated to the version 1.7.4. With this update, the user interface has changed a lot. For example, in the value input dialog, the data is checked for a structure by default and, therefore, you will get error messages in most cases when entering data. In order to avoid these, deactivate the Code switch at the top right.

Units

Values with time specifications are specified in the following time units:

  • seconds (s, sec)

  • minutes (m, min)

  • hours (h, hr)

  • days (d)

  • weeks (w, wk)

  • months

  • years (y, yr)

Example - with time units

2 hours and 30 minutes: 2h30m

4 minutes and 2 seconds: 4m2s

ACTION_EXECUTOR

ACTION_EXECUTOR specifies the backend system.

The key is available for the following services:

  • seal-operator-dpf
  • seal-operator-p4
  • seal-operator-p5
  • seal-preprocess

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-dpf/tag/any/ACTION_EXECUTOR
  • dc/home/env/service/operator-p4/tag/any/ACTION_EXECUTOR
  • dc/home/env/service/operator-p5/tag/any/ACTION_EXECUTOR
  • dc/home/env/service/preprocess/tag/any/ACTION_EXECUTOR

Available values: String

  • CONVERT

    Conversion

  • DPF

    Digital Paper Factory

  • MOCK

    Only simulation

  • P4

    PLOSSYS netdome system

  • P5

    PLOSSYS 5 system

Default: MOCK

ALLOWED_OIDC_CLIENTS

ALLOWED_OIDC_CLIENTS specifies the mapping of permissions to roles specified in the OIDC identity provider. For some examples, refer to Configure Roles.

The key is available for the seal-operator-server and seal-operator-fileupload services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/ALLOWED_OIDC_CLIENTS
  • dc/home/env/service/operator-fileupload/tag/any/ALLOWED_OIDC_CLIENTS

If you like to specify it only once, specify it here:

  • dc/home/env/service/any/tag/any/ALLOWED_OIDC_CLIENTS

Available values: JSON string format

Default: none

API_BASE_URL

API_BASE_URL specifies the URL of the server API.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/API_BASE_URL

Available values: String

  • <api_base_url>

Default: https://api:3008

API_VERSION

API_VERSION specifies the version of the server API.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/API_VERSION

Available values: String

  • <api_version>

Default: v1

APW_URL

APW_URL specifies the URL of the APW REST server.

The key is available for the seal-operator-p4 service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p4/tag/any/APW_URL

Available values: String

  • <apw_url>

Default: https://localhost:8443

AUTH_CLIENT_ID

AUTH_CLIENT_ID specifies the client name configured in the OIDC identity provider for retrieving the access token.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/any/tag/any/AUTH_CLIENT_ID for all services
  • dc/home/env/service/<service>/tag/any/AUTH_CLIENT_ID for the specific <service> service

Available values: String

  • <client_id>

Default:

  • seal-print-client for the user interface
  • operator for all other services

AUTH_CLIENT_SECRET

AUTH_CLIENT_SECRET specifies the client secret for retrieving the OIDC identity provider's access token.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/any/tag/any/AUTH_CLIENT_SECRET for all services
  • dc/home/env/service/<service>/tag/any/AUTH_CLIENT_SECRET for the specific <service> service

Available values: String

  • <client_secret>

Default: not revealed

AUTH_CLOCK_TOLERANCE

AUTH_CLOCK_TOLERANCE specifies the number of seconds allowed as time difference between the OAuth provider and client.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/AUTH_CLOCK_TOLERANCE

Available values: String

  • <number_seconds>

Default: 5

AUTH_DEFAULT_SESSION_DURATION

AUTH_DEFAULT_SESSION_DURATION specifies the duration of the default session in seconds if the OAuth provider does not expose the refresh_expires_in parameter in the token.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/AUTH_DEFAULT_SESSION_DURATION

Available values: String

  • <number_seconds>

Default: 180

AUTH_ISSUER_URL

AUTH_ISSUER_URL specifies the OIDC issuer URL. This URL points to Keycloak for example. For more information about Keycloak used with SEAL Systems products, refer to the SEAL Interfaces for OIDC documentation.

The key is available for the following services:

  • seal-operator-ui
  • seal-operator-server

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/AUTH_ISSUER_URL
  • dc/home/env/service/operator-server/tag/any/AUTH_ISSUER_URL

Available values: String

  • <oidc_issuer_url>

Default: https://localhost:32769/auth/realms/SEAL

AUTH_REFRESH_TOLERANCE

AUTH_REFRESH_TOLERANCE specifies the number of seconds after which a token will be refreshed when it is about to expire.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/AUTH_REFRESH_TOLERANCE

Available values: String

  • <number_seconds>

Default: 5

AUTH_TOKEN_ENDPOINT

AUTH_TOKEN_ENDPOINT specifies the URL of the token endpoint.

The key is available for the following services:

  • seal-operator-dpf
  • seal-operator-p4
  • seal-operator-p5

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-dpf/tag/any/AUTH_TOKEN_ENDPOINT
  • dc/home/env/service/operator-p4/tag/any/AUTH_TOKEN_ENDPOINT
  • dc/home/env/service/operator-p5/tag/any/AUTH_TOKEN_ENDPOINT

Available values: String

  • <auth_token_endpoint>

Default: The default is evaluated by the OpenID configuration path.

AVAILABLE_LANGUAGES

AVAILABLE_LANGUAGES specifies the languages provided to the user in the user interface. With the same name, a language file (<language>.json) has to exist in C:\Program Files\SEAL Systems\seal-operator-ui\dist\assets\i18n on Windows or /opt/seal/seal-operator-ui/dist/assets/i18n on Linux. Multiple languages are separated by comma.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/AVAILABLE_LANGUAGES

Available values: String

  • <language1>,<language2> ... <languagex>

Default: de,en

CHECK_DOC_NAMES

CHECK_DOC_NAMES specifies if entries with the same name are allowed in My Documents.

The key is available for the seal-operator-fileupload service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-fileupload/tag/any/CHECK_DOC_NAMES

Available values: Boolean

  • Y

    The entries have to have different names. (<n>) is appended to duplicate entries.

  • N

    Duplicate entries are allowed.

Default: Y

CLOSE_PANEL_AFTER_START_TASK

CLOSE_PANEL_AFTER_START_TASK specifes if the task panel will be closed after starting the task (printing or converting for example).

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/CLOSE_PANEL_AFTER_START_TASK

Available values: Boolean

  • true

    The task panel will be closed.

  • false

    The task panel will stay open.

Default: false

CONNECTOR_FILE_NAME

CONNECTOR_FILE_NAME specifies the path and the name of the YAML file containing the configuration of the connectors if SEAL Operator is running in a cloud environment.

Example - connector file

operator:
  connectors:
    p4:
      cstatus: 'on'
      serviceName: operator-p4
      url: 'https://operator-p4:3000'
    scratch:
      cstatus: 'on'
      serviceName: operator-fileupload
      url: 'https://operator-fileupload:3000'

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/CONNECTOR_FILE_NAME

Available values: String

  • <config_file>

Default: /config/connector.yml

CONSUL_TOKEN

CONSUL_TOKEN specifies the ACL token with which the SEAL Operator services authenticate themselves to Consul.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/any/tag/any/CONSUL_TOKEN

Available values: String

  • <token>

Default: none

CONSUL_URL

CONSUL_URL specifies the address of the Consul server to which the SEAL Operator services log on.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/any/tag/any/CONSUL_URL

Available values: String

  • consul_url

Default: https://localhost:8500

CREATE_PREVIEW

CREATE_PREVIEW specifies if previews are created for the documents in My Documents.

The key is available for the seal-operator-fileupload service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-fileupload/tag/any/CREATE_PREVIEW

Available values: Boolean

  • Y

    Previews are created.

  • N

    No previews are created.

Default: Y

CS_TYPE

CS_TYPE specifies the used credential store type.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/CS_TYPE

Available values: String

  • none

    No credential store

  • mock

    Only simulation

  • mongo

    Store credentials in MongoDB

Default: mongo

DEFAULT_DPF_SCHEMA

DEFAULT_DPF_SCHEMA specifies the path to the JSON schema file containing the configuration of the DPF connector.

The key is available for the seal-operator-dpf service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-dpf/tag/any/DEFAULT_DPF_SCHEMA

Available values: String

  • <path_name>

Default: <dpf_connector_install_dir>/lib/defaultConfig/schema.json

DEFAULT_FILEUPLOAD_PANEL

DEFAULT_FILEUPLOAD_PANEL specifies the path to the JSON schema file containing the configuration of the panel.

The key is available for the seal-operator-fileupload service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-fileupload/tag/any/DEFAULT_FILEUPLOAD_PANEL

Available values: String

  • <path_name>

Default: <fileupload_connector_install_dir>/lib/defaultConfig/panel.json

DEFAULT_FILEUPLOAD_SCHEMA

DEFAULT_FILEUPLOAD_SCHEMA specifies the path to the JSON schema file containing the configuration of the My Documents connector.

The key is available for the seal-operator-fileupload service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-fileupload/tag/any/DEFAULT_FILEUPLOAD_SCHEMA

Available values: String

  • <path_name>

Default: <fileupload_connector_install_dir>/lib/defaultConfig/settings.json

DEFAULT_P4_PANEL

DEFAULT_P4_PANEL specifies the path to the JSON schema file containing the configuration of the panel.

The key is available for the seal-operator-p4 service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p4/tag/any/DEFAULT_P4_PANEL

Available values: String

  • <path_name>

Default: <p4_connector_install_dir>/lib/defaultConfig/panel.json

DEFAULT_P4_SCHEMA

DEFAULT_P4_SCHEMA specifies the path to the JSON schema file containing the configuration of the PLOSSYS netdome connector.

The key is available for the seal-operator-p4 service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p4/tag/any/DEFAULT_P4_SCHEMA

Available values: String

  • <path_name>

Default: <p4_connector_install_dir>/lib/defaultConfig/settings.json

DEFAULT_P5_PANEL

DEFAULT_P5_PANEL specifies the path to the JSON schema file containing the configuration of the panel.

The key is available for the seal-operator-p5 service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p5/tag/any/DEFAULT_P5_PANEL

Available values: String

  • <path_name>

Default: <p5_connector_install_dir>/lib/defaultConfig/panel.json

DEFAULT_P5_SCHEMA

DEFAULT_P5_SCHEMA specifies the path to the JSON schema file containing the configuration of the PLOSSYS 5 connector.

The key is available for the seal-operator-p5 service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p5/tag/any/DEFAULT_P5_SCHEMA

Available values: String

  • <path_name>

Default: <p5_connector_install_dir>/lib/defaultConfig/settings.json

DEFAULT_PANEL

DEFAULT_PANEL specifies the type of the panel that is opened when opening the user interface and no panel yet exists.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/DEFAULT_PANEL

Available values: String

  • <panel_type> e. g. operator-p4, operator-p5, operator-dpf

Default: none

DEFAULT_SAP_PANEL

DEFAULT_SAP_PANEL specifies the path to the JSON schema file containing the configuration of the panel.

The key is available for the seal-operator-sap service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-sap/tag/any/DEFAULT_SAP_PANEL

Available values: String

  • <path_name>

Default: <sap_connector_install_dir>/lib/defaultConfig/panel.json

DEFAULT_SAP_SCHEMA

DEFAULT_SAP_SCHEMA specifies the path to the JSON schema file containing the the configuration of the SAP connector.

The key is available for the seal-operator-sap service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-sap/tag/any/DEFAULT_SAP_SCHEMA

Available values: String

  • <path_name>

Default: <sap_connector_install_dir>/lib/defaultConfig/settings.json

DISABLE_ADD_FAVORITE

DISABLE_ADD_FAVORITE specifies if the button for adding a favorite panel is available.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/DISABLE_ADD_FAVOURITE

Available values: Boolean

  • true

    The favorite panel button is hidden.

  • false

    The favorite panel button is shown.

Default: false

DISABLE_ADD_PANEL

DISABLE_ADD_PANEL specifies if the Add Panel button is available in the menu on the left.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/DISABLE_ADD_PANEL

Available values: Boolean

  • true

    The Add Panel button is hidden.

  • false

    The Add Panel button is shown.

Default: false

DISABLE_LATEST_TASKS

DISABLE_LATEST_TASKS specifies if the list containing the latest tasks is available in the menu on the left.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/DISABLE_LATEST_TASKS

Available values: Boolean

  • true

The last tasks list is hidden.

  • false

The last tasks list is shown.

Default: false

DISABLE_MESSAGES

DISABLE_MESSAGES specifies if the message panel is available.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/DISABLE_MESSAGES

Available values: Boolean

  • true

    The message panel is hidden.

  • false

    The message panel is shown.

Default: false

DISABLE_MY_LISTS_ACCESS

DISABLE_MY_LISTS_ACCESS specifies if the My Lists list is available in the menu on the left.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/DISABLE_MY_LISTS_ACCESS

Available values: Boolean

  • true

    The My Lists list is hidden.

  • false

    The My Lists list is shown.

Default: false

DISABLE_REMOVE_PANEL

DISABLE_REMOVE_PANEL specifies if the button for removing a panel is available.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/DISABLE_REMOVE_PANEL

Available values: Boolean

  • true

    The removing panel button is hidden.

  • false

    The removing panel button is shown.

Default: false

DISABLE_TASK_NOTIFICATIONS

DISABLE_TASK_NOTIFICATIONS specifies if the task notification item is available in the menu on the left.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/DISABLE_TASK_NOTIFICATIONS

Available values: Boolean

  • true

    The task notification item is hidden.

  • false

    The task notification item is shown.

Default: false

DETAILS_DISABLE_METADATA

DETAILS_DISABLE_METADATA specifies if the metadata editor is available in the details panel of the active panel.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/DETAILS_DISABLE_METADATA

Available values: Boolean

  • true

    The metadata editor in the details panel is hidden.

  • false

    The metadata editor in the details panel is shown.

Default: false

DETAILS_DISABLE_TOOLBAR

DETAILS_DISABLE_TOOLBAR specifies if the toolbar is available in the details panel of the active panel.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/DETAILS_DISABLE_TOOLBAR

Available values: Boolean

  • true

    The toolbar in the details panel is hidden.

  • false

    The toolbar in the details panel is shown.

Default: false

DPF_URL

DPF_URL specifies the URL for the REST calls for DPF.

The key is available for the seal-operator-dpf service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-dpf/tag/any/DPF_URL

Available values: String

  • dpf_rest_url

Default: https://localhost:9126/rest/dpf

FEAT_ACTION_MOCK_INPUT

FEAT_ACTION_MOCK_INPUT specifies if the DPF simulator reads the document content from fileupload.

The key is available for the seal-operator-dpf service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-dpf/tag/any/FEAT_ACTION_MOCK_INPUT

Available values: Boolean

Default: Y

FEAT_ACTION_MOCK_OUTPUT

FEAT_ACTION_MOCK_OUTPUT specifies if the DPF simulator writes the result document content to fileupload.

The key is available for the seal-operator-dpf service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-dpf/tag/any/FEAT_ACTION_MOCK_OUTPUT

Available values: Boolean

Default: Y

FEAT_TASK_STATUS

FEAT_TASK_STATUS specifies if the task status may be set via a REST call by third party applications.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/FEAT_TASK_STATUS

Available values: Boolean

  • Y

    Third party applications may set the task status via a REST call.

  • N

    Only the operator-server service is allowed to set the task status.

Default: N

HIDE_LEFT_MENU

HIDE_LEFT_MENU specifies if the left menu will be open or closed at the beginning.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/HIDE_LEFT_MENU

Available values: Boolean

  • true

    The left menu is closed at the beginning.

  • false

    The left menu is open at the beginning.

Default: false

HOUSEKEEPER_INTERVAL

HOUSEKEEPER_INTERVAL specifies the time interval after which the seal-operator-fileupload service looks for obsolete documents in the My Documents panel. The time interval has to be specified including the unit. For the available units, refer to Units at the top of the page.

The key is available for the seal-operator-fileupload service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-fileupload/tag/any/HOUSEKEEPER_INTERVAL

Available values: String

  • <time_interval_and_unit>

Default: 1h

HOUSEKEEPER_SWEEP_AGE

HOUSEKEEPER_SWEEP_AGE specifies the minimum age of documents to be deleted from the My Documents panel. The minimum age has to be specified including the unit. For the available units, refer to Units at the top of the page.

The key is available for the seal-operator-fileupload service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-fileupload/tag/any/HOUSEKEEPER_SWEEP_AGE

Available values: String

  • <time_interval_and_unit>

Default: 3d

ID_PROVIDER_CERT

ID_PROVIDER_CERT specifies the path and the file name of the certificate generated by the OIDC identity provider.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/any/tag/any/ID_PROVIDER_CERT

Available values: String

  • <path_name>

Default: none

ID_PROVIDER_NAME

ID_PROVIDER_NAME specifies the name of the OIDC identity provider. When using more than one OIDC identity providers, separate them by a blank.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/any/tag/any/ID_PROVIDER_NAME

The key is mandatory.

Available values: String

  • <id_provider_name> (For example, with Keycloak, it is a complete URL: https://<hostname>:32769/auth/realms/SEAL)

  • <id_provider_name_1> <id_provider_name_2> (For example, with Keycloak, they are complete URLs: https://<cluster internal hostname>:32769/auth/realms/SEAL https://<cluster external hostname>:32769/auth/realms/SEAL)

Default: none

IMPERSONATE_TOKEN_OWNER

IMPERSONATE_TOKEN_OWNER specifies the JSON Web token key containing the owner. This is used for the impersonate functionality.

The key is available for the seal-operator-server and seal-operator-fileupload services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/IMPERSONATE_TOKEN_OWNER
  • dc/home/env/service/operator-fileupload/tag/any/IMPERSONATE_TOKEN_OWNER

Available values: String

  • <token-key>

Default: preferred_username

INFOSERVER_URL

INFOSERVER_URL specifies the URL of PLOSSYS Infoserver.

The key is available for the node-p4rest service.

The key is specified as system variable when installing the REST package in the PLOSSYS netdome system.

Available values: String

  • <infoserver_url>

Default: socket://localhost:7125

JWT_ROLES

JWT_ROLES specifies the property name set in the JSON Web Token (JWT) for accessing the user roles.

The key is available for all services.

In Consul, the key is specified here:

  • dc/home/env/service/any/tag/any/JWT_ROLES

Available values: String

  • <property_name>

Default: none

JWT_USERNAME

JWT_USERNAME specifies the user name set in the JSON Web Token (JWT). JWT_USERNAME specifies the user name in the current output job.

The key is available for the following services:

  • seal-operator-p4
  • seal-operator-p5

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p4/tag/any/JWT_USERNAME
  • dc/home/env/service/operator-p5/tag/any/JWT_USERNAME

Available values: String

  • <user_name>

Default: sub

LISTITEM_NAME

LISTITEM_NAME specifies the name of the property used as a list item name.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/LISTITEM_NAME

Available values: String

  • <property>

Default: metadata.name

LOG_LEVEL

LOG_LEVEL specifies the log level for the correspondent service. Messages that correspond to this log level or a higher one are written to the log file.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/any/tag/any/LOG_LEVEL for all services
  • dc/home/env/service/<service>/tag/any/LOG_LEVEL for the specific <service> service

Available values: String

  • debug

    Debug messages are written to the log file of the service.

  • info

    Information messages are written to the log file of the service.

  • warn

    Warnings are written to the log file of the service.

  • error

    Error messages are written to the log file of the service.

  • fatal

    Messages about serious errors are written to the log file of the service.

Default: info

Example - log level error

Messages of the log levels error and fatal are written to the log file.

Example - log level info

Messages of the log levels info, warn, error and fatal are written to the log file.

MESSAGE_TIMOUT

MESSAGE_TIMOUT specifies the time interval after that the messages will be deleted. The time interval has to be specified including the unit. For the available units, refer to Units at the top of the page.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/MESSAGE_TIMOUT

Available values: String

  • <time_interval_and_unit>

Default: 1h

MESSAGE_TTL

MESSAGE_TTL specifies how long the messages will be stored. The time interval has to be specified including the unit. For the available units, refer to Units at the top of the page.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/MESSAGE_TTL

Available values: String

  • <time_interval_and_unit>

Default: 24h

MONGO_CONNECT_RETRIES

MONGO_CONNECT_RETRIES specifies how often the service attempts to connect to the database.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/MONGO_CONNECT_RETRIES

Available values: Integer

  • <retries>

Default: 10

MONGO_FILEUPLOAD_URL

MONGO_FILEUPLOAD_URL specifies the URL of the MongoDB for file uploads into My Documents.

The key is available for the seal-operator-fileupload service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-fileupload/tag/any/MONGO_FILEUPLOAD_URL

Available values: String

  • <fileupload_url>

Default: mongodb://localhost:27017/operator-fileupload

MONGO_SERVER_URL

MONGO_SERVER_URL specifies the URL of the MongoDB.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/MONGO_SERVER_URL

Available values: String

  • <mongodb_url>

Default: mongodb://localhost:27017/operator-server

MONGO_TOKEN

MONGO_TOKEN specifies the key for credential encryption and decryption.

The key is available for the seal-operator-server service.

MONGO_TOKEN is only used when CS_TYPE is set to mongo.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/MONGO_TOKEN

Available values: String

  • <token>

Default: not revealed

NODE_TLS_REJECT_UNAUTHORIZED

NODE_TLS_REJECT_UNAUTHORIZED specifies if self-signed certificates are allowed.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/any/tag/any/NODE_TLS_REJECT_UNAUTHORIZED

Available values: Integer

  • 0

    Self-signed certificates are allowed.

  • 1

    Self-signed certificates are not allowed.

Default: 1

Caution - security gap

Setting NODE_TLS_REJECT_UNAUTHORIZED to 0 in a productive system is a serious security gap! Only use it for test purposes!

Hint - certificate

Unless NODE_TLS_REJECT_UNAUTHORIZED is set to 0 or specified at all, the certificate has to contain the correct IP address or hostname since this is used for the authorization check.

ONLINE_DOCS_URL

ONLINE_DOCS_URL specifies the URL pointing to the external online documentation.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/ONLINE_DOCS_URL

Available values: String

  • <docs_url>

Default: ``

OPERATOR_UI_PORT

OPERATOR_UI_PORT specifies the port for accessing the seal-operator-ui service.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/OPERATOR_UI_PORT

Available values: String

  • <port_number>

Default: 3000

OPERATOR_SERVER_SERVICE

OPERATOR_SERVER_SERVICE specifies the name of the operator-server service as it is registered in Consul.

The key is available for the following services:

  • seal-operator-p4
  • seal-operator-p5

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p4/tag/any/OPERATOR_SERVER_SERVICE
  • dc/home/env/service/operator-p5/tag/any/OPERATOR_SERVER_SERVICE

Available values: String

  • <operator_name>

Default: operator-server

PANEL_DISABLE_ACTIONS

PANEL_DISABLE_ACTIONS specifies the standard actions to be disabled in the active panel.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/PANEL_DISABLE_ACTIONS

Available values: Comma-separated strings

  • 'down', 'up', 'paste', 'delete', 'view', 'save'

Default: ``

PANEL_DISABLE_DROP_AREA

PANEL_DISABLE_DROP_AREA specifies if the file drag'n'drop area is available in the active panel.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/PANEL_DISABLE_DROP_AREA

Available values: Boolean

  • true

    The file drag'n'drop area is hidden.

  • false

    The file drag'n'drop item is shown.

Default: false

PANEL_DISABLE_METADATA

PANEL_DISABLE_METADATA specifies if the metadata editor is available in the active panel.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/PANEL_DISABLE_METADATA

Available values: Boolean

  • true

    The metadata editor is hidden.

  • false

    The metadata editor is shown.

Default: false

PANEL_DISABLE_START_BUTTON

PANEL_DISABLE_START_BUTTON specifies if the start (print or convert) button is available in the active panel.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/PANEL_DISABLE_START_BUTTON

Available values: Boolean

  • true

    The start button is hidden.

  • false

    The start button is shown.

Default: false

PANEL_DISABLE_STATUS

PANEL_DISABLE_STATUS specifies if the panel status of the active panel is displayed.

The key is available for the seal-operator-ui service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-ui/tag/any/PANEL_DISABLE_STATUS

Available values: Boolean

  • true

    The panel status is hidden.

  • false

    The panel status is shown.

Default: false

PGHOST

PGHOST specifies the server name of the PLOSSYS netdome PostgreSQL database used for the job reply.

The key is available for the node-p4rest service.

The key is specified as system variable when installing the REST package in the PLOSSYS netdome system.

Available values: String

  • <plossys_netdome_server_name>

Default: localhost

PGPORT

PGPORT specifies the port number of the PLOSSYS netdome PostgreSQL database used for the job reply.

The key is available for the node-p4rest service.

The key is specified as system variable when installing the REST package in the PLOSSYS netdome system.

Available values: String

  • <plossys_netdome_port>

Default: 7128

PLOSSYS_IPP_URL

PLOSSYS_IPP_URL specifies the URL of the checkin service of the PLOSSYS 5 system.

The key is available for the seal-operator-p5 service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p5/tag/any/PLOSSYS_IPP_URL

Available values: String

  • <ipp_checkin_url>

Default: ipp://localhost:631

PLOSSYS_TIMEOUT

PLOSSYS_TIMEOUT specifies the timeout for connecting and retrieving data from a PLOSSYS netdome system. The minimum value is two seconds. The time interval has to be specified including the unit. For the available units, refer to Units at the top of the page.

The key is available for the seal-operator-p4 service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p4/tag/any/PLOSSYS_TIMEOUT

Available values: String

  • <time_interval_and_unit>

Default: 10s

PLOSSYS_URL

PLOSSYS_URL specifies the URL of the PLOSSYS netdome system to which SEAL Operator has to connect.

The key is available for the seal-operator-p4 service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p4/tag/any/PLOSSYS_URL

Available values: String

  • <plossys_netdome_url>

Default: https://localhost:3011

PLSHOST

PLSHOST specifies the server name of PLOSSYS Infoserver.

The key is available for the node-p4rest service.

The key is specified as system variable when installing the REST package in the PLOSSYS netdome system.

Available values: String

  • <infoserver_server_name>

Default: localhost

PLSPORT

PLSPORT specifies the port number of PLOSSYS Infoserver.

The key is available for the node-p4rest service.

The key is specified as system variable when installing the REST package in the PLOSSYS netdome system.

Available values: String

  • <infoserver_port>

Default: 7125

PLSROOT

PLSROOT specifies the PLOSSYS netdome installation directory.

The key is available for the node-p4rest service.

The key is specified as system variable when installing the REST package in the PLOSSYS netdome system.

Available values: String

  • <plossys_netdome_dir>

Default: c:\SEAL\applications

RLI_JOBNAME_KEY

RLI_JOBNAME_KEY contains the name of a key in repro list files whose value is used as job name in SEAL Print Client. Unless the specified key exists in the repro list file, PLS_PLOTID, PLS_ORIG_NAME and a self-generated UUID are used in this order.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/RLI_JOBNAME_KEY

Available values: String

  • <rli_key>

Default: name

RLIGATE

RLIGATE specifies the name of the target directory for the repro list files (rli, rlist) without path. The correspondent path is determined from the PLOSSYS netdome environment.

The key is available for the node-p4rest service.

The key is specified as system variable when installing the REST package in the PLOSSYS netdome system.

Available values: String

  • <gate_name>

Default: rlipdmgate

SAP_URL

SAP_URL specifies the URL for the SAP system.

The key is available for the seal-operator-sap service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-sap/tag/any/SAP_URL

Available values: String

  • <sap_url>

Default: none

SERVICE_DISCOVERY

SERVICE_DISCOVERY specifies if SEAL Operator is running in a cloud environment or on premise.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/any/tag/any/SERVICE_DISCOVERY

Available values: String

  • cloud

    SEAL Operator is running in a cloud environment.

  • consul

    SEAL Operator is running on premise.

Default: consul

SERVICE_DISCOVERY_PORT

SERVICE_DISCOVERY_PORT specifed the HTTPS port under which all services are available in a cloud environment.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/any/tag/any/SERVICE_DISCOVERY_PORT

Available values: Integer

  • <port>

Default: 3000

SERVICE_URL

SERVICE_URL specifies how a service can be accessed.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/<service>/tag/any/SERVICE_URL for the specific <service> service

Available values: String

  • <url>

Default: https://localhost:<service_port>

Hint - port list

Default: The server name is determined when a service is started and the default port is used. The correspondent assignment is described in Used Ports.

STAMP_META

STAMP_META specifies if stamps are also applied to additional sheets, such as cover or trailer sheets.

The key is available for the seal-operator-p4 service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p4/tag/any/STAMP_META

Available values: Boolean

Default: N

TARGET_CONTENT_TYPE

TARGET_CONTENT_TYPE specifies the PLOSSYS netdome-specific job format.

The key is available for the seal-operator-p4 service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p4/tag/any/TARGET_CONTENT_TYPE

Available values: String

  • application/rli

    For creating a repro list

  • application/json

    For creating a set collation

Default: application/json

TARGET_FILE_KEY

TARGET_FILE_KEY specifies the key where to put the names of local files (i. e. the files stored in SEAL Print Client My Documents) when exporting to a repro list.

The key is available for the seal-operator-p4 service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p4/tag/any/TARGET_FILE_KEY

Available values: String

  • <plossys_key>

Default: PLS_ORIG_NAME

TASK_CREATE_WITH_USER_DEFAULT

TASK_CREATE_WITH_USER_DEFAULT specifies if the tasks are created with the user defaults as metadata.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/TASK_CREATE_WITH_USER_DEFAULT

Available values: Boolean

  • Y

    The user defaults are used as metadata of new tasks.

  • N

    The system defaults are used as metadata of new tasks.

Default: Y

TASK_TIMEOUT

TASK_TIMEOUT specifies the time interval after which the seal-operator-server service looks for finished tasks to be deleted. The time interval has to be specified including the unit. For the available units, refer to Units at the top of the page.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/TASK_TIMEOUT

Available values: string

  • <time_interval_and_unit>

Default: 1h

TASK_TTL_ABORTED

TASK_TTL_ABORTED specifies the time interval after which an aborted task will be deleted by the seal-operator-server service. The time interval has to be specified including the unit. For the available units, refer to Units at the top of the page.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/TASK_TTL_ABORTED

Available values: String

  • <time_interval_and_unit>

    Aborted tasks will be deleted after the specified time.

  • 0

    Aborted tasks never will be deleted.

Default: 1w

TASK_TTL_COMPLETED

TASK_TTL_COMPLETED specifies the time interval after which a completed task will be deleted by the seal-operator-server service. The time interval has to be specified including the unit. For the available units, refer to Units at the top of the page.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/TASK_TTL_COMPLETED

Available values: String

  • <time_interval_and_unit>

    Completed tasks will be deleted after the specified time.

  • 0

    Completed tasks never will be deleted.

Default: 1w

TASK_TTL_FAILED

TASK_TTL_FAILED specifies the time interval after which a failed task will be deleted by the seal-operator-server service. The time interval has to be specified including the unit. For the available units, refer to Units at the top of the page.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/TASK_TTL_FAILED

Available values: String

  • <time_interval_and_unit>

    Failed tasks will be deleted after the specified time.

  • 0

    Failed tasks never will be deleted.

Default: 1w

TASK_TTL_OPEN

TASK_TTL_OPEN specifies the time interval after which an open task will be deleted by the seal-operator-server service. The time interval has to be specified including the unit. For the available units, refer to Units at the top of the page.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/TASK_TTL_OPEN

Available values: String

  • <time_interval_and_unit>

    Open tasks will be deleted after the specified time.

  • 0

    Open tasks never will be deleted.

Default: 0

TASK_TTL_PROCESSING

TASK_TTL_PROCESSING specifies the time interval after which a processing task will be deleted by the seal-operator-server service. The time interval has to be specified including the unit. For the available units, refer to Units at the top of the page.

The key is available for the seal-operator-server service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-server/tag/any/TASK_TTL_PROCESSING

Available values: String

  • <time_interval_and_unit>

    Processing tasks will be deleted after the specified time.

  • 0

    Processing tasks never will be deleted.

Default: 1w

TLS_DIR

TLS_DIR specifies the directory containing the certificate files necessary for the secure transfer between the clients and servers and within SEAL Operator/SEAL Print Client.

The key is available for all services.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/any/tag/any/TLS_DIR

Available values: String

  • <dir_name>

The directory contains the following files:

  • key.pem

    File containing the private key

  • cert.pem

    File containing the certificate

  • ca.pem (optional)

    File containing the CA certificate

Default: none

Hint - certificate files contained in delivery

The self-signed certificates contained in delivery are hard-coded. The tls directories contained in delivery only contain examples which certificate files are required and how they look like.

Caution - security gap

Using the pre-installed self-signed certificate in a productive system is a serious security gap!

TRUSTED_CLIENT

TRUSTED_CLIENT specifies the client name configured in the OIDC identity provider for granting access via access token.

The key is available for the following services:

  • seal-operator-fileupload
  • seal-operator-server

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-fileupload/tag/any/TRUSTED_CLIENT
  • dc/home/env/service/operator-server/tag/any/TRUSTED_CLIENT

Available values: String

  • <client_name>

Default: operator

USER_NAME_KEY

USER_NAME_KEY specifies the key where to put the name of the logged-in user when exporting to a repro list. By default, no user is set in a repro list passed to PLOSSYS netdome. If you want the name of the logged-in user to be set in the repro list, specify the repro list key where to put the user name (e. g. PLS_USERNAME). The user name will then be set regardless of an already existent user name in the repro list.

The key is available for the seal-operator-p4 service.

In Consul, the key is specified here. If the key does not yet exist, you have to create it:

  • dc/home/env/service/operator-p4/tag/any/USER_NAME_KEY

Available values: String

  • <plossys_key>

Default: none

Back to top