TaskCentre v4.5 Run Crystal Report Tool White Paper

Transcription

1 TaskCentre v4.5 Run Crystal Report Tool White Paper Document Number: PD _0-WP Orbis Software Limited 2010

2 Table of Contents COPYRIGHT 1 TRADEMARKS 1 INTRODUCTION 2 Overview 2 Features 2 TECHNICAL SUMMARY 3 Working with other Steps 3 Dependencies 4 Objects Consumed 4 Objects Exposed 4 CONFIGURATION 4 General 4 Report 4 Map Parameter dialog 6 Options 7 i

3 Copyright & Trademarks Copyright The copyright in this document is owned by Orbis Software All rights reserved. This publication may not, in whole or part, be reproduced, transmitted, transcribed, stored in a retrieval system or translated into any language in any form or by any means without the prior written consent of Orbis Software Limited. Head Office: Orbis Software Limited (UK) 2 Nuffield Road Nuffield Industrial Estate Poole, Dorset BH17 0RB United Kingdom Tel: +44 (0) Fax: +44 (0) enquiries@orbis-software.com Trademarks Orbis Software Ltd owns the registered Trademark TaskCentre. All other Trademarks used within this documentation are acknowledged as the property of their respective owners. The information provided in this publication may contain errors, omissions, or typographical errors or may be out of date. Orbis Software may change, delete, or update any published information at any time and without prior notice. The information published in this document is provided for informational purposes only and is not binding on Orbis Software in any way except to the extent that it is specifically indicated to be so. 1

4 Introduction Overview The Run Crystal Report is a Format Tool which is used to create a Task Step to automate the running of Crystal reports. By the use of dynamic data passed to the report as run time parameters the Step can be used to run a report one or many times. The dynamic data could be from an Input Step such as Database Query (ODBC). In use, an example would be running a statement for each of a list of customers, or producing an order acknowledgement for each of the current day s orders. In addition, where a report requires access to data tables that have specific security associated with them, the relevant login names and encrypted passwords can be passed by the Step to the report concerned. The documents exposed by the Step can be delivered by s such as Send Message (SMTP), File Transfer (FTP) or Save as File and then used to present sophisticated management information, delivered via , fax or published to form part of web or intranet content. New reports are designed in the Seagate Crystal Reports Designer environment, so experienced users of this powerful application will quickly be able to produce a new report, or modify an existing one, and integrate it with TaskCentre. The inclusion of sub reports is also managed through the provision of a separate report tab for each sub report which provides the same configuration options covering the mapping of parameters to dynamic data from an Input Step and access to secure data tables The HTML Table functionality is extremely flexible allowing presentation of the data in exactly the form required. Tables support grouping, sub totals, grand totals, data formatting and ultimately flexible hyperlink support for common hyperlink types to enable drill-down/through to other content or custom protocols to automate applications. Use your default third-party HTML editor such as Microsoft Expression Studio or Adobe Dreamweaver in conjunction with TaskCentre by simply using the Edit button. Features 2

5 Technical Summary Working with other Steps The other Steps that the Run Crystal Report Step will interact directly with, whether by exposing information to it or consuming information from it are listed below. Step Icon Name Step Type Schedule Event Step MS SQL Server Trigger Oracle Trigger SMTP Workflow Job Submission Database Query (ODBC) Database Query (OLEDB) Call Procedure (OLEDB) Data Filter Text Parser Decision Create Workflow Job XML to Recordset Event Step Event Step Event Step Event Step Input Step Input Step Input Step General Step General Step General Step Format Step Format Step Send Message (SMTP) Save as File File Transfer (FTP) Print Document Send Fax (M:Science) Call Procedure Call COM Object Call Procedure Execute Step Execute Step 3

6 Dependencies The products, technologies, protocols or systems that are required for the Run Crystal Report Step to work are listed below. Objects Consumed Objects that the Run Crystal Report Step consumes that are exposed by other Steps are listed below. Objects Exposed Objects that the Run Crystal Report Step exposes, that can be utilised by other Steps are listed below. Configuration The Run Crystal Report Step is configured through the Run Crystal Report dialog which is the main interface for creating a new Step. The dialog is displayed through the methods described below. To create a new Step: To open an existing Step: The dialog contains the five tabbed panes described below through which a Run Crystal Report Step may be created and configured. General Figure 1. Run Crystal Report General tab. The contents of the General tab (Ref: Figure 1) are as follows: Report 4

7 The Report tab (Ref: Figure 2) is used to import an existing Crystal Report and then map report parameters to columns, properties and variables created through other Task Steps. Where security is required to access database tables being used by the report, the relevant user names and passwords may be entered for the tables to enable automated logon when running the Task. Once a report is imported into the Step, it can be edited when required by clicking the 'Edit' button. This launches the report in the Crystal Reports Designer. Once complete the report may then also be exported. The tab contains the following: Figure 2. Run Crystal Report Main tab. o Mapped Report Parameters Mapped Parameters (list) - Displays a list of mapped report parameters under the following column headings: Report Parameter Displays the parameter name. Mapping Type - 'Discrete' or 'Range' is displayed depending on the mapping type selected for the parameter in the Map Parameter Dialog. When the 'Discrete' mapping type option is selected then only the data from 'Value 1' is used. When the 'Range' option is selected then the data range between both 'Value 1' and 'Value 2' is used. Value 1 - Displays the first Task column, property or variable selected from the Task Browser to be mapped against the parameter. 5

8 Value 2 - Displays the second Task column, property or variable selected from the Task Browser to be mapped against the parameter when using the 'Range' mapping type. Clear All (button) - Removes all parameters from the list. Add (button) - Opens the Map Parameter dialog to enable another report parameter to be selected and mapped to a column, property or variable exposed in the Task Browser. Parameters must first be created in the report in order for a selection to be available for mapping. Edit (button) - Opens the Map Parameter dialog (Ref: Figure 4) and displays details for the selected parameter. o Database Tables Logon Information (Automated Running) Database Tables' list - Displays a list of database tables used by the report under the following headings: Table Name - The table name. User Name - The user name required to access the table. Password - The password required for the selected user name. 'Select All' button - Selects all of the tables listed. 'Edit' button - Opens the Logon Details dialog (Ref: Figure 3) to enable the User Name and Password for the selected table to be edited. Map Parameter dialog Figure 3. Logon Details dialog. The Map Parameter dialog (Ref: Figure 4) is used to create a new parameter and map it to a column in a recordset produced by an Input Step. The dialog contains the following: 6

9 Figure 4. Map Parameter dialog. Options The Options tab (Ref: Figure 5) is used to configure the Step behaviour if an error occurs when the Step is being processed. The following options are provided for selection: o o o Abort Task - If the Step is aborted then the Task is aborted. Continue - If the Step is aborted then the Task will continue onto the next Step in the process if one exists. Create bookmarks from group tree for PDF output (option check box) - If this option is available and checked then bookmarks will automatically be created in the resultant PDF file. 7

10 Figure 5. Run Crystal Report Options tab. 8