Self Help Article (External)
Purpose
The purpose of this document is to guide Banner ePrint repository administrators through the creation of report definitions.
Requirements
The user of this article must have administrator access to at least one ePrint repository to follow the steps outlined below.
Step-by-Step Procedures
- Use the URL https://eprint.okstate.edu/cgi-bin/admin.cgi to connect to the ePrint administrator interface. This uses non-OKEY credentials. Upon logging in you will see a page similar to this:
To create and/or edit report definitions, click the Define button.
You have the option to edit an existing definitions or create a new definition.- To edit an existing definition use the dropdown menu to select the definition you wish to edit and click the Edit button.
- To create a new definition (from scratch) type the name of the definition you wish to create in the Create New File section, select the From Scratch option, and press Create.
- To create a new definition (based on an existing definition) select an existing definition in the Edit Existing File section, type the name you wish to use for the new definition in the Create New File section, Select the Copy select as template option, and press Create.
- The following screens will take you through the various report definition options. The first page will be available when creating a definition using any of the Input File Format options. However, the screens that appear afterwards will only be visible when creating a definition for the Text file format.
- After completing each page in the definition, you have the option to go to the Previous page, go to the Next page, Cancel editing of the definition, or click Finished to save the changes.
Page Definitions
Page 1 - Report Info
- Repository: (Read Only) Displays the repository you are working in. It can only be changed by using the Change Repository button.
- Label: (Optional) If not entered ePrint will use the Filename as the Label.
- Description: A general description of the report.
- Filename: Must match the name of the report being sent. For .lis files this is the name of the Banner job. For all other file types it will be the Banner job name with an underscore and the file type (ex: fgrtrni_log)
- Input File Format: The majority of definitions use TEXT, but other input types are also usable (PDF, HTML, XLS, CSV, etc.). Fine-grained security only works with TEXT files.
- Top of Form: Use BANNER for all reports coming from Banner.
- Lines per Page: Depends on the format of the input file. The value of 66 is the most common.
- Authorization Type: There are two possible values.
- ALL will allow users with access to the report to see all records in the report.
- VBS will use Value-Based Security to enable users to view only that information that they have been granted access to.
Page 2 - Verify and Title
- Enter data to describe the location of text in the incoming report that will allow ePrint to identify it and give it your preferred report title. Both elements are found in the incoming report file.
Page 3 - Date and Time
- Select the Date and Time options that you would like to use for reports stored under the definition. There are two options:
- SYSTEM: ePrint will assign the time/date that the report is processed.
- REPORT: ePrint will use the time/date that is contained in the report itself. This option requires providing the location of the time and date in the report.
Page 4 - Junk Pages
- Defines pages that Banner ePrint should not use (e.g. a title page). (OPTIONAL)
Page 5 - Page Keys
- A page key is a collection of values on your report that are used to index. These keys are only used for Value-Based Security (VBS) and will only work with reports defined as the TEXT type. (OPTIONAL)
Page 6 - Notification
