Spread for Biztalk Developer's Guide
Total Page：16
File Type：pdf, Size：1020Kb
Developer’s Guide Spread™ for ® ® Microsoft BizTalk Server Legal Notices Information in the documentation is subject to change without notice and does not represent a commitment on the part of GrapeCity, Inc. The software described in this document is furnished under a license or non-disclosure agreement. The software may be used or copied only in accordance with the terms of the agreement. It is against the law to copy this software on any medium except as is specifically allowed in the license or non-disclosure agreement. No part of the documentation may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose without the express written permission of GrapeCity, Inc. © 2006-2011 GrapeCity, Inc. All rights reserved. Unless otherwise noted, all names of companies, products, street addresses, and persons contained herein are part of a completely fictitious scenario or scenarios and are designed solely to document the use of a GrapeCity, Inc., product. FarPoint Spread is a trademark of GrapeCity, Inc. Microsoft, BizTalk, Excel, Visual Basic, Visual C#, and Visual Studio are either registered trademarks or trademarks of Microsoft Corporation in the United States or other countries. Other brand and product names are trademarks or registered trademarks of their respective holders. Distribution Restrictions If you are using the trial or evaluation version of this product, then you may not distribute any of the files provided with the trial or evaluation version. The component assemblies (DLLs) may be deployed on your development machines, test servers and on your production server. Distribution by the user of any designers or design-time assistants (EXEs or DLLs), executables, or source code distributed by GrapeCity as part of this product is prohibited. You shall not develop applications that provide an application programmable interface to the Software or the Software as modified nor may you create Web Services with the Software without the appropriate license from GrapeCity. Redistribution by your users of GrapeCity' assemblies (DLLs) or your modified or wrapped version of our assemblies without the appropriate redistribution license from GrapeCity is prohibited. ii Spread for BizTalk Developer’s Guide Dedication This documentation was written as a collaborative effort by employees. Developers, technical support personnel, testers, and technical writers all added their knowledge of how the product works and can best be applied. This documentation is a diverse collection that follows a tradition of extensive examples and code snippets to clarify the use and flexibility of our product. Because the world of software development and the computer-based economy are changing so rapidly, developers like you need a tool that is flexible and extendable, and you do not have a lot of time to learn how best to apply it. A well-supported and well-documented product is necessary for success. Recognizing that there are various levels of readers, from beginners with pipeline components, to experienced BizTalk consultants, we have tried our best to provide essential procedural documentation to help you get started as well as detailed reference documentation to let you customize the use of the product to the fullest extent. We dedicate this documentation to the developers who can think beyond the traditional boundaries of spreadsheets and use this product to extend their creative and innovative ideas. Spread for BizTalk Developer’s Guide iii Table of Contents Dedication ........................................................................................ iii Overview .......................................................................................... 1 Disassembling Spreadsheet Input ........................................................ 4 Working with Originating Spreadsheet Files .................................... 5 Adding a Spreadsheet Disassembler to a Receive Pipeline ................ 6 Selecting the Input XML Document Schema for the Disassembler ..... 10 Testing the Pipeline with the Spreadsheet Disassembler .................. 12 Mapping Inputs and Outputs .............................................................. 17 Pipeline Property Assignment ............................................................. 18 Assembling Document Output ............................................................. 19 Adding a Document Assembler to a Send Pipeline .......................... 19 Selecting the Output XML Document Schema for the Assembler ....... 22 Designing the Format for the Document Assembler ........................ 25 Viewing (and Reviewing) the Output Documents ............................ 25 Using the Spreadsheet Schema Wizard ................................................ 26 Select the Spreadsheet File for Schema Information (Wizard Screen)27 Select Additional Schema Settings (Wizard Screen) ........................ 28 Select the Data Range (Wizard Screen) ........................................ 29 Select the Entity Mapping (Wizard Screen) .................................... 30 Seeing the Resultant Spreadsheet Schema ................................... 34 Using the Spreadsheet Format Designer ............................................... 35 Adjust Sizes ............................................................................. 36 Add Images .............................................................................. 36 Format Rows ............................................................................ 36 Format Columns ........................................................................ 37 (continued) iv Spread for BizTalk Developer’s Guide Format a Sheet ......................................................................... 39 Reset the Design ....................................................................... 40 Glossary .......................................................................................... 43 CLS Compliance Notes ....................................................................... 47 Getting Technical Support .................................................................. 48 Contacting Us .................................................................................. 49 Spread for BizTalk Developer’s Guide v vi Spread for BizTalk Developer’s Guide Spread for Microsoft BizTalk Server Overview The Spread for Microsoft® BizTalk® Server (which we simply call "Spread") offers a way to handle Excel spreadsheet data as input and provide documents as outputs allowing you to create a completely automated handling of spreadsheet data in your BizTalk process. Spread integrates with Microsoft BizTalk Server 2006 and is compatible with R2. Generally, there are two tasks that Spread can automate in your BizTalk process - disassembling spreadsheet input (typically parsing Excel data) and assembling document output (typically creating Excel or PDF documents). These tasks of handling spreadsheet data can be done independently or in concert in a BizTalk process; you may only be interested in automating one of these tasks or you may do both. For more information see the SpreadOverview. The Disassembler automates the parsing of Excel message streams to XML message streams for Excel integration with Microsoft BizTalk Server 2006. It provides you a codeless solution to parse Excel spreadsheet into XML. At the design time, the Spreadsheet Wizard helps you develop a custom schema based on the Excel sheet and at the runtime, the Excel is parsed and disassembled into XML. With a Format Designer you can customize the appearance of output documents, which can be either Excel or PDF documents. This documentation assumes you have some familiarity with developing projects in Microsoft Visual Studio and with handling components with Microsoft BizTalk Server 2006. For more information on those topics refer to Microsoft documentation. You should have already installed Spread following the instructions in the Read Me file. Spread is not CLS-compliant because the Microsoft .NET interfaces required to communicate with Microsoft BizTalk Server 2006 at runtime and with Microsoft Visual Studio at design time are not CLS-compliant. For more details, see CLS compliance note. Spread for BizTalk Developer’s Guide 1 Generally, there are two tasks that Spread can automate in your BizTalk process - disassembling spreadsheet input (typically parsing Excel data) and assembling document output (typically creating Excel or PDF documents). These tasks of handling spreadsheet data can be done independently or in concert in a BizTalk process; you may only be interested in automating one of these tasks or you may do both. The diagram below illustrates the tasks and the pieces that Spread offers. 2 Spread for BizTalk Developer’s Guide Using Spread for BizTalk involves the following tasks: Disassembling Spreadsheet Input * Working with Originating Spreadsheet Files * Adding a Spreadsheet Disassembler to a Receive Pipeline * Selecting the Input XML Document Schema for the Disassembler * Creating the Input Spreadsheet Schema with the Wizard * Testing the Pipeline with the Spreadsheet Disassembler Mapping Inputs and Outputs Assembling Document Output * Adding a Document Assembler to a Send Pipeline * Selecting the Output XML Document Schema for the Assembler * Designing the Format for the Document Assembler * Viewing (and Reviewing) the Output Documents Spread for BizTalk Developer’s Guide 3