A glossary of terms related to Argos and SIS reports.
Argos is a web-enabled application used to create custom reports against a database.
This is where filters are utilized to narrow down the results of the data you are trying to obtain.
The Report Query is an SQL query and is how the requirements are sent to the database.
- The query incorporates three things: our search parameters, our criteria, and the list of data elements that we want returned.
In Aros, we take a DataBlock form, and the Report Query, and we combine them into one object, that we call a DataBlock.
- The report format contains the instructions used to create the report.
- Reports are created as children of the DataBlock. This means that we can use the DataBlock form and query to create multiple reports.
- The reports under a DataBlock are just different ways of formatting the data we get back from the database.
- A DataBlock can contain five different report types:
- Dashboard
- CSV Report
- Extract Report
- Banded Report
- Crosstab Report
Report Query and Object Query are different and should not be confused with one another. Object Queries are the queries used to populate the objects placed on Dashboards while the Report Query is the main driving query used to generate your report output. Object Queries and Report Queries may or may not be identical. Report queries can have additional fields or filtering applied. For example, an Object Query may show counts or totals for a subset of data within a Report Query.
- In the query process, we enter our search parameters.
- The DataBlock would then incorporate the criteria into a query.
- The query is then sent to the data source for processing.
- The requested records are passed back through Argos to the DataBlock
- The DataBlock would then process the information and build a report with the format that was selected.
- A DataBlock can produce different types of reports and reports formatted differently for each type.
- If we have a DataBlock that returns the fields, Name, Address, Grade, and Registration Status, we can create various reports because we are not required to use all the returned fields.
- From the return fields, we can choose which ones we want to display on the report
- For example, if you wanted a Class Grade Roster report that contains the fields: Name, Grade, and Registration Status. The Address field will not be used and then would be removed from the output.
- If you wanted a report for Mailing Labels the report could be created within the same DataBlock. The DataBlock will return all the same fields but will only use the fields we wish to display. This report may just contain the fields, Name and Address. Since we do not need the remaining fields, they will be discarded.
Here are a few points to remember as you navigate through Argos.
- Information comes from data sources.
- All fields are not required to be used in a report or dashboard.
- Incorrect data
- Query Issue
- Data in Data Source
Folder structure and the detailed view
- Under Explorer, we have folders. Folders organize and maintain security on DataBlocks.
- The folders are broken out and organized by business function.
- The contents seen in your folder tree will be based on your user permissions as well.
- When you click into a parent folder, you can drill down until you see different DataBlocks.
- From here, you can then select the Details of the DataBlock to see the different reports under the DataBlock, along with related information such as title, description, author, creation date, and modified date.
Five different report formats can be created in Argos. Each format has an icon to represent it.
- A Dashboard is represented by an icon that looks like a magnifying glass. Dashboards are designed to be on-screen reports. This is what you will be interacting with as an end user to choose your parameters and drill down your data accordingly.
- An Extract Report has an icon with the letters FIX (fixed width), but this may be DEL (delimited) or XML as well. An extract report is designed to meet predefined output specifications.
- A CSV or a comma-delimited report. This report is identified by letters CSV. This report format exports the data to a flat text file.
- A Banded Report is represented by an icon is a dash representing a band. A Banded Report is a fully formatted report designed to be printed. This report is used for major publications, presentation reports, and PDF files.
- A Crosstab Report is represented by a table icon. A Crosstab provides an easy way to relate two or more data attributes in a simple table format.
- Navigating through the Explorer tab can be time-consuming and with a shortcut, we can access the report or DataBlock more quickly.
- We have two types of shortcuts: My Shortcuts or Shortcuts that you make for your exclusive use. Shared shortcuts are shortcuts that everyone sees. Report Viewers and Writers can only create a My Shortcut.
- To create a Shortcut, you will drill down to the DataBlock or Report you would like to add to the shortcut, and then select the star icon to the left of the Title.
- You will then be prompted with a pop-up confirming the shortcut location (My Shortcut), the Argos location, and an option to rename your object in your shortcut.
- Once created, you can view your shortcuts in the Shortcuts tab.
- To the right of your shortcuts, you can see other icons.
- Icons with a lock are your personal shortcuts, and any without would be shared shortcuts.
- The X button will allow you to delete a shortcut.
Dashboard
- To run a Dashboard report you will need to identify and drill down to the DataBlock you wish to run.
- Clicking on the DataBlock will then launch the Dashboard. From here you can see the DataBlock form that is the basis of all the reports created under this DataBlock. Each report will use the same DataBlock form, but the information will be processed differently.
- A Dashboard will provide us with a status report of the DataBlock. You will see various filtering options that coincide with the specific report you are viewing.
- Various filtering options may be used within a Dashboard.
- A Dropdown filter allows for a single item to be selected from a drop-down menu.
- Edit Boxes and Memo Boxes allow the user to type in letters or numbers to search by all or part of a text. The Memo Box allows for more lines of text and is larger than an Edit box.
- A Date Field allows the user to either enter a date manually or select the date icon to select a specific date. This is typically used to drill down data to a specific date or a specific date range.
- ListBoxes house a list of items to filter by. This can either be a multi-select field or a single-select field depending on the setup and intention of the Dashboard. If the ListBox is a multi-select box, you can select multiple options within the box that are non-adjacent while holding the ctrl key on your keyboard or selecting a range by using the shift key or clicking and dragging down with your mouse.
- Checkboxes are typically grouped with a ListBox to provide additional narrowing or expansion of the results and act as a Yes/No indicator.
- Radio Buttons allow for a single selection within a group of values.
- There Is a Saved Setting option in the top right corner. When selecting various filtering options, it can be beneficial to utilize the saved setting option. This allows you to preset filters that you run on a regular basis. The feature is currently only able to be set in the Client version of Argos though, so it will need to be requested if you feel it would be beneficial to you. Please send an email to reports.sis@yale.edu.
- In most cases, the Dashboard will contain a Multicolumn ListBox at the bottom with either a preview of the results, with limited columns, or a list of the full results, with all columns available. You will know whether it is a preview, or a full list based on the terminology of the Button above the box. A “Show Results” option is for full results, and a “Preview Results” option is for a limited column option.
- The bottom right corner of the ListBox contains a gear icon that will allow you to Filter, Order Columns, or Export the results to a CSV.
- The Filter option allows you to filter down your results further based on the columns available in the report.
- Select the column you would like to filter by, the operator, and the value. You will need to press the + button, followed by the Apply button to have the additional filter applied.
- The column Ordering option allows you to reorder the columns on your screen only. These will reset each time the Dashboard is run.
- The Export All to CSV option will allow you to select columns available that you wish to see and export them into a CSV file.
- You can check and uncheck the columns you wish to see.
- It is recommended to not select additional values outside of the preset checks as it may throw off results.
- You can also utilize the byte order mark option which will ensure that any characters with special formatting are exported correctly.
- Clicking Apply will download the CSV file to your computer.
CSV Report
- You can find any reports associated with the Dashboard in the Reports dropdown found below the main toolbar.
- Select the filters you wish to be represented in the data output.
- From the Report dropdown you may see multiple reports and formats, select the report you wish to run with your selected parameters, then click Run.
- If you select a CSV report, it will download the CSV report to your computer.
- A CSV file is represented by a CSV icon.
- Your output will be in a comma-delimited file format.
Extract Report
- Extract files are represented by a multiline document icon.
- The output of this file will be a fixed column width text file, delimited, or an XML.
Banded Repot
- Banded reports encompass the most formatting and are typically designed for printing.
- A Banded report is represented by a single-line document icon.
- These can be downloaded and saved as a PDF file.
Crosstab Report
- A crosstab report, also known as a cross-tabulation or matrix report, provides an easy way to relate two or more data attributes in a simple table format.
- The Crosstab is represented by a table icon.