TaskCentre v4.5 Merge MS Word Document Tool White Paper

Transcription

1 TaskCentre v4.5 Merge MS Wrd Dcument 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 TECHNICAL SUMMARY 3 Wrking with ther Steps 3 Dependencies 4 Objects Cnsumed 4 Objects Expsed 4 CONFIGURATION 4 General 4 Main 5 Dcument Prperties 7 Advanced 8 Optins 9 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 Merge MS Wrd Dcument Tl Intrductin Overview The Merge MS Wrd Dcument is a Frmat Tl which is used t create a Task Step that prduces single r multiple HTML dcuments, primarily utilising infrmatin prvided by Input Steps such as the Database Query (ODBC). Yu may create new HTML pages within the interface r imprt pages that have already been created elsewhere. The Step uses merge fields t merge data bjects int the dcument and/r insert tabulated data frm a surce t prduce dynamic dcuments such as rder acknwledgements, statements, intranet r web site cntent r summary reprts. These HTML dcuments can then be delivered using many f the Output Steps such as Send Message (SMTP), File Transfer (FTP) and Save t File. The HTML Table functinality is extremely flexible allwing presentatin f the data in exactly the frm required. Tables supprt gruping, sub ttals, grand ttals, data frmatting and ultimately flexible hyperlink supprt fr cmmn hyperlink types t enable drill-dwn/thrugh t ther cntent r custm prtcls t autmate applicatins. Use yur default third-party HTML editr such as Micrsft Expressin Studi r Adbe Dreamweaver in cnjunctin with TaskCentre by simply using the Edit buttn. Features Drag-drp table builder Flexible Data frmatting Flexible Hyperlink Supprt Aut Hyperlink detectin fr dynamic data Flexible frmatting f fnts, brders, clurs, backgrunds Sub ttals & Grand ttal Flexible ttal labelling & psitining 2

5 Merge MS Wrd Dcument Tl Technical Summary Wrking with ther Steps The ther Steps that the Merge MS Wrd Dcument 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 Event Step MS SQL Server Trigger Oracle Trigger SMTP Wrkflw Jb Submissin Database Query (ODBC) Database Query (OLEDB) Call Prcedure (OLEDB) Data Filter Text Parser Decisin Create Wrkflw Jb XML t Recrdset Event Step Event Step Event Step Event Step Input Step Input Step Input Step General Step General Step General Step Frmat Step Frmat Step Send Message (SMTP) Save as File File Transfer (FTP) Send Fax (M:Science) Output Step Output Step Output Step Output Step Call Prcedure Call COM Object Call Prcedure Output Step Execute Step Execute Step 3

6 Merge MS Wrd Dcument Tl Dependencies The prducts, technlgies, prtcls r systems that are required fr the Merge MS Wrd Dcument Step t wrk are listed belw. Objects Cnsumed Objects that the Merge MS Wrd Dcument Step cnsumes that are expsed by ther Steps are listed belw. Objects Expsed Objects that the Merge MS Wrd Dcument Step expses, that can be utilised by ther Steps are listed belw. Cnfiguratin The Merge MS Wrd Dcument Step is cnfigured thrugh the Merge MS Wrd Dcument dialg which is the main interface fr creating a new Step. It is used t create a single r multiple Wrd, XML, HTML, RTF r plain text dcuments frm an imprted Wrd dcument r template cntaining mail merge fields. Either the existing dcument data surce can be used r data frm TaskCentre can be mapped t mail merge fields and can then be added t the dcument by simply dragging and drpping them int the required field frm the Task Brwser dialg. The Merge MS Wrd Dcument dialg is displayed thrugh the methds described belw. T create a new Step: T pen an existing Step: The dialg cntains the five tabbed panes described belw thrugh which a Merge MS Wrd Dcument Step may be created and cnfigured. General 4

7 Merge MS Wrd Dcument Tl Figure 1. Merge MS Wrd Dcument General tab. The cntents f the General tab (Ref: Figure 1) are as fllws: Main The Main tab (Ref: Figure 2) imprting a Wrd dcument r template cntaining mail merge fields. The mail merge fields can then either remain mapped t their riginal dcument data surce r TaskCentre data frm the Task Brwser dialg can be dragged and drpped against specific fields. 5

8 Merge MS Wrd Dcument Tl The tab cntains the fllwing: Figure 2. Merge MS Wrd Dcument Main tab. Imprt (buttn) Displays a standard file brwser dialg t enable a MS Wrd dcument r template file t be selected fr imprting int the TaskCentre database. Exprt (buttn) Displays a standard file brwser dialg t enable the imprted MS Wrd dcument r template file t be exprted frm the TaskCentre database t anther lcatin and saved as a file. File Name (field) Regardless f the existing name f the file being imprted, anther name can be specified by manually entering it int the field. Edit (buttn) Opens the dcument in the MS Wrd applicatin t enable it t be edited. After editing the existing dcument versin in the TaskCentre database is verwritten with the new versin when it is saved. Use passwrd fr data surce (ptin check bx) If checked then the 'Passwrd' field is activated. Passwrd (field) With the 'Use passwrd fr data surce' check bx selected, the passwrd required t access the riginal data surce at task run time may be manually entered. Test (buttn) Tests the riginal dcument mail merge data surce cnnectin using where applicable the passwrd entered in the 'Passwrd' field. A pp-up dialg displays the results f the test. Mail Merge field Displays the mail merge field name. Data surce clumn Displays '[Mapped Field]' where the Tl recgnises that the field is crrectly mapped t the mail merge data surce. The clumn rw will be blank where n mail 6

9 Merge MS Wrd Dcument Tl merge field is mapped. TaskCentre data may be dragged and drpped frm the Task Brwser dialg int a clumn rw against any mapped r unmapped mail merge field. One dcument Only ne dcument is prduced when the Step is run. New dcument when clumn changes This ptin is used in cnjunctin with the 'Clumn' drp dwn list t generate a dcument when the selected clumn changes. 'Clumn' drp dwn list - When an input recrdset has been previusly selected in the 'General' tab, the available clumns are displayed in a drp dwn list fr selectin. New dcument fr each rw - A new dcument is generated fr each rw in the recrdset. Dcument Prperties The Dcument Prperties tab (Ref: Figure 3) allws users t specify the dcument prperties, either manually r dynamically at Task run time by dragging and drpping bjects int the apprpriate field frm the Task Brwser dialg. The tab cntains the fllwing: Title Subject Authr Manager Cmpany Categry Keywrds Cmments Hyperlink base Template (nt editable) 7

10 Merge MS Wrd Dcument Tl Figure 3. Merge MS Wrd Dcument Dcument Prperties tab. Advanced The Advanced tab (Ref: Figure 4) allws users t custmise the mail merge dcument's SQL statement that Wrd uses t select the applicable data surce, either manually r by dragging and drpping bjects int the SQL frm the Task Brwser dialg. The tab cntains the fllwing: 8

11 Merge MS Wrd Dcument Tl Figure 4. Merge MS Wrd Dcument Advanced tab. 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. Merge MS Wrd Dcument Optins tab. 9

12 Merge MS Wrd Dcument Tl The fllwing ptins are prvided fr selectin: 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. 'Imprt data surce file' check bx - If selected then the mail merge data surce file will be imprted alng with the dcument 10