Roles Guide

Use this workbook to setup roles for Super User, Financial Aid Staff, and Read Only. These roles provide a variation in permissions to assist you with user acceptance testing.

Workbook Description

The file name for this workbook is Roles.csv.

Configuration Workbooks are delivered in the form of Excel spreadsheets. In these spreadsheets, every configurable field is represented as a spreadsheet column and there are as many spreadsheet rows as needed for that particular configuration. Here are the column descriptions:
  • Field Name.
  • Column: Spreadsheet column associated with the field.
  • Required?: Denote if you're required to populate the field or not.
  • Field Type and Accepted Values:
    • String: These are usually alphanumeric.
    • Integer: Numeric, a whole number.
    • Double: Numeric with places to the right of the decimal.
    • Enumeration: List of values.
    • Boolean: True or False, Yes or No.
    • Groovy script: A logical query using groovy script.
    • Date: yyyy-mm-dd format.
  • Description.
Field Name Column Required Field Type and Accepted Values Description
Role Code A Y

String

  • SUPER_USER
  • FA_STAFF
  • ADVS_READ_ONLY

Code associated to Role.

Role Description B Y

String

Alphanumeric ASCII text, up to 255 characters.

User-defined Role Description.

Permissions C Y Enumeration

System Defined Permissions

SELECT * FROM PERMISSION

This is for initialization of an environment setup. Once UI for document permissions is accessed, this workbook will cease to function as we do not want actions taken in the UI to be overwritten

Enable the Configuration in the UI

You do not have to complete any setup in the user interface to enable this configuration. To update an manage Roles, General and Document Permissions on an ongoing basis through the Student Financial Aid user Interface, you must have the Administration General Permission enabled for your Role.

Required Permissions

You must have a role with this General Permission through Roles Management in order to enable and view the configuration in the UI: Administration.

See Set General Permissions Matrix.

Considerations for Configuration

When your environments are provisioned this workbook is used for the initialization of the environment setup. Once the user interface for document permissions is accessed, this workbook will cease to function as we do not want actions taken in the UI to be overwritten. After initialization all configurations for General Permissions and Document Permissions should be updated in the Roles Management screen of the Student Financial Aid user interface.

Configuration in the User Interface

The configuration is visible in the Student Financial Aid User Interface if you navigate to the following screens:

  • Administration > Security Management > Roles Management
  • Select a specific role to see it's associated General Permissions and Document Permissions.

Understanding How the Baseline Configuration Works

The following roles are delivered with Student Financial Aid:

System Administrator Role

The System Administrator role comes with all permissions enabled except:

  • Fund Eligibility Viewer
  • General Read-Only
  • Reports

SAIG Administrator

The SAIG Administrator role comes with only the following permissions enabled:

  • Administration
  • SAIG Errors

Financial Aid Staff User

The SAIG Administrator role comes with only the following permissions enabled:

  • At Will Sap Status Updater
  • Dashboard
  • Document Review Task
  • G5 Drawdown
  • Grant Over Payment Resolution Task Review
  • Grant Over Payment Task Review
  • ISIR Matching Task
  • ISIR Review Task
  • ISIR Status Override
  • ISIR Verification Task
  • NFF Eval Review Task
  • NFF Forms Task Review
  • NFF Workflow
  • Over Award Review Task
  • Professional Judgement Review Task
  • SAP Appeal Review Task
  • SAP Review Task
  • Student
  • Student Holds
  • Student Letters
  • Task
  • Transfer Change of Program Evaluator
  • Transfer Overlapping Academic Years Evaluator