Package com.ptc.windchill.mpml.processplan

Class LoadProcessPlan

java.lang.Object

com.ptc.windchill.mpml.processplan.LoadProcessPlan

public class LoadProcessPlan
extends Object

Creates and persists MPMProcessPlan objects based on input from a XML file Method names and parameters are defined in csvmapfile.txt.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
static boolean	beginPartToProcessPlanLink(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvBeginPartToProcessPlanLink" directive in the XML load file.
static boolean	beginProcessPlan(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvBeginProcessPlan" directive in the XML load file.
static boolean	beginStandardProcedureLink(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvBeginStandardProcedureLink" directive in the XML load file.
static boolean	createPartToProcessPlanLink(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvCreatePartToProcessPlanLink" directive in the XML load file.
static boolean	createProcessPlan(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvCreateProcessPlan" directive in the XML load file.
static boolean	createProcessPlanRepresentation(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "createProcessPlanRepresentation" directive in the csv load file.
static boolean	createStandardProcedureLink(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvCreateStandardProcedureLink" directive in the XML load file.
static boolean	endPartToProcessPlanLink(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvEndPartToProcessPlanLink" directive in the csv load file.
static boolean	endProcessPlan(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvEndProcessPlan" directive in the csv load file.
static boolean	endStandardProcedureLink(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Processes the "csvEndStandardProcedureLink" directive in the csv load file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

beginProcessPlan

public static boolean beginProcessPlan(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvBeginProcessPlan" directive in the XML load file. This format CAN add Soft Attributes(IBA). For more info on the csvformat and other information see createProcessPlan.

XML Format

<csvbeginProcessPlan handler="com.ptc.windchill.mpml.processplan.LoadProcessPlan.beginProcessPlan" >
</csvbeginProcessPlan >
<csvIBAValue handler="wt.iba.value.service.LoadValue.createIBAValue" >
	...
</csvIBAValue >
<csvEndProcessPlan handler="com.ptc.windchill.mpml.processplan.LoadProcessPlan.endProcessPlan" >
	...
</csvEndProcessPlan >

Supported API: true

endProcessPlan

public static boolean endProcessPlan(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvEndProcessPlan" directive in the csv load file. Causes the cached part to be checked-out, associates soft attribues from preceding IBAValue load file lines with the processplan, applies the default attribute values associated with the specified type definition, persists the object, checks it back in, and caches it in the loader's memory.

XML Format

<csvEndProcessPlan handler="com.ptc.windchill.mpml.processplan.LoadProcessPlan.endProcessPlan" >

</csvEndProcessPlan >

Tag Definitions

Supported API: true

See Also:

• beginProcessPlan(java.util.Hashtable, java.util.Hashtable, java.util.Vector)

createProcessPlan

public static boolean createProcessPlan(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvCreateProcessPlan" directive in the XML load file. Creates a processplan object, persists it in the database, checks it out, applies the default attribute values associated with the specified type definition, persists the processplan, checks it back in, and caches it in the loader's memory.

If a processplan with this number already exists, the processplan is looked up and a new iteration of the latest revision is created, unless the revision/iteration are specified using attributes in the the load file.

This format cannot add Soft Attributes(IBA). For that see beginProcessPlan.

When using wt.load.LoadFromFile to load processplans, use the following XML format:

XML Format (only processplan specific ones are described, rest are same as for part)

<csvCreateProcessPlan handler="com.ptc.windchill.mpml.processplan.LoadProcessPlan.createProcessPlan" >
	<csvuser>	created by user	</csvuser>
	<csvname>	name of processplan	</csvname>
	<csvnumber>	unique number	</csvnumber>
	<csvdefaultUnit>	default Unit	</csvdefaultUnit>
	<csvcategory>	category	</csvcategory>
	<csvStandardProcessPlan>	standard	</csvStandardProcessPlan>
	<csvfolder>	folder	</csvfolder>
	<csvlifecycle>	lifecycle	</csvlifecycle>
	<csvview>	view	</csvview>
	<csvteamTemplate>	team template	</csvteamTemplate>
	<csvlifecyclestate>	lifecycle state	</csvlifecyclestate>
	<csvtypedef>	typedef	</csvtypedef>
	<csvversion>	revision	</csvversion>
	<csviteration>	iteration	</csviteration>
	<csvorganizationName>	organization name	</csvorganizationName>
	<csvorganizationID>	organization id	</csvorganizationID>
	<csvcreateTimestamp>	creation time stamp	</csvcreateTimestamp>
	<csvmodifyTimestamp>	modification time stamp	</csvmodifyTimestamp>
</csvCreateProcessPlan>

Tag Definitions

category	The category value for the processplan. Valid values is one of the below 'production', 'quality', 'maintenance', 'repair'
standard	Tells whether process plan is a regular processplan or a standard procedure Valid values are true (standard procedure), false(regular process plan)

Revisions and Iterations

This method follows the standard used by LoadPart for the revisions and iterations

Supported API: true

Parameters:

nv - Name/Value pairs of processplan attributes.

cmd_line - command line argument that can contain supplemental load data

return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.

Returns:

true	success
false	failure

beginPartToProcessPlanLink

public static boolean beginPartToProcessPlanLink(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvBeginPartToProcessPlanLink" directive in the XML load file. This format CAN add Soft Attributes(IBA). For more info on the csvformat and other information see createPartToProcessPlanLink.

XML Format

<csvBeginPartToProcessPlanLink handler="com.ptc.windchill.mpml.processplan.LoadProcessPlan.beginPartToProcessPlanLink" >
</csvBeginPartToProcessPlanLink >
<csvIBAValue handler="wt.iba.value.service.LoadValue.createIBAValue" >
	...
</csvIBAValue >
<csvEndPartToProcessPlanLink handler="com.ptc.windchill.mpml.processplan.LoadProcessPlan.endPartToProcessPlanLink" >
	...
</csvEndPartToProcessPlanLink >

Supported API: true

endPartToProcessPlanLink

public static boolean endPartToProcessPlanLink(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvEndPartToProcessPlanLink" directive in the csv load file. Causes the cached PartToProcessPlanLink to be checked-out, associates soft attribues from preceding IBAValue load file lines with the PartToProcessPlanLink, applies the default attribute values associated with the specified type definition, persists the object, checks it back in, and caches it in the loader's memory.

XML Format

<csvEndPartToProcessPlanLink handler="com.ptc.windchill.mpml.processplan.LoadProcessPlan.endPartToProcessPlanLink" >

</csvEndPartToProcessPlanLink >

Tag Definitions

Supported API: true

See Also:

• beginPartToProcessPlanLink(java.util.Hashtable, java.util.Hashtable, java.util.Vector)

createPartToProcessPlanLink

public static boolean createPartToProcessPlanLink(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvCreatePartToProcessPlanLink" directive in the XML load file. Creates a PartToProcessPlanLink object, persists it in the database, checks it out, applies the default attribute values associated with the specified type definition, persists the PartToProcessPlanLink, checks it back in, and caches it in the loader's memory.

This format cannot add Soft Attributes(IBA). For that see beginPartToProcessPlanLink.

When using wt.load.LoadFromFile to load PartToProcessPlanLink, use the following XML format:

XML Format (only PartToProcessPlanLink specific ones are described, rest are same as for part)

<csvCreatePartToProcessPlanLink handler="com.ptc.windchill.mpml.processplan.LoadProcessPlan.createPartToProcessPlanLink" >
	<csvtypedef>	typedef	</csvtypedef>
	<csvparentNumber>	Part Number	</csvparentNumber>
	<csvparentVersion>	Part Version	</csvparentVersion>
	<csvparentIteration>	Part Iteration	</csvparentIteration>
	<csvparentView>	Part View	</csvparentView>
	<csvchildNumber>	ProcessPlan Number	</csvchildNumber>
	<csvchildVersion>	ProcessPlan Version	</csvchildVersion>
	<csvchildIteration>	ProcessPlan Iteration	</csvchildIteration>
	<csvchildView>	ProcessPlan View	</csvchildView>
</csvCreatePartToProcessPlanLink>

Tag Definitions

Part Number(Mandatory)	Number of the part
ProcessPlan Number (Mandatory)	ProcessPlan number

Supported API: true

Parameters:

nv - Name/Value pairs of PartToProcessPlanLink attributes.

cmd_line - command line argument that can contain supplemental load data

return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.

Returns:

true	success
false	failure

beginStandardProcedureLink

public static boolean beginStandardProcedureLink(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvBeginStandardProcedureLink" directive in the XML load file. This format CAN add Soft Attributes(IBA). For more info on the csvformat and other information see createStandardProcedureLink.

XML Format

<csvBeginStandardProcedureLink handler="com.ptc.windchill.mpml.processplan.LoadProcessPlan.beginStandardProcedureLink" >
</csvBeginStandardProcedureLink >
<csvIBAValue handler="wt.iba.value.service.LoadValue.createIBAValue" >
	...
</csvIBAValue >
<csvEndStandardProcedureLink handler="com.ptc.windchill.mpml.processplan.LoadProcessPlan.endStandardProcedureLink" >
	...
</csvEndStandardProcedureLink >

Supported API: true

endStandardProcedureLink

public static boolean endStandardProcedureLink(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvEndStandardProcedureLink" directive in the csv load file. Causes the cached StandardProcedureLink to be checked-out, associates soft attribues from preceding IBAValue load file lines with the StandardProcedureLink, applies the default attribute values associated with the specified type definition, persists the object, checks it back in, and caches it in the loader's memory.

XML Format

<csvEndStandardProcedureLink handler="com.ptc.windchill.mpml.processplan.LoadProcessPlan.endStandardProcedureLink" >

</csvEndStandardProcedureLink >

Tag Definitions

Supported API: true

See Also:

• beginStandardProcedureLink(java.util.Hashtable, java.util.Hashtable, java.util.Vector)

createStandardProcedureLink

public static boolean createStandardProcedureLink(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "csvCreateStandardProcedureLink" directive in the XML load file. Creates a StandardProcedureLink object, persists it in the database, checks it out, applies the default attribute values associated with the specified type definition, persists the StandardProcedureLink, checks it back in, and caches it in the loader's memory.

This format cannot add Soft Attributes(IBA). For that see beginStandardProcedureLink.

When using wt.load.LoadFromFile to load StandardProcedureLink, use the following XML format:

XML Format (only StandardProcedureLink specific ones are described, rest are same as for part)

<csvCreateStandardProcedureLink handler="com.ptc.windchill.mpml.processplan.LoadProcessPlan.createStandardProcedureLink" >
	<csvtypedef>	typedef	</csvtypedef>
	<csvparentNumber>	OperationHolder Number	</csvparentNumber>
	<csvparentVersion>	OperationHolder Version	</csvparentVersion>
	<csvparentIteration>	OperationHolder Iteration	</csvparentIteration>
	<csvparentView>	OperationHolder View	</csvparentView>
	<csvparentType>	OperationHolder Type	</csvparentType>
	<csvchildNumber>	StandardProcedure Number	</csvchildNumber>
	<csvopLabel>	OperationLabel	</csvopLabel>
</csvCreateStandardProcedureLink>

Tag Definitions

OperationHolder Number(Mandatory)	Number of the operationholder to be assoicated to the standard procedure via StandardProcdeure link
OperationHolder Type (Mandatory)	Type of the operationholder object to be assoicated. Valid values are 'processplan', 'operation', 'sequence'
StandardProcedure Number (Mandatory)	Number of the standard procedure to be associated via StandardProcdeure link
OperationLabel (Mandatory)	Operation label. This is mandatory and must be unique under the OperationHolder specified above.

Supported API: true

Parameters:

nv - Name/Value pairs of StandardProcedureLink attributes.

cmd_line - command line argument that can contain supplemental load data

return_objects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.

Returns:

true	success
false	failure

createProcessPlanRepresentation

public static boolean createProcessPlanRepresentation(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Processes the "createProcessPlanRepresentation" directive in the csv load file. Imports the information to create a Representation, and associate it with processplan

Parameters:

nv - Name/Value pairs of arguments. The arguments are as follows:

• parentNumber : Number of the processplan
• parentVersion
• parentIteration
• parentView
• repName : Name of the representation.
• repDirectory: Directory of the representation. Its relative to WTHome
• repDefault
• repCreateThumbnail : Create thumbnail or not. Valid values 'true', 'false'
• repStoreEdz

Supported API: true

cmd_line - command line argument that can contain supplemental load data

return_objects - Vector of the object(s) created by this method.