reports:egreports:advanced
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
reports:egreports:advanced [2022/05/25 12:31] – [Introduction] smorrison | reports:egreports:advanced [2024/03/21 15:43] (current) – [Data Type Key] smorrison | ||
---|---|---|---|
Line 3: | Line 3: | ||
===== Introduction ===== | ===== Introduction ===== | ||
- | The information in this section builds upon the information discussed in the [[reports: | + | The information in this section builds upon the information discussed in the [[reports: |
Though it is not necessary to create templates in Evergreen, some knowledge of relational databases will come in handy, as the reports interface can be overwhelming. It may be helpful to review a brief [[reports: | Though it is not necessary to create templates in Evergreen, some knowledge of relational databases will come in handy, as the reports interface can be overwhelming. It may be helpful to review a brief [[reports: | ||
Line 16: | Line 16: | ||
// | // | ||
+ | |||
+ | Below shows these three fields within the report template filters tab: | ||
+ | |||
+ | {{: | ||
==== Data Type Key ==== | ==== Data Type Key ==== | ||
Within the template editor, data fields are associated with the following icons, which notate what type of data the field contains: | Within the template editor, data fields are associated with the following icons, which notate what type of data the field contains: | ||
- | {{: | + | {{: |
- | + | {{: | |
- | {{: | + | {{: |
- | + | {{: | |
- | {{: | + | {{: |
- | + | {{: | |
- | {{: | + | {{: |
- | + | {{: | |
- | {{: | + | {{: |
- | + | ||
- | {{: | + | |
- | + | ||
- | {{: | + | |
- | + | ||
- | {{: | + | |
- | + | ||
- | {{: | + | |
===== Modifying a Cloned Template ===== | ===== Modifying a Cloned Template ===== | ||
Line 50: | Line 46: | ||
==== Editing Existing Display Fields ==== | ==== Editing Existing Display Fields ==== | ||
- | The following adjustments can be made to existing entries in the Display Fields tab, which will reflect in your output report: | + | The following adjustments can be made to existing entries in the Display Fields tab, which will reflect in your output report. |
+ | |||
+ | {{:reports: | ||
**Change Column Label** | **Change Column Label** | ||
Line 59: | Line 57: | ||
**Change Column Documentation** | **Change Column Documentation** | ||
- | + | This function allows you to add additional information, | |
- | This can be used to document any notes or helpful | + | |
* Right-click the appropriate row in the Display Fields tab. | * Right-click the appropriate row in the Display Fields tab. | ||
* Enter text in field. | * Enter text in field. | ||
Line 89: | Line 86: | ||
**Notes on editing fields:** | **Notes on editing fields:** | ||
- | * The appearance of the displayed data is dictated by the field’s data type and the field transform that is applied to the field. The data type cannot be changed, but a different field transform can be applied, which will format the output data in different ways. | + | * The appearance of the displayed data is dictated by the field’s |
* If a field causes data to be broken down into smaller chunks, removing that field will aggregate the data on a single line. For example, say you have a template using Classic Item List as the Core Source with Display Fields “Owning Library” (as //Raw Data//) and “Copy ID” (with //Sum// field transform). This report will give you a count of copies (that meet the conditions specified in the filters) for each owning library on separate lines. If “Owning Library” is removed from the Display Fields, the output will contain a single line with a count of all copies that meet the conditions specified in the filters, rather than breaking them out by owning library. | * If a field causes data to be broken down into smaller chunks, removing that field will aggregate the data on a single line. For example, say you have a template using Classic Item List as the Core Source with Display Fields “Owning Library” (as //Raw Data//) and “Copy ID” (with //Sum// field transform). This report will give you a count of copies (that meet the conditions specified in the filters) for each owning library on separate lines. If “Owning Library” is removed from the Display Fields, the output will contain a single line with a count of all copies that meet the conditions specified in the filters, rather than breaking them out by owning library. | ||
- | |||
==== Adding New Display Fields ==== | ==== Adding New Display Fields ==== | ||
Line 123: | Line 119: | ||
Existing fields in the Filters tab can be edited just as in the Display Fields tab: by right-clicking on the row and selecting the option from the dropdown menu, OR by clicking Actions and choosing from the dropdown menu. | Existing fields in the Filters tab can be edited just as in the Display Fields tab: by right-clicking on the row and selecting the option from the dropdown menu, OR by clicking Actions and choosing from the dropdown menu. | ||
- | However, the options for editing Filters are slightly different. Edits can only be made to the Operator, Field Transform, and Filter fields. Filters can be removed, though the Move Up and Move Down functions are not available, as the order of fields is not relevant to filters. | + | The options for editing Filters are slightly different, however. Edits can only be made to the Operator, Field Transform, and Filter fields. Filters can be removed, though the Move Up and Move Down functions are not available, as the order of fields is not relevant to filters. |
+ | |||
+ | **Change Column Documentation** | ||
+ | |||
+ | In Filters, this function can be used to document any notes or helpful hints that will appear in the report template. For example, if you have a filter to choose the Owning Library and another filter to choose the Circulating Library, you can label these filters using column documentation. This shows up on the template form when you’re running the report. To add column documentation: | ||
+ | * Right-click the appropriate row in the Display Fields tab. | ||
+ | * Enter text in field. | ||
+ | * Click OK/ | ||
+ | |||
+ | The highlighted text in the screenshot below shows what filter column documentation looks like when running a report: | ||
+ | |||
+ | {{: | ||
==== Adding New Filters ==== | ==== Adding New Filters ==== | ||
Line 148: | Line 155: | ||
- **Create a new template.** You will create a new template in the appropriate subfolder under Templates. | - **Create a new template.** You will create a new template in the appropriate subfolder under Templates. | ||
- | - **Select the core source.** You will determine which main source you use as your starting point for the template. | + | - **Select the Core Source.** You will determine which main source you use as your starting point for the template. |
- | - **Set up filters.** Here, you set up restrictions on the output so you only retrieve the data you need. | + | - **Set up Display Fields.** You will decide what data will be included in the output and how it will appear. |
- | - **Set up display fields.** You will decide what data will be included in the output and how it will appear. | + | - **Set up Filters.** Here, you set up restrictions on the output so you only retrieve the data you need. |
- **Name and save the template.** Once you've defined the filters and displays, it's time to name the template and save it for future use. | - **Name and save the template.** Once you've defined the filters and displays, it's time to name the template and save it for future use. | ||
Line 164: | Line 171: | ||
* Fill in your Template Name and Template Description. | * Fill in your Template Name and Template Description. | ||
- | //The Template Description can be updated before, during, or after you create your report, however, it is very important to notate which fields, filters, and column labels you used. It is also helpful to add which Core Source you used. For a guide, please refer to report descriptions in Quick Reports or in any of the Shared Templates in the staff client.// | + | < |
**Step 2: Select the Core Source** | **Step 2: Select the Core Source** | ||
Line 188: | Line 195: | ||
The filters themselves will vary according to your needs, and there are far too many possibilities to list here, so you may need to experiment a bit. However, the basic steps are the same for all filters. | The filters themselves will vary according to your needs, and there are far too many possibilities to list here, so you may need to experiment a bit. However, the basic steps are the same for all filters. | ||
- | For each filter in your template, repeat | + | For each filter in your template, repeat |
- | **1. Select the Filter Field** | + | //**1. Select the Filter Field**// |
Click on the Core Source name next to the arrow to populate the Source fields. If you click on the arrow, more categories will populate underneath the Core Source. | Click on the Core Source name next to the arrow to populate the Source fields. If you click on the arrow, more categories will populate underneath the Core Source. | ||
- | **2. Select the Transform** | + | //**2. Select the Transform**// |
Once you click on a Source field, the Field Transform box will populate with the available options. | Once you click on a Source field, the Field Transform box will populate with the available options. | ||
- | **3. Add the Field to the Filters Tab** | + | //**3. Add the Field to the Filters Tab**// |
Once you have the field and field transform highlighted, | Once you have the field and field transform highlighted, | ||
- | **4. Select Operator/ | + | //**4. Select Operator/ |
//Equals// is the default operator for a filter. If you want to choose a different operator for a filter, right-click the row and click the Change Operator button from the pop-up menu at the bottom of the screen. Choose the correct operator from the list. If you aren't certain which operator to use, refer to the [[reports: | //Equals// is the default operator for a filter. If you want to choose a different operator for a filter, right-click the row and click the Change Operator button from the pop-up menu at the bottom of the screen. Choose the correct operator from the list. If you aren't certain which operator to use, refer to the [[reports: | ||
Line 229: | Line 236: | ||
Templates and reports can be shared between libraries within a system, though they cannot be shared across systems. Only GPLS staff can share across PINES. This is because the assumptions that you make in your library or library system may be very different from the assumptions a different library or library system makes. For example, there may be variances in vocabulary, which may endanger the situation that you are using the data for, and you may be depending on a report that may not be appropriate for your system. Anything you would want shared is ideally already provided in Quick Reports, or there is a template in the provided PINES staff template folders. | Templates and reports can be shared between libraries within a system, though they cannot be shared across systems. Only GPLS staff can share across PINES. This is because the assumptions that you make in your library or library system may be very different from the assumptions a different library or library system makes. For example, there may be variances in vocabulary, which may endanger the situation that you are using the data for, and you may be depending on a report that may not be appropriate for your system. Anything you would want shared is ideally already provided in Quick Reports, or there is a template in the provided PINES staff template folders. | ||
- | Think of sharing reports as publishing a report. Subfolders should be weeded as much as possible to rid of junk or bad reports that you may have used while testing a new report. Be mindful when naming reports as well, to ensure | + | Think of sharing reports as publishing a report. Subfolders should be weeded as much as possible to rid of junk or bad reports that you may have used while testing a new report. Be mindful when naming reports as well, to ensure titles and descriptions are useful and relevant |
+ | |||
+ | //Source: {{ : |
reports/egreports/advanced.1653481882.txt.gz · Last modified: 2022/05/25 12:31 by smorrison