Documentation Center

IBackgroundTaskHandler - IshShell

Starts an external background process that zips files using the hardcoded cscript.exe "%ISHPROJECTDATAPATH%\ExportService\Scripts\ZipFiles.vbs" command.

Input data

The input data XML file contains the required data for the handler to work. It is stored in a temporary folder on the file system, and the corresponding file path is passed to the external process as an argument. The input data XML can contain a setendevent element to specify whether or not the handler should end the event.

Background task configuration

The background process to trigger the cIshShell is configured in the background task configuration, which is accessible from Organize Space by selecting Settings > XML Settings > Background Tasks.

location
Path to the file system folder where the input data XML is temporarily stored.
  • Required: yes
passauthenticationcontext
Boolean value to pass the Authentication Context of the logged in user to the external process. This parameter is optional, if not passed the Authentication Context is not passed on to the external process.
passeventprogressid
Boolean value to pass the unique Event Progress Id for the running process. This parameter is optional, if not passed the Event Progress Id is not passed on to the external process.
cleanup
Boolean value that indicates whether to remove the temporary eventdata file from the filesystem. This parameter is optional, if not passed the temporary eventdata file will be removed from the filesystem.
eventmonitorprogressstatus
Either "calculate" or "lastresult" can be used. When "calculate" is used, the event overview will take into account all event details (when one is "Failed", the event overview will report "Failed"). When "lastresult" is used the event overview will directly be set to last result, so either "Success" or "Failed". This parameter is optional, if not passed the event overview will use "calculate".
raiseevent
The event type of the next event in the chain.

This component is typically used for the ZIPFILES handling

Default background task configuration example

The following configuration gets and handles a ZIPFILES event from the background task queue:

<handler eventType="ZIPFILES">
  <scheduler executeSynchronously="true" />
  <authorization type="authenticationContext" />
  <execution timeout="01:00:00" recoveryGracePeriod="00:10:00" isolationLevel="None" useSingleThreadApartment="true" />
  <activator>
	<net name="IshShell">
	  <parameters>
		    <parameter name="location">%ISHPROJECTDATAPATH%\ExportService\Data\WatchFolder</parameter>
		  </parameters>
	</net>
  </activator>
  <errorHandler maximumRetries="0" />
</handler>