system.mes.batch.queue.getStepDocument(batchID, documentStepPath)

Sepasoft MES Module Suite

system.mes.batch.queue.getStepDocument(batchID, documentStepPath)

Returns the document HTML content. This function can be used to retrieve documents for batches in every state within the batch queue lifecycle, from Idle to Complete, as well as for batches out of the batch queue.

Version Specific

Available in Batch Procedure version 3.81.7 RC2 and later.

getStepDocument(batchID, documentStepPath) → HTML document(s)

Syntax

getStepDocument(batchID, documentStepPath)

Parameters

• • batchID: String

The batch ID containing the document to return.

• • documentStepPath: String

The path to the step of the document phase. The format of the path must follow the /Procedure/Unit Procedure/Operation:Step pattern. Example: /Make Cookies/Mix:Add Instructions

Returns

 Document HTML

Scope

All

Scripting Example

doc = system.mes.batch.queue.getStepDocument('BatchID-01', '/RecipeName:StepName')
print(doc)

Output

<div>
	<p>
		This is a document with parameters.
		<br><br>
		String
		 
		<input type="text" name="Param_String" value="">
		 
		<br><br>
		Integer 
		<input type="number" name="Param_Int" value="">
		 
	</p>
</div>

Example document HTML output with values:

Output

<div>
	<p>
		This is a document with parameters.
		<br><br>
		String 
		<input type="text" name="Param_String" value="Test String">
		 
		<br><br>
		Integer 
		<input type="number" name="Param_Int" value="12.5">
		 
	</p>
</div>

Sepasoft MES Module Suite