Settings
For every user, the following settings are available:
Change password
Opens up a window to change your current password.
Data sources
Opens up the page that lists all the data sources that you have created or have been shared with you. For more information on the supported data sources, click here.
Create a new data source
To create a new data source, click Create new. This will open a new modal with a new form with the following fields:
- vendor - click on the dropdown menu to select the supported data source types. For more information, check the supported data sources
- name - the data source name. This name is important because it will be converted into a link based on which you can switch to the data source.
- url - each data source url has a recommended url template. It is a JDBC connection string and it requires at least the host (name or IP address) of the database service and the database name to connect to.
- driver - each data source has a recommended jdbc driver. Check your database vendor documentation for what the appropriate class name is here if you need to overwrite it.
- username - the data source username
- password - the data source account password
- shared - if the radio button is:
- selected or true - the data source is shared with all Scai users, which means the data the user has access to will be shared with the rest of the Scai users, unless there are table visibility restrictions in place.
- not selected or false - the data source is private
Connect to a new data source
To connect to a data source, simply click on its name in the data source table, then click Yes to switch to it.
Delete a data source
To delete a data source, identify the data source in the data sources table and click the button. If you are sure that you want to delete the given data source, click the Yes button.
Deleting a data source is an irreversible action! It only removes the access to that data source in the Scai platform. Your data will still be present in the database. Access to the data source can be re-added by creating a new data source from scratch.
Edit a data source
To edit a data source, click on the button. This will open the form with all the data source parameters.
To save the changes to the data source, you need to fill in the password again.
Refresh
To refresh all the metadata related to the connected data source. This should be used as a last resort if there are some settings that have not been updated properly (e.g. a new table was created by an application outside of Scai and you would like Scai to detect and show the new table).
General table configuration
The general configuration of a table and its columns. This will open a page that will list all the tables and views of the data source you are connected to. For each such table, a window can be opened that will allow you to:
- change the representative column of this table. This allows you to define which is the column, if any, that identifies a row of the table in a manner that is also human readable and should be used for replacing id values. Think of the name column of a table that also contains an id column as its primary key.
- for each table column, you can define additional constraints for inputs that will be used to introduce new values. For example, you might want to mark some columns to only allow valid e-mail addresses or that some fields should have a minimum/maximum value.
Table visibility
The visibility of each table/view that can be configured on a per role basis. This will open a page composed of three widgets:
The first widget allows you to select the role you are trying to show/hide tables for. If unselected, then all tables hidden will be hidden for all users.
Tables will be shown for a given user if the table appears in the shown list of the user's given role and it does not appear in the hidden list of any role that is superior to the user's given role. This means that even though a table appears in the shown tables list for a given role, it still may be hidden for users with that role if it appears in the hidden list of its parent role or of its superiors or in the hidden list when no role is selected.
The second widget will list the tables that have not been explicitly hidden for that particular role, if any
- The third widget will list all the tables that have been explicitly hidden for that particular role, if any
Table updates
Each table can be marked as read-only on a per role basis. Users that have access to a read-only table will not be able to create/delete/update its contents. This will open a page composed of three widgets:
The first widget allows you to select the role you are trying to mark read-only tables for. If unselected, then all tables marked read-only will be read-only for all users.
Tables will not be read-only for a given user if the table does not appear in the read-only list of the user's given role and it does not appear in the read-only list of any role that is superior to the user's given role. This means that even though a table appears in the writable tables list for a given role, it still may be marked as read-only for users with that role if it appears in the read-only list of its parent role or of its superiors or in the read-only list when no role is selected.
- The second widget will list the tables that have not been explicitly marked as read-only for that particular role, if any
- The third widget will list all the tables that have been explicitly marked as read-only for that particular role, if any
Column visibility
The visibility of each column in a table can be configured on a per role basis. This will open a page composed of three widgets:
The first widget allows you to select the role you are trying to show/hide columns for. If unselected, then all columns hidden will be hidden for all users.
Columns will be shown for a given user if the column appears in the shown list of the user's given role and it does not appear in the hidden list of any role that is superior to the user's given role. This means that even though a column appears in the shown columns list for a given role, it still may be hidden for users with that role if it appears in the hidden list of its parent role or of its superiors or in the hidden list when no role is selected.
- The second widget will list the columns that have not been explicitly hidden for that particular role, if any
- The third widget will list all the columns that have been explicitly hidden for that particular role, if any
Column visibility in details
The visibility of each column can be further tuned to hide some columns (e.g. sensitive data like SSNs or credit card information) even when accessing a row details. This will open up a page that will allow you to manually pick which columns should be hidden in the details view of a row in a similar fashion to the column visibility page.
If you are an Administrator, then you will also have access to:
Change license
This will allow you to enter a new license key in case of license renewals, Scai upgrades.
Users
This will open up a page with all the users that have access to Scai, presented in a table. For each user, you can choose to activate/de-activate them. You can also create new users or delete existing ones.
Attention! If you delete a user, the action is irreversible. All of its dashboards, data sources and settings will be permanently deleted.
Roles
This will open up a page with all user roles that are defined in Scai. User roles allow you to group similar users together into groups that have the same privileges.Roles are organized in a tree-like structure and each role has a parent role (superior). At the top of the hierarchy is the Administrator role that is above all roles that can be created in Scai.The Administrator role cannot be deleted.
Usually you would define the roles in accordance to the hierarchy of the organization that has access to Scai, e.g. Administrators -> Management -> Developer and Administrators -> Management -> Analyst. You would then create three additional roles: Management with parent role Administrator, Developer with parent role Management and Analyst with parent role Management.