system.mes.batch.phase.exportPhase(phaseLink)

Sepasoft MES Module Suite

system.mes.batch.phase.exportPhase(phaseLink)

Export a Batch Procedure phase. See Parameter Properties to understand xml nodes.

exportPhase(phaseLink) → String

Syntax

exportPhase(phaseLink)

Parameters

MESObjectLink phaseLink - The link of the batch phase to export.

Returns

XML list of BatchPhase objects.

Scope

All

Code Examples

Code Snippet

Copy Code

Code

phaseName = 'myDocument'

#Get the phase type link - see Base Phase in Online Help for a list of types.
defaultPhaseLink = system.mes.batch.phase.getPhaseLink('Document')

#Give the Phase Class a name and get the link
phaseClassName = 'Custom Phases'
phaseClassLink = system.mes.batch.phase.getClassLink(phaseClassName)

#Create the phase and export as XML
phase = system.mes.batch.phase.createPhase(phaseName, defaultPhaseLink, phaseClassLink)
print system.mes.batch.phase.exportPhase(phase.asLink())

Output

Copy Code

Code

<?xml version='1.0' encoding='UTF-8'?>
<MESObjectList>
	<MESObject MESObjectType="BatchPhase">
		<CoreProperty name="UUID">36edf263-0a78-4697-bbf5-bf273e875636</CoreProperty>
		<CoreProperty name="Name">myDocument6</CoreProperty>
		<CoreProperty name="Enabled">true</CoreProperty>
		<CoreProperty name="Creator">Unknown</CoreProperty>
		<CoreProperty name="Phase Type">4</CoreProperty>
		<CoreProperty name="Phase Expose">false</CoreProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Begin_Date_Time" uuid="d8aa44a9-6e9c-44ac-a345-53ac8cb896c3">
			<ComplexMember name="ParamUUID">27467e68-6a13-4265-82b6-005d4dbcfb3d</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Begin_Date_Time</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">4</ComplexMember>
			<ComplexMember name="ParamDataType">Date</ComplexMember>
			<ComplexMember name="ParameterValueSource">7</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Command" uuid="a364ce83-700b-4432-a610-5fc16a42e879">
			<ComplexMember name="ParamUUID">3f72ec83-e3f5-46a9-89aa-e19419170962</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Command</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">4</ComplexMember>
			<ComplexMember name="ParamDataType">String</ComplexMember>
			<ComplexMember name="ParameterValueSource">7</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Command_Number" uuid="b228ebf2-92a2-4d9e-975e-a537cd3ce61e">
			<ComplexMember name="ParamUUID">0a55e0bd-6488-43f0-a1cf-8e201fb93888</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Command_Number</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">1</ComplexMember>
			<ComplexMember name="ParamDataType">Integer</ComplexMember>
			<ComplexMember name="ParameterValueSource">4</ComplexMember>
			<ComplexMember name="ParamValue">0</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Complete" uuid="40c3e9f3-5392-4cb5-842d-e8ac7ac827fb">
			<ComplexMember name="ParamUUID">b086dd47-3cf2-4d60-af90-dd361c0ef783</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Complete</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">4</ComplexMember>
			<ComplexMember name="ParamDataType">Boolean</ComplexMember>
			<ComplexMember name="ParameterValueSource">7</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Document_Name" uuid="98b6996e-f01c-47e7-b682-47a0d860bbb1">
			<ComplexMember name="ParamUUID">3e65ce84-fa87-4bd5-b283-dbf6555be1ad</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Document_Name</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">4</ComplexMember>
			<ComplexMember name="ParamDataType">String</ComplexMember>
			<ComplexMember name="ParameterValueSource">2</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Duration" uuid="fbd71bf5-f22e-46f2-8b75-d5f57f212b58">
			<ComplexMember name="ParamUUID">2ff55e20-cc28-4536-93c2-4d7eebc907d0</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Duration</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">5</ComplexMember>
			<ComplexMember name="ParamDataType">Long</ComplexMember>
			<ComplexMember name="ParameterValueSource">7</ComplexMember>
			<ComplexMember name="ParamValue">0</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="End_Date_Time" uuid="697b3194-4f80-405a-8a99-41afe8d3f1cc">
			<ComplexMember name="ParamUUID">26dd2915-4f76-4460-aadd-fde4b6213a44</ComplexMember>
			<ComplexMember name="ParamFriendlyName">End_Date_Time</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">4</ComplexMember>
			<ComplexMember name="ParamDataType">Date</ComplexMember>
			<ComplexMember name="ParameterValueSource">7</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Execute_Count" uuid="ac9c5a4f-e2eb-42b0-a8eb-46e6352d15d9">
			<ComplexMember name="ParamUUID">33f3be3c-7409-48a7-8765-791709e0f644</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Execute_Count</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">4</ComplexMember>
			<ComplexMember name="ParamDataType">Long</ComplexMember>
			<ComplexMember name="ParameterValueSource">7</ComplexMember>
			<ComplexMember name="ParamValue">0</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Manually_Executed" uuid="8fd8976c-e6a7-4d72-958d-687a5a2f828e">
			<ComplexMember name="ParamUUID">99cef05c-773d-4382-a996-478a732f5f75</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Manually_Executed</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">3</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">3</ComplexMember>
			<ComplexMember name="ParamDataType">Boolean</ComplexMember>
			<ComplexMember name="ParameterValueSource">7</ComplexMember>
			<ComplexMember name="ParamValue">false</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Mode" uuid="45a9b5b2-1680-484f-9a9d-33da1fea4f43">
			<ComplexMember name="ParamUUID">66a68252-7e67-4b5e-a7e5-3ab1c92b836a</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Mode</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">1</ComplexMember>
			<ComplexMember name="ParamDataType">String</ComplexMember>
			<ComplexMember name="ParameterValueSource">7</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Phase_Exception" uuid="b17481f0-60e3-4139-85a8-603da1679e1c">
			<ComplexMember name="ParamUUID">88056446-5177-4bc5-94da-a914be5dceb1</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Phase_Exception</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">2</ComplexMember>
			<ComplexMember name="ParamDataType">String</ComplexMember>
			<ComplexMember name="ParameterValueSource">4</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Propagate_Hold_To_Parent" uuid="2b72dc6f-47b4-485f-bd51-3b9dcfff31ce">
			<ComplexMember name="ParamUUID">266371f6-b859-494b-99f9-6307422c7237</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Propagate_Hold_To_Parent</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">1</ComplexMember>
			<ComplexMember name="ParamDataType">Boolean</ComplexMember>
			<ComplexMember name="ParameterValueSource">2</ComplexMember>
			<ComplexMember name="ParamValue">true</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="State" uuid="1b0d771e-6f05-4fa6-937e-8b2afb5c7695">
			<ComplexMember name="ParamUUID">c50b6384-71bd-4769-ade9-29940430569a</ComplexMember>
			<ComplexMember name="ParamFriendlyName">State</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">4</ComplexMember>
			<ComplexMember name="ParamDataType">String</ComplexMember>
			<ComplexMember name="ParameterValueSource">7</ComplexMember>
			<ComplexMember name="ParamValue">b472d04a-6e84-4224-a089-36cdc5baf0ce</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="State_Number" uuid="5c234826-ee14-41e0-83f6-9a82a0ba859f">
			<ComplexMember name="ParamUUID">9833f897-b080-442d-94cb-5cc9fffda1b2</ComplexMember>
			<ComplexMember name="ParamFriendlyName">State_Number</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">1</ComplexMember>
			<ComplexMember name="ParamDataType">Integer</ComplexMember>
			<ComplexMember name="ParameterValueSource">4</ComplexMember>
			<ComplexMember name="ParamValue">1</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Step_Active" uuid="8224b62e-931c-4040-bdee-bfe5a3070e52">
			<ComplexMember name="ParamUUID">1ec8f390-80f8-4d5e-952e-f9f228a50f93</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Step_Active</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">3</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">3</ComplexMember>
			<ComplexMember name="ParamDataType">Boolean</ComplexMember>
			<ComplexMember name="ParameterValueSource">7</ComplexMember>
			<ComplexMember name="ParamValue">false</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Step_Name" uuid="8fec4710-81b6-43fe-a8ac-4b63fdc516e3">
			<ComplexMember name="ParamUUID">56c42b01-2cd2-490a-8827-c4fb13bf0134</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Step_Name</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">2</ComplexMember>
			<ComplexMember name="ParamDataType">String</ComplexMember>
			<ComplexMember name="ParameterValueSource">7</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Step_Sequence" uuid="99851e64-f543-489b-8fa8-3bbd05035999">
			<ComplexMember name="ParamUUID">719e209c-db3f-4a8d-853c-3334c63d3845</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Step_Sequence</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">1</ComplexMember>
			<ComplexMember name="ParamDataType">Integer</ComplexMember>
			<ComplexMember name="ParameterValueSource">7</ComplexMember>
			<ComplexMember name="ParamValue">0</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
		<ComplexProperty kind="BatchPhaseParameters" name="Unit_Path" uuid="eb93f857-1418-4ef6-b43a-d7121a9554d7">
			<ComplexMember name="ParamUUID">3e5bba34-cbc0-4fea-a615-2bbf435869ee</ComplexMember>
			<ComplexMember name="ParamFriendlyName">Unit_Path</ComplexMember>
			<ComplexMember name="ParamImmutable">true</ComplexMember>
			<ComplexMember name="ParamKind">6</ComplexMember>
			<ComplexMember name="ParamTagType">0</ComplexMember>
			<ComplexMember name="ParamRecordingType">2</ComplexMember>
			<ComplexMember name="ParamDataType">String</ComplexMember>
			<ComplexMember name="ParameterValueSource">7</ComplexMember>
			<ComplexMember name="ParamSortOrder">2000000000</ComplexMember>
		</ComplexProperty>
	</MESObject>
</MESObjectList>

Sepasoft MES Module Suite