Catalog
What is it used for (purpose)?
- See reports
- Run reports you have access to & Create and Edit reports you own (extract raw data from a process)
- By default you will land on the Catalog tab. Other available tabs are: My Reports, Scheduled Reports & Admin (permission based)
What is on this page?
- The Catalog tab displays a list of all available reports with their Report Name, Description Summary, Created Date and Report Icon.
- Search
- Count - total number of reports
- Sort Options, default option is Recent (Displays reports sorted by creation date, from newest to oldest)
- Name - Displays reports sorted alphabetically by Report Name (A–Z)
- Report card - for each report the following is visible:
- Report Name
- Description Summary
- Created Date
- Report Detail (right pane)
- if a report is selected, the Detail page is visible by default
- Collapsible menu items for a selected report are:
- Detail - see Description Summary, Global Report Parameters, Report Parameters (by sheet)
- Information - see Description, Created By, Created Date, Updated By, Updated Date and Last Run Date.
Navigation (How do I get to Reporting Catalog?)
There are two ways to navigate to this page:
- In the Home page
- Click ‘Reporting’ on the Frequently Used Apps or Available Apps
- By default, you will be taken to the Reports Catalog Page
- Using the Navigation bar.
- Click ‘Apps’ button on the top right corner of the Navigation bar, and see all available apps
- Click on the ‘Reporting’ App
- By default, you will be taken to the Reports Catalog Page.
How do you use the functionality of Reporting Catalog?
Select an existing report. Report Detail (right pane):
- If a report is selected, the Detail page is visible by default
- Collapsible menu items for a selected report are:
- Detail - see Description Summary, Global Report Parameters, Report Parameters (by sheet)
- Information - see Description, Created By, Created Date, Updated By, Updated Date and Last Run Date.
- Run Security - see whether a report is public (appears in the Catalog for anyone with a reporting license)
- If the report is restricted, the User(s) / Group(s) allowed to run the report are listed
Actions you can take (In default Details page):
- Run - allows you to execute a report. The report will be queued (status badge will update from Queued to Running then to Completed). Once Completed, the report can be downloaded.
- Download Latest - you can access the version of the report that was last run (this means any new data will not be included)
- Create Schedule - set up a schedule for the report to run automatically based on a given cadence
- Edit Schedule - permission based - an existing schedule can be modified
- Edit - permission based - the selected report can be modified (Details, Sheets, Catalog Page and Report Security)
How to create a schedule?
- Click Create Schedule
- Select frequency (Daily, Weekly, Monthly)
- Hour of the day - Hour of the day (in UTC) the report will run
- Report expiry (months) - Months until scheduled report expires
- Add recipients for the schedule
- If any selected recipient does not have permission for a report, the system will skip the user and only make the report available to those with permission.
- Submit
How to edit a schedule?
- Click Edit Schedule
- You will be taken to the 'Scheduled Reports' tab
- Existing schedules for the report will be listed
- Select the schedule one you want to edit
- Make your changes
- Re report recipients:
- If any selected recipient does not have permission for a report, the system will skip the user and only make the report available to those with permission.
How to Create a Report?
Permission based: Add a report. Click on the Add button.
- An add sheet prompt will request you select Type: WMS Extract, Advanced WMS Extract or Data Import Extract
- Make your selection and click Ok
- Details page will load, populate the following accordingly:
- Report Name
- Report Summary
- Report Icon
- Identify if a template will be used, if enabled, upload the template
- Click on Sheets menu item (left pane) to define data exported per sheet in the report
- You can use the existing sheet
- Give your sheet a name
- Sheet Summary
- Select the process
- Include Task values
- Include Field values
- Apply filters to data
- Click on Catalog Page menu item (left pane) to add content users will see in the Catalog for the report. Use Content Elements and Layout Elements as needed
- Click Save
- Resolve Validation errors (if you have any)
- Example: If you selected a process which is restricted (you do not have permission to use it) the report cannot be saved
- You must correct the process selection to proceed