Aras Innovator 8.1 Document #: Last Modified: 4/4/2007. Copyright 2007 Aras Corporation All Rights Reserved.

Transcription

1 Aras Innvatr Service Usage Instructins Aras Innvatr 8.1 Dcument #: Last Mdified: 4/4/2007 Aras Crpratin

2 ARAS CORPORATION Cpyright 2007 All rights reserved Aras Crpratin Heritage Place 439 Suth Unin Street Lawrence, MA Phne: Fax: Website: Ntice f Rights Cpyright 2007 by This material may be distributed nly subject t the terms and cnditins set frth in the Open Publicatin License, V1.0 r later (the latest versin is presently available at Distributin f substantively mdified versins f this dcument is prhibited withut the explicit permissin f the cpyright hlder. Distributin f the wrk r derivative f the wrk in any standard (paper) bk frm fr cmmercial purpses is prhibited unless prir permissin is btained frm the cpyright hlder. Aras Innvatr, Aras, and the Aras Crp "A" lg are registered trademarks f Aras Crpratin in the United States and ther cuntries. All ther trademarks referenced herein are the prperty f their respective wners. Ntice f Liability The infrmatin cntained in this dcument is distributed n an "As Is" basis, withut warranty f any kind, express r implied, including, but nt limited t, the implied warranties f merchantability and fitness fr a particular purpse r a warranty f nn-infringement. Aras shall have n liability t any persn r entity with respect t any lss r damage caused r alleged t be caused directly r indirectly by the infrmatin cntained in this dcument r by the sftware r hardware prducts described herein. Page 3

3 Table f Cntents 1 SEND US YOUR COMMENTS OVERVIEW COMPONENTS INSTALLATION AND CONFIGURATION INSTALLATION CONFIGURATION Aras Innvatr Server Cnnectin Prperties: Jb Cntrl Prperties: Aras Innvatr Service Operating Prperties: CONFIGURATION FILE EXAMPLE EVENT MONITOR Page 4

4 1 Send Us Yur Cmments Aras Crpratin welcmes yur cmments and suggestins n the quality and usefulness f this dcument. Yur input is an imprtant part f the infrmatin used fr future revisins. Did yu find any errrs? Is the infrmatin clearly presented? D yu need mre infrmatin? If s, where and what level f detail? Are the examples crrect? D yu need mre examples? What features did yu like mst? If yu find any errrs r have any ther suggestins fr imprvement, please indicate the dcument title, and the chapter, sectin, and page number (if available). Yu can send cmments t us in the fllwing ways: Or, Or, Supprt@aras.cm Subject: Aras Innvatr Dcumentatin Pstal service: Aras Crpratin Heritage Place 439 Suth Unin Street Lawrence, MA Attentin: Aras Innvatr Dcumentatin FAX: Attn: Aras Innvatr Dcumentatin If yu wuld like a reply, please prvide yur name, address, address, and telephne number. If yu have usage issues with the sftware, please visit Page 5

5 2 Overview The Aras Innvatr Service is a Windws executable prgram that runs as a Windws Service (see screen sht). It is used t autmatically run Innvatr Methds n a peridic schedule, as specified in the InnvatrServiceCnfig.xml file. A single running instance f the Aras Innvatr Service can be cnfigured t peridically cnnect t any number f Aras Innvatr Servers, and fr each Aras Innvatr Server, run any number f Methds. The standard Windws Event Viewer is used fr lgging f prgram status and errr messages. Examples f when the Aras Innvatr Service shuld be used are: 1) Running a Methd that creates and sends Wrkflw reminder s 2) Running a Methd nightly that creates a reprt and mails it t a set f users 2.1 Cmpnents InnvatrService.exe InstallService.bat UnInstallService.bat InnvatrServiceCnfig.xml Windws executable prgram Batch file t install the Innvatr Service Batch file t un-install the Innvatr Service Cnfiguratin file NOTE: The InnvatrService requires Aras Innvatr 6.1 and higher. Page 6

6 3 Installatin and Cnfiguratin 3.1 Installatin The cmpnents listed in sectin 2.1 can be fund n the Aras Innvatr CD in the Scheduler flder. 1) Cpy the InnvatrService.exe file and the tw BAT files int any Flder. 2) Cpy the file InnvatrServiceCnfig.xml int the same flder. 3) In the Flder selected in step 2, run the BAT file InstallService.bat. This prgram runs the standard.net utility named INSTALLUTIL. This prgram will leave a set f.net lg files in the wrking directry which shuld be checked fr errr messages, and then deleted. Yu will need t specify the.net framewrk yu wish t install t (2.0 r 1.1) in the cmmand. (i.e. C:\InnvatrSrevice\InstallService 2.0) 4) INSTALLUTIL will prmpt yu fr a windws authenticatin user name and passwrd fr the machine n which yu are installing the service, use a fully qualified user name like dmain_name\user_name. If the user name and passwrd are nt valid the installatin will fail. 5) Verify that the Windws Service named Innvatr Service was added t the management cnsle (see screen sht abve). Specify whether the service shuld be started autmatically r manually. The user name and passwrd fr the service can be edited frm the LgOn tab in the service Prperties. 6) Edit the cnfiguratin file (see belw) and then start the service. NOTE: Starting and stpping the InnvatrService can be dne using the Windws management cnsle, r in a DOS cmmand Windw: NET START INNOVATORSERVICE NET STOP INNOVATORSERVICE 3.2 Cnfiguratin The InnvatrServiceCnfig.xml file is analgus t a UNIX CrnTab file, specifying which prcesses t run, and when they shuld be run. Example cnfiguratin file: <?xml versin="1.0" encding="utf-8"?> <innvatrs> <innvatr> <server>server </server> <database>database</database> <username>username</username> <passwrd>password</passwrd> <http_timeut_secnds>600</http_timeut_secnds> <jb> <methd>method NAME</methd> <mnths>month STRING </mnths> <days>day STRING </days> <hurs>hour STRING</hurs> <minutes>minute STRING</minutes> </jb> </innvatr> <eventlgginglevel>logging LEVEL</eventLggingLevel> <intervalminutes>interval</intervalminutes> Page 7

7 </innvatrs> Page 8

8 3.2.1 Aras Innvatr Server Cnnectin Prperties: <innvatr> tag is used t specify an Aras Innvatr server t cnnect t. There can be multiple <innvatr> tags in the cnfiguratin file. <server> is the HTTP url f the server. This is the same url that end-users use t run the standard Aras Innvatr client Example <server> <database> is the ID f the database in the InnvatrServerCnfig.xml. Nte that this string is case sensitive. Example: <database>prductin</database> <username> is the lgin accunt that shuld be used fr running the Methds. Example: <username>admin</username> NOTE: See dcumentatin n the Methd RunAs prperty fr mre cntrl ver the permissins granted t the Methds that are run. <passwrd> is the passwrd fr the lgin accunt, in plain-text. Example: <passwrd>innvatr</passwrd> Jb Cntrl Prperties: Fr each <innvatr>, there may be ne r mre <jb> tags, specifying Methds that shuld be run. The * (asterix) is used as a wildcard in the scheduling tags. <methd> is the Methd name in the Innvatr instance. Example: <methd>wrkflw Reminders</methd> <mnths> is the day f the week that the Methd shuld be run. Supprts a cmma delimited list f 1 thrugh 12. January is mnth=1 and December is mnth=12. Examples: <mnths>2,5,8,11</mnths> Run nly in Mar, Jun, Sep and Dec <mnths></mnths > Run every mnth <days> is the day f the week that the Methd shuld be run. Supprts a cmma delimited list. Sunday is day=1 and Saturday is day=7. A special value, last, is used t indicate the last day f the current mnth. Examples: <days>1, 5</days> Run n Sunday and Thursday <days>*</days> Run every day <days>last</days> Run nly n the last day f the mnth <hurs> is the hurs f the day that the Methd shuld be run. Supprts a cmma delimited list f hur values frm 0 thrugh 23. Page 9

9 Examples: <hurs>6,17</hurs> Run 6am and again at 5pm <hurs>*</hurs> Run every hur <minutes> is the minute f the hur that the Methd shuld be run. Supprts a cmma delimited list f hur values frm 0 thrugh 59. A special value, nce, is used t indicate the jb shuld be run nly nce when the <hurs> criteria is met, but n which minute is nt imprtant. Examples: <minutes>2,4,6,8,10,12</minutes> Run every 2 minutes <minutes>*</minutes> Run every minute <minutes>nce</minutes> Run nly nce when the <hurs> pattern is met. There is an implied tag f <secnds> with a value f <secnds>nce</secnds>. All jbs are run nly nce within the minute that satisfies the scheduling criteria Aras Innvatr Service Operating Prperties: Tw tags are used t cntrl the behavir f the running InnvatrService prcess: <eventlgginglevel> sets the level f detail fr messages that are sent t the Windws Event mnitr. Examples: <eventlgginglevel>0</eventlgginglevel> Service startup annuncement and errr messages frm Innvatr nly <eventlgginglevel>1</eventlgginglevel> Annunces the start f every Methd run <eventlgginglevel>2</eventlgginglevel> Detailed reprting f every run cycle. <intervalminutes> sets the Windws timer t cntrl hw ften the InnvatrService is start and the <jb> timing lgic is tested Any value frm 1 t 60 is supprted. Examples: <intervalminutes>1</ intervalminutes> Service is run every minute (recmmended setting) Page 10

10 3.3 Cnfiguratin file example The fllwing example will run the Aras Innvatr Prgram Management dailyupdate methd every day at midnight with a timeut f 100 minutes: <?xml versin="1.0" encding="utf-8"?> <innvatrs> <innvatr> <server> <database>innvatrslutins71</database> <username>admin</username> <passwrd>innvatr</passwrd> <http_timeut_secnds>6000</http_timeut_secnds> <jb> <methd>dailyupdate</methd> <mnths>*</mnths> <days>*</days> <hurs>0</hurs> <minutes>nce</minutes> </jb> </innvatr> <eventlgginglevel>2</eventlgginglevel> <intervalminutes>2</intervalminutes> </innvatrs> 3.4 Event Mnitr The standard Windws Event Mnitr is used fr lgging. InnvatrService will lg startup and shutdwn messages. All errr messages returned by the Aras Innvatr Cnnectin, r by the Methds are als lgged t the Event Mnitr. The level f lgging infrmatin displayed is cnfigured in the InnvatrService.xml file. Page 11