TaskCentre v4.5 SMTP Tool White Paper

Transcription

1 TaskCentre v4.5 SMTP 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 Dependencies... 3 SMTP Agent... 3 Objects Cnsumed... 4 Objects Expsed... 4 CONFIGURATION... 5 General... 6 Main... 6 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) [email protected] 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 SMTP Tl Intrductin Overview The SMTP Tl is used t create a Task Step that triggers a Task t run based n the cntents f incming r utging mail sent via a virtual SMTP Mail Server. When an is received it is cmpared against a number f filters created in the Step which define values fr the message parameters. Where all filter requirements are met the message is utilised t trigger a Task t run. On receipt, each f the parameters is expsed and their values may be mapped t variables created fr the Task and then used in ther Steps. Fr example, a Task is created t mnitr fr messages received frm any f the Sales team fr a specific prduct and then t supply the infrmatin directly t the apprpriate Prduct Manager. This is achieved by creating a SMTP Step that selects messages received cntaining the Sales team and prduct names. The message 'Bdy Text' and 'Frm' values are then mapped t variables. A SMTP Step is created and the variables drpped int the message bdy. When the Task is run an is then sent t the Prduct Manager t shw details f the message sender and the message itself Features Create filters fr any message parameter. Include multiple filters in a Step. Map message parameters t Task variables fr use in ther Steps. Map message attachments t a variable array. Glbal Cnfiguratin Befre the SMTP Step is used a User with System Administratr rights may cnfigure the Tl s that messages are delivered either directly t the recipient (Direct Delivery Mde) r are handled by TaskCentre (Mail Intercept Mde). T prevent delays in prcessing messages if TaskCentre is running slwly, the default ptin is set t Direct Delivery Mde. This is achieved thrugh the Mail System Integratin Cnfiguratin dialg (Ref: Figure 1) which may be pened by clicking n the Event nde in the Task Manager and then duble-clicking n the SMTP icn in the Items List. 2

5 SMTP Tl Figure 1. Mail System Integratin Cnfiguratin dialg. The dialg cnsists f the fllwing tw ptin radi buttns: Direct Delivery Mde (default) - Chse this ptin t enable Direct Delivery Mde. messages will be stred by the SMTP Event Tl and then passed immediately t the riginal recipient. Mail Intercept Mde - In this mde, messages are intercepted by the SMTP Virtual Server, handled by TaskCentre and then re-submitted t the recipient. This allws messages t be abrted by TaskCentre if required and therefre nt delivered t the riginal recipient Technical Summary Wrking with ther Steps The SMTP Step is independent f any ther Steps used in a Task. Hwever, it accesses parameters that the Task expses thrugh the Task Brwser dialg. 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. TaskCentre SMTP Agent - The SMTP Agent must be installed and registered n the same machine as the Micrsft IIS Server fr the SMTP Step t be used. SMTP Agent The SMTP Event Agent wrks with the SMTP Tl t prcess incming SMTP messages. It can run n the same r n a separate machine t the server and launches Tasks when messages arrive that match filter rules previusly cnfigured within a SMTP Step fr a Task. 3

6 SMTP Tl It interfaces with Micrsft Virtual SMTP Server which is part f the Micrsft Internet Infrmatin Services. When a message is received by the Virtual SMTP Server, a cpy f the message is passed t the Agent which in turn decides if there are any Tasks t run. The SMTP Event Agent cnsists f tw main cmpnents: IIS Event Sink - This cmpnent sits within the prcess space f the Micrsft SMTP Virtual Server and accepts messages as they are submitted t the engine. The messages are then passed directly t the SMTP Event Agent Service t be prcessed. SMTP Event Agent Service - This cmpnent runs as a Service and accepts messages frm the IIS Event Sink cmpnent. As messages are received the cmpnent examines the cnfigured events in the system and runs Tasks as required Objects Cnsumed Objects that the SMTP Step cnsumes are listed belw. Parameters (Text) - Textual data is extracted frm message parameters and mapped t variables Objects Expsed Objects that the SMTP 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 4

7 SMTP Tl Cnfiguratin The SMTP dialg is used t create a new r edit an existing SMTP Step which triggers a Task t be run when a message is sent r received cntaining specific parameter values. The Step can be set t trigger a Task t run based n data cntained in the 'Sent Frm', 'T Recipients', 'Cc Recipients', 'Subject' and 'Bdy Text' parameters f the message. In additin, variables created fr the Task may be mapped t the message parameters s that their values may be used in ther Steps. Fr example, a variable called 'Message' culd be mapped t the 'Bdy Text' variable and then included in an SMS text message created using the Send SMS (m:science SMS Server) Step. T create a new Step: In the Task Brwser dialg, select the 'Tls' tab, click n the SMTP icn under the 'Event' nde and then drag and drp- it nt the Task Plan. The SMTP dialg will pen and nce created an icn fr the Step will be displayed n the Task Plan. In the Task Brwser dialg, select the 'Envirnment' tab, right-click n the Steps nde and select the 'SMTP' ptin frm the 'New' > 'Event' drp dwn menu. The SMTP 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 'SMTP' ptin frm the 'New' > 'Event' drp dwn menu. The SMTP 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 SMTP icn. The SMTP dialg will pen t enable the Step details t be edited. In the Task Brwser dialg, select the 'Envirnment' tab and duble-click n the SMTP nde displayed under the Steps nde. The SMTP dialg will pen t enable the details t be edited. In the Task Brwser dialg, select the 'Envirnment' tab, right-click n the SMTP nde displayed under the Steps nde and select the 'Edit Step' ptin frm the drp dwn menu. The SMTP dialg will pen t enable the details t be edited. The dialg has three tabbed panes described belw thrugh which an SMTP Step may be created and cnfigured. 5

8 SMTP Tl General Figure 2. SMTP 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) prvides a cmprehensive set f ptins fr cnfiguring the Step. The cntents f the Main tab are as fllws: Use Agent (drp dwn list) - Displays a list f all mail servers that have the Mail Event Agent installed n them fr selectin. Selecting a specific mail server means that nly e- mails received by that server will be used t trigger a Task. Alternatively, selecting the 'All Mail Event Agents' ptins means that all mail servers listed will be used. Filters (area) - Filters restrict the triggering f a Task unless the specified filter criteria is matched. This area cntains the fllwing fr cnfiguring filters: Filters (table) - Displays a list f Filters created fr the Step. Any f the abve (ptin radi buttn) - Only s received that match the criteria fr any f the filters listed will be used t trigger a Task. 6

9 SMTP Tl All f the abve (ptin radi buttn) - Only s received which match the criteria fr all f the filters listed will be used t trigger a Task. Add (buttn) - Opens the Filter Prperties dialg (Ref: Figure 4) t enable a new Filter t be created. Edit (buttn) - Opens the Filter Prperties dialg t enable details fr the Filter selected in the table t be edited. Remve (buttn) - Remve the selected Filter frm the table. Mapping (area) - This area cntains a table which displays a list f Variables created fr the Task. The 'Parameter' clumn cntains a drp dwn list f message parameters fr selectin t be mapped against the Variable. If the array ptin has been selected fr the variable then it may be mapped t the message attachments Figure 3. SMTP Main tab. 7

10 SMTP Tl Figure 4. Filter Prperties dialg. The Filter Prperties dialg is displayed when either the 'Add' r 'Edit' buttn is selected in the Main tab f the SMTP dialg and is used t cnfigure a new Filter fr a SMTP Step thrugh the fllwing: Mail Prperty (drp dwn list) - Displays a list f message parameters fr selectin t which the Filter is t be applied when the message is sent r received. Filter Mask (text bx) - Specific text t be searched fr, which must be cntained within the selected message parameter fr the message t match the Filter requirements and therefre be used by the Step. Case Sensitive Match (ptin check bx) - Selecting this ptin means that the search made n the text entered in the 'Filter Mask' text bx will be case sensitive Optins The Optins tab (Ref: Figure 5) f the SMTP dialg prvides a number f ptins fr abrting the delivery f a message t the riginal recipient and fr setting up a list f Users t ntify. The riginal message can als be included in the ntificatin as an attachment. The tab cntains the fllwing: Message Abrt Optins (area) - Prvides radi buttn t select the fllwing ptins: Never - The message is never abrted and is always delivered t the riginal recipient. Always - The message is always abrted and is never delivered t the riginal recipient. On Fail - If the filter cnditins set in the Main tab are nt met, then the message is delivered t the riginal recipient. On Success - If the filter cnditins set in the Main tab are met, then the message is never delivered t the riginal recipient. 8

11 SMTP Tl Send Errr Ntificatin T (check bx) - Checking this ptin prvides the fllwing fr selecting recipients t receive an ntificatin f an errr: 'Recipients' (table) - prvides a list f recipients. 'T' buttn - Opens the Select Recipients dialg t enable any number f recipients t be selected t receive the ntificatin . 'Attach Original Message T Errr Ntificatin' - Users added t the 'Recipients' table will als receive a cpy f the riginal as an attachment. Figure 5. SMTP - Optins tab. 9