How to Download the Configuration Report
The Configuration Report is a system-generated Microsoft Excel workbook that provides a comprehensive overview of your Faculty Success instrument's structure. It details the input fields for each screen on separate worksheets, making it a valuable resource for understanding your data collection setup.
Note: A sample Configuration Report is included at the end of this article. This is a generic example that will not reflect any customizations made to your instance of Faculty Success.
Getting Started
To download the Configuration Report for your Faculty Success instance, follow these steps:
-
From the navigation bar, go to Tools and select Home.
- On the Home page, locate the "Your Configuration" box.
- Select the Download hyperlink. The report will automatically download to your computer.
Note: If your Faculty Success instance contains multiple instruments, a "Download" hyperlink will be available for each one.
Why It's Useful
The Configuration Report allows you to review all screens and fields within your Faculty Success instance, including any access restrictions that have been applied.
This report is also beneficial when importing data into Faculty Success using a CSV file. The "Code" columns in the report can be used to create the header row for your import file. The "Data Type" and "Options" columns indicate the expected data format for each field, ensuring a smooth data import process. For more information on using the Configuration Report for CSV data imports, please see Overview of Importing CSV Data Into Faculty Success.
Understanding the Report
The Configuration Report Excel workbook contains an Overview tab and multiple Screen-Specific tabs.
Overview Tab
- Screen code: An internal code for each activity screen.
- Summary Display logic: The information that appears on the summary screen for existing records.
- Screen access settings: Any access restrictions, viewable in the "Permission" and "Access" columns.
- Force editable: Indicates if any restrictions prevent users from creating new records, found in the "Force Editable" column.
- Permission: Shows if a screen is visible only to specific user groups based on their college or department in Yearly Data. Only one level of restrictions is permitted per system.
- Date required: Indicates whether a significant date is mandatory to save a record.
- Primary Key: A set of fields used to identify unique records and prevent duplicates during data imports.
Screen-Specific Tabs
- Field codes: Internally assigned codes for each field, used in CSV file headers for data imports.
- Field types: The "Display" and "Data Type" columns show the type of field and the expected data format.
- Field access settings: The "Access" column displays any restrictions on editing a field for users without "manage data" permissions.
- Required Fields: Identifies fields that must be completed to save any record edits.
- Default value: The "Default" column shows any value that is automatically added to the field.
- Minimum/Maximum values: The "Min" and "Max" columns display the set range for fields with numerical values.
- Options: For drop-down and checkbox fields, this column lists the predefined choices.
- Other attributes: This column displays any field-specific help text. For date fields, it indicates if the date is significant.