Configurations¶

The application is configurable with environment variable. Below we present the list of configurations and there usage.

Below is the component wise configurations.

DB Setup: RDBMS hosting the primary datastore can be configured using below setting.

Config	Remark
SCT_DB_TYPE	Database (Options: mysql, postgres, sqlite)
SCT_DB_HOST	Database host
SCT_DB_PORT	Database port
SCT_DB_NAME	Database name
SCT_DB_SCHEMA	Database schema
SCT_DB_USER	Database user
SCT_DB_PWD	Database user password
SCT_DB_TABLE_BLACKLIST	Comma separated pattern in name for table that need not be considered to be viewed by this tool

UI Setup: Web UI operation settings.

Config	Remark
SCT_UI_PAGESIZE	Max record to show per page
SCT_UI_DOWNLOAD_SIZE	Max record in downloaded CSV
SCT_UI_UPLOAD_SIZE	Max record that can be appended uploaded feature

Audit Setup: Currently only RDBMS based audit is supported.

Audit table can be made available before starting tool:

create table governance.sct_audits (
    audit_id serial PRIMARY KEY,
    audit_user VARCHAR (100) not null,
    audit_time timestamp NOT NULL DEFAULT NOW(),
    operation_performed VARCHAR (100) not null,
    table_name VARCHAR (100) not null,
    operation_status VARCHAR (15) not null,
    operation_metadata VARCHAR (5000)
);

Config	Remark
SCT_AUDIT_TYPE	Database type (Options: mysql, postgres, sqlite)
SCT_AUDIT_DB_NAME	Audit database
SCT_AUDIT_DB_SCHEMA	Audit schema
SCT_AUDIT_DB_HOST	Database hostname
SCT_AUDIT_DB_PORT	Database port
SCT_AUDIT_DB_USER	Database user
SCT_AUDIT_DB_PWD	Database password
SCT_AUDIT_DB_TABLE	Audit table
SCT_AUDIT_TABLE_CREATE	Create audit table while app initiation (yes/no)

Scheduler Setup: Uploaded files are processed asynchronously using scheduler.: Additional maintenance work can also be scheduled using configuration.

Config	Remark
SCT_SCHEDULER_INTERVAL_VALUE	Schedule interval
SCT_SCHEDULER_JOB_MAX_ATTEMPT	Number of attempt before failing the scheduler action
SCT_SCHEDULER_CUSTOM_JOB	Module and function name for custom scheduled task

Authentication Setup: Currently only Okta based authentication is supported.: There is also new user registration page where new user request for access which drops mail to admin to add user to Okta organization.

Config	Remark
SCT_AUTH_OKTA_DOMAIN	Okta Domain
SCT_AUTH_OKTA_CLIENT_ID	Okta Client Id
SCT_AUTH_OKTA_CLIENT_SECRET	Okta Client secret

Authorization Setup: Current there are four predefined roles for authorization, below is the access for the same.

NONE: No access
VIEWER: View table data only, no mutation allowed
OPERATOR: View and mutate table data
ADMIN: View and mutate table data also track audits

Note

If you have not enabled authentication you need to set SCT_ACCESS_ANONYMOUS_ROLE to ADMIN.

You can use wild card * if you want to give *all authenticated* user to a role.

Config Remark
SCT_ACCESS_ANONYMOUS_ROLE	Roles assigned to anonymous user (without login)
SCT_ACCESS_ADMIN	List of principal assigned ADMIN role
SCT_ACCESS_OPERATOR	List of principal assigned OPERATOR role
SCT_ACCESS_VIEWER	List of principal assigned VIEWER role

Email Setup: If you do not want to use email notification set enabled to blank string. If you enable you will need to provide configuration from your email provider.

Config	Remark
SCT_MAIL_ENABLED	Mail notification is enabled or disabled
SCT_MAIL_SERVER	Mail Server
SCT_MAIL_PORT	Mail Server Port
SCT_MAIL_USE_TLS	Mail Server TLS Support
SCT_MAIL_USE_SSL	Mail Server SSL Support
SCT_MAIL_USERNAME	Mail Server User
SCT_MAIL_PASSWORD	Mail Server User Password
SCT_MAIL_RECIPIENTS	Notification Recipients (Comma Separated List)

Warning

All configuration defaults are available for verification and updating in module utilities.sct_env.