TaskCentre v4.5 XML to Recordset Tool White Paper

Transcription

1 TaskCentre v4.5 XML t Recrdset Tl White Paper Dcument Number: PD _0-WP Orbis Sftware Limited 2010

2 Table f Cntents COPYRIGHT 1 TRADEMARKS 1 INTRODUCTION 2 Overview 2 GLOBAL CONFIGURATION 2 Schema Cnfiguratin dialg 3 TECHNICAL SUMMARY 4 Wrking with ther Steps 4 Objects Cnsumed 4 Objects Expsed 5 CONFIGURATION 5 General 6 Main 7 Optins 8 i

3 Cpyright & Trademarks Cpyright The cpyright in this dcument is wned by Orbis Sftware All rights reserved. This publicatin may nt, in whle r part, be reprduced, transmitted, transcribed, stred in a retrieval system r translated int any language in any frm r by any means withut the prir written cnsent f Orbis Sftware Limited. Head Office: Orbis Sftware Limited (UK) 2 Nuffield Rad Nuffield Industrial Estate Ple, Drset BH17 0RB United Kingdm Tel: +44 (0) Fax: +44 (0) enquiries@rbis-sftware.cm Trademarks Orbis Sftware Ltd wns the registered Trademark TaskCentre. All ther Trademarks used within this dcumentatin are acknwledged as the prperty f their respective wners. The infrmatin prvided in this publicatin may cntain errrs, missins, r typgraphical errrs r may be ut f date. Orbis Sftware may change, delete, r update any published infrmatin at any time and withut prir ntice. The infrmatin published in this dcument is prvided fr infrmatinal purpses nly and is nt binding n Orbis Sftware in any way except t the extent that it is specifically indicated t be s. 1

4 XML t Recrdset Tl Intrductin Overview The XML t Recrdset is a Frmat Tl which is used t cnvert XML data int a flat-frmat TaskCentre recrdset, thereby allwing the data t be utilised by ther Tls that accept a recrdset as an input. This culd then be used t pwer alerts via fax/ /sms, create reprts, pwer a wrkflw, perfrm FTP transfer, etc. Glbal Cnfiguratin The XML t Recrdset Tl des nt need t have any Glbal Cnfiguratin ptins set in rder t wrk effectively. Hwever, if it is desired t have a "library" f frequently used XML Schemas, then the Glbal Cnfiguratin is the place t d this. This is achieved thrugh the XML t Recrdset Glbal Cnfiguratin dialg (Ref: Figure 1 ) which may be pened by clicking n the XML nde in the Task Manager and then duble-clicking n the XML t Recrdset icn in the Items List. The dialg cnsists f a list f Schemas that will be available within the cnfiguratin f XML t Recrdset Steps. The Add, Edit and Remve buttns will allw the additin f a new Schema, the editing f the selected schema in the list, r the remval f the selected schema. When adding r editing a schema, the Schema Cnfiguratin dialg (Ref: Figure 2) is shwn. Frm here it is pssible t lad r paste in a XML schema file (XSD frmat) r a sample XML file frm which the Schema will be inferred. Figure 1. XML t Recrdset Glbal Cnfiguratin dialg. 2

5 XML t Recrdset Tl Schema Cnfiguratin dialg The Schema Cnfiguratin dialg (Ref: Figure 2) is used t define the schema f the XML t be used as the input data surce fr the XML t Recrdset step. An XML schema defines the structure f the XML, in terms f what tags are present, and the nesting f the tags. The frmat used by the XML t Recrdset tl is the industry standard XSD frmat. Figure 2. Schema Cnfiguratin dialg. The dialg cntains the fllwing t add a new XML schema r edit an existing ne: 3

6 XML t Recrdset Tl Technical Summary Wrking with ther Steps The ther Steps that the XML t Recrdset Step will interact directly with, whether by expsing infrmatin t it r cnsuming infrmatin frm it are listed belw. Step Icn Name Step Type Database Query (ODBC) Database Query (OLEDB) Call Prcedure (OLEDB) XML t Recrdset Data Filter Text Parser Decisin Recrdset t XML Input Step Input Step Input Step Input Step General Step General Step General Step Frmat Step Create Wrkflw Jb Send Message (SMTP) Save as File File Transfer (FTP) Send Fax (Tbit) Frmat Step Output Step Output Step Output Step Output Step Call Prcedure (OLEDB) Call COM Object Call Prcedure (OLEDB) Output Step Execute Step Execute Step Objects Cnsumed Objects that the XML t Recrdset Step cnsumes that are expsed by ther Steps are listed belw. 4

7 XML t Recrdset Tl Objects Expsed Objects that the XML t Recrdset Step expses, that can be utilised by ther Steps are listed belw. Cnfiguratin A XML t Recrdset Step fr a Task is cnfigured thrugh the XML t Recrdset dialg which is displayed thrugh the fllwing methds: T create a new Step: T pen an existing Step: The dialg cntains the three tabbed panes listed and described belw thrugh which a XML t Recrdset Step may be created and cnfigured. 5

8 XML t Recrdset Tl General Figure 3. XML t Recrdset General tab. The cntents f the General tab (Ref: Figure 3) are as fllws: 6

9 XML t Recrdset Tl Main The Main tab (Ref: Figure 4) is used t enter the XML schema details fr an XML t Recrdset Step. Here the required fields frm the XML input, in fr the frm f a TaskCentre variable, can be made available in the frm f a TaskCentre recrdset fr use by ther Steps within the Task. The tab cntains the fllwing: Figure 4. XML t Recrdset Main tab. Task step (ptin radi buttn and drp dwn list) A list f Steps previusly created in the Task that can be used t prvide the XML data surce are listed fr selectin. Variable (ptin radi buttn) Selecting this ptin activates the cntrls prvided in the Variable data surce ptins area. Predefined schema (ptin radi buttn and drp dwn list) A list f XML schemas previusly defined thrugh the XML t Recrdset Glbal Cnfiguratin dialg (Ref: Figure 1) are listed fr selectin. Custm schema (ptin radi buttn and field) Selecting this ptin activates the field and the Define buttn. Define (buttn) Clicking n this buttn displays the Schema Cnfiguratin dialg (Ref: Figure 2) t enable yu t define the XML schema t be used fr the XML data cntained in the Task Variable that will be selected as the input surce. Data surce variable (field) Drag and drp the Task Variable int the field that at runtime will cntain the required XML data. This must cnfrm t the XML schema that has been defined abve. 7

10 XML t Recrdset Tl All and Nne (buttns) Use these buttns t quickly tggle the selectin f the fields. Nte: At runtime, the data expsed in the utput Recrdset f the Step is a unin f all the child bjects selected in the XML structure, thereby cnverting the hierarchical data cntained within the XML int a flat recrdset as used by TaskCentre. Optins The Optins tab (Ref: Figure 5) is used t cnfigure the Step behaviur if an errr ccurs when the Step is being prcessed Figure 5. XML t Recrdset Optins tab. The fllwing ptins are prvided fr selectin if the Step is abrted: Abrt Step - If there is an errr mapping a rw then the Step will abrt. Cntinue - The Step will cntinue even if there is an errr mapping an individual rw frm the input data surce. Abrt Task - If the Step is abrted then the Task is abrted. Cntinue - If the Step is abrted then the Task will cntinue nt the next Step in the prcess if ne exists 8