TaskCentre v4.5 Workflow Job Submission Tool White Paper

Transcription

1 TaskCentre v4.5 Wrkflw Jb Submissin 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 TECHNICAL SUMMARY... 2 Wrking with ther Steps... 2 Dependencies... 2 Wrkflw Agent... 3 Objects Cnsumed... 4 Objects Expsed... 4 CONFIGURATION... 4 General... 5 Main... 5 Filter Prperties dialg... 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 Wrkflw Jb Submissin Tl Intrductin Overview The Wrkflw Jb Submissin Tl is used t create a Task Step that triggers a Task t run when respnses frm Wrkflw Jbs match criteria specified in ne r a number f filters. Initially the Create Wrkflw Jb Tl is used t create a Wrkflw Jb Step in a Task that publishes ne r a number f web frms called Wrkflw Jbs t a web site flder n a specified Web Server when the Task runs. They cntain cntrls that enable data t be manually entered r selected frm a list f ptins by specified users / recipients. When a Wrkflw Jb Submissin Step is cnfigured, the apprpriate Wrkflw Jb is selected which expses the data fields that its related web frm cntains. Via variables, Filters may then be created n the data fields s that when specified criteria are met, the Task is triggered t run. The Wrkflw Agent manages all Wrkflw Jbs and Wrkflw Jb Submissin Steps fr the Web Server n which it is installed. When a user cmpletes a Wrkflw Jb web frm and submits it, all available Wrkflw Jb Submissin Event Steps that use that Wrkflw Jb will then attempt t match their filter criteria against thse entered n the frm by the user and where they match, thse Tasks will be run Glbal Cnfiguratin There is n Glbal Cnfiguratin required fr this Tl. Hwever Micrsft IIS and the Wrkflw Agent must be installed n the Web Server yu wish t publish the Wrkflw Jb(s) t and if required a specific web site set up. Otherwise the default web site installed with IIS will be used Technical Summary Wrking with ther Steps The Wrkflw Jb Submissin Step is independent f any ther Steps used in a Task. It is used t trigger a Task t run based n data received frm a Wrkflw Jb web frm that matches criteria cnfigured as filters fr specific fields. In additin, all fields available fr the selected Wrkflw Jb web frm are expsed in a table allwing them t be individually mapped nt Task variables fr use in ther Task Steps Dependencies The prducts, technlgies, prtcls r systems that are required fr the Oracle Trigger Step t wrk are listed belw. Micrsft IIS Server (Windws 2000 nwards) - The virtual SMTP server is used. Nte the Micrsft Vista des nt include the virtual SMTP server. Internet Explrer 2

5 Wrkflw Jb Submissin Tl Wrkflw Agent - The Wrkflw Agent must be installed and registered n the Web Server hsting the Wrkflw Jb web frms. Wrkflw Agent The Wrkflw Agent is a Windws Service which resides n ne r a number f Web Server machines. It cnnects t and mnitrs all cnfigured Wrkflw Jb and Wrkflw Jb Submissin Steps n its assciated TaskCentre Server. These are retrieved and cached lcally. The Wrkflw Agent checks the IIS server and verifies that the currently cnfigured flders can handle Wrkflw Jbs if requested. When new Wrkflw Jb Steps are created, a flder crrespnding t the Step is created in the publishing flder f the IIS server and the script files and graphics assciated with the Step are cpied int it. When a Wrkflw Jb is cmpleted and the web frm submitted the Wrkflw Agent transmits the data back t its TaskCentre Server and autmatically remves the assciated files and publishing flder frm the IIS Server. Any Wrkflw Jb Submissin Steps assciated with the Wrkflw Jb will then trigger a Task t run if their cnfigured filter cnditins have been met. When the Service is started any existing Wrkflw Jb pages which are n the web server are remved and replaced with the latest versin Figure 1. Wrkflw Agent Architecture. 3

6 Wrkflw Jb Submissin Tl Objects Cnsumed The Wrkflw Jb Submissin Step cnsumes n bjects that are expsed by ther Steps. Objects Expsed Objects that the Wrkflw Jb Submissin Step expses fr use by ther Steps are listed belw. Variables (Text) - Textual data is mapped t selected Parameter Variables fr use in ther Steps Cnfiguratin The Wrkflw Jb Submissin dialg is used t create a new r edit an existing Wrkflw Jb Submissin Step. The Step triggers a Task t be run when data received frm a submitted Wrkflw Jb web frm matches filter criteria specified in the Step. In additin, variables created fr the Task may be mapped t web frm fields s that their values may be used in ther Steps. T create a new Step: In the Task Brwser dialg, select the 'Tls' tab, click n the Wrkflw Jb Submissin icn under the 'Event' nde and then drag and drp- it nt the Task Plan. The Wrkflw Jb Submissin dialg will pen and nce created an icn fr the Step will be displayed n the Task Plan. In the Task Brwser dialg, right-click n the Steps nde and select the 'Wrkflw Jb Submissin' ptin frm the 'New' > 'Event' drp dwn menu. The Wrkflw Jb Submissin dialg will pen and nce created the Step is displayed under the Steps nde in the Task Brwser. It may then be dragged and drpped nt the Task Plan. Right-click anywhere n the Task Plan in the Design tab f the Task dialg and selected the 'Wrkflw Jb Submissin' ptin frm the 'New' > 'Event' drp dwn menu. The Wrkflw Jb Submissin dialg will pen and nce created an icn fr the Step will be displayed n the Task Plan. T pen an existing Step: On the Task Plan in the Design tab f the Task dialg, duble-click n the Wrkflw Jb Submissin icn details t be edited.. The Wrkflw Jb Submissin dialg will pen t enable the Step In the Task Brwser dialg, duble-click n the Wrkflw Jb Submissin nde displayed under the Steps nde. The Wrkflw Jb Submissin dialg will pen t enable the Step details t be edited. In the Task Brwser dialg, right-click n the Wrkflw Jb Submissin nde displayed under the Steps nde and select the 'Edit Step' ptin frm the drp dwn menu. The Wrkflw Jb Submissin dialg will pen t enable the Step details t be edited. 4

7 Wrkflw Jb Submissin Tl The dialg has tw tabbed panes described belw thrugh which a Wrkflw Jb Submissin Step may be created and cnfigured. General Figure 2. Wrkflw Jb Submissin General tab. The cntents f the General tab (Ref: Figure 2) are as fllws: Name (field) A unique name fr the Step may be manually entered. Descriptin (field) A descriptin fr the Step may be manually entered. Main The Main tab (Ref: Figure 3) f the Wrkflw Jb Submissin dialg prvides ptins fr cnfiguring the cnnectin t the required Wrkflw Jb, mapping data fields in the Wrkflw Jb web frm t Task variables and creating filters t be applied t the web frm data fields when the frm is submitted. The filters are used t restrict the triggering f a Task unless the data submitted matches specified criteria. The cntents f the Main tab are as fllws: Wrkflw Agent: (drp dwn list) - Displays a list f all available Web Servers that have the Wrkflw Agent installed fr selectin. An ptin is als prvided t use all available Wrkflw Agents. Surce Wrkflw Jb: (drp dwn list) - Displays a list f all Wrkflw Jbs available n the selected Web Server(s) fr selectin. 5

8 Wrkflw Jb Submissin Tl Filters (table) - Displays a list f filters created fr the Step under the fllwing clumn headings: Message Prperty - Displays the prperty n which the filter has been created. Case Sensitivity - Displays 'Yes' r 'N' depending n the selectin chsen fr the filter. Filter Mask - Displays the filter expressin. Figure 3. Wrkflw Jb Submissin Main tab. Any f the abve (ptin radi buttn) - If selected then if any f the listed filter cnditins are met then the Task will be triggered t run. All f the abve (ptin radi buttn) - If selected then nly if all f the listed filter cnditins are met will the Task then be triggered t run. 'Add' buttn - Opens the Filter Prperties dialg (Ref: Figure 4) t enable a new filter t be created and added t the list. 'Edit' buttn - Opens the Filter Prperties dialg t enable details fr the filter selected in the list t be edited. 'Remve' buttn - Remves the selected filter frm the list. 'Mapping' table - Displays a list f fields available fr the selected Wrkflw Jb under the fllwing clumn headings which may then be mapped t Task parameter variables t ppulate them with data frm the Wrkflw Jb web frm: 6

9 Wrkflw Jb Submissin Tl Name - The field name. Type -The field type, e.g. Numeric, Character etc. Attributes - The field attributes. Parameter - Displays the name f the variable mapped t the field. These may be mapped by dragging and drpping Task parameter variables frm the Task Brwser dialg int the field. Nte that nn-parameter variables will nt be displayed in the list. Filter Prperties dialg The Filter Prperties dialg (Ref: Figure 3) is used t create a filter expressin n a specific data field value cntained within a Wrkflw Jb web frm. When the frm is submitted the filter is applied t the field value and if the cnditins are met then that triggers a Task t run. Figure 4. Filter Prperties dialg. The dialg cntains the fllwing fr creating a filter: Frm Field (drp dwn list) - Displays a list f fields fr selectin t be used by the filter. Filter Mask (text bx) - The filter expressin is manually entered int this area. Case Sensitive Match (ptin check bx) - If selected then the filter expressin is case sensitive. 'OK' buttn - Saves the new filter and clses the dialg. The filter will be added t the list in the Filters table in the Main tab. 'Cancel' buttn - Clses the dialg withut saving the changes. 7