Report Runner Event Server

Transcription

1 Report Runner Event Server Jeff-Net, LLC Copyright 2012 ::: All rights reserved

2 Report Runner Event Server by Jeff-Net

3 Report Runner Event Server Jeff-Net, LLC Copyright 2012 ::: All rights reserved All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Printed: April 2012 in (whereever you are located) Publisher Jeff-Net Managing Editor Tracie Morgan Technical Editors Jeff-Net Fan Support Special thanks to: Jeff-Net Fan Support for contributing to this documentation. We appreciate all the sacrifice given to make this all possible. We also want to thank all our wonderful Report Runner Fans for your support over the years. We appreciate the opportunity to serve you!

4 4 Report Runner Event Server Table of Contents Foreword 5 Part I Introduction 7 1 About... Jeff-Net Report Runner Event Server 7 2 Getting... Started 8 3 Getting... Help 9 Part II Documentation 12 1 Overview Features Functions Part III Reference 24 1 Random... Tips 25 2 Online... Videos 26 3 Definitions Modifying... Batch XML Files 27 5 Event... Server Add-Ons 28 Mail Event Rules File Event Rules SQL Event Rules Index 31

5 Foreword 5 Foreword We want to thank you for your interest and support in Jeff-Net Report Runner Event Server. We have a long history of hard work, easy-to-use software, world-class support and happy customers. We had you in mind when creating this latest version of Report Runner Event Server and hope you find this Help Documentation useful. We will continue to make modifications and enhancements as we go along to make sure you stay up-to-date with the latest features and functions. If you have any questions and/or suggestions, we want to hear from you. We hope you love what you see and read! Tracie Morgan & Jeff-Net Fan Support

6 Part I

7 Introduction 1 7 Introduction We will cover the basics of Jeff-Net Report Runner Event Server in this Help and Documentation. If you have any questions, please do not hesitate to let us know. How to get started Check out the Getting Started for quick installation notes and requirements Getting Help is available within this Help and Documentation. 1.1 About Jeff-Net Report Runner Event Server Jeff-Net Report Runner Batch Event Server is a service that monitors an input queue for an "instructional" Crystal Reports file, and automatically processes it. It accomplishes this by watching for a Report Runner Batch (Enterprise Version Only) XML input files to 'hit' a designated input directory. This is a great option for applications or websites looking to allow users to create batches of reports and process them on-the-fly. If the batch file is processed successfully, it is moved to a "Processed" directory. If there is a problem, it is moved to an "Error" directory. Combined with our Report Runner Batch software, this add-on allows you to automate any kind of report processing of your own.

8 8 1.2 Report Runner Event Server Getting Started We will cover the following topics below to help you get started with Jeff-Net Report Runner Event Server. Quick Installation Notes We highly recommend reading each step during the installation process as we

9 Introduction 9 have explained everything you need to know. Here is the direct link to the Report Runner Event Server Install Instructions: php?/knowledgebase/article/view/43/13/installing-report-runner-event-server Jeff-Net Report Runner Event Server needs to be installed on the SAME machine as Report Runner Batch Enterprise Edition. It also requires Report Runner Batch 2011 or later. Jeff-Net Report Runner Event Server runs as a "Service" within the Windows Task Manager. System Requirements Jeff-Net Report Runner Event Server runs best on... Microsoft Windows XP Pro SP2 and higher Microsoft Windows Vista Microsoft Windows 7 Microsoft Windows Server 2003 Microsoft Windows Server Getting Help Need help? No problem, that is what we are here for. Getting Help is easy as we have provided below our Contact Information and our Support hours. Jeff-Net Fan Support Contact Information Jeff-Net P.O. Box 546 Bedford, Texas 76095

10 10 Report Runner Event Server Phone: JEFF-NET ( ) x 1 Fax: Sales: customerservice@jeff-net.com Support: support@jeff-net.com Jeff-Net Fan Support Hours Office hours: Monday Friday 9:00AM to 6:00PM (Central Standard Time) For Sales, Development & Technical Support Additional Technical Support hours: Monday Friday 6:00PM to Midnight (Central Standard Time) For Technical Support ONLY Critical Technical Support hours: 24hours/7days a week We have someone on call for critical technical support issues that would pertain to Report Runner Batch failing and/or licensing issues that are prohibiting production. To contact us for production-down issues, please open a help desk ticket and set it for the highest priority.

11 Part II

12 12 2 Report Runner Event Server Documentation This Documentation is to cover the basics of Report Runner Event Server. It is pretty simple to use once you familiarize yourself with this Report Runner Event Server Service and the Display Monitor. Everything you need is also explained in detail DURING the installation. The installer itself adds a manually started Service in your Windows Task Manager (under the Services tab) and it adds a Service Controller for that service in your Jeff-Net Report Runner "Start" Program Files group. Windows Task Manager:

13 Documentation 13 Service Controller: 2.1 Overview Jeff-Net Report Runner Event Server watches for your Report Runner Batch (Enterprise Edition ONLY) XML input files to 'hit' a designated input directory, and processes them as they show up. Great option for applications or websites looking to allow users to create batches of reports and process them on-the-fly. If the Batch File is processed successfully, it is moved to a "Processed" directory. If there is a problem, it is moved to an "Error" directory. Combined with our Report Runner Batch software, this add-on would allow you to automate any kind of report processing from your own, custom web-based application. 2.2 Features You will find below the features of Jeff-Net Report Runner Event Server. Features Add Functionality - Some of our customers use this product along with their own web apps to process reports in the background (our Report Runner Web Portal uses it, too).

14 14 Report Runner Event Server Event Triggers - Dynamic report processing based on data and file triggers. Beautifully Designed - This add-on is laid out in a way that makes sense. We are meticulous in our design. If you know Crystal Reports, our Report Runner products will make perfect sense. Easy to Setup and Deploy - Purchase, download, install, and be running Crystal Reports templates over the web in under one hour. Very Affordable - It is just $1,000 for the 1st Year License and $ after that for the Annual License. To purchase your Report Runner Event Server today, simply click on this Jeff-Net Report Runner Event Server link. It will take you directly to the Jeff-Net Web store page for Report Runner Event Server. Excellent Technical Support - We provide free technical support for all of our software products. We'll even show you how to use, setup, configure, and integrate the Report Runner Event Server product into your environment during your evaluation period with us. Here is our Jeff-Net Fan Support Page to contact us: Try Before You Buy - Check out the live links for the Report Runner Web Portal. If you provide us with an Access database and a Crystal Report, we can actually do a live demo setting it up on the portal and letting you run your report over the web. Just contact us a let us know you would like to do that! 2.3 Functions In this section we provide the necessary functions to get your started with working with Report Runner Event Server. Functions

15 Documentation 15 Event Server Directory You have three (3) new "Work" directories that should have been installed (Input, Error, Processed). They have been added under the Event Server directory, added under AppData directory of Report Runner Batch Data folder. Example: C:\Users\Public\Documents\Jeff-Net\Report Runner Batch\AppData\Event Server Example: You can see the three (3) folders listed (Error, Input, Processed)

16 16 Report Runner Event Server Service Controller Jeff-Net Report Runner Event Server Service Controller is added to Startup folder and is available for a manual startup in base Jeff-Net Report Runner "Start" Program Files group. This Service Controller, once started, runs out-ofthe way in your System Task area (JN Logo icon at bottom right corner of your computer screen). If you right-click (with your mouse) on the JN Logo icon, you will see all the options to Start/Stop/Pause/Resume/Exit Service as well as a Display Monitor option. This Display Monitor option will show a live display of your work queues and system load of Report Runner. Examples: System Task area with the JN Logo icon at the bottom right corner of your computer screen.

17 Documentation 17 This is the Jeff-Net Report Runner Event Server Service Controller that displays when you do a right-click with your mouse over the JN Logo icon. This is the Display Monitor after you have selected this option in the Jeff-Net Report Runner Event Server Service Controller above. This is the Batch Process CPU Usage and Stats area of the Display Monitor. It displays up to five (5) Batch Processes even though you can place as many XML Batch Files as you want in the Input Directory.

18 18 Report Runner Event Server This is the CPU area of the Display Monitor. It displays up to four (4) CPU Processors. This is the Memory area of the Display Monitor. It displays the Memory Used.

19 Documentation 19 XML Batch Files You select the number of XML Batch Files to process at once and how often to check the queue (in seconds). The Display Monitor shows up to 5 Batch Processes at a time (In the Batch Process CPU Usage and Stats section of the Display Monitor) A simple way to test Event Server: 1) Create a test Batch File that sends you an (In Report Runner Batch).

20 20 Report Runner Event Server 2) Then, take that Batch XML File and copy it into your Input directory. 3) If you've started the Event Server Service using your Service Controller,

21 Documentation it will run the batch and send you the . Example of Batch XML File in the Input Queue: Example of Batch XML File moved to the Processed Queue: Example of Batch XML File in the Error Queue: 21

22 22 Report Runner Event Server Note: If your Batch XML File is in the Error directory, you can go back to your Batch XML File in Report Runner Batch to see why it failed.

23 Part III

24 24 3 Report Runner Event Server Reference This Reference section has additional information for a more comprehensive understanding of Report Runner Event Server. Tasks Covered In This Section Reference Random Tips Online Videos Definitions

25 Reference Random Tips Random Tips Report Runner Event Server runs as a "Service" within the Windows Task Manager. There is not a software application to open and/or launch. This Service Controller, once started, runs out-of-the way in your system task area (JN Logo icon at bottom right of your computer screen). If you right-click on the JN Logo icon, you see all the options to Start/Stop/Pause/Resume/Exit Service as well as a Display Monitor option. Since Report Runner Event Server runs as as "Service", by default, a service runs as a "local service" (ALL services run that way). Security within Windows does NOT allow a service to access ANYTHING on the network. If you need to access a report on the network, that is fine, you will need to configure the service to "run as" your ID/Password. Here is a Jeff-Net Knowledgebase Article for more details and for reference: Report can not be found For batches that you've created with INI Settings, Mail Header, or Mail Footer, you will need to copy all of those files to the Input directory along with your Batch Files. These files are normally saved in the same folder as your Batch File and also automatically saved with the same name as your Batch File. We recommend saving your Batch Files under My Batches (Example: C: \Users\Public\Documents\Jeff-Net\Report Runner Batch\AppData\My Batches) Example of a Batch XML File with an INI File, Mail Header, Mail Footer: Batch File Name = JNRRB Test.xml INI File Name = JNRRB Test.INI Mail Header File Name = JNRRB Test.txt Mail Footer File Name = JNRRB Test_FOOTER.txt

26 26 Report Runner Event Server The Input queue is the ONLY directory maintained automatically. The Error and Processed queue directories will need to be cleaned up periodically. We recommend running a delete script (bat or cmd) file on Sunday nights or some other non-production time. 3.2 Online Videos Online Videos coming soon! Online Videos Jeff-Net Support Knowledgebase Link for Event Server 3.3 Definitions We have put together a summary of definitions to help you with an easy reference of the functions and features within Report Runner Event Server. Definitions Term Batch File CPU Display Monitor Windows Task Manager Definition A Batch File is a XML File (Extensible Markup Language) that uses a set of rules for encoding in machine-readable form The Central Processing Unit (CPU) is a portion of a computer system that carries out the instructions of a computer program. This is the Report Runner Event Server Monitor that displays Input, Error, Processed activity along Batch Processes, CPU and Memory Usage. Windows Task Manager is an application included with your Microsoft Windows Operating System that provides detailed information about computer performance, services, applications, processes, CPU usage, etc.

27 Reference Modifying Batch XML Files We have a built-in utility to the Report Runner executable (Report Runner Unified.Exe) to update your Report Runner Batch XML files externally. This is necessary for updating your XML files dynamically and then running your Batch XML file on-demand via the command line or using Report Runner Event Server. NOTE: This update process only updates your XML file, it does not run it, so feel free to test this update process as much as you want. Check your Batch XML file after each update to see if it's working. By the way, if you've never looked at any of your Batch XML files, try editing one with NotePad or Wordpad, or simple "Open With" your internet browser of choice. You'll see it's laid out like a table with field names "wrapped around" each value. Updating your Report Runner Batch XML file dynamically is easy. Simply call the executable with these four (4) command line parameters at once: jnfile= (full path and XML file name) jnrecord= (record number in XML file - it's easier if this is always "1" and your dynamic batches have only one (1) record) jnfield= (field name in XML file) jnvalue= (value to set) Examples For example, you command line might look like this: jnfile=c:\my Dynamic Batches\PrintHelpDeskTicket.XML jnrecord=1 jnfield=parm1 jnvalue= In the example above, we are updating a batch that print's an individual helpdesk ticket. The ticket number we want to print is "123456". What if we wanted to then print ticket number "456123"? Simply call it like this: jnfile=c:\my Dynamic Batches\PrintHelpDeskTicket.XML jnrecord=1 jnfield=parm1 jnvalue= What if after updating the ticket number, you wanted to update the printer (printer name is HP2320-1) it is to be printed at? It might look like this: jnfile=c:\my Dynamic Batches\PrintHelpDeskTicket.XML jnrecord=1

28 28 Report Runner Event Server jnfield=destinationname jnvalue=hp You can call update utility as many times as you need to. Each call/update is extremely fast so don't worry about this taking a long time to run. After you are finished updating your Batch XML file, you can then process it on-demand calling the Batch XML file via the command line passing it to the Report Runner executable or "throwing it" into the Input directory of Report Runner Event Server. And just to be clear on how to "call" the Report Runner executable with the command lines above, using our first example, the full "call" might look like this: "C:\Program Files\Jeff-Net\Report Runner\Report Runner Unified.Exe" jnfile=c:\my Dynamic Batches\PrintHelpDeskTicket.XML jnrecord=1 jnfield=parm1 jnvalue= If you have any questions about this, just let us know! We are always HAPPY to help! 3.5 Event Server Add-Ons This section covers the Report Runner Event Server "Add-Ons" that are available. Tasks Covered In This Section Event Server Add-Ons Mail Event Rules File Event Rules SQL Event Rules Mail Event Rules Details to follow on the functionality. This is a new add-on for Report Runner Event Server as of version 2011 or later.

29 Reference 29 This function is considered an Event Server Add-On. To add this Mail Event Rules function to your Event Server it is $ per year. Simply contact Jeff-Net Support for any questions. Jeff-Net Fan Support Jeff-Net P.O. Box 546 Bedford, Texas Phone: JEFF-NET ( ) x 702 (For Support) Fax: Support: support@jeff-net.com File Event Rules Details to follow on the functionality. This is a new add-on for Report Runner Event Server as of version 2011 or later. This function is considered an Event Server Add-On. To add this File Event Rules function to your Event Server it is $ per year. Simply contact Jeff-Net Support for any questions. Jeff-Net Fan Support Jeff-Net P.O. Box 546 Bedford, Texas Phone: JEFF-NET ( ) x 702 (For Support) Fax: Support: support@jeff-net.com SQL Event Rules Details to follow on the functionality. This is a new add-on for Report Runner Event Server as of version 2011 or later. This function is considered an Event Server Add-On. To add this SQL Event Rules function to your Event Server it is $ per year.

30 30 Report Runner Event Server Simply contact Jeff-Net Support for any questions. Jeff-Net Fan Support Jeff-Net P.O. Box 546 Bedford, Texas Phone: JEFF-NET ( ) x 702 (For Support) Fax: Support: support@jeff-net.com

31 Index Index -QQuick Installation Notes -BBatch File 13, 26 Batch Process CPU Usage and Stats -CCPU -R14 Report Report Report Report Runner Batch 13 Runner Event Server 12 Runner Event Server Service Runner Web Portal 13 14, 26 -S- -DDisplay Monitor 12 Windows Task Manager Error 14 Event Server 14 -X- -FFeatures XML 13 XML Batch Files 13 -GGetting Help 9 -I14 -MMemory Used 14 -PProcessed Service Controller 12, 14 System Requirements 8 -W- -E- Input ,

32 32 Report Runner Event Server Endnotes 2... (after index)

33 Thank you for using Report Runner Event Server! Jeff-Net Copyright 2011