Extreme Processing User`s Manual for version 1.x
Contents
1. notifysmtp Task will send simple email notification message This task can be used to notify system administrators about job execution and status server SMTP email server name port SMTP port number from From email address to To email address subject Email subject line body Email body onerrorsmtp Task will send simple email notification message when any of the tasks nested in it fail This task can be used to notify system administrators about job execution and status server SMTP email server name port SMTP port number _from From email address to To email address subject Email subject line body Email body readhttp Read messages via internet and place them into internal queue qname Internal queue name where to place messages received via HTTP server Web server name port Web server port number binary _ lf set to true will use binary transfer mode _writehttp _ Read messages from internal queue and post them to web server qname Internal queue name where to place messages received via HTTP server Web server name contenttype Default value application x www form urlencoded for posting HTML method Default value is POST for posting to web server readmsmq Read messages from MSMQ and place them into internal queue for future processing2. Additional Validator Tasks VATasks If you use xvalidator task in your script make sure that valideng dll is the same as one used by EDI Validator installation You can copy over valideng dll from EDI Validator installation to make sure your validation execution uses same runtime version Task Parameters Usage _xvalidator _ Task will run EDI Validator schema definitions file appendouitput lf set to True appends to output file instead of overwrite If set to False use macros such as Count to create unique output file names definitionsfile Extreme Validator definitions file including path license Extreme Validator license key for the map to run input Input file name Input file name contains data that will be validated Example C test somedirectory test txt This will pickup all text files that start with word test in specific directory output Output file name Output file will contain validation results Example C Mtest somedirectory test_out txt outputformat Output file format Accepted values XML or Plain Etasoft Inc Page 27 2 10 2011 Extreme Processing File Edit View Project Help Coc E bc EI Task False detinitionstile C Mestnow West 56 wa input C Westnow West txt license S48TL ULATX XGL3X6 3661 output C Westnow out 99 td outputtonmat 957 appendoutput Append to output file Ex
3. Extreme Processing Software should use your license key to run samples if sample fails to run try to copy your license key from Product License dialog screen into the sample script you want to run Every script can be opened in XML capable editor and edited or viewed Tasks in scripts are usually indented if they are contained by other tasks Job name Job Llicense demo failonerror true verbose false tasksdir _ gt EN time name Pun at specific times schedule 5 40PN 5 42PM gt echo name Show message when executed messagqe Hello World gt time job gt EN EX This is screen shot of sample run opened in XML editor Script contains job that has a task executed at predefined times during the day 3 Extreme Processing Script Editor D projects etc xproc install samples sample1 run Le JI File Edit View Project Help e a ER O w Db Script Schema 5 Cp Source BE ol SA ja i 0O echo First message PER 0 pause Pause for D seconds SA ech Fail DI echo Second message oe We A E S E Job license 6 7 34L H8LL8 98LT6D Verbose False FTF Aun name Job name used tor logging and reporting Started in directory D projects vete xproc bin D ebug EN Finished L E sample1 run is very basic sample script that just prints a few messages and pauses for 5 seconds Etasoft Inc Page 30 2 10 20
4. SQL statement in a form of SELECT connection Connection string to ODBC data source Example _DSN test UID myname PWD mypassword Extreme Processing Script Editor C testnow trans odbec_test run File Edit view MER A ERE Project gt Help Script Schema Script Source Oars ifeglhasto sqlexec ze Time Vereen Run o H L t ifsglhasrows CTT tglesecute Started in director DO projectsetc xproc bin Debug gt gt Task itsglhasrows has started gt gt Task sglexecute has started Example of ODBC tasks in action Additional Reporting Tasks RPTTasks amx D Task connector DSH 837Claims2 agl UPDATE dbo Raw Data SET upload_type 37 sql SOL statement tor execution Reporting tasks should be set at the top of job execution tree above most of other tasks Reporting tasks capture and save reporting information from lt xtranslator gt lt xvalidator gt and other tasks Task Parameters Usage csvreport Task will prepare processing reports in CSV format based on results from other tasks such as lt xtranslator gt or lt xvalidator gt and save them into CSV file filename _ Path and file name where report should be saved in CSV format Comma Etasoft Inc Page 22 2 10 2011 Extreme Processing Separated Value flat file xmlreport Task will prepare proc
5. Task runs other tasks nested within itself at predefined times everyday schedule Time schedule with hours and minutes separated by comma Example 10 30AM 11 45AM 1 20PM this schedule will trigger this task at these predefined times If specific time already passed today it will trigger again tomorrow calendar Task runs other tasks nested within itself at predefined date and time schedule Datetime schedule with date hours and minutes separated by comma Example 1 14 2006 10 20AM 1 2 25 2006 3 20PM this schedule will trigger this task at these predefined dates If date is in the past it will trigger again after 1 year This way you can setup schedule to run tasks at specific date every year subjob Sub job is an independent execution unit inside of the job Sub job starts new thread and runs tasks nested inside It is recommended to avoid using Sub job as it may complicate your script execution Use Sub jobs only if you have no other solution N A property Reserved for future use key Unique key to identify property value Value for the property Property task is used to define constants in scripts loop Execute nested tasks in the infinite loop This task can be used for some service _ jobs running in the background all the time N A log Log notification messages into the file using this task file Log file name with directory message Information message to be written to the log file timest
6. Etasoft Building blocks of intedration Extreme Processing User s Manual for version 1 x Copyright 2004 2011 Etasoft Inc Main website http www etasoft com Extreme Processing website http Avww xtranslator com PUP DOSC ME 2 REGUIFGMGINS srcccicsscsecsasasessecesndssntenearecsesesvensenedeiendeesestsensassesetnstnscmmiseemnennne 2 Terminology and Detntions ee KK KKK E AER EE KE E EE EE E ER E E EE EE EEN KE 2 LICENSING ocina Ea na 2 PACKAGES TOO E 3 CH dl A ET 3 M MGI seciinissnann mae ciaeiainis ant aaie adnate again isla nice ein edd aia md mem edi WE i 3 SCFIPU Ed ItIN isisscssssesassinncaiccncicncanienls sina suivadisinas cin cawe aaa d Available Task TN e EE 8 CH d dl A EX CuCiOny RE 9 PASSING PALaMeCte CT 10 IM ACTOS initia sciweneninmnscannesonwad diccuscasinnsunnareienimsemnsmeeeineiMaReiecneaeRamnaneaednveneacienioane ul 12 JOD POD Die d LE 13 nternal QUEUE EE 13 TASKS ononon a AE EEEE EAE ERRES 15 Se EI WEE Additional Input Output Tasks IOTasks 0nnnnn00nnnnoonnnnnoonnnanonnnnnenrnnnneernnnnenrnnnnennnnnnennnnnennnnnnennnnnrennne Additional SQL Database Tasks ODBCTasks on0nnnnoonnnnooennnoonennnoeernnnnnrnnnneernnnnrernnnnrrrnnnerrrnnnrenr Additional Reporting Tasks HPTTaekel AE Additional Translator Taske THlaekel Additional FormXT Tasks FXT SKS cccccsesscsseceeeeeeeeeecseseeaeeseeeeeeeeeeeesseeaesaaeseeeeeeeesecseseeaeseseeeeeeess Additional Validator Tasks VATae
7. Your Task class and properties have to be decorated with special attributes in order to be properly displayed and accessible in editing tools vil askName attribute defines how task should be called and displayed in the graphical interface Task name must be unique otherwise running script may call wrong task during execution Etasoft Inc Page 34 2 10 2011 Extreme Processing Syst em System ITO System ml System ComponentModel etc xuproc etc uproc attributes namespace etc_iotasks Sea ee J Task has to inherit from KS ff 25 tite Era i vil ask or i This is simple legging task that vilaskContainer jf d Sunar y gt F wiTaskGroup Basic E Let viTaskName mylog Se eet public class villyLogTask rss L string file ff path or file nate for log file string message bool timestamp true if g t rye f f af sie rye public villyLogTask L Your Task class has to be inherited from vil ask or vilaskContainer In this example viMyLog Task is inherited from vilask and can not contain other nested tasks within itself Developer SDK has other example called viMyLoopTask that inherits from vitaskContainer and can contain other tasks Technical Support Please contact technical support if you have any questions or concerns Contact information is listed on the product and company websites For most technical support questions we will request processing log This log can be obtaine
8. qname Internal queue name where messages will be taken to msmgqname MSMQ name Example private myQueue seconds Number of seconds to wait for every incoming message writemsmgq _ Write messages from internal queue into MSMQ qname Internal queue name where messages will be taken from msmqname MSMQ name Example myQueue ifqnotempty _ Task will execute other tasks nested in itself if internal queue is not empty _qname _ If queue has messages execute nested tasks ifqempty Task will execute other tasks nested in itself if internal queue is empty _qname _ lf queue has no messages execute nested tasks _Clearq _ Task will clear internal queue qname _ Clear internal queue from all messages it contains filterq Task will filter and remove messages from internal queue that match _ specific criterion qname Internal queue name contains see Filter message from queue if message contains this text to and from to Start looking for contains text up to this text Etasoft Inc Page 20 2 10 2011 Extreme Processing from _ Start looking for contains text from this text startswith Filter message from queue if message starts with this text endswith _ Filter message from queue if message ends with this text keepq Task will keep messages in the internal queue only if they match specific criterion Essentia
9. ss e EE EE orbe Script Editor main window has sidebar to add new tasks current job schema and properties for selected task All available tasks are refreshed every time Tasks Directory is changed In order to add or edit or execute tasks Tasks Directory must be set to the directory where DLLs containing tasks are Default value for Tasks Directory is and that means current directory In most cases this setup is appropriate unless tasks should be deployed in separate directory than main runtime DLL Etasoft Inc Page 5 2 10 2011 Extreme Processing Script Schema Script source job name job license Falloneror true verbose true tasksdir gt readtiles dir C Mtesttrans pathern tet encoding A45Cll opames default C port 21 dir patterm username password binary true qname detault gt writettp server Zwrteftpz teadtles gt Zo ke gt e fou can edit script source code XML definitions on this screen fi During script execution d d processing messages will Ek be displayed in this tab Script source code editor allows direct XML script editing Once you click Script Schema tab back changes made to source code will move to schema if source code changes are valid You can right click on this script editing area to copy paste or select the script Etasoft Inc Page 6 2 10 2011 Extreme Processing SN Se KA T Sege NR AE ee Extreme P
10. PM alarm WORKED 1219 2005 9 34 37 PM alarm lt lt Task echo has finished 12 19 2005 9 34 37 PM alarm gt gt Task echo has started 12 79 2005 9 34 37 HM alarm WW OAR KE D 1279 2005 9 34 37 PM alarm lt lt Task echo has finished 1219 2005 9 34 37 HM alarm gt gt Task echo has started 12 79 2005 9 34 37 PM alarm W ORKE D 1219 2005 9 34 37 PM alarm lt lt Task echo has finished 12 19 2005 9 34 37 HM alarm gt gt Task echo has started 12 79 2005 9 34 37 PM alarm WORKED 121972005 9 34 38 PM alarm lt lt Task echo has finished 12 79 2005 9 34 38 PM alarm gt gt Task subjob test has started 1219 2005 9 34 38 PM alarm gt gt Task time has started 1219 2005 9 34 38 PM alarm gt gt Task time has started Running Windows based Script Run tool runs job with job verbose property set to true You can pass number of parameters and change Script Run tool options via command line Accepted parameters 1 showintaskbar true or false if set to true Script Run will always appear in Windows Task Bar 2 showballoontips true or false if set to true will display processing messages as balloon tips near system tray 3 closewhendone true or false if set to true will close itself upon job completion 4 balloontipslong true or false if set to true will show balloon tips until they are explicitly closed Etasoft Inc P
11. be recovered Additional SQL Database Tasks ODBC Tasks You will need to setup ODBC data source in Control Panel to use those tasks You can perform simple database maintenance using ODBC tasks use lt ifsqlhasrows gt task to check for existing records and then perform actions using lt sqlexecute gt Task Parameters Usage sqlexecute Task will execute SQL query using ODBC connection sql SQL statement in a form of INSERT UPDATE or DELETE connection Connection string to ODBC data source Example DSN test UID myname PWD mypassword ifsqlhasrows Task will execute SQL query using ODBC connection If resulting record set contains any rows nested tasks will be executed This task could be used in combination with lt sqlexecute gt task sal SQL statement in a form of SELECT connection Connection string to ODBC data source Example _DSN test UID myname PWD mypassword untilsqlhasrows Task will execute SQL query using ODBC connection If resulting record set contains any rows nested tasks will be executed This task could be used in combination with lt sqlexecute gt task Task will loop repeat until SQL returns Etasoft Inc Page 21 2 10 2011 Extreme Processing any rows that s why it is important for nested tasks to update database otherwise this task will loop indefinitely sql
12. type Application Target location Debug Start in D projects etc sproc bins Debug Shortcut kep Ctrl Alt M Aur Normal window Comment There is example of desktop shortcut that calls Script Editor This example shows how to pass parameter into Script Editor tool in order to run script with the property dir that accepts parameter called directory Macros Macros are similar to expressions covered in chapter Passing Parameters They are special expressions enclosed in between and During script execution those special expressions are replaced by dynamic values of date date time or internal counts Macros are mostly used to create messages with date time embedded in them or create unique output file names during processing _ Macro Result DateTimeShort Produces date and time in format YYMMDD_hhmmss _ DateTimeLong or DateTime _ Produces date in format CCYYMMDD_hhmmss DateShort Produces date in format YYMMDD _ DateLong or Date Produces date in format CCYYMMDD Count1 or Count2 or Counts Produces internal count Count6_ 1 or Count6_ 2 or Count6_ 3 Produces internal count padded with zeros on the left with total size of 6 positions Count8_ 1 or Count8_2 or Count8_ 3 Produces internal count padded with zeros on the left with total _size of 8 positions Etasoft Inc Page 12 2 10 2011 Extreme
13. 0 2011 Extreme Processing Developer SDK Developer SDK provides basic samples on how to call script jobs from NET applications You can call jobs directly and handle exceptions in your applications using System using Gaestem LU using etc ZDEOG New using clause must be included at the top of your file that will call job script Reference to xproc dll should be added to your project in order to have access to viJob and viJobFile classes try widJoh job widJobFile Load jobFile true arge Job EchoHandler new viConsoleEchoHandler i Job Execute catch Exception exp Console WriteLine t Console WriteLinei ERROR exp Message i exp InnerException mull Console _WriteLine Caused by exp InnerException Message Console WriteLine SsthackTrace exp StackTrace if texp InnerException null Console _WriteLine Caused by StackTrace exp InnerException StackTrace This is basic job script execution example Developer SDK also provides example on how to write your own EchoHandler EchoHandler is used to output information messages during job execution If EchoHandler is not assigned to the job information messages from lt echo gt and other tasks will not be sent to your application public class viFormEchoHandler viEchoHandler private frmxmlocriptPun form public wiForwEchoHandler frmtmlocriptRun form _form form p
14. 0070316 DRER LO txt lt input gt output DSN ss7Claimsez output processdatetime gt 4 12 2007 2 02 37 P processdatetime gt report gt lt report gt smapfile gt C testnowitrans MASTER NMEDENT DE access3 xmp mapfile gt S0urcename gt xvlZ S37 HC Health Care Claim sourcename destrame 37 Claims dest name gt ep wee Te A eee ee ee dm s A THAIS Tes Ta MECT 14 t art fa meat lt xmlreport gt reporting task saves processing results in XML format Etasoft Inc Page 23 2 10 2011 Extreme Processing a Extreme Processing Script Editor C testnow trans listener_test run File Edit View Project Help EI Common RER name SE i G stranslator i CS 77 D Tack Execute j filename E Mreport xml fies Peportingtasks ON Cee fabove other tasks MSMO i UDB i xmireport f lt ALL A Fa z Add reporting task aN filename using this icon Ge S file name where reporting information should e saved Example of reporting task setup You can use SQL reporting task to save reports into SQL database via ODBC lt sqlreport gt task needs database connection information and table name where report data will be logged Etasoft Inc Page 24 2 10 2011 Extreme Processing E EP_REPORT Table jo FieldName DataType Descripti
15. 11 Extreme Processing Job name job license demo failonerror tru e verbose false tasksdir gt echo name First message message Hello World vs pause name Pause for 5 seconds minutes 0 seconds 5 vs 2echo name Second message message This is second message after the pause vs Job gt This is same sample run opened in XML editor II job Oh time Run at specific times TT echo Show message when exec s Run at specific times schedule 5 40PM 5 42PM name Task name used for logging and display purposes Etasoft Inc Page 31 2 10 2011 sample2 run runs in the time loop and fires at specific times Help File Edit View Project Sid O E Ea 3 E L wiritehiles EI Common name E Task complete dir encoding patter Extreme Processing simply read files True C testtproc_cases input ASCII File Edit Project Script Schema i Script Source VIe E LO jab a h readtiles simply read files em L weitetiles simply write files Ta name Task endsWith Opname SloartaAd ht sample3 run reads text files from specific directory and writes them to another directory default H Task Content search contains ISA sample4 run is the same as sample3 run with the filter added in order to remove all the files that contain text ISA in them Etasoft Inc Page 32 2 1
16. Processing GK NEE La ExXTPEME Processing File Edit View Project Help Script Schema Message to show in the console during processing gt gt Task echo has started Date 20110710_ 1333 Count 00000001 cc Task echo has finished gt Task echo has started Date 20110710_ 1333 Count 00000002 d4 Task echo has finished gt gt Task echo has started Date 20110710_ 1333 Count 00000003 cc Task lecho has finished Finished There is simple example on macro use in output messages J ob Properties Job has number of properties that are global for whole script execution Property Description name Name used to display and identify job in log file and console screen failonerror If set to false it will try to continue job execution even if task in the job has failed license License key to run this job tasksdir Tasks directory defaults to That means current directory Tasks directory is very _ Important as it instructs job where to look for tasks that it needs to execute verbose _ lf set to false it will reduce number of information messages in the output Internal Queue lOTasks tasks library comes with build in internal queue This queue is used to keep processing data around between individual task calls Some tasks are also created to clean or manage internal queue IOTasks library uses queue c
17. X 509 certificate file will be loaded using file name with full path set in this property Works only if ssl property is also set to true timeout Communication timeout value in number of seconds standardftp lf set to true will use standard FTP provide support for SSL passive mode keep alive and all other properties if set to false will use only small subset of FTP features to allow communication with old or not fully RFC compatible systems ifftofilesexist Task will check if FTP files matching pattern exist in server directory if files exist then tasks nested in this task will be executed server FTP server name port FTP server port dir FTP server directory pattern Remote file name or pattern to select multiple files username FTP server user name password User password to log into FTP server passive _ lf set to true will use passive connection mode keepalive If set to true will keep connection open between FTP requests ssl _If set to true will use FTP over SSL FTPS channel certificatefile X 509 certificate file will be loaded using file name with full path set in this property Works only if ssl property is also set to true timeout Communication timeout value in number of seconds readpop3 _ Task will read messages from email server into internal queue
18. _ Directory where files will be moved pattern Only file names matching this pattern should be deleted Examples of patterns txt will delete all text files from specified directory overwrite _ lf set to true will overwrite existing destination files __ Copy _If set to true will copy files instead of moving them splitfiles Task will split files in the directory based on certain text inside those files Example if you set boundary to ST it will split incoming EDI X12 files into separate transactions Separate ST SE blocks See lt splitq gt task that Etasoft Inc Page 17 2 10 2011 Extreme Processing also splits files based on data in them lt splitq gt works on the queue while _ lt splitfiles gt works on files dir Directory where files are pattern Only file names matching this pattern should be split Examples of _ patterns txt will split all text files from specified directory outputpattern Pattern for output file naming Example out txt will create files out Dei out2 txt out3 txt etc boundary Any text that will indicate beginning of the new file Example EDI X12 Purchase Orders 850 could be split using boundary set to ST or ST 850 keepheader lf set to true will keep header data and produce all the split files with it at
19. age 9 2 10 2011 Extreme Processing Command line run tool takes script file name as parameter Command line script run tool takes script file name as first parameter Second parameter is optional and may contain word stopiferror in which case it will stop before closing if error is encountered Passing Parameters You can pass external parameters to script to supply custom property values for execution Simple text properties can be passed in via command line or as parameters for job execution Etasoft Inc Page 10 2 10 2011 Extreme Processing Gi File Edit View Project Help O a ld b Script Schema Script Source Basic Ay job esa 3 5 H readftp ac SS BH ommon Es oy writefiles ap Execute El Task 3 append alse ii Ers FTP encoding ASCII e pattern AS SOUTZ Http grame default MSME dir Hueue Director where to write output files Time Bum There is example of the property dir that accepts parameter called directory passed into the script Microsoft Windows sP CUersion 5 1 26k OC Copyright 1965 2661 Nicrosoft Da rN Hproccemd testftp run S ldtrectory C test De p d testftp rel tory test This is example how to pass in external parameter called directory into testftp run script Etasoft Inc Page 11 2 10 2011 Extreme Processing ProcPad Properties foro Geh General Shortcut Compatibility FrocPad Target
20. alled default however they are not limited to one queue You can have more than one internal queue by simply calling them with different qname For example you can have one queue to read email messages via POPS and write to local files and another queue to read files from FTP and send them using email via SMTP Etasoft Inc Page 13 2 10 2011 Extreme Processing Internal queue concept is important for OTasks tasks library to function It allows data flow between tasks and provides support for many additional tasks to filter and process data Many tasks in lOTasks library have qname property that is set to default This property indicates what internal queue will be used to read data from or write data into In most cases you will only need one queue per job to read data in process it and write it out E Ext reme P rocessing Script Editor D projects etc xp roc install isam ples sample3 run SAX i File Edit wiew Project Help E Common name simply read files E Task complete True dir C testtproc_cases input encoding ASCII pattern txt gname default readonlymode False L t readfiles simply read files Ly writefiles simply write files Se Intemal Queue name where all incoming files from directory will be loaded qname Name of the queue where data is stored between calls to tasks Internal queue name is set to default but more than one
21. amp If set to true will write current timestamp into the output log file logfilenames Log file names currently in the queue into the file using this task Etasoft Inc Page 15 2 10 2011 Extreme Processing file Log file name with directory message Information message to be written to the log file timestamp If set to true will write current timestamp into the output log file fail _Task throws exception in order to abort job execution message Message to be produced in the output just before job fails This task is used to _ abort job execution or force job execution out of looping catch Catch errors in nested tasks This task is useful if you want to proceed with job execution even if errors occurred in the tasks nested inside lt catch gt task Catch task can be very useful for tasks used in data communications Example let say if lt readftp gt task fails to connect to FTP server you want to try reconnect after 10 minutes in this case catch will absorb lt readftp gt failure and keep job executing N A exit _ Exit job gracefully N A exec Execute external program and wait for its completion program External application or program to run Example C Windows notepad exe parameters Parameters to pass to external program _workingdir Working directory timeout Number of seconds to wait u
22. ample of xvalidator task setup Container Task Execution Tasks nested in other container tasks are executed if following conditions are met during container execution Container Task Condition under which it will execute nested tasks interval _ When interval defined in minutes and seconds will pass time When time defined in schedule will come calendar When date and time defined in schedule will come subjob Will always execute tasks nested in it but run them in separate thread _ loop Will always execute tasks nested in it but run them repeatedly in the loop catch Will always execute tasks nested in it but suppress any errors that might happen during execution of those tasks nested exec If external program runs and returns expected exit code if specific exit code is expected execjob If external job runs and does not fail Etasoft Inc Page 28 2 10 2011 Extreme Processing readfiles _ If files have been read from specified directory _writefiles _ If files have been written to specified directory _ iffilesexist _If files exist in specific directory _readfto If files have been read from FTP server remote directory writeftp If files have been written to FTP server remote directory _ifftpfilesexist _If files exist on FTP server remote directory readpop3 If email messages have been read from the POP3 ma
23. bug gt Task xmlreport has started Task xmlreport has finished gt gt Task cevreport has started CC Task cevreport has finished lt sqlreport gt task is used to log data into the SQL database via ODBC connection lt sqlreport gt task should be set before above lt xtranslator gt and lt xvalidator gt tasks in the Extreme Processing screen Additional Translator Tasks TRTasks If you use xtranslator task in your script make sure that xtraneng dll is the same as one used by Extreme Translator installation You can copy over xtraneng dll from Extreme Translator installation to make sure your map execution uses same runtime version Task Parameters Usage _xtranslator _ Task will run Extreme Translator map mapfile Extreme Translator map file including path license Extreme Translator license key for the map to run Input Input file name and directory Word Input without quotes has to be entered in DataPath property for the input side of the map output Output file name and directory Word Output without quotes has to be entered in DataPath property for the output side of the map parameters _ Additional parameters separated by spaces includedirectories Include subdirectories when processing input files If set to true looks for files not just in current directory set but input property but also looks for files in all subdirectorie
24. d by changing log level values in xprocpad exe config file Figure below shows values that need to be set before you run the processing script that fails in Script Editor Processing will write extra information in xorocpad log file that might be useful to identify technical problem Sam version 1 0 encoding utit a F gt PEs omn configuration e ag Set these values to Am w Ee e E j procpad exe contig file See In order to log additional i lt add name eto it ee 6 Pvwalue 5 processing informator Im Fi lt add name etc_xproc walue 3 gt external log file sadd name xprocpad vrajue 3 f gt fe lt fowltches gt lt trace autoflush true indentsize 0 gt listeners gt lt add name xprocpad type System DPlagnostics TextilriterTraceListener initializebata xprocpad log gt i lt flisteners gt lt ftrace gt lt fsystem diagnostics gt lt fconfiguration gt These are special values to enable extensive logging into xprocpad log file Other values can reduce amount of logging produced There are allowed values E Li m Le ES Li Etasoft Inc Page 35 2 10 2011 Extreme Processing 1 errors only 2 errors and warnings 3 errors warnings and additional information Etasoft Inc Page 36 2 10 2011
25. d end tags if task has an end tag Available Task Packages All available tasks come in 3 major libraries Library Description Xproc dll Basic tasks for general processing lotasks dll Input and output tasks for data communication and transfer Trtasks dll _ Translator tasks for Extreme Translator map execution Etasoft Inc Page 8 2 10 2011 Extreme Processing Script Execution Scripts can be executed unattended using command line and script run tools coming with the package Scripts can be also executed for testing purposes in the Script Editor Script Editor execution provides more information as active tasks are highlighted in red If you have NET application and would like to run jobs from your application directly take a look at chapter about Developer SDK Extreme Processing Script Run AAxx File Options Script D projects etc xprocbin D ebugsprojects xml fshowintaskbarstalse showballoontips tue clasewhendone talse balloontipslong false Script Started 121972005 9 34 32 PM alarm Started in directory 1279 2005 9 34 32 PM alarm gt gt Task pause has started 1279 2005 9 34 37 PM alarm lt lt Task pause has finished 1279 2005 9 34 37 PM alarm gt gt Task echo has started 12 79 2005 9 34 37 PM alarm WOREED 1219 2005 9 34 37 PM alarm lt lt Task echo has finished 1219 2005 9 34 37 PM alarm gt gt Task echo has started 12 79 2005 9 34 37
26. e pattern dir Directory where files should be monitored pattern Only file names matching this pattern should be watched Examples of patterns txt will monitor all text files from specified directory changeevent _ If set true will monitor for file change events createevent _ lf set true will monitor for file create events renameevent _ If set true will monitor for file rename events deleteevent If set true will monitor for file delete events deletefiles _ Task will delete files in the directory based on file name pattern dir Directory where files are pattern Only file names matching this pattern should be deleted Examples of patterns txt will delete all text files from specified directory movefiles Task will move files from source to destination directory based on file pattern sourcedir Directory where files are destinationdir Directory where files will be moved pattern Only file names matching this pattern should be moved Examples of patterns txt will delete all text files from specified directory _ overwrite _If set to true will overwrite existing destination files copy If set to true will copy files instead of moving them movefilesonebyone Task will move files from source to destination directory based on file _ pattern It also runs other nested tasks below on every copied moved file sourcedir Directory where files are destinationdir
27. eceive permanent license key This new key must be entered in Script Editor and in job property called license GH Product License Current License License key 67SXL ABLLB 9SLTBO XLLA Pm ee License key should be entered in Script Editor so all future scripts would default to this new license key Etasoft Inc Page 2 2 10 2011 Extreme Processing Extreme Processing Script Editor Modified File Edit View Project Help Oe BE Script Schema Script Source name job base D Job Http ch D o AME E Common u X tee o True _ blue Za Zeg kep to run this job lt etn enen this job and tasks mt Permanent license key have to be entered after the purchase in old scripts used during trial period if you want to continue using them Packaged Tools Extreme Processing comes with number of tools Tools are designed to fill three basic needs 1 Script editing and testing You can edit scripts using directly using any XML editor or notepad However this can be tedious and error prone We provide graphical Script Editor tool that you can use to add tasks edit they properties and run them in test environment 2 Script execution using script execution tools You can execute scripts using command line or Windows GUI based tool Both tools provide simplest way to execute scripts in unattended and automated environment 3 Script execution via your progra
28. essing reports in XML format based on results from other _ tasks such as lt xtranslator gt or lt xvalidator gt and save them into XML file filename _Path and file name where report should be saved in XML format sqlreport Task will prepare processing reports based on results from other tasks such as lt xtranslator gt or lt xvalidator gt and save them into SQL database via ODBC connection connection Connection string to ODBC data source Example DSN test UID myname PWD mypassword table Table name in the database that will hold saved reports Table must be pre created before reporting begins Task can not create table if it does not exists Task only inserts new reports it can not update them Default suggested table name is EP_REPORT If you choose other name do not use any spaces in the name lt report gt smapfile gt C itestnow trans MASTER MEDENT DB access3 xmp mapfile gt S0urcename gt s1l2 S37 HC Health Care Claim sourcename gt destname gt 837C laims lt dest name gt input gt C testnow trans z 0070316 DRER LO txt input gt Output DSEN 8S7ClaimsZ output gt processdatetime gt 4 12 2007 1 58 24 D processdatetime gt report gt report gt smapfile gt C testnowitrans MASTER MNEDENT DE access3 xmp mapfile s0urcename gt x1lZ 837 HC Health Care Claim sourcename gt es trae gt 33 7C lLaims dest mame gt lt iLnput gt C testnow trans lt
29. il server _writesmtp lf email messages have been sent to SMTP mail server _readhttp If file has been read from HTTP Web server writehttp _If file has been written to HTTP Web server readmsmq _ If messages have been read from MSMQ writemsmq _ If messages have been written to MSMQ ifqnotempty H internal queue is not empty and contains messages _ ifqempty H internal queue is empty and contains no messages ifsqlhasrows If resulting SELECT statement record set contains any rows xtranslator If Extreme Translator map runs without errors formxt H FormXT map runs without errors _xvalidator _ lf Extreme Validator validation runs without errors Samples Samples are located in samples directory under product installation directory They show basic use of the product In order to run samples you might need to change license key that comes with the sample script you want to run Gi Fie Edit Wiew Project Help Debt Script Schema SCIpt Source Basic SS a8 ae HIE Email echo First message ee LT pause Pause for 5 seconds E Common mg Execute CTT echo Second message Hele 0 D Job Files failonerror True ETP LEE license GFS4L AGLLE 38LT6D ALLFS f Yr Change this license key ef e Http f in order to run sample verbose False MSMO Script K fe license Lueue D ao License to run this jab and tasks in it Run Etasoft Inc Time Page 29 2 10 2011
30. internal queue can be used for complex job scripts when multiple streams of data required Simply use different value in qname for other streams of data if you need more than one Etasoft Inc Page 14 2 10 2011 Tasks Extreme Processing Most tasks are independent building blocks of the job Tasks can be added to the list of available tasks by simply placing new DLL containing new tasks into job s tasksdir You or third parties can also develop them independently Tasks provide an extensible framework as new tasks can be added without a need to recompile or rebuild whole application Some basic tasks come pre packaged with the runtime Build in Tasks Task Properties Usage echo Task sends simple information messages to the output console or notification window It is very helpful in testing and debugging job execution message Message to be produced in the output screen or command line window This task is very useful for diagnostic and testing purposes pause Task pauses job execution for predefined time minutes Number of minutes to wait seconds Number of seconds to wait interval Task runs other tasks nested within itself at predefined time intervals minutes Number of minutes to wait before executing tasks nested in it seconds Number of seconds to wait before executing tasks nested in it time
31. kel 000nnnnnnannnnnannonnnnnnnnnnnnnenennnnrnnnnnnnnssrerrnnrnnnsnnnnenrnerrnnnnnnnnnrenennnne Container EE Ee SAIN UTC 29 Developer Saibene eege gester eege gege eege EE EE a E 33 HOW CO write your OWN TASK ssisisisicdsccicsinsccdimanseneansincamannesicnsnsmadnanasinsindacaaieansansmni 34 TECHNICS SUP DOM dE 35 Etasoft Inc Page 1 2 10 2011 Extreme Processing Extreme Processing Purpose Extreme Processing is a set of tools for data processing and communication The backbone of it is XML based job script Each job contains tasks executed for data send receive filtering and other processing Tasks can trigger other tasks repeat execute other jobs and run based on scheduled time events Requirements Minimum R equirements Software Windows 2000 XP Vista Server 2003 _ Hardware Pentium 1GHz RAM 256Mbt Recommended Software Windows XP Pro Hardware _ Pentium 1 5GHz RAM 512Mbt Terminology and Definitions Scripts are XML based job descriptions containing tasks Each script can contain single root job and number of sub jobs Sub jobs are executed in separate execution threads Licensing Default package installation comes as time limited trial evaluation license After fixed number of days starting from the day of the first use trial evaluation license will expire and most of software features will become disabled If you will like the product and purchase it you will r
32. ks can be used to set mode when Schema nodes are always expanded Show Stack Trace if turned on will show stack trace if executing job fails Auko Expand Tasks Show Stack Trace Run can be used to run current job defined in editor script Stop can be used to stop current job execution Validate can be used to validate script for mandatory values and value ranges Tasks Directory can be used to change directory where tasks are located and loaded from Default setup loads tasks from current directory Validate Tasks Directory Crit Script Editing You can edit scripts in any XML editor or notepad However it is much easier to use graphical Script Editor tool It combines three most important features 1 Script schema editing when each task can be added and task properties changed 2 Script source code editing when actual XML representation of the script could be changed manually in the editor window 3 Script testing and execution monitoring You can use other tools to modify or create job scripts Scripts have to be valid XML format files and tasks listed in them should be in tasks directory Script Editor tool scans directory for available tasks and retrieves they properties Simple tasks are pure execution entities They cannot contain other tasks and they do not change script execution flow Container tasks on other hand can contain other tasks and can change execution flow Exam
33. lly this task is an opposite to filterq task qname Internal queue name contains see Keep message in queue if message contains this text to and from to _ Start looking for contains text up to this text _from _ Start looking for contains text from this text startswith Keep message in queue if message starts with this text endswith Keep message in queue if message ends with this text splitq Task will split messages in the internal queue based on structure of the data in the message Essentially this task is pre processing task to filterq or keen task It is used to split big EDI X12 and EDIFACT files into _smaller interchanges and separate messages _qname Internal queue name x12_interchange If set to true split EDI X12 block of data into separate X12 interchanges edifact_message If set to true split EDIFACT block of data into separate EDIFACT messages pattern File name or pattern to form multiple files Macros can be inserted in order to produce unique file names or file names that match input files Available macros are Y count produce unique number in the file name date produce date in the file name time produce time in the file name Y source produce input file or source name Gproperties Reserved for future use persistent lf set to true will persist each queue message in internal storage for safety If job fails or computer crashes messages can
34. m using Developer SDK for NET Script Basics There are some basic rules regarding script creation 1 Each script has to start with job tag 2 Each script can contain only one job 3 Script has to be in valid XML format 4 Only container tasks can have other tasks nested in them Main Menu Etasoft Inc Page 3 2 10 2011 Extreme Processing Main menu contains standard submenus File Edit View Project and Help It contains most of functions available Some functions are duplicated and placed under toolbar buttons and under right click popup menus Edit view Project Help Mew Ctrl New menu option is used to start new scripts Open is used to load existing script files Den Cl Save and Save As can be used to save edited script files Recent Files can be used to load recently modified and saved files SE Gr Exit can be used to close this application Save S Ctrl Shifk 5 Exit Ctrl Add Task can be used to add new tasks from the complete list of available tasks Available tasks are loaded from Tasks Directory They can be changed by pointing Tasks Directory to other folder Delete can be used to delete tasks Add Task Ctrl 4 Delete Ctrl D Schema can be used to switch editor view to script schema view Schema Ctrl 1 S l Source can be used to switch editor view to script source code view SHOU Ce Ctrl 2 Auto Expand Tas
35. ntil program finishes checkexitcode If set to true will check exit code from external program ifexitcode H exit code returned by the application matches one set in this property then execute tasks nested in this task Check is performed only if checkexitcode property is set to true execjob _ Execute external job script file File name of the external job parameters Parameters to pass to external job onerror Execute external job script and if it fails then run nested tasks This is like a combination of lt execjob gt and lt catch gt tasks in one task file File name of the external job parameters Parameters to pass to external job GC Run garbage collector GC This task is used for long running intense scripts that process data in real time or near real time Use this task to recycle memory _used by the script Additional Input Output Tasks lO Tasks Task Parameters Usage readfiles Task will read files into internal queue based on the directory and file pattern _qname _ Internal queue where files should be placed dir Directory where files are pattern Only file names matching this pattern should be read Examples of patterns txt will read all text files from specified directory encoding Encoding to use when reading the files Possible values ASCII European_8bit Unicode complete This option slows down reading task significan
36. on dS MAPFILE Text varchar or text Field size of 200 E SOURCENAME Text varchar or text Field size of 200 __ DESTNAME Text varchar or text Field size of 200 INPUT Text varchar or text Field size of 200 OUTPUT Text varchar or text Field size of 200 _ PROCESSDATETIME Text varchar or text Field size of 50 Field Properties General Lookup Field Size Format Eyed Wart 4 Field name ey can be up to 64 Default Value characters long Validation Rule including Validation Text spaces Press Required Fi For help on Allow Zero Length Field names Indexed Unicode Compression There is layout of the MS Access table You can use almost any SQL based database that you can connect to using ODBC data source defined in the Control Panel AA 171 837 HC He 637Claims CMestnpa trar DSN 837Claims2 416 2007 4 34 33 DM __ CAtestnow wvaliditest wva X12 837 HC He 997 CATESTNOW EXOQUTPUTZOUF04161 4716 2007 4 34 38 PM Record D d 1 HI kal oF 2 This is a view of the table that contains report logged with lt sqlreport gt task Etasoft Inc Page 25 2 10 2011 Extreme Processing GI Extreme Processing Script Editor C testnow trans listener_test run File Edit View Project Help Gor Gel ES Be SS Script Schema SClipt Source a GR job O xmlreport ore Al SD SIE eqlrepart L IT vltapslator ct xvalidator connection Connection string Started in director D Aproiechsketc xproc binsDe
37. ple of simple non container task is lt pause gt task It simply pauses for defined amount of time Example of container task is lt time gt This task waits for certain time event defined in schedule property and executes other tasks nested in it Visually simple and container tasks are decorated with different icons Etasoft Inc Page 4 2 10 2011 Extreme Processing EE is used to indicate simple tasks is used to indicate container tasks Container tasks can be used in very powerful ways They can work as IF statements or Loops Example lt readfiles gt task will read files that match certain naming pattern from certain directory this task will also call other nested tasks however it will not execute nested tasks if there are no files matching the pattern This way you can nest lt writeftp gt task in lt readfiles gt task and that way files retrieved from the directory will be transferred to FTP server GI File Edit View Project Hein O a fd bP Script Schema acnpt Source RG SE S teadfiles Files LA writeftp SEOMRA name E Task ilesexist dir C test trans encoding ASCII pattern txt readtiles qname default writefiles Kee SR 2 Ee Re FIP eo Selected task properties g Se Http uai 0 att MSMO pattern Display Read files matching this pattern Nr e Processing script schema re Bun e Script componente tasks ZS i you can add to the script i a E i j he er
38. qname server POPS email server port POPS port username User name used to read email password User password for POPS server attachmentsonly Messages are in attachments Ignore email body and do not create message for it in the internal queue subjectcontains Read and add message to internal queue only if email subject contains text defined in this property readonlymode Keep copy of the email on server do not remove email message after it was read This option assumes that some other process will remove email messages from email server _writesmtp _Task will write messages from internal queue into email server qname _Internal queue that will provide messages for the SMTP email server server SMTP email server name port SMTP port number _from From email address to To email address subject Email subject line body Email body pattern Email attachment file name or pattern to name multiple files Macros can be inserted in order to produce unique file names or file names that match input files Available macros are Y count produce unique number in the file name date produce date in the file name time produce time in the file name Source produce input file or source name _useattachments If set to true will use attachments instead of body to send messages Etasoft Inc Page 19 2 10 2011 Extreme Processing
39. rocessing Script Editor Modified File Edit View Project Help GDeRLSir di 7 Weg E e Script Schema Script You can add tasks from the Queue list to the selected job or task In the script schema Files ittilesexict encoding GG eacdhles pattern qname C test trans ASCII txt default 7 wiitefiles You can add specific tasks Ze to the selected job or task in the script schema Http MSMO Time Processing pattern Display Read files matching this pattern Execute There are two ways to add tasks to schema using sidebar or using dialog screen with all tasks listed in the drop down list Dialog screen has one advantage as you can add tasks at any nested point in the tree while sidebar only allows addition of the tasks as last nested item Most task properties are mandatory While Script Editor does not enforce them to be set script execution will fail if property is missing value Etasoft Inc Page 7 2 10 2011 Add Task Available T asks Tasks stead Extreme Processing Positiort First nested item This dialog screen allows addition of tasks to any point in the nested tree You can also edit XML script manually in order to move tasks around but make sure that only container tasks have other tasks nested in them Also if you copy and paste XML script make sure you copy and paste both XML start an
40. s below current Setup procedures 1 In the translator Map Editor you need to enter word Input in the input side DataPath and word Output in the output side DataPath Etasoft Inc Page 26 2 10 2011 Extreme Processing 2 Once you do that Extreme Processing will be able to pass values into your map Without words Input and Output in DataPath properties map will use whatever values are set in the map already and values you set in the Extreme Processing will not get passed to the map 3 Now once you set DataPath to words Input and Output You will notice that you can not run map in the Map Editor You can still do that by going to Runtime Parameters in the Map Editor and setting those values in that screen After that you should be able to run map in the Map Editor and also use it in the Extreme Processing Additional FormXT Tasks F XTasks If you use formxt task in your script make sure that formxteng dll and found dll is the same as one used by FormXT installation You can copy over formxteng dll and found dll from FormXT installation to make sure your execution uses same runtime version Task Parameters Usage _formxt Task will run FormXT map mapfile FormXT map file including path _license _FormXT license key for the map to run input Input file name and directory output Output file name and directory parameters Additional parameters separated by spaces
41. the top of the file Example if you split EDI X12 files using ST your header will be ISA GS segments of the original file iffilesexist Task will check if files matching the pattern exist in the directory if files exist then nested tasks will be executed dir Directory where to search for files This task will execute nested tasks only if at least one file is found that matches include exclude patterns include Include files that match this pattern Pattern examples txt or xml exclude Exclude files that match this pattern Pattern examples txt or xml _ readftp _ Task will read files from FTP server directory into internal queue qname Internal queue where FTP files will be placed server FTP server name port _ FTP server port dir _ FTP server directory pattern Remote file name pattern to select multiple files Example txt would match all the text files in remote directory username FTP server user name password User password to log into FTP server binary lf set to true will use binary data transfer mode readonlymode If set to true will read files but keep original files on server and do not _ remove them from remote directory after read passive _If set to true will use passive connection mode keepalive _If set to true will keep connection open between FTP requests ssl _If set to true will use FTP over SSL FTPS channel certificatefile X 509 certificate file will be loaded
42. tly if there are many files to read If set to true will check if file is complete before reading tt If other Etasoft Inc Page 16 2 10 2011 Extreme Processing process or program is writing same file at the same moment this option will attempt to take file only when other process is done with writing it This option cannot guarantee the file is complete if other process s write is _ slow or other process is appending to the file constantly readonlymode lf set to true will read files but keep original files and do not remove them from source directory after read writefiles Task will write files from internal queue into directory using defined naming pattern qname Internal queue where files should be written off dir Directory where files will be placed pattern File name or pattern to write multiple files Macros can be inserted in order to produce unique file names or file names that match input files Available macros are Y count produce unique number in the file name date produce date in the file name time produce time in the file name Y source produce input file or source name encoding Encoding to use when reading the files Possible values ASCII European_8bit Unicode append If set to true will append to existing files instead of overwrite filewatch Task will monitor directory based on file nam
43. ublic void Echolstring jobNWame string message _form SetText string Format O 1 4 DateTime Now ToString jobWame messages There is an example of EchoHandler that calls Form method every time there is new information message coming from the job Etasoft Inc Page 33 2 10 2011 Extreme Processing How to write your own Task Tasks are classes inherited from vil ask or vifaskContainer decorated with special attributes and compiled into NET library CLR DLL Tasks that can contain and execute other tasks nested below have to be inherited from vilaskContainer Installation comes with sample task called viMyLogTask that you can modify rename and repackage for your needs It is simple task and can not contain other tasks nested in it This sample task simply logs information messages passed to it via message property namespace etc _iotasks gee eee Paal ai e na i These attributes define i EE Task name and Task d iple logying tas group proc I F A a public class villLogTask wiTask L string file dd path or fale meme for log fi string message bool timestamp true These attributes define Te i Task property Po a wWiTaska attributel file Required true wistringValidator AllowEmpty false Categorya attribute Task i Description ttributet Log file name j public string file get return file Set file value
44. using file name with full path set in this property Works only if ssl property is also set to true timeout Communication timeout value in number of seconds standardftp lf set to true will use standard FTP provide support for SSL passive mode keep alive and all other properties if set to false will use only small subset of FTP features to allow communication with old or not fully RFC compatible systems writeftp _ Task will write files from internal queue into FTP server directory _qname Internal queue where files are before they are written to FTP server server FTP server name port FTP server port dir _ FTP server directory pattern Remote file name or pattern to write multiple files Macros can be inserted in order to produce unique file names or file name that match input files Available macros are count produce unique number in the file name date produce date in the file name time produce time in the file name Y source produce input file or source name username FTP server user name password User password to log into FTP server Etasoft Inc Page 18 2 10 2011 Extreme Processing binary _ If set to true will use binary data transfer mode passive _ lf set to true will use passive connection mode keepalive If set to true will Keep connection open between FTP requests ssl _If set to true will use FTP over SSL FTPS channel certificatefile
Download Pdf Manuals
Related Search