Custom task
Use the custom task template to set parameters that govern the way IEE runs an external windows process from the task system and stores log information within IEE. This task is for system administrators or integrators. Run this task through the task scheduler, orchestration, or add it to a recurring schedule.
Use the following procedure to configure a task template:
-
Go to System Operations > Task Management > Task Templates.
-
Use the dropdown menu to select the Task Type and Task Template. (Click Add to create a new task template. For more information, see Adding task templates.)
-
Configure the Task specific parameters. These parameters are defined after step 5 of this procedure.
-
Configure the Common task template parameters. For more information, see Task template parameters.
-
Click Save.
Task Specific Parameters
Path to Custom Tool
Defines the path to the external tool (external to IEE) to run. This tool can be a batch file, an executable, or a script (a VBSCRIPT should use the following path: c:\windows\system32\cscript.exe). Itron recommends using an absolute path, but if you need to use a relative path, the path should be relative to the <Program Files>\Itron\Enterprise Edition\bin directory. This parameter supports custom tasks and custom imports.
Custom Tool Parameters
Defines any parameter that you want to pass to the custom tool. If the tool is a VB script, type the path to the script here. In addition to the Itron directory variables [($ItronData), ($ImportDirectory), ($ExportDirectory)], you can also embed the ($TaskID) variable in this parameter. For the Custom Import Task, you can embed the ($ImportFilePath) variable, as it is necessary for IEE to be able to pass the path of the imported file to the external process.
Seconds to Timeout
Defines the number of seconds that IEE waits for the external process to return a response before IEE times out. If you set this parameter to 0 (zero), the process will not time out. Setting the parameter to 0 (zero) may cause the task runner to hang. Seconds to Timeout is a custom task and custom import parameter.
Note: The external process can log information to the task system by writing a line to the console starting with one of the words CRITICAL, ERROR, WARNING, or INFO. For example, in a batch script you could write: echo INFO TaskID passed to batch script was:%1. If ($TaskID) was the first parameter in the custom tool parameters, this would write the message to the task log.