TaskCentre v4.5 File Management Tool White Paper

Transcription

1 TaskCentre v4.5 File Management 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 Objects Cnsumed 3 Objects Expsed 3 CONFIGURATION 4 General 4 Main 4 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 File Management Tl Intrductin Overview The File Management is a General Tl which enables a user t carry ut a number f actins n a single file r multiple files n disk autmatically. Features 2

5 File Management Tl Technical Summary Wrking with ther Steps The ther Steps that the File Management Step will interact directly with, whether by expsing infrmatin t it r cnsuming infrmatin frm it are listed belw. Step Icn Name Step Type XML Dcument Imprt Input Step Objects Cnsumed Objects that the File Management Step cnsumes that are expsed by ther Steps are listed belw. Objects Expsed Objects that the File Management Step expses which can be utilised by ther Steps are listed belw. InputFileName - The name f the surce file. OutputFileName - The name f the utput file, ppulated at Task runtime, which is dependent n the selectins made in the Step dialg. InputFilePath - The lcatin f the surce file. OutputFilePath - The destinatin path f the utput file, ppulated at Task runtime, which is dependent n the selectins made in the Step dialg. The values returned fr the FilePrcessed bject are updated each time the Step prcesses a file. Therefre if a wildcard (*) is used t select multiple files fr inclusin in the Step, the FilePrcessed bject is updated with infrmatin fr the first file prcessed by the Step, then fr the secnd file prcessed and s n fr each available file. This is particularly useful when utilising the memry feature within the Step as infrmatin fr all prcessed files can be maintained in a Repsitry t preclude the inclusin f files that were previusly prcessed. 3

6 File Management Tl Cnfiguratin The File Management Step is cnfigured thrugh the File Management dialg which is the main interface fr creating a new Step. The dialg is displayed thrugh the methds described belw. T create a new Step: T pen an existing Step: The dialg cntains the three tabbed panes described belw thrugh which a File Management Step may be created and cnfigured. General The cntents f the General tab (Ref: Figure 1) are as fllws: Main Figure 1. File Management General tab. The Main tab (Ref: Figure 3) f the File Management dialg is used t select the actin t be perfrmed n the selected file(s). The tab cntains the items listed belw. Mve Optins 4

7 File Management Tl Figure 2. File Management Main tab Mve Optins. The Mve ptin enables yu t mve the selected file(s) t a new lcatin thrugh the fllwing: Path (field and brwse buttn) - The lcatin where the file(s) are t be mved t may be either manually entered r lcated and selected thrugh the Brwse buttn. Create destinatin flder if nt fund (ptin check bx) - If this ptin is selected then if the flder int which the file(s) are t be cpied des nt exist, it is autmatically created at Task run time. Overwrite file if it already exists (ptin check bx) - If this ptin is selected then if the file(s) already exist in the selected lcatin, they are verwritten at Task run time. D nt change (ptin radi buttn) - If this ptin is selected then the file(s) Read Only attribute will be left in its current state. Set Read Only Attribute (ptin radi buttn) - If this ptin is selected then whatever its current state, the file(s) Read Only attribute is set t Read Only. Clear Read Only Attribute (ptin radi buttn_ - If this ptin is selected then if the file(s) Read Only attribute is set t Read Only then this is remved. Maximum file size (field) - In this mandatry field yu can enter a number in megabytes (MB) representing the maximum file size that the Step will mve at run time. This defaults t 10MB. Any larger files will nt be mved. Cpy Optins 5

8 File Management Tl Figure 3. File Management Main tab Cpy Optins. The Cpy ptin enables yu t cpy the selected file(s) t a new lcatin thrugh the fllwing: Path (field and brwse buttn) - The lcatin where the file(s) are t be cpied t may be either manually entered r lcated and selected thrugh the Brwse buttn. Create destinatin flder if nt fund (ptin check bx) - If this ptin is selected then if the flder int which the file(s) are t be cpied des nt exist, it is autmatically created at Task run time. Overwrite file if it already exists (ptin check bx) - If this ptin is selected then if the file(s) already exist in the selected lcatin, they are verwritten at Task run time. D nt change (ptin radi buttn) - If this ptin is selected then the file(s) Read Only attribute will be left in its current state. Set Read Only Attribute (ptin radi buttn) - If this ptin is selected then whatever its current state, the file(s) Read Only attribute is set t Read Only. Clear Read Only Attribute (ptin radi buttn) - If this ptin is selected then if the file(s) Read Onl y attribute is set t Read Only then this is remved. Maximum file size (field) - In this mandatry field yu can enter a number in megabytes (MB) representing the maximum file size that the Step will cpy at run time. This defaults t 10MB. Any larger files will nt be cpied. Rename Optins 6

9 File Management Tl Figure 4. File Management Main tab Rename Optins. The Rename ptin enables yu t rename the selected file(s) thrugh the fllwing: Use input file name as part f utput file name (ptin check bx) - Selecting this ptin means that the existing name f the file(s) t be renamed will be used as part f the new name. Filename (field) - A new name fr the file may be manually entered int the field. Prefix filename with (ptin check bx) - If this ptin is selected then this prvides tw ptins fr adding a prefix t the new file name thrugh tw ptin radi buttns. Optin 1 - Selecting the first ptin prvides a blank field int which the prefix may be manually entered. Alternatively, a dynamic value may als be used by dragging and drpping a clumn r variable cntaining the file path r part f the file path, frm the Task Brwser int the field. Optin 2 - Selecting this ptin prefixes the new file name with a date and time stamp. Suffix filename with (ptin check bx) - If this ptin is selected then this prvides tw ptins fr adding a suffix t the new file name thrugh tw ptin radi buttns Optin 1 - Selecting the first ptin prvides a blank field int which the suffix may be manually entered. Alternatively, a dynamic value may als be used by dragging and drpping a clumn r variable cntaining the file path r part f the file path, frm the Task Brwser int the field. Optin 2 - Selecting this ptin suffixes the new file name with a date and time stamp. File name created: (field) - This nn editable field displays the structure f the file name that will be created, based n the selectins made abve. 7

10 File Management Tl D nt change (ptin radi buttn) - If this ptin is selected then the file(s) Read Only attribute will be left in its current state. Set Read Only Attribute (ptin radi buttn) - If this ptin is selected then whatever its current state, the file(s) Read Only attribute is set t 'Read Only'. Clear Read Only Attribute (ptin radi buttn) - If this ptin is selected then if the file(s) Read Only attribute is set t Read Only then this is remved. Delete Optins Figure 5. File Management Main tab Rename Optins. The Delete ptin enables yu t delete the selected file(s) thrugh the fllwing: Only delete file if last mdified time is mre than (field and drp dwn list) - If this ptin is selected then a time perid may be set that restricts the deletin f a file if it has been mdified within that time. The time perid is set using a cmbinatin f a field int which a number may be manually entered and a drp dwn list that prvides time perids f Years, Mnths, Weeks, Days, Hurs and Minutes. A dynamic value may als be used by dragging and drpping a clumn r variable cntaining the value frm the Task Brwser int the field. Optins 8

11 File Management Tl Figure 6 File Management Optins tab. The Optins tab (Ref: Figure 6) f the File Management dialg is used t cnfigure the Step behaviur if an errr ccurs when the Step is being prcessed. The fllwing ptins are prvided fr selectin: Abrt Step - If there is an errr prcessing an individual file then the step will abrt. Cntinue - The Step will cntinue n t prcess the next file, if available, even if there is an errr prcessing an individual file. 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. Errr - If the file specified n the General tab has been specified withut using wildcard characters (*) and n file is fund then the step will errr. Treat as Success - If the file specified n the General tab has been specified withut using wildcard characters (*) and n file is fund then the step will nt errr. Errr - If the file specified n the General tab has been specified using wildcard characters (*) and n file is fund then the step will errr. Treat as Success - If the file specified n the General tab has been specified using wildcard characters (*) and n file is fund then the step will nt errr. 9