Retrievals
Retrievals are used to define how data is retrieved from GS. This applies to Dashboards, Reports, Data Exports, and Default Retrievals.
Settings
| Setting | Description | Applies To Dashboards | Applies To Reports | Applies To Data Exports | Applies To Default Settings |
|---|---|---|---|---|---|
| Retrieval Name | The display name for this Retrieval. This name must be unique in the specific context (e.g. in a given Dashboard), but does not need to be globally unique. | Yes | Yes | Yes | No |
| Script ID | Identifies how this Retrieval is referenced in Dashboards. | Yes | No | No | No |
| Date | The date range to retrieve data for. See Dates for more information. | Yes | Yes | Yes | Yes |
| Retrieval Type | The type of data that this retrieval is capable of fetching. | Yes | Yes | Yes | Yes |
| Selection Type | The type of standards to use to fetch data. | Yes | Yes | Yes | Yes |
| Standards | A list of standards to retrieve data for. Only visible when Selection Type is set to Select Parts / Processes or Select Characteristics. See Standards for more information. |
Yes | Yes | Yes | No |
| Standard Filter | A filter to control which standards data is retrieved for. Only visible when Selection Type is set to Part / Process Filter or Characteristic Filter. | Yes | Yes | Yes | Yes |
| Data Filter Type | Controls what type of Filter is used to fetch data. | Yes | Yes | Yes | Yes |
| Data Filter | A saved Filter. Only visible when Data Filter Type is set to Select a Filter. | Yes | Yes | Yes | Yes |
| Quick Filter | An inline filter which may not be reused across Retrievals. Only visibile when Data Filter Type is set to Quick Filter. | Yes | Yes | Yes | Yes |
| Maximum Records to Retrieve Per Standard | The number of data records which will be retrieved for each selected standard. See Standards for more information. | Yes | Yes | No | Yes |
| Bypassed Data | Whether to include, exclude, or only include data which has been marked as bypassed. | Yes | Yes | Yes | Yes |
| Exclude From Insights | A list of Traceability to ignore when calculating Insights. | Yes | No | No | Yes |
Dates
Retrievals operate over either a Fixed or Relative date range. The data retrieved will fall between the given dates, and the
Fixed Date Range
When Date Type is set to Fixed, a start date and end date must be selected. The data retrieved will fall within this range.
Relative Date Period
If more dynamic dates are desired, the Date Type may be set to Relative. This allows creating Dashboards and Reports which automatically update to show the most recent data.
| Time Period | Current | Ending Now | Previous |
|---|---|---|---|
| Years | The current calendar year, beginning January 1 of the current year, and ending just before January 1 of the next year. | A date range beginning on the current date N years ago, and ending on the current date. | The previous N calendar years, ending just before January 1 of the current year. |
| Quarters | The current quarter, beginning on the first day of the first month of the quarter, and ending just before the first day of the first month of the next quarter. | A date range beginning on the same date 3 months ago, and ending on the current date. | The previous N quarters, beginning on the first day of the first month N quarters ago, and ending just before the first day of the first month of the current quarter. |
| Months | The current month, beginning on the first day and ending on the last day of the month | A date range beginning on the same date N months ago and ending on the current date. | The previous N calendar months, ending just before the first of the current month. |
| Weeks | The current week, beginning on the First Day of Week, and ending 7 days later. | A date range beginning on the same weekday N weeks ago, and ending on the current date. | The previous N weeks, beginning on the First Day of Week and ending just before the first day of the current week. |
| Days | The current day, beginning at 12:00 AM on the current day, and ending just before 12:00 AM of the next day. | A date range beginning at the same time N days ago, and ending at the current date and time. | The previous N days beginning at 12:00 AM N days ago, and ending just before 12:00 AM of the current day. |
| Hours | The current hour, beginning at the 0th minute, and ending just before the 0th minute of the next hour. | A date range beginning on the same minute N hours ago, and ending at the current time. | The previous N hours, beginning at the 0th minute N hours ago, and ending just before the current hour. |
All time periods (with the exception of Hours) adjust the start and end time based on the Start of Day Offset. For example, a Start of Day Offset of 10 minutes will cause Current Month to run from 12:10 AM on the first day of the month to 12:09 PM on the first day of the next month, instead of 12:00 AM on the first day of the month to 11:59 PM on the last day of the month.
Standards
With the exception of Accountability, all data in GS is retrieved based on standards. For SPC data, a Standard is always an SPC Characteristic. For OEE, DMS, and Task data, Standards can be either a Part or a Process. When retrieving SPC data using a Parts and Processes retrieval type, a query is first performed to determine which SPC Characteristics have data for the requested Parts and Processes.
When multiple Parts or Processes are selected, the data retrieved will have at least one of the selected Parts or Processes set.
Default Retrievals
Users who frequently use the same settings may set up a Default Retrieval in the User Settings. Users who have set up a Default Retrieval will have the Retrieval settings automatically populated when creating a new Retrieval for Dashboards, Reports, or Data Exports.
