EverServ PixelPoint. Revision History 6/27/ Revision 1 - v12.0 Functionality added 08/17/ Revision 0 - Initial Release

Transcription

1 EverServ PixelPoint External Report Viewer Revision History - Revision 1 - v12.0 Functionality added 08/17/ Revision 0 - Initial Release Functionality effective as of PixelPoint v12.0

2 Publication Details Copyright This product and related documentation are protected by copyright and are distributed under licenses restricting their use, copying, distribution, and decompilation. No part of this product or related documentation may be reproduced in any form by any means without prior written authorization of PAR and any requisite licensors. Trademarks PixelPoint, ParTech, and their respective logos are all trademarks of PAR Technology Corporation. PAR may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from PAR, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property. Microsoft and Windows are registered trademarks of Microsoft Corporation in the United States and/or other countries. Other product names may be trademarks or registered trademarks of their respective companies and are hereby acknowledged. Disclaimer PAR has thoroughly reviewed this document and believes it to be reliable. However, this document is provided for informational purposes only and PAR makes no warranties, either expressed or implied, in this document. Information in this document is subject to change without notice. Risk of use and responsibility for the results of use of this document lie with the user. Patents The following patents apply to some areas of functionality within the PixelPoint software suite: Pat. 6,384,850; 6,871,325; 6,982,733; 8,146,077; 8,287,340

3 Table of Contents External Report Viewer Overview... 4 Installation... 5 Configuring... Functionality 8 Report... Group Folder Functions 10 Report... Functions 11 Running... Reports 16 Reports... not in the Tree 17 Query... Builder 18

4 Overview Report Viewer is used primarily to generate sales and operational reports. The User Interface is divided into two panels - a tree with report choices, and a viewing panel where selected reports can be seen when run on-screen. This document will guide you through the installation and use of Report Viewer. Page 4

5 Installation Begin the installation procedure by right-clicking on the setup file and selecting [Run as administrator]. When the Windows User Account Control (UAC) prompt appears, select [Yes]. When the installer is ready, select [Next]. Choose the PixelPOS folder for the installation destination. If prompted that the chosen folder already exists, select [Yes] again. There are two types of installations that can be performed. If the system that the installation is being performed on is a server (whereby other stations will be connecting to it in order to use Report Viewer), perform a Report Viewer Server Install. Prerequisites and Report Viewer files will be installed using this installation option. If the system that the installation is being performed on is a station (whereby it will be connecting to a server in order to use Report Viewer), perform a Report Viewer Station Install. Page 5

6 Note: If a Report Viewer Server Install is being performed and other computers will be connecting to that system in order to use Report Viewer, make sure to share the folder that Report Viewer is being installed to. Otherwise, stations will not be able to access Report Viewer. Review the setup configuration and then select [Install] to proceed. When the installer has finished extracting the necessary files, it will first install Microsoft.NET Framework 4 Extended. When the.net window appears, review and accept the license terms and then select [Install]. Select [Finish] when the.net installation completes. The SAP Crystal Reports runtime engine for.net Framework 4 setup will now begin. Accept the License Agreement and then select [Next]. Page 6

7 When the installation completes, select [Finish]. If a Server Install has been performed, the prerequisites will have been installed and Report Viewer files will have been put into place. The PixelPOS directory will contain the Report Viewer application and a folder called PixelReports with QueryBuilder queries and schemas. If a Station Install has been performed, the prerequisites will have been installed. Page 7

8 Configuring Functionality BackOffice Setup Important services will not work if the designated port for communication is blocked by a software or hardware firewall, or by antivirus software. When designating a port for communication, make sure that the port is not blocked. To make use of the functionality in PixelPoint POS, run Pixel Server.exe from the \PixelPOS directory (which also needs to contain the two accompanying DLL files) on each POS station. Run this executable one time only. From that point on, services will be entirely transparent. Report Viewer uses the configuration settings stored in the database by BackOffice (SystemSet.exe). Open System Setup from the Administrator menu in BackOffice, and switch to the Setup tab. From there, modify the settings as per the provider. 1. Enter the server's address or network name. 2. Enter the communication port. Webmail (like Gmail, Hotmail, Yahoo! Mail, etc.) and SMTP ports can be used. 3. If the mail server requires SSL encryption, enabled it by checking the SSL box. 4. Enter the user name and password for the mail server, and specify the address for outgoing messages in the Sender field. 5. Choose a display name for outgoing mail. The final step is to select the Enable SMTP for Report Viewer option in the Setup>Overview tab (shown above). When this is complete, use [Send test ] to verify that all configuration information is correct. Page 8

9 Report Viewer Verification To verify that Report Viewer is properly configured to send s, open the Options window from the Tools menu and make sure that the settings are the same as those entered in BackOffice. You may test the functionality from here as well. If changes are necessary, modify the settings in BackOffice. Page 9

10 Report Group Folder Functions New The New function can be used to create a new group folder to be displayed in the tree. To create a new group folder: 1. Right-click the report folder where the new group folder is to be inserted, and select [New]. For example, to create a new subfolder under EMPLOYEES, right-click on the EMPLOYEES folder, and choose [New]. 2. Enter a name, and choose a security level to apply in the Group Properties box that appears. The available security options are Clock IN-OUT Only, Lead Cashier, Managers, Owners/System Administrators, and Wait Staff Normal. Select [OK] when finished. Edit To change the name or security level of a group folder displayed in the tree, use the Edit function. 1. Right-click on a folder in the tree, and select [Edit]. 2. Modify the name or security level for the group folder, and then select [OK]. Note that in order to edit the properties of a folder with a security level already applied, the user must meet those security level requirements. Delete The Delete function can be used to delete group folders from the Report Tree. To delete a group folder: 1. Right-click on a folder in the tree, and select [Delete]. 2. Choose [Yes] when asked if you are sure that you want to delete the group. The folder will then no longer appear in the Report Tree. Page 10

11 Report Functions The following functions can be used to add and edit reports in the Report Tree: New To add a new report to the Report Tree: 1. Select the group folder where you want the new report to be inserted, and then choose [New] from the Report menu above. 2. In the Report Properties window that appears, use the button to browse for an RPT file to import. Only import reports that reside in the \PixelPOS\PixelReports\ directory. Reports in other locations will not work. After selecting a report, the Name and Description fields will be filled in automatically. You can accept these values or edit them accordingly. 3. Set the desired security levels for running, editing, and deleting reports in the appropriate fields. Skip this step if no security limitations are needed. 4. If the report requires a date range before running, enable the Ask For Date Range option. Associated restrictions and parameters for the report should be entered in the Formula and Parameters fields. 5. Under Destination, decide how you would like the report to be viewed when run. Available options are: Window: Will display the report in the right panel of Report Viewer. Will send the report by . File format, file name, and an address are needed. MS Exchange: Will send the report via an MS Exchange server. File: Creates the report as a file. File format, file name, and an export directory are needed. 6. Select [OK] to finalize the new report's properties. Page 11

12 Edit To edit the properties of a report displayed in the tree, right-click on it and select [Edit]. Modify the report properties and then select [OK]. Note that in order to edit the properties of a report with a security level already applied, the user must meet those security level requirements. Delete This function is used to delete a report from the Report Tree. Right-click on a report and choose [Delete]. Select [Yes] when asked if you are sure that you want to delete the report (s). The report will then be removed from the Report Tree. Run To run a report, right-click on it and select [Run]. The report will be run in the way that it is configured to do so - on-screen, by , by an MS Exchange server, or as an exported file. Print This function sends chosen reports to a printer on the network. Right-click on a report in the tree and select [Print]. Depending on the report, you may also need to select the date range to print. Export This function exports a report in the way that it was configured to do so. Only reports that have been configured for export (in the Report Properties window) can be exported. The available export options can be seen in the image below. To export a report, right-click on one and select [Export]. Page 12

13 Send Mail This function s reports to the address set in Report Properties. To use this function, the settings must be properly configured as described in "Configuring Functionality". To send a report by , right-click on one and select [Send Mail]. MS Exchange This function sends reports within an MS Exchange environment. An MS Exchange server must be set up prior to configuring and using this function. Add to Schedule Report Viewer enables reports to run at set times, without any human intervention. Reports are added to a schedule in Report Viewer and then sent to Windows Scheduled Tasks (schtasks.exe). To use this feature, first make sure that schtasks.exe is in the Windows System32 folder on that system. To add a report to a schedule: 1. Open Schedule Setup from the Tools menu and select [New]. 2. Enter a schedule name, and choose the parameters for the report (export options and report period). Make sure to enter a correct address if the option has been selected. Select [OK] and then [Close] to return to the main Report Viewer window. 3. Right-click on a report in the Report Tree and select [Add to schedule]. 4. The list of report schedules will appear. Choose the schedule that was just created and then select [OK]. Page 13

14 5. Open Schedule Setup from the Tools menu to verify that the report has been added to the schedule group. To modify or create new schedules, use the associated buttons in this window. When the desired reports are in the correct schedule groups, select a group from the list and click the [Add to Task Scheduler] button. You will be offered scheduling options to choose from, after which the schedule will be added to the Windows Scheduled Tasks list. Page 14

15 Repeat this process for each schedule group, and then select [OK] to finalize the schedule(s). It is recommended that you verify that the report has been added to the Windows scheduled tasks list by opening up Scheduled Tasks in the Control Panel and locating the task in the list. Select [Close] to exit Schedule Setup. Note: If changes are made to an existing report schedule task, the task will need to be manually removed from the Window Scheduled Tasks list before being added back by the [Add to Task Scheduler] button. Page 15

16 Running Reports To run a report, double-click on the report name in the Report Tree on the left. Certain reports may first require a date range and/or Pay Period before they display. If this is the case, set these parameters and then select [OK]. The system may take a moment to generate the report. When it is ready, the report will be presented in the way that it was configured - on screen in the display panel of Report Viewer, by , through an exchange server, or as an exported file in any of the available formats. Show Details The Show Details option in the Tools menu can be used to toggle additional details in a report on or off. Reports will only look different when run with this option enabled if they have additional details embedded in them. Page 16

17 Reports not in the Tree When the Show Reports not in the Tree feature is enabled, a second tree will appear beneath the Report Tree. In it you will find all the reports in the PixelReports folder that are not in the tree above. To use the bottom tree to add a report to the Report Tree above, simply drag a report to the desired Report Group. Page 17

18 Query Builder The QueryBuilder tool is used to create ad hoc data sets. It constructs complex ad hoc SQL statements, and queries the PixelPoint database to produce data that can be passed on to external applications. QueryBuilder uses predesigned schemas to guide the creation of each query. To use QueryBuilder, choose Query Builder from the Tools menu in Report Viewer. The Query Menu The Query menu contains the following options: New: Creates a new query based on the Data Model selected in the Select a Data Model menu below. Enter a query name. Edit: Enables the name of the selected query to be changed. Save: Saves all changes made to queries. Save As: Re-saves the selected query by a new name. Remove: Deletes the selected query. Export: This option, available from the Results tab, exports results to a CSV or XLS file. Add to Schedule: Schedules queries to run as set times. Queries are added to a schedule and then sent to Windows Scheduled Tasks. Refresh: Restores queries to their last saved state. Close: Exits from Query Builder. To run a query, select a data model from the list and choose the related query to run. On the right side of the screen, all query columns for a query are displayed. icon beside a query column To sort, delete, or aggregate query columns, click on the name. Page 18

19 To change a query column, click on one and choose a new query column. To change the alias name for a query column (which follows the "as" after the query column name), click on one. To specify sorting options, click on "Not sorted". To add a new column to the query, select Click here to add a new column. Query Conditions Conditions can be added beneath existing queries by selecting the Click here to add a new condition button in the Query Conditions section. To add a condition beneath a particular row, icon beside a condition and choose Open a new condition after the current row. select the Rows can also be selected for deletion through the same button. To add a bracketed condition, select the icon beside an existing query condition and choose Add a new bracket after the current row. SQL Sentence This section shows the SQL statement, built according to the specified query options. As soon as changes are made to query columns or conditions, the statement will change accordingly. Results Tab Shows the results of the query. The results are updated immediately as the query columns or conditions change. Page 19

20 Notes