In addition to being able to create and update object and relationship data, the XML can be constructed to perform the following supported instructions:
-
DeleteInstruction
-
InsertInstruction
-
UpdateInstruction
-
SPFAttachWorkflow
-
SPFClaimInstruction
-
SPFUnClaimInstruction
-
SPFGenerateFormInstruction
-
SPFMergeInstruction
-
SPFPrgRegisterInstruction
-
SPFReclassifyInstruction
-
SPFReviseInstruction
-
SPFSignOffInstruction
-
SPFAttachFileInstruction
An example of each instruction follows.
Delete instruction
<DeleteInstruction>
<IObject UID="{f3edefd3-3a00-4360-a434-b19c4a825d5a}" Name="Delete_SPFAuthSignature" />
<IRefObject RefClass="PropertyDef" RefUID="SPFAuthSignature" RefName="SPFAuthSignature" />
<IDeleteInstruction DeleteTransition="Deleted" />
<IInstruction />
</DeleteInstruction>
A Delete instruction can also be used for terminate by substituting the DeleteTransition
parameter with the value Terminated.
<DeleteInstruction>
<IObject UID="{f3edefd3-3a00-4360-a434-b19c4a825d5a}" Name="Delete_SPFAuthSignature" />
<IRefObject RefClass="PropertyDef" RefUID="SPFAuthSignature" RefName="SPFAuthSignature" />
<IDeleteInstruction DeleteTransition="Terminated" />
<IInstruction />
</DeleteInstruction>
Insert instruction
<InsertInstruction>
<IObject UID="{349c5957-e5a5-42b1-959f-8313155ca0dc}" Name="Insert_ISPFFTRItem" />
<IRefObject RefClass="InterfaceDef" RefUID="ISPFFTRItem" RefName="ISPFFTRItem" />
<IPropValues PropValues="IObject\%UID\%ISPFFTRItem\%IObject\%Name\%ISPFFTRItem\%IObject\%Description\%Interface to support FTR\%ISchemaObj\%DisplayName\%ISPFFTRItem" AddedInterfaces="IObject~IInterfaceDef~IInterfaceRole~IPropCategory~IEnumMetadata~ISchemaObj~IInterfaceDefExt" />
<IInsertInstruction />
<IInstruction />
</InsertInstruction>
Update instruction
<UpdateInstruction>
<IObject UID="Update_UID" Name="Update_UID" />
<IRefObject RefClass="PropertyDef" RefUID="UID" RefName="UID" />
<IPropValues PropValues="IPropertyDefExt\%HistoryNotRetained\%True"
AddedInterfaces="IPropertyDefExt" />
<IInstruction />
<IUpdateInstruction />
</UpdateInstruction>
Progress register instruction
<SPFPrgRegisterInstruction>
<IObject UID="Delete_ISPFAdhocReport.MTH_CopyIfOwner"
Name="Delete_ISPFAdhocReport.MTH_CopyIfOwner" />
<IRefObject RefClass="Rel"
RefUID="ISPFAdhocReport.MTH_CopyIfOwner" RefName="ISPFAdhocReport.MTH_CopyIfOwner" />
<ISPFPrgRegisterInstruction
SPFPrgInstructionTimestring="T1"
SPFPrgInstructionPlannedDate="20/04/2007"/>
<IInstruction />
</SPFPrgRegisterInstruction>
Revise instruction
<SPFReviseInstruction>
<IObject UID="Revise_001" Name="Revise_001" />
<IRefObject RefClass="SPFDesignDocRevision" RefUID="{68Y69856458GGKH}" RefName="DocABC" />
<ISPFReviseInstruction SPFReviseInstRevScheme="01A" SPFReviseInstMajorRevision="01" SPFReviseInstMinorRevision="B" SPFReviseInstFilesToCopy="False"/>
<IInstruction />
</SPFReviseInstruction>
To copy all existing files from the existing document to the new revision, provide
"True" for the SPFReviseInstFilesToCopy property. "False" will create the new revision
without copying any files attached to the existing revision.
SignOff instruction
<SPFSignOffInstruction>
<IObject UID="SignOff_001" Name="SignOff_001" />
<IRefObject RefClass="SPFDesignDocRevision"
RefUID="{68Y69856458GGKH}" RefName="DocABC" />
<ISPFSignOffInstruction
SignOffInstructionComment="All is OK"
SignOffInstructionAllowWorkingRefs="True" />
<IInstruction />
</SPFSignOffInstruction>
Reclassify instruction
<SPFReclassifyInstruction>
<IObject UID="Reclassify_FLD-001" Name="Reclassify_FLD-001" />
<IRefObject RefClass="SPFFolder"
RefUID="FLD-001"
RefName="ISPFAdhocReport.MTH_CopyIfOwner" />
<ISPFReclassifyInstruction SPFNewClassificationUID="MyFolder" />
<IInstruction />
</SPFReclassifyInstruction>
Generate form instruction
This instruction is used to generate a default form definition for the class definition, relationship definition named, or all class definitions associated with a specific component schema.
<SPFGenerateFormInstruction>
<IObject UID="Instruction_GenForm-PBSAuthoringComponent"
Name="GenForm-PBSAuthoringComponent" />
<IRefObject RefClass="CompSchema" RefUID="PBSAuthoringComponent" />
<IInstruction />
<ISPFGenerateFormInstruction />
</SPFGenerateFormInstruction>
Claim instruction
<SPFClaimInstruction>
<IObject UID="Claim_Tag001" Name="Claim_Tag001" />
<IRefObject RefClass="DEVTag" RefUID="{4687889FDT98760L}" RefName="Tag001" />
<ISPFClaimInstruction />
<IInstruction />
</SPFClaimInstruction>
UnClaim instruction
<Container Scope="Data" IObject_Config="PR_Project1">
<SPFUnClaimInstruction>
<IObject UID="Test" />
<IInstruction />
<ISPFUnClaimInstruction />
<IRefObject RefName="Tag1" RefClass="DEVTag" RefUID="UID" />
</SPFUnClaimInstruction>
</Container>
Attach workflow instruction
<SPFAttachWorkflowInstruction>
<IObject UID="AWF_Tag001" Name="AWF_Tag001" />
<IRefObject RefClass="DEVTag" RefUID="{4687889FDT98760L}" RefName="Tag001" />
<ISPFAttachWorkflowInstruction SPFWorkflowTemplateUID="TagWorkflow001" />
<IInstruction />
</SPFAttachWorkflowInstruction>
Merge instruction
<SPFMergeInstruction>
<IObject UID="Merge_Tag001" Name="Merge_Tag001" />
<IRefObject RefClass="DEVTag" RefUID="{4687889FDT98760L}" RefName="Tag001" />
<ISPFMergeInstruction SPFMergeInstructionComment="External object claim" />
<IInstruction />
</SPFMergeInstruction>
Attach file instruction
This instruction is used to attach files to a given object.
<SPFAttachFileInstruction>
<IObject Name="AttachFiles" UID="AttachFile001"/>
<IRefObject RefName="Doc_Mas" RefUID="ba3501bc-afec-4328-91dd-4de7c0fffddd" RefClass="SPFDesignDocVersion"/>
<ISPFAttachFileInstruction SPFAFIActionIfDuplicateFileExists="CREATENEWVERSION" SPFAFIFileClassDef="SPFDesignFile"
SPFAFILocalFilePath="C:\UploadFile.txt" SPFAFIRemoveLocalFileInd="False" SPFAFISignOffAfterAttach="True"/>
<IInstruction/>
</SPFAttachFileInstruction>
The instruction assumes that the files are already uploaded to a SessionID named folder in the temp directory of the file or database server.