My Query Builder Function

Transcription

1 My Query Builder Function The My Query Builder function is used to build custom SQL queries for reporting information out of the TEAMS system. Query results can be exported to a comma-separated value file, a Microsoft Excel file, or a PDF. Users can save queries as profiles to be used again. In this document: Building an SQL Query How to Build an SQL Query How to Create a Join How to Select the Columns for Display Using Function Buttons How to Create an Aggregate Function How to Create an Arithmetic Function Working With Profiles How to Save a Query as a Profile How to Save a Query as a Filter Profile How to Delete a Saved Profile TEAMS User Guide: My Query Builder Prologic Technology Systems, Inc.

2 MY QUERY BUILDER FUNCTION Building an SQL Query This section is an overview of how to build a basic SQL query. How to Build an SQL Query To build an SQL query, follow the steps below. 1. Navigate to the TEAMS Home page and select the Reports menu. Note: The exact name of the menu you use to access this function depends on how your district has configured its TEAMS Home page. 2. Select the My Query Builder link. The SQL Builder tab is displayed. Figure 1: SQL Builder tab 3. In the Database field, select the database to query from the drop-down list. 4. In the Table field, select the table or view to use from the drop-down list. Views are indicated by a V (for example, V Applicant). Note: If you want to join tables, click the + link to display the Create Join box, see "How to Create a Join" on page 6 for more information. Note: The views and tables available for selection are configured in the Maintain RFDS TEAMS Report Table View function and then distributed to employees using the Position View Association function. For more information about these functions, see the TEAMS Functions for SQL Queries User Guide or TEAMS Online Help. 5. In the Column field, select the column that contains the information you want to query. 6. In the Operator field, select an operator from the drop-down list. 2 TEAMS User Guide: My Query Builder

3 Building an SQL Query 7. In the Value field, if the operator you selected requires a value to complete the expression, enter the value in the field. Note: If you want to query on a date, enter the date in the Value field using the following format: YYYY-MM-DD (for example, August 31, 2013 would be ). You must include the single quotation mark at the beginning and end of the date information. 8. Optional. In the Tags field, you can select the variable {Current Fiscal Year} to use as a value in your query. When you run the query, the system will pull the value of the Current Fiscal Year from the value set in the District Business Rules function for the rule Fiscal Year Current Fiscal Year. When the current fiscal year is updated in the business rule, saved SQL profiles that use the Current Fiscal Year tag will automatically pull the correct value. 9. Click the Insert button. The criterion you built is added to criteria panel, and the And, Or, and Clear buttons are displayed on the tab. Figure 2: SQL Builder tab with criterion added and buttons displayed 10. Repeat Step 5 through Step 8 to configure additional criteria for the query. 11. For your additional criteria, click one of the following button options: Click the And button to require that search results match all criteria joined by and. Click the Or button to require that search results match any criteria joined by or. Note: Click the Clear button to clear the tab of all your criteria selections. The SQL Builder tab with additional criteria selected is shown in the following figure. TEAMS User Guide: My Query Builder 3

4 MY QUERY BUILDER FUNCTION Figure 3: SQL Builder tab with additional criteria selected 12. Optional. Click the Select columns button to select what columns of information from the table or view will be included in your results and the order in which they are displayed. For more information, see "How to Select the Columns for Display" on page 7. Note: You also have the ability to create aggregate functions and arithmetic functions. For more information, see "Using Function Buttons" on page 9. Note: The Max Rows field defaults to 500. You can change this setting, if necessary, but increasing the number may increase the time it takes to process the query. 13. Click the Execute button. The Query Execution box (shown below) is displayed to let you know the query is executing. Figure 4: Query Execution Note: To cancel a query during the execution process, click the Cancel button. When the query is finished executing, matching results are displayed on the tab, as shown in the following figure. 4 TEAMS User Guide: My Query Builder

5 Building an SQL Query Figure 5: SQL Builder tab with query results 14. Optional. If you want to export the results to a file you can modify or save, select one of the options below: Click the Export to CSV button to export the results to the comma-separated value file. Click the Export to Excel button to export the results to a Microsoft Excel file. Click the View PDF button to open the results as a PDF file that you can save. You can select whether you want the orientation of the PDF document to be Portrait (default selection) or Landscape. Note: If you have created a query that you want to use again, you can save it as a profile. For more information, see "Working With Profiles" on page 12. TEAMS User Guide: My Query Builder 5

6 MY QUERY BUILDER FUNCTION How to Create a Join To join tables, follow the steps below. 1. Click the + link to display the Create Join box, shown below. Figure 6: Create Join box 2. Select the Source table. After the Source table is selected, the only available selections in the Destination table field are tables that can be joined directly to any table in the list. This will prevent you from selecting an invalid table to use in the query. 3. Select the Join Condition. The join is listed in the box, as shown in the following figure. Figure 7: Create Join box with join added Note: To delete a join, click the icon in the Delete column for the join. 6 TEAMS User Guide: My Query Builder

7 Building an SQL Query 4. Optional. You can continue creating joins, if desired. The system will automatically determine which of the remaining tables can be joined to the table(s) already selected. When you are finished creating joins, click the Ok button to return to the SQL Builder tab. The joined tables are displayed in the Table field separated by a comma (,), as shown in the following figure. Figure 8: SQL Builder tab (partially illustrated) with joined table selected When you select columns for the query, all fields available for any object in the list of selected items are available for selection. How to Select the Columns for Display To select the columns of information from the table or view you selected to include in the query, follow the steps below. 1. Click the Select columns button. The Select Columns box is displayed. Figure 9: Select Columns box TEAMS User Guide: My Query Builder 7

8 MY QUERY BUILDER FUNCTION 2. The Visible box next to each column name defaults as selected, meaning the column will be displayed in your report. If you do not want to display a column, click the Visible box to deselect it. Tip: Clicking the Deselect All button removes the selection in the Visible box for all column names; clicking the Select All button selects the Visible box for all column names. 3. To rearrange the order how the columns of information will be displayed, highlight to select a column name. Figure 10: Select Columns box (partially illustrated) with selected column name 4. Use the Move Up and Move Down buttons to move the column name to the desired order. 5. Click the OK button. The Select Columns box closes. 8 TEAMS User Guide: My Query Builder

9 Using Function Buttons Using Function Buttons This section is an overview of how to use the Aggregate Function and Arithmetic Function buttons on the SQL Builder tab. How to Create an Aggregate Function With the Aggregate button on the SQL Builder tab, you can select a column for which to perform one of the following functions for the values in the column: Find the average of all the values in the column, Find the total count of all the values in the column, Find the minimum value in the column, Find the maximum value in the column, or Find the sum of all the values in the column. To create an aggregate function, follow the steps below. 1. Click the Aggregate button to display the Aggregate Function box, as shown below. Any previously saved aggregate functions are listed on the box. Hover your cursor over a column to display a popup box Figure 11: Aggregate Function box 2. In the Column field, select the column of information for which to perform the aggregate function. Note: The columns that are available for selection in the drop-down list are those you have chosen in the Select Columns box, which is accessed by clicking the Select Columns button. TEAMS User Guide: My Query Builder 9

10 MY QUERY BUILDER FUNCTION 3. In the Aggregate Function field, select one of the following values for the function to be performed: AVG, COUNT, MIN, MAX, or SUM. Once a selection is made in the Aggregate Function field, the aggregate function is listed on the Aggregate Function box. Note: To delete an aggregate function, click the button. A Confirmation box is displayed asking you to confirm the deletion. Click the Yes button to proceed with the deletion. 4. Click the Ok button to close the Aggregate Function box and return to the SQL Builder tab. How to Create an Arithmetic Function With the Arithmetic Function button on the SQL Builder tab, you can include calculations in your queries. Arithmetic functions can be created using the columns selected for the query, as well as any aggregate functions or other arithmetic operations that have been created for the query. To create an arithmetic operation, follow the steps below. 1. Click the Arithmetic Function button to display the Arithmetic Function box, as shown below. Hover your cursor over a column to display a popup box Figure 12: Arithmetic Function box 2. In the Aux Name field, enter a name for the arithmetic operation. 3. In the Column1 field, select the source for the first part of the calculation. The drop-down list includes all selected columns, aggregate functions, and arithmetic operations that have been saved for the query. 4. In the Operator field, select one of the following options: + (add), - (subtract), * (multiply), or / (divide). 10 TEAMS User Guide: My Query Builder

11 Using Function Buttons 5. In the Column2 field, select the source for the second part of the calculation. The drop-down list includes all selected columns, aggregate functions, and arithmetic operations that have been saved for the query. Once a selection is made in the Column2 field, the details of the arithmetic operation are listed on the Arithmetic Function box. Note: To delete an arithmetic operation, click the button. A Confirmation box is displayed asking you to confirm the deletion. Click the Yes button to proceed with the deletion. 6. Click the Ok button to close the Arithmetic Function box and return to the SQL Builder tab. TEAMS User Guide: My Query Builder 11

12 MY QUERY BUILDER FUNCTION Working With Profiles If you have created a query that you want to use again, you can save it as a profile. You can also save profiles to be used as Filter Profiles. This section is an overview of query profile functionary. Profile panel Figure 13: SQL Builder tab (partially illustrated) How to Save a Query as a Profile 1. Enter a name in the New Profile field. 2. Click the Save Profile button. The new profile is added to the selections in the Profile field. Note: For details about using the Filter Profile box, see How to Save a Query as a Filter Profile below. How to Save a Query as a Filter Profile You can save query profiles defined as Filter Profiles that when active, will filter your search results on many Student Search tabs. For example, you can create a query in My Query Builder that returns At-Risk students. You can save this query as a filter profile that can be activated to filter your student search results to only return students At-Risk. An overview of the process for creating queries for use as a filter for student searches is below. 1. Save a query in the My Query Builder function to be used as a filter profile (see page 13). 2. Activate one or more filter profiles to be used in Student Searches in the Active Profile Filter function (see page 14). 3. When a filter is active, the icon is displayed in the upper right corner of your TEAMS browser window, and on Student Search functions, only students who meet the criteria of the active filter profile query in addition to any selected search criteria will be returned (see page 15). Note: The icon is only displayed on the main TEAMS browser window. It is not displayed in an alternate browser window. 12 TEAMS User Guide: My Query Builder

13 Working With Profiles Creating a Filter Profile To create a profile to use as a filter, follow the steps below: 1. In the My Query Builder function, when you are adding a new profile or editing an existing profile, select (checkmark) the Filter Profile box. Note: The Max Rows field on the SQL Builder tab only applies to queries executed in the My Query Builder function. The maximum number of rows returned in search results with a filter profile is controlled by the My Query Builder FilterProfileMaxRows district business rule. Important: Filter profiles must have the Student Person ID column (for example, PER_ID or STU_PER_ID) selected as one of the columns to display, as shown in the following figure. (Click the Select columns button to access the Select Columns box.) For queries that will be saved as Filter Profiles, the Student Person ID column (for example, PER_ID) must be selected as a column to display. My Query Builder function, Select Columns box 2. Click the Save button to save the profile. TEAMS User Guide: My Query Builder 13

14 MY QUERY BUILDER FUNCTION Activating a Profile Filter Use the Active Profile Filter function to select the filter profile(s) you want to use with Student Search functions. You can have multiple active filter profiles. When multiple active filter profiles are used, the system employs and logic. To be included in search results, students must meet the criteria of each active filter profile. For example, if you have selected a filter profile that returns Special Education Students and have selected a filter profile that returns 9th grade students, only Special Education Students who are in the 9th grade are returned in search results. When a filter profile is added to the Active Profiles List, the system stores a filtered list of the students meeting the criteria for saved active filter profiles. This list will remain static throughout the your TEAMS session unless you return to the Active Profile Filters function and refresh the filter profiles. The filtered list of students is also updated when you log in to the TEAMS application. To make a filter profile active, follow the steps below. 1. Navigate to the TEAMS Home page and select the Reports menu. Note: The exact name of the menu you use to access this function depends on how your district has configured its TEAMS Home page. 2. Select the Active Profile Filter link. The the Active Profiles tab is displayed. Figure 14: Active Profile Filter function, Active Profiles tab 3. In the Profile Names field, select a filter profile. The drop-down selection list displays all queries that have been saved as filter profiles in the My Query Builder function. 4. Click the Add button. The profile is displayed in the Active Profile Filter function, a message is displayed that the filter profile was added successfully, and the active filter profile icon is displayed in the upper right corner of the TEAMS browser window (as shown in Figure 15). The filter profile will be used by default on all Student Search tabs. Note: If the system found no students who met the criteria for the saved active filter profile(s), the active filter profile icon is not displayed in the TEAMS browser window, which means no filter will be applied. 14 TEAMS User Guide: My Query Builder

15 Working With Profiles Refreshing Active Profile Filters During your TEAMS session, you can refresh all active filter profiles to update the filtered list of students meeting the criteria of your active profiles. To do this, click the Refresh button on the Active Profiles tab. Filter Profiles are also automatically refreshed each time you log in to the TEAMS system. Inactivating Active Profile Filters To inactivate a profile filter, select the filter profile in the Active Profile Filters list and click the Delete button. Active Profile Filter in TEAMS Browser Window When you have an active filter profile, the TEAMS browser window as shown below. icon is displayed in the upper right corner of the Note: The icon is only displayed on the main TEAMS browser window. It is not displayed in an alternate browser window. Filter Students option Active filter profile icon Figure 15: TEAMS Browser Window with Active Filter Profile When a filter profile is active, only students who meet the criteria of the active filter profile query in addition to any other selected search criteria will be returned. For example, if you select Name in the Search By field and enter the Last Name of Smith, only those students with the last name of Smith who qualify for the active filter profile query will be returned. In the Search By field, you can select the Filter Students option and click Search button to quickly display all search results that qualify for the active filter profile. TEAMS User Guide: My Query Builder 15

16 MY QUERY BUILDER FUNCTION How to Delete a Saved Profile 1. In the Profile field, select the profile to be deleted and click the Delete button. A message box is displayed asking you to confirm the deletion action. 2. Click Yes to continue with the deletion. 16 TEAMS User Guide: My Query Builder