TaskCentre v4.5 XML Document Import Tool White Paper

Transcription

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

2 Table f Cntents COPYRIGHT 1 TRADEMARKS 1 INTRODUCTION 2 Overview 2 Features 2 GLOBAL CONFIGURATION 2 TECHNICAL SUMMARY 3 Wrking with ther Steps 3 Objects Cnsumed 3 Objects Expsed 3 CONFIGURATION 3 General 4 Main 5 Schema 5 Output XML 5 Optins 7 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 Dcument Imprt Tl Intrductin Overview The XML Dcument Imprt is an Input Tl which is used t create a Task Step that imprts a cpy f an XML dcument, the data cntent f which is t be used in a Task. T validate the XML dcuments at runtime an XML schema (XSD) can be imprted r ne can be built either by inference frm an XML dcument r manually cnstructed. The Tl utput is an XML dcument which is then available fr use by ther XML cnsuming Tls, such as the XML t Recrdset Tl. The XML schema is als made available. Features Glbal Cnfiguratin Fr the XML Dcument Imprt Step t wrk, a time-ut perid in secnds must be cnfigured thrugh the Glbal Cnfiguratin dialg (Ref: Figure 1) fr the XML Dcument Imprt Tl. This is used t set the time perid t be used at Task run time during which TaskCentre will try t retrieve the selected file by entering a time perid in secnds int the File Imprt time-ut perid: field and clicking n the OK buttn. After this time an errr will be reprted if the file cannt be retrieved. Figure 1. XML Dcument Imprt Glbal Cnfiguratin dialg. 2

5 XML Dcument Imprt Tl Technical Summary Wrking with ther Steps The ther Steps that the XML Dcument Imprt Step will interact directly with, whether by expsing infrmatin t it r cnsuming infrmatin frm it are listed belw. Step Icn Name Step Type Schedule MS SQL Server Trigger Oracle Trigger SMTP Wrkflw Jb Submissin Frmat as Text Frmat Step Frmat as HTML Frmat Step XML t Recrdset Frmat Step Save as File Output Step File Management General Objects Cnsumed Objects that the XML Dcument Imprt Step cnsumes that are expsed by ther Steps are listed belw. Objects Expsed Objects that the XML Dcument Imprt Step expses, that can be utilised by ther Steps are listed belw. Cnfiguratin A XML Dcument Imprt Step fr a Task is cnfigured thrugh the XML Dcument Imprt 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 Dcument Imprt Step may be created and cnfigured. 3

6 XML Dcument Imprt Tl General Figure 2. XML Dcument Imprt General tab. The cntents f the General tab (Ref: Figure 2) are as fllws: 4

7 XML Dcument Imprt Tl Main The Main tab is used t define the schema against which the imprted XML dcument will be validated. It als prvides a preview f the structure f the utput XML which will be generated by the Step. The tab cntains tw sub-tabs described belw, thrugh which the Step may be cnfigured. Schema Figure 3. XML Dcument Imprt Main tab Schema sub-tab. An XML schema defines the structure f the XML in terms f the tags that are present and the nesting f the tags. The frmat used by this Tl is the industry standard XSD frmat. The schema tab is used t define the schema against which the data cntained in the surce XML dcument will be validated and thereby the structure visible t ther task Steps. The Schema tab (Ref: Figure 3) cntains the fllwing: Output XML 5

8 XML Dcument Imprt Tl Figure 4. XML Dcument Imprt Main tab Output XML sub-tab. Selecting the Output XML tab (Ref: Figure 4) displays the XML schema defined in the 'Schema' tab in a tree structure. This is the structure that will be utputted by the Step at Task run time. It is nn editable. File Prperties Figure 5. File Prperties dialg. The File Prperties dialg (Ref: Figure 5) is displayed by clicking n the Extract File Prperties buttn in the Schema sub-tab f the Main tab. Each file prperty type that may be extracted frm the surce XML dcument is displayed in a list and t the left f each prperty is a check bx t enable that prperty t be selected. 6

9 XML Dcument Imprt Tl The selected file prperties are then made available t ther Steps created in the Task thrugh the Task Brwser dialg and are ppulated with values at Task run time. Optins Figure 6. XML Dcument Imprt Optins tab. The Optins tab (Ref: Figure 6) is used t cnfigure the Step behaviur if an errr ccurs when the Step is being prcessed. The fllwing ptins are prvided fr selectin: Abrt Step - When validating the input file against the schema, if a validatin errr ccurs then the Step will be abrted. This is the default selectin. Cntinue with next matching file - The Step will cntinue even if a validatin errr ccurs. Abrt Step - If a file cannt be accessed the Step will be abrted. This is the default selectin. Cntinue with next matching file - If a file cannt be accessed, the Step will cntinue with the next matching file r end the Step if it is the last file. Abrt Task - If the Step is abrted due t ne f the cnditins abve the Task will be abrted. This is the default selectin. Cntinue - The Task will cntinue with the next Step if this Step is abrted due t ne f the cnditins abve. Abrt Task - If n files can be fund r all files have validatin prblems and there are n mre files present then the Task will be abrted. This is the default selectin. Cntinue - The Task will cntinue if n files can be prcessed. 7