IntelliTuneX / OptiInk Scripting - arkitex - Agfa

More documents

Recommendations

Info

ITX / OptiInk Scripting ________________________________________________________________________________________ 7. MOVE BY SCRIPT SCRIPTING 7.1. Script Hook Description The MoveByScript script is a specific Postprocess script operation. It is set up and executes in a very similar way to the general purpose PostProcess scripts described previously. There are two separate operations in the Postprocess selection called “Copy Result to Folder” and “Move Result to Folder”. These previously actually performed exactly the same function namely the result file was copied to the output path configured next to the operation. Moves are not allowed as it is necessary to keep the result file in the filestore until the job is purged or deleted. From version 2.01 onwards if the Move Result to Folder operation is selected then a script function is used to perform the copy operation. With the default script provided the functionality is identical but now the script can be adjusted to perform other operations during the copy without necessarily affecting the result file. The supplied default script, for example allows for the file to be renamed further during the copy although as supplied no renaming actually takes place. The Copy Result to Folder performs a copy without invoking the script and should be used if no scripting functionality is required. The script is set up just by choosing Move Result to Folder as a postprocess operation. Note the MoveByScript.vbs is global across all Postprocess items that is used in. 7.2. Set Up When the MoveByScript.vbs script is run then it is passed 4 command line arguments • The path and name of the result file • The original name of the source file • The name which will be used for output • An output path which is the one configured next to the operation The default operation of the supplied script (MoveByScript_Default.vbs) is to copy the file specified by the first parameter to the Output path of the 4 th parameter using the 3 rd parameter as the filename. 7.3. Script Adjustment New versions of the script may be written or the current one may be edited to adjust the functionality. For example, in the default script the output filename is generated by a script function called Rename which is passed the Original Filename and the configured Output Name. Currently this just returns the Output Name but it can generate any other name based on this material. E.g. it could strip off unrequired characters. It could also perform processing on the file itself without affecting the result. This would best be done by creating a temporary copy of the file, performing the processing on this and then moving the temporary copy to the output. ________________________________________________________________________________________ Agfa 25-Jan-11 Issue 001 Released Page 12 R.J.Tidey
ITX / OptiInk Scripting ________________________________________________________________________________________ 8. SCRIPT WRITING TIPS 8.1. General It is easier to start from an existing script, particularly one already used for the existing script hook. That way the basic start up and getting the command line arguments are already in place. 8.2. Writing scripts Scripts can be written using any text editor like Notepad. For more extensive editing or creation it can be helpful to use a more sophisticated editor like Notepad+ (available on the internet) as this highlights syntax and makes it easier to control things like string quoting and bracket usage. For more extensive writing and debugging specific script development environments can be used like Visual Studio but major scripts can be developed quite easily without such tools if care is taken. It is worth taking care to properly indent the material to show the logic. Scripts should normally be broken up into a main script and a number of supporting functions. Each function should have a well defined purpose and take parameters that make it more generally useful. It is much harder to debug and maintain a script that just contains a huge monolithic block of code. Although VB scripting allows use of variables without declaring them this is bad practice and allows errors to creep in just by simple spelling mistakes which are then difficult to find. If an “Option Explicit” statement is included at the start of the script then this enforces a check for all variable to be properly declared and is a good step to ensure that this type of error is avoided. 8.3. Using existing functions Copy and use existing functions from the scripts supplied. For example, command line arguments are extracted in existing scripts normally by a GetArguments function. This allows for checking the number of arguments and also for invoking the script manually by double clicking it and manually entering the arguments. This makes it more convenient to debug without having to run through the main application. Logging functions are also available in most of the supplied scripts. There is an InitLogging function and a WriteLog function. To use just include these functions and then have the following calls at the top of the script Dim Logging Dim ScriptPath Dim ScriptTime Dim fso Set fso = CreateObject("Scripting.FileSystemObject") InitLogging ScriptTime = Timer() The fso object which gives access to filing system functions will be required by most scripts. 8.4. Debugging When debugging scripts errors will fall into three categories; basic syntax problems, run time execution errors, program logic. Basic Syntax problems will show up as soon as the script is executed. The script environment does a pre-check over the whole code and will normally refuse to start real execution if there is a basic syntax error. A dialog box will highlight the line in error which should be corrected and the script run again. This may be an iterative procedure when first testing a script to get rid of basic errors. Run time execution errors such as division by zero, mismatched dta types or indexing into array beyond their bounds will also stop the script running unless there is explicit error trapping built into the script. These will also bring up a dialog box highlighting the type of error and the line on which it ________________________________________________________________________________________ Agfa 25-Jan-11 Issue 001 Released Page 13 R.J.Tidey
Page 1 and 2: ITX / OptiInk Scripting ___________
Page 11: ITX / OptiInk Scripting ___________

IntelliTuneX / OptiInk Scripting - arkitex - Agfa

Create successful ePaper yourself

Delete template?

Save as template?