beVault UI configuration

Docker compose service example

CODE

data-factory-ui:
    image: container.dfakto.com/depfac/innoviris/datafactory-ui:1.5.0
    ports:
     - 8080:80
    environment:
     - NG_APP_DEPLOY_ENVIRONMENT=staging
     - NG_APP_SENTRY_DSN=<SENTRY_DSN>
     - NG_APP_SENTRY_CLIENT=<SENTRY_CLIENT>
     - NG_APP_SENTRY_ERROR_FEEDBACK=true
     - NG_APP_SENTRY_TRACES_SAMPLE_RATE=0.5
     - NG_APP_SENTRY_REPLAY_SAMPLE_RATE=0.1
     - NG_APP_SENTRY_REPLAY_MASK=true
     - NG_APP_USE_NEW_BRANDING=true
     - NG_APP_SENTRY_ERROR_FEEDBACK_DIALOG=false
     - METAVAULT_API_URL=<METAVAULT_API_URL>
     - NG_APP_STATES_URL=<STATES_APPLICATION_URL>
    healthcheck:
      test: service nginx status || exit 1
      interval: 10s
      timeout: 3s
      retries: 10
      start_period: 10s

Environment

This section is used to define the environment on which the service is deployed. This environment configuration is also used for Sentry configuration :

DeployEnvironment: STRING INTRODUCED IN 1.3.0 Environment on which the app is deployed.

Environment variables

YAML

NG_APP_DEPLOY_ENVIRONMENT=

Sentry

Sentry is an application performance monitoring and error tracking tool that can be configured on the service.

Sentry can be configured with the following parameters:

SentryDSN: STRING INTRODUCED IN 1.3.0 where to send events, so the events are associated with the correct project.
SentryClient: STRING INTRODUCED IN 1.3.0 Client info to be displayed in Sentry issues
SentryErrorFeedback: BOOLEAN INTRODUCED IN 1.3.0 DEFAULT: FALSE Defines whether the user feedback button must be shown in the interface.
https://docs.sentry.io/product/user-feedback/
SentryTracesSampleRate: NUMBER INTRODUCED IN 1.3.0 DEFAULT: 0 Number value between 0 and 1 that defines the percentage of session for which performance will be tracked.
SentryProfilesSampleRate: NUMBER INTRODUCED IN 1.3.0 DEFAULT: 0 Number value between 0 and 1 that defines the percentage of session for which profiling will be tracked.
SentryReplaySampleRate: NUMBER INTRODUCED IN 1.6.0 DEFAULT: 0 Number value between 0 and 1 that defines the percentage of session for which session replay will be tracked.
SentryReplayMask: BOOLEAN INTRODUCED IN 1.6.0 DEFAULT: TRUE Boolean that defines if text and media should be masked for sessions replay. Default true.
SentryErrorFeedbackDialog: BOOLEAN INTRODUCED IN 1.6.0 Boolean that defines whether the popup dialog should be displayed for error feedback

Environment variables

YAML

NG_APP_SENTRY_DSN=
NG_APP_SENTRY_CLIENT=
NG_APP_SENTRY_ERROR_FEEDBACK=false
NG_APP_SENTRY_TRACES_SAMPLE_RATE=0
NG_APP_SENTRY_PROFILES_SAMPLE_RATE=0
NG_APP_SENTRY_REPLAY_SAMPLE_RATE=0
NG_APP_SENTRY_REPLAY_MASK=true
NG_APP_SENTRY_ERROR_FEEDBACK_DIALOG=false

New branding

beVault UI is the new interface of dataFactory UI. beVault UI can be activated by enabling new branding with the following parameter :

UseNewBranding: BOOLEAN INTRODUCED IN 1.4.0 DEFAULT: FALSE Boolean that defines whether the new branding (beVault) should be applied or not.

Environment variables

YAML

NG_APP_USE_NEW_BRANDING=false

Backend services communication

This section is used to configure the communication between the UI service and the backend service.

The url to metavault backend can be configured with this parameter:

MetavaultApiUrl: STRING INTRODUCED IN 1.0.0 Url to the metavault backend api
DataFactoryUIHost: STRING INTRODUCED IN 1.0.0 DEPRECATED IN 1.6.0 Host forwarded in the header configuration (needed for dFakto REST).

Environment variables

YAML

METAVAULT_API_URL=

States - Orchestrator

This section is used to define the url of the orchestrator used by beVault to manage state machines.
This url can be configured with the following parameter:

StatesUrl: STRING INTRODUCED IN 1.7.0 States application url

Environment variables

YAML

NG_APP_STATES_URL=

About panel

This section is used to define whether the about panel with component versions should be displayed in the top bar of the application.

ShowAboutPanel: BOOLEAN INTRODUCED IN 1.8.0 DEFAULT: FALSE Boolean that defines whether the about panel containing components' versions should be displayed

Environment variables

YAML

NG_APP_SHOW_ABOUT_PANEL=