Template engine (Python)

def onFieldChanged(self,  fieldName, fieldValue, fieldsToChange):
	if fieldName == "MAYAFILENAME":
		basePath = os.path.dirname(fieldValue)
		if basePath.endswith("scenes") and len(basePath) > 6:
			separator = "/";
			if fieldValue.find("\\") != -1: 
				separator = "\\"
			projectPath = basePath[0:len(basePath)-7]
			fieldsToChange.addEvent("MAYAPROJECTPATH",projectPath,MTemplateAPI.MTemplateItemEvent.kTemplateItemFieldsActivationNone)
			fieldsToChange.addEvent("MAYADESTINATION",projectPath + separator + "images",MTemplateAPI.MTemplateItemEvent.kTemplateItemFieldsActivationNone)

The previous code sample is used inside the Maya template to automatically fill the projects and image output path when a user selects the Maya scene.

def onBuildCommandLine(self, platform, job, chunk, clientTemplatePreferences,instanceNum):
	renderCmd = "-r sw"
	renderCmd += " -n " + clientTemplatePreferences['PROCUSAGE']
	renderCmd += " -proj \"" + job.attributeGetString(manager.resolveMappingToJob(self.getID(),"MAYAPROJECTPATH")) + "\""
	if job.attributeIsEnabled(manager.resolveMappingToJob(self.getID(),"MAYADESTINATION")):
		renderCmd += " -rd \"" + job.attributeGetString(manager.resolveMappingToJob(self.getID(),"MAYADESTINATION")) + "\""
	renderCmd += " -s " + '%.3f' % chunk.getStartFrame()
	renderCmd += " -e " + '%.3f' % chunk.getEndFrame()
	renderCmd += " -b " + '%.3f' % chunk.getByFrame()
	renderCmd += " -rfs " + str(chunk.getFrameStart())
	renderCmd += " -rfb " + str(chunk.getFrameStep())
	renderCmd += " -pad " + job.attributeGetString("MAYADIGITS")
	renderCmd += " " + job.attributeGetString("ADD_FLAGS")
	renderCmd += " \"" + job.attributeGetString(manager.resolveMappingToJob(self.getID(),"MAYAFILENAME")) + "\""
	return renderCmd

The previous code sample is used inside the Maya template to create the Mayabatch command line.

def onGetFlagForRenderLayers(self,job,layers):
	layersWithComma = ",".join(layers )
	return "-rl "+layersWithComma

The previous code sample is used inside the Maya mental ray template to requeue just a subset of render layers.

def onBuildAdditionalParameters(self, attributes):
	renderCmd = ""
	if (attributes.isEnabled("MM")):
		renderCmd += "-mm " + attributes.getString("MM") + " "
	return renderCmd

The previous code sample is used inside the Maya template to create additional parameters from the attributes previously declared.

def onGetApplicationPath(self,job,chunk,clientTemplatePreferences,pathOut ):
	pathOut.setString(clientTemplatePreferences['MAYAEXECUTABLE'])
	return MTemplateAPI.MTemplateError()

The previous code sets the Maya batch process grabbing the value from the MAYAEXECUTABLE field of the client preferences.

def onGetApplicationStartingFolder(self,job,chunk,clientTemplatePreferences,pathOut):
	pathOut.setString(clientTemplatePreferences['MAYASTARTINGFOLDER'])
	return MTemplateAPI.MTemplateError()

The previous code sets the Maya starting folder grabbing the value from the MAYASTARTINGFOLDER field of the client preferences.

def onBuildEnvironment(self, job, chunk, clientTemplatePreferences, existingEnvironment):
	environment = existingEnvironment
	platform = MClientAPI.GetPlatform()
	if platform == MClientAPI.kPlatformOSX:
		environment.setValue("DYLD_LIBRARY_PATH","")
	elif platform == MClientAPI.kPlatformLinux:
		environment.setValue("LD_LIBRARY_PATH","")
	return environment

The previous code sample is used inside the Maya template. It grabs the running platform, and resets the library search paths to avoid clashing with the Muster QT distribution by setting new environmental variables.

def onCheckForSubframeAdvancingString(self,job,chunk,line):
	result = re.search(".*(Finished Rendering).*", line)
	if result != None:
		return 1
	return 0

The previous code sample is used inside the Maya template to check for the “Finished rendering” log line to tell Muster that a frame has been completed.

def onCheckForFramesMask(self,job,chunk,line, maskOut):
	result = re.search(".*Finished Rendering\\s(.*\\.)(\\d+)\\.", line)
	if result != None:
		maskOut.setString(result.group(1))
		return 1
	return 0

The previous code uses a regular expression to grab the frames prefix from the Maya log and report it back to Muster. Notice the usage of the MStringRef class to set back the value into the prefixOut variable.

def onCheckForFramesMaskForLayer(self,job,chunk,line, maskOut, layerOut):
	result = re.search(".*progr:\swriting\sframe\sbuffer\s(.*)\sto\simage\sfile\s(.*)\s\(frame\s(\d+)\).*", line)
	if result != None:
		maskedFile = MClientAPI.GetSequenceMask(result.group(2))
		if maskedFile:
			maskOut.setString(maskedFile)
			layerOut.setString(MClientAPI.GetLayerFolderFromPath(maskedFile))
			return 1
	return 0

The previous code uses a regular expression to grab the frames prefix from the Maya log and report it back to Muster. Notice the usage of the MStringRef class to set back the value into the prefixOut variable.

def onCheckForSubframeProgress(self,job,chunk,line, progressOut):
    result = re.search(".*progr:\\s*(.*)\\%\\s*rendered on.*", line)
    if result != None:
	 progressOut.setString(result.group(1))
	 return 1
    return 0

The previous code sample is used inside the Maya template to create additional parameters from the attributes previously declared.

def onCheckLogLine(self,job,chunk,clientTemplatePreferences,line,lineNum,warnings,errors,silencedWarnings,silencedErrors):
	abortRendering = job.attributeGetBool("ABORTRENDER")
	if abortRendering and line.find("Error") != -1 :
		error = MTemplateAPI.MTemplateError(1,"Premature render termination. Error keyword found in the log",MTemplateAPI.MTemplateError.kTemplateErrorTypeError)
		error.addErrorAction(MTemplateAPI.MTemplateError.kTemplateErrorAbortRender);
		return error
 
	return MTemplateAPI.MTemplateError()

The previous code checks the Maya output line by line while rendering. If the ABORTRENDER field is enabled, it checks for an “Error” string in the output, and aborts the render before its termination by setting an MTemplateError object according.

def onCheckLog(self,job,chunk,clientTemplatePreferences,log,warnings,errors,silencedWarnings,silencedErrors):
	lines = log.split("\n")
	completed = -1
	finished = -1
 
	for idx, val in enumerate(lines):
		marker = manager.checkForLineParsingOverrides(job,chunk,val,idx)
		if marker.getType() == MClientAPI.MTextFileMarker.kFileMarkerError:
			errors.append(marker)
		elif marker.getType() == MClientAPI.MTextFileMarker.kFileMarkerWarning:
			warnings.append(marker)
		elif marker.getType() == MClientAPI.MTextFileMarker.kFileMarkerSilenceError:
			''' The builtin parser has a skip rule for this line, do not include it in the warnings/errors but in the silenced errors'''
			silencedErrors.append(marker)
		elif marker.getType() == MClientAPI.MTextFileMarker.kFileMarkerSilenceWarning:
			''' The builtin parser has a skip rule for this line, do not include it in the warnings/errors but in the silenced warnings'''
			silencedWarnings.append(marker)
		else:
			''' We have no fixed rule , parse the line according to the template logic '''
			baseError = -1
			baseWarning = -1
			length = -1
			baseError = val.lower().find("error")
			baseWarning = val.lower().find("warning")
			if val.lower().find("completed.") >= 0 : completed = val.lower().find("completed.")
			if val.lower().find("rendering finished") >= 0 : finished = val.lower().find("rendering finished")
 
			if baseError != -1:
				length = len(val)-baseError;
				marker = MClientAPI.MTextFileMarker(MClientAPI.MTextFileMarker.kFileMarkerError,idx,baseError,length)
				errors.append(marker)
			if baseWarning != -1:
				length = len(val)-baseWarning;
				marker = MClientAPI.MTextFileMarker(MClientAPI.MTextFileMarker.kFileMarkerWarning,idx,baseWarning,length)
				warnings.append(marker)
 
	if completed < 0:
		return MTemplateAPI.MTemplateError(3,"Missing \"completed.\" keyword. Batch render may have crashed",MTemplateAPI.MTemplateError.kTemplateErrorTypeError)
	if finished < 0:
		return MTemplateAPI.MTemplateError(3,"Missing \"rendering finished\" keyword. Batch render may have crashed",MTemplateAPI.MTemplateError.kTemplateErrorTypeError)
	if len(errors) > 0 and len(warnings) > 0:
		return MTemplateAPI.MTemplateError(2,"Errors and warnings reported in the log. Please check the chunk details for a detailed list",MTemplateAPI.MTemplateError.kTemplateErrorTypeError)
	elif len(errors) > 0:
		return MTemplateAPI.MTemplateError(2,"Errors reported in the log. Please check the chunk details for a detailed list",MTemplateAPI.MTemplateError.kTemplateErrorTypeError)
	elif len(warnings) > 0:
		return MTemplateAPI.MTemplateError(1,"Warning reported in the log. Please check the chunk details for a detailed list",MTemplateAPI.MTemplateError.kTemplateErrorTypeWarning)
 
	return MTemplateAPI.MTemplateError()

The previous code sample is used inside the Maya template to parse the output log and check for specific strings. It sets the MTemplateError object according.

def onCheckExitCode(self,job,chunk,clientTemplatePreferences,exitCode):
	if exitCode == 211:
		return MTemplateAPI.MTemplateError(exitCode,"Abnormal render termination",MTemplateAPI.MTemplateError.kTemplateErrorTypeError)
	if exitCode != 0:
		return MTemplateAPI.MTemplateError(exitCode, "%d Exit code different from expected 0 value" % exitCode,MTemplateAPI.MTemplateError.kTemplateErrorTypeWarning)
 
	return MTemplateAPI.MTemplateError()

The previous code sample is used inside the Maya template to check the batch process exit code.

def onApplicationFinder(self,moduleRegExp,moduleTag):
	platform = MClientAPI.GetPlatform()
	''' Search maya.exe '''
	if platform == MClientAPI.kPlatformWindows:
		moduleRegExp.setString("mayabatch.exe")
	elif platform == MClientAPI.kPlatformOSX:
		moduleRegExp.setString("MayaBatch")
	elif platform == MClientAPI.kPlatformLinux:
		moduleRegExp.setString("maya")
	moduleTag.setString("Maya")
	return MTemplateAPI.kTemplateScanModule

The previous code sample is used inside the Maya template to instruct the Services Control panel applet on how to search for Maya inside the filesystem. It returns the MTemplateAPI.kTemplateScanModule to tell Muster that it must search for a specific module inside the file system. Alternatively, it can report kTemplateScanNone to avoid application scanning, or kTemplateScanClass to use the template onFindApplication() function.

def onFindApplication(self, basePath, clientTemplatePreferences):
	basePath.setString("/usr/local/bin/myrender")
	return 1

The previous code sample directly sets the path to the render engine without performing a file system scan.

def onModuleFound(self,moduleExec,modulePath,clientTemplatePreferences):
	platform = MClientAPI.GetPlatform()
	basePath = modulePath.getString()
	if platform == MClientAPI.kPlatformWindows:
		clientTemplatePreferences["MAYAEXECUTABLE"] = basePath + "\\Render.exe"
	elif platform == MClientAPI.kPlatformOSX:
		clientTemplatePreferences["MAYAEXECUTABLE"] = basePath + "/Render"
	elif platform == MClientAPI.kPlatformLinux:
		clientTemplatePreferences["MAYAEXECUTABLE"] = basePath + "/Render"
 
	clientTemplatePreferences["MAYASTARTINGFOLDER"] = basePath
	return 1

The previous code sample is used inside the Maya template to setup the client preferences with the values reported back by the application filesystem scan.

def onGetSlicesInputFilename(self, job, chunk):
	imgFile = job.attributeGetString("output_folder")
	imgFile += os.sep + "Muster_sf_" + '%d' % job.getJobId() + "_" + '%d' % chunk.getChunkId() + "." + job.attributeGetString("source_file_format") + '.%d' % int(job.attributeGetString("start_frame")) 
	return imgFile

The previous code sample is used inside the Maya template to tell Muster the slices filenames and path.

def onGetSlicesOutputFilename(self, job, chunk):
	imgFile = job.attributeGetString("output_folder")
	imgFile += os.sep + "final" + "_" + '%d' % job.getJobId() + "." + job.attributeGetString("destination_file_format")
	return imgFile

The previous code sample is used inside the Maya template to tell Muster the output assembled image filename and path.

def onGetSliceBoundaries(self, job, chunk, refBoundaries):
	final_x_res = int(job.attributeGetString("x_res"))
	final_y_res = int(job.attributeGetString("y_res"))
	as_overlap = int(job.attributeGetString("as_overlap"))
	num_slices = job.getPacketSize()
	sliceWidth = int(final_x_res / num_slices);
	sliceNumber = chunk.getChunkId()
	sliceEffectiveWidth = sliceWidth + as_overlap
	if (sliceNumber == num_slices):
		sliceEffectiveWidth = final_x_res - (sliceWidth * (sliceNumber - 1))
 
	refBoundaries.setSliceFrameResolutionX(sliceEffectiveWidth);
	refBoundaries.setSliceFrameResolutionY(final_y_res);
	refBoundaries.setSliceSamplesOriginX(0);
	refBoundaries.setSliceSamplesOriginY(0);
	refBoundaries.setSliceWidth(sliceWidth);
	refBoundaries.setSliceHeight(final_y_res);
	refBoundaries.setFinalPositionX(sliceWidth * (sliceNumber-1));
	refBoundaries.setFinalPositionY(0);

The previous code sample is used inside the Maya template to tell Muster how to expect the slices.

def onStartProcess(self, job, chunk, instanceNum, runningProcessPid):

…

def onTerminateProcess(self, job, chunk, process, instanceNum):

…

def onCollectProcessOutput(self, mainProcess, runningProcess, instanceNum output):

def onChangeProcessPriority(self, job, chunk, process, priority instanceNum):

…

def onCheckProcessTermination(self, job, priority instanceNum):

…

def onValidateJobSubmission(self, job, err):
	return 1

The function is invoked when a job requires validation before the submission. This is fired from the Console and/or mrtool before a job submission.

def onClientIdling():
      ''' Do your stuff '''
      pass

The function is invoked by the Renderclient on a certain basis to perform background tasks. Be as fast as possible because the function is called inline when the client core activities and you may stall it.

def onCheckClientAvailability():
      ''' Do your stuff '''
      return MTemplateAPI.kTemplateFunctionDoDefault

The function is invoked by the Renderclient to check if it's available for rendering.

def onInstanceOverrideImpersonationUser(self,job,chunk,clientTemplatePreferences,usernameOut,passwordOut):
	usernameOut.setString("John");
        passwordOut.setString("Johnpassword")
        return MTemplateAPI.kTemplateFunctionSuccess

The function is invoked when a client is about to start a process. May be used to change the impersonation user on a template basis.

def onDispatcherIdling():
      ''' Do your stuff '''
      pass

The function is invoked by the Dispatcher on a certain basis to perform background tasks. Be as fast as possible because the function is called inline when the client core activities and you may stall it.

def onDispatcherOverrideImpersonationUser(self,job,chunk,usernameOut,passwordOut):
	usernameOut.setString("John");
        passwordOut.setString("Johnpassword")
        return MTemplateAPI.kTemplateFunctionSuccess

The function is invoked when a client is about to start a process. May be used to change the impersonation user on a template basis.

def onDispatcherOverrideFlagJobsAsArchived(self,job):
        ''' Check parameters on the job, and return according, in this case, we skip the auto flagging '''
	return MTemplateAPI.kTemplateFunctionFailed

The function is invoked before a job is automatically flagged as archive. It can be used to change the behaviour

def onDispatcherOverrideDeleteArchivedJobs(self,job):
        ''' Check parameters on the job, and return according, in this case, we skip the auto flagging '''
	return MTemplateAPI.kTemplateFunctionFailed

The function is invoked before an archived job is automatically deleted . It can be used to change the behaviour

def onDispatcherOverrideBackupJob(self,job):
        ''' Check parameters on the job, and return according, in this case, we skip the auto backup '''
	return MTemplateAPI.kTemplateFunctionFailed

The function is invoked before a job is automatically backed up . It can be used to change the behaviour

def onPrepareTasks(self,job,tasks):
	''' The following code disables a task depending on the job settings, dependancies are automatically cleared '''
	for item in tasks:
		if item.getName() == "Files validation" and not job.attributeGetBool("ENABLEFILEVALIDATION"): 
			item.setEnabled(False)
		elif item.getName() == "Frames Render 2nd pass" and not job.attributeGetBool("ENABLEPASS2"): 
			item.setEnabled(False)
		elif item.getName() == "Compress files" and not job.attributeGetBool("ENABLECOMPRESS"): 
			item.setEnabled(False)

The purpose of the function is to enable or disable and relink tasks depending on the job settings.

def onClientConnected(self, node):
	pass

The function is invoked when a node establish a connection. This is fired from the Dispatcher, be as fast as possible to avoid stalling the networking thread.

def onClientDisconnected(self, node):
	pass

The function is invoked when a node disconnects. This is fired from the Dispatcher, be as fast as possible to avoid stalling the networking thread.

def onClientDisconnectedByHeartbeath(self, node):
	pass

The function is invoked when a node is disconnected by the Dispatcher for an heartbeat failure. This is fired from the Dispatcher, be as fast as possible to avoid stalling the networking thread.

def onClientStatusChanged(self, node):
	pass

The function is invoked when a node status changes. This is fired from the Dispatcher, be as fast as possible to avoid stalling the networking thread.

def onPauseJob(self,job):
	pass

The function is invoked when a job is paused. This is fired from the Dispatcher, be as fast as possible to avoid stalling the networking thread.

def onResumeJob(self,job):
	pass

The function is invoked when a job is resumed. This is fired from the Dispatcher, be as fast as possible to avoid stalling the networking thread.

def onDeleteJob(self,job):
	pass

The function is invoked when a job is deleted. This is fired from the Dispatcher, be as fast as possible to avoid stalling the networking thread.

def onSubmitJob(self, job):
	pass

The function is invoked when a job is submitted in the queue. This is fired from the Dispatcher, be as fast as possible to avoid stalling the networking thread.

def onReinitJob(self,job):
	pass

The function is invoked when a job is reset. This is fired from the Dispatcher, be as fast as possible to avoid stalling the networking thread.

def onEditJob(self,job):
	pass

The function is invoked when a job is edited. This is fired from the Dispatcher, be as fast as possible to avoid stalling the networking thread.

def onJobPropertiesChanged(self,job):
	pass

The function is invoked when any of the job parameter is changed live. This is fired from the Dispatcher, be as fast as possible to avoid stalling the networking thread.

def onJobStart(self,job):
	return MTemplateAPI.MTemplateError()

The function is invoked when the job is started. This is fired from the Dispatcher in a new thread, you can take your time inside the function.

def onJobEnd(self,job):
	return MTemplateAPI.MTemplateError()

The function is invoked when the job completed its chunks. This is fired form the Dispatcher in a new thread, you can take your time inside the function.

def onJobCompleted(self,job):
	pass

The function is invoked when the job is effectively completed and all its data are updated. This is fired form the Dispatcher in a new thread, you can take your time inside the function.

def onChunkStart(self, job, chunk,clientTemplatePreferences,instanceNum):
	return MTemplateAPI.MTemplateError()

The function is invoked when a chunk is started. This is fired from the Render client, you should be as fast as possible to avoid a rendering start timeout.

def onChunkEnd(self, job, chunk,clientTemplatePreferences,instanceNum):
	return MTemplateAPI.MTemplateError()

The function is invoked when a chunk is started. This is fired from the Render client, you should be as fast as possible to avoid stalling the client.

def onChunkSubmitted(self, job, chunk,instanceId):
	return MTemplateAPI.MTemplateError()

The function is invoked when a chunk is submitted. This is fired from the Dispatcher, you should be as fast as possible to avoid stalling it.

def onChunkCompleted(self, job, chunk,instanceId):
	return MTemplateAPI.MTemplateError()

The function is invoked when a chunk is completed. This is fired from the Dispatcher, you should be as fast as possible to avoid stalling it.

def onChunkRequeued(self, job, chunk):
	return MTemplateAPI.MTemplateError()

The function is invoked when a chunk is requeued. This is fired from the Dispatcher, you should be as fast as possible to avoid stalling it.

def onCustomNodeMessage(self, instanceId, message):
	print(message);

The function is invoked when an instance sends a custom message.

def onCustomConsoleMessage(self, clientId, message):
	print(message);

The function is invoked when a console sends a custom message. Available 9.0.13+

def onCustomNotificatorMessage(self, clientId, message):
	print(message);

The function is invoked when a notificator sends a custom message. Available 9.0.13+

def onCustomDispatcherMessageToConsole(self, message):
	print(message);

The function is invoked when the Dispatcher sends a custom message to Console. Available 9.0.13+

def onCustomDispatcherMessageToConsole(self, instanceId, message):
	print(message);

The function is invoked when the Dispatcher sends a custom message to a node. Available 9.0.13+

def onCustomDispatcherMessageToNotificator(self, message):
	print(message);

The function is invoked when the Dispatcher sends a custom message to a notificator connection. Available 9.0.13+

def onValidateJobDependancies(self, job):
    return MTemplateAPI.kTemplateFunctionFailed # Job is not valid
    return MTemplateAPI.kTemplateFunctionSuccess # Job is valid
    return MTemplateAPI.kTemplateFunctionDoDefault # Perform the default check

The function is invoked by the Dispatcher to check if a job is valid for submission.

def onValidateJobDependancies(self, chunk):
    return MTemplateAPI.kTemplateFunctionFailed # Chunk is not valid
    return MTemplateAPI.kTemplateFunctionSuccess # Chunk is valid
    return MTemplateAPI.kTemplateFunctionDoDefault # Perform the default check

The function is invoked by the Dispatcher to check if a chunk is valid for submission.

def loadMailingCss(self):
		# Source the css from the installation path 
 
		normalizeCss = mailingCss = ""
		normalizeCssPath = os.path.join(MClientAPI.GetLibraryPath(),"htdocs","css","normalize.css")
		mailingCssPath = os.path.join(MClientAPI.GetLibraryPath(),"htdocs","css","mailing.css")
 
		with open(normalizeCssPath, 'r') as normalizeFile:
			normalizeCss=normalizeFile.read()
 
		with open(mailingCssPath, 'r') as mailingFile:
			mailingCss=mailingFile.read()
 
		return normalizeCss + mailingCss
 
	def makeFooter(self):
		out = "<div class='footer'></div><div><img  class='footerLogo' src='https://www.vvertex.com/external/vvertex.png'></div>"
		return out
 
	def makeHeader(self):
		out = "<h1><img class='headerLogo' src='https://www.vvertex.com/external/logo.png'>"
		out += "Muster notification</h1>"
		return out
 
	def onMailConfigurationsChanged(self,message,subjectOut, htmlOut,plainOut):
		css = self.loadMailingCss()
 
		out = "<html><head><title>Muster - Configurations changed</title>"
		out +="<style>" +  css+ "</style></head>"	
		out += "<body>"
		out += self.makeHeader()
		out += "<p>"
		out += message
		out += "</p>"
		out += self.makeFooter()
		out += "</body></html>"
		htmlOut.setString(out)
 
		out = "Muster - Configurations changed"
		subjectOut.setString(out)
 
		return True
 
	def onMailSoftRestarts(self,message,subjectOut, htmlOut,plainOut):
		css = self.loadMailingCss()
 
		out = "<html><head><title>Muster -Soft restart event</title>"
		out +="<style>" +  css+ "</style></head>"	
		out += "<body>"
		out += self.makeHeader()
		out += "<p>"
		out += message
		out += "</p>"
		out += self.makeFooter()
		out += "</body></html>"
		htmlOut.setString(out)
 
		out = "Muster - Soft restart event"
		subjectOut.setString(out)
 
		return True
 
	def onMailEngineStatus(self,state,subjectOut, htmlOut,plainOut):
		css = self.loadMailingCss()
 
		out = "<html><head><title>Muster - Dispatcher engine status change</title>"
		out +="<style>" +  css+ "</style></head>"	
		out += "<body>"
		out += self.makeHeader()
		out += "<p>"
		if state:
			out += "Dispatcher selection engine changed to active state!"
		else:
			out += "Dispatcher selection engine changed to disabled state!"
		out += "</p>"
		out += self.makeFooter()
		out += "</body></html>"
		htmlOut.setString(out)
 
		if (state):
			out = "Muster -  Dispatcher selection engine changed to active state!"
		else:
			out = "Muster -  Dispatcher selection engine changed to disabled state!"
		subjectOut.setString(out)
 
		return True
 
	def onMailExclusionListEvent(self,message,subjectOut, htmlOut,plainOut):
		css = self.loadMailingCss()
 
		out = "<html><head><title>Muster - Exclusion lists event</title>"
		out +="<style>" +  css+ "</style></head>"	
		out += "<body>"
		out += self.makeHeader()
		out += "<p>"
		out += message
		out += "</p>"
		out += self.makeFooter()
		out += "</body></html>"
		htmlOut.setString(out)
 
		out = "Muster -  Exclusion lists event"
		subjectOut.setString(out)
 
		return True
 
	def onMailJobStart(self,job,subjectOut, htmlOut,plainOut):
		css = self.loadMailingCss()
		statusText = "successfully"
		statusImage = "https://www.vvertex.com/external/completed.png"
 
		out = "<html><head><title>Muster - Processing of job " + job.getName() + "(" + str(job.getJobId()) + ")" + " started</title>"
		out +="<style>" +  css+ "</style></head>"	
		out += "<body>"
		out += self.makeHeader()
		out += "<p>"
		out += "<img class='headerLogo' src='" + statusImage + "'>"
		out += "Job " + job.getName() + "(" + str(job.getJobId()) + ") started on " 
		out += time.ctime(job.getStartTime())
		out += "."
		out += "</p>"
		out += self.makeFooter()
		out += "</body></html>"
		htmlOut.setString(out)
 
		out = "Muster - Job " + job.getName() + "(" + str(job.getJobId()) + ") started processing"
		subjectOut.setString(out)
 
		return True
 
	def onMailChunkStart(self,job,chunk,node,subjectOut, htmlOut,plainOut):
			# Source the css from the installation path 
		css = self.loadMailingCss()
		statusText = "successfully"
		statusImage = "https://www.vvertex.com/external/completed.png"
 
		out = "<html><head><title>Muster - Processing of chunk " + str(chunk.getChunkId()) + " of job " + job.getName() + "(" + str(job.getJobId()) + ")" + " started by " + node.getInstanceName() + "(" + str(node.getNodeId()) + ")</title>"
		out +="<style>" +  css+ "</style></head>"	
		out += "<body>"
		out += self.makeHeader()
		out += "<p>"
		out += "<img class='headerLogo' src='" + statusImage + "'>"
		out += "Chunk " + str(chunk.getChunkId()) + " of job " + job.getName() + "(" + str(job.getJobId()) + ") started on " 
		out += time.ctime(chunk.getStartTime())
		out += " by " + node.getInstanceName() + "(" + str(node.getNodeId()) + ")."
		out += "</p>"
		out += self.makeFooter()
		out += "</body></html>"
		htmlOut.setString(out)
 
		out = "Muster - ";
		out += "Chunk " + str(chunk.getChunkId()) + " of job " + job.getName() + "(" + str(job.getJobId()) + ")" + " started processing by " + node.getInstanceName() + "(" + str(node.getNodeId()) + ")"
		subjectOut.setString(out)
 
		return True
 
	def onMailJobCompleted(self, job, framesHaveBeenRequeued, subjectOut, htmlOut,plainOut):
		 # Source the css from the installation path 
		css = self.loadMailingCss()
		statusText = "successfully"
		statusImage = "https://www.vvertex.com/external/completed.png"
 
		if job.getStatus() == MClientAPI.MJob.kJobStatusCompletedWithWarnings:
			statusText = " with warnings"
			statusImage = "https://www.vvertex.com/external/completedw.png"
		elif job.getStatus() == MClientAPI.MJob.kJobStatusCompletedWithErrors:
			statusText = " with errors"
			statusImage = "https://www.vvertex.com/external/completede.png"
 
		out = "<html><head><title>Muster - Processing of job " + job.getName() + "(" + str(job.getJobId()) + ")" + " completed</title>"
		out +="<style>" +  css+ "</style></head>"	
		out += "<body>"
		out += self.makeHeader()
		out += "<p>"
		out += "<img class='headerLogo' src='" + statusImage + "'>"
		out += "Job " + job.getName() + "(" + str(job.getJobId()) + ") started on " 
		out += time.ctime(job.getStartTime())
		out += " completed "
		out += statusText
		out += " on " 
		out += time.ctime(job.getEndTime())
		out += ". Job processing toke " + job.getTotalTime() + "."
		out += "</p>"
		if framesHaveBeenRequeued:
			out += "<p>Automatic frames check reported rescheduled missing frames!</p>"
		out += self.makeFooter()
		out += "</body></html>"
		htmlOut.setString(out)
 
		out = "Muster - Job " + job.getName() + "(" + str(job.getJobId()) + ") completed"
		if job.getStatus() == MClientAPI.MJob.kJobStatusCompletedWithWarnings: out += " with warnings!"
		elif job.getStatus() == MClientAPI.MJob.kJobStatusCompletedWithErrors: out += " with errors!"
		subjectOut.setString(out)
 
		return True
 
	def onMailChunkCompleted(self, job, chunk, node,chunkHasBeenRequeued,chunkHasMissingFrames, subjectOut,htmlOut,plainOut):
		# Source the css from the installation path 
		css = self.loadMailingCss()
		statusText = "successfully"
		statusImage = "https://www.vvertex.com/external/completed.png"
 
		if chunk.getStatus() == MClientAPI.MChunk.kChunkStatusWarning:
			statusText = " with warnings"
			statusImage = "https://www.vvertex.com/external/completedw.png"
		elif chunk.getStatus() == MClientAPI.MChunk.kChunkStatusError:
			statusText = " with errors"
			statusImage = "https://www.vvertex.com/external/completede.png"
 
		out = "<html><head><title>Muster - Processing of chunk " + str(chunk.getChunkId()) + " of job " + job.getName() + "(" + str(job.getJobId()) + ")" + " completed by " + node.getInstanceName() + "(" + str(node.getNodeId()) + ")</title>"
		out +="<style>" +  css+ "</style></head>"	
		out += "<body>"
		out += self.makeHeader()
		out += "<p>"
		out += "<img class='headerLogo' src='" + statusImage + "'>"
		out += "Chunk " + str(chunk.getChunkId()) + " of job " + job.getName() + "(" + str(job.getJobId()) + ") started on " 
		out += time.ctime(chunk.getStartTime())
		out += " completed "
		out += statusText
		out += " on "
		out += time.ctime(chunk.getEndTime())
		out += " by " + node.getInstanceName() + "(" + str(node.getNodeId()) + "). Chunk processing toke " + str(chunk.getElapsed()) + " seconds to complete."
		out += "</p>"
		if chunkHasMissingFrames:
			out += "<p>Chunk has been automatically requeued due to missing frames!</p>"
		elif chunkHasBeenRequeued:
			out += "<p>Chunk has been automatically requeued due to settings!</p>"
		out += self.makeFooter()
		out += "</body></html>"
		htmlOut.setString(out)
 
		out = "Muster - ";
		if chunkHasMissingFrames or chunkHasBeenRequeued:
			out += "(Requeued)"
		out += "Chunk " + str(chunk.getChunkId()) + " of job " + job.getName() + "(" + str(job.getJobId()) + ")" + " completed by " + node.getInstanceName() + "(" + str(node.getNodeId()) + ")"
		if chunk.getStatus() == MClientAPI.MChunk.kChunkStatusWarning: out += " with warnings!"
		elif chunk.getStatus() == MClientAPI.MChunk.kChunkStatusError: out += " with errors!"
		subjectOut.setString(out)
 
		return True
 
	def onMailSendLogs(self, logs, subjectOut,htmlOut,plainOut):
		numOfLogs = len(logs)
		if numOfLogs > 2:
			oldestLog = logs[0]
			newestLog = logs[numOfLogs-1]
 
			collectionStartTime = oldestLog.getTime()
			collectionEndTime = newestLog.getTime()
 
			subject = "Muster - Dump of logs between " + time.ctime(collectionStartTime) + " and " + time.ctime(collectionEndTime)
			subjectOut.setString(subject)
 
			# Source the css from the installation path 
			css = self.loadMailingCss()
 
			html = "<html><head><title>Muster - Dump of logs between " + time.ctime(collectionStartTime) + " and " + time.ctime(collectionEndTime)
			html += "</title>";
			html +="<style>" +  css+ "</style></head>"	
			html += "<body>"
			html += "<h1><img class='headerLogo' src='https://www.vvertex.com/external/logo.png'>Muster - Dump of logs between " + time.ctime(collectionStartTime) + " and " + time.ctime(collectionEndTime) + " </h1><table class='logTable'>"
			html += "<tr class='logTableHeader'><td>Time</td><td>Description</td><td>User</td><td>IP</td><td>Host</td></tr>"
			for item in logs:
				cssclass = "logRowSourceSystem"
				if (item.getType() == MClientAPI.MLog.kLogSourceSystem): cssclass = "logRowSourceSystem"
				elif   (item.getType() == MClientAPI.MLog.kLogSourceUser): cssclass = "logRowSoucerUser"
				elif  (item.getType() == MClientAPI.MLog.kLogSourceInstanceWithSuccess): cssclass = "logRowInstanceSuccess"
				elif   (item.getType() == MClientAPI.MLog.kLogSourceInstanceWithFailure): cssclass = "logRowInstanceFailure"
 
				html += "<tr class='" + cssclass + "'>"
				html +="<td>" + time.ctime(item.getTime()) + "</td>"
				html +="<td>" + item.getDescription() + "</td>"
				html +="<td>" + item.getUser() + "</td>"
				html +="<td>" + item.getSourceIp() + "</td>"
				html +="<td>" + item.getSourceHost() + "</td>"
				html += "</tr>"
			html += "</table>"
			html += self.makeFooter()
			html += "</body></html>"
			htmlOut.setString(html)
 
		return True

The function is invoked by the Dispatcher to check if a chunk is valid for submission.