GetInfoInXML As Long - Integration - Update 46 - Help - Hexagon

This method returns a set of data in XML format for an input set of parameters. This method is designed to be generic for any kind of data that can be passed in XML format. The content and structure of oOutput depends on the arguments passed in oInputArguments. This method should be used only after an agreement has been reached between the design tool developers and SmartPlant Common UI developers on the input arguments and the content and structure of output XML.

Currently this method supports fetching workflows, revision schemes, document types, owning groups, and SmartPlant Foundation file types from SmartPlant Foundation based on the following format:

For workflows

oInputArgs

<Request Action="GetWorkflows">

<DocClassDef UID="1234" />

<DocClassDef UID="5436" />

<Request/>

oOutPut

<Response Action="GetWorkflows">

<DocClassDef UID="1234" />

<Workflow Name="abcd" Desc="fsdg" />

<Workflow Name="dsafas" Desc="asdf" />

<DocClassDef UID="5436" />

<Workflow Name="dsfa" Desc="" />

<Response>

For revision schemes

oInputArgs

<Request Action="GetRevSchemes">

<Request/>

oOutPut

<Response Action="GetRevSchemes">

<RevScheme Name="abcd" Desc="fsdg" FirstRevCode="1" />

<RevScheme Name="dsafa" Desc="adf" FirstRevCode="A" />

<Response>

For document types

oInputArgs

<Request Action="GetDocTypes">

<DocCategory UID="1234" />

<Request/>

oOutPut

<Response Action="GetDocTypes">

<DocCategory UID="1234" Name="abcd">

<DocType UID="2345" Name="bcde">

<DocSubType UID="7890" Name="defg" />

<DocType>

<DocType UID="3456" Name="cdef" />

<DocCategory>

<Response>

For owning groups

oInputArgs

<Request Action="GetOwningGroups">

<Request/>

oOutPut

<Response Action="GetOwningGroups">

<OwningGroup UID="DAG_DEV2" Name="DEV2"></OwningGroup>

     <OwningGroup UID="DAG_ADMIN" Name="ADMIN"></OwningGroup>

     <OwningGroup UID="DAG_ENGINEER" Name="ENGINEER"></OwningGroup>

     <OwningGroup UID="DAG_DEV" Name="DEV"></OwningGroup>

     <OwningGroup UID="DAG_OPEN_TO_ALL" Name="OPEN TO ALL"></OwningGroup>

<Response>

For SmartPlant Foundation file types

oInputArgs

<Request Action=" GetSPFFileTypes">

<Request/>

oOutPut

<Response Action=" GetSPFFileTypes ">/>

<SPFFileType SPFFileViewable="True" SPFFileEditable="True" SPFFileExtension="xls" UID="FT_xls"/>

<SPFFileType SPFFileViewable="True" SPFFileEditable="True" SPFFileExtension="wri" UID="FT_wri"/>

<SPFFileType SPFFileViewable="True" SPFFileEditable="False" SPFFileExtension="binz" UID="FT_binz"/>

<SPFFileType SPFFileViewable="True" SPFFileEditable="False" SPFFileExtension="i06" UID="FT_i06"/>

<Response>

Arguments

Return Value

• 0 if method is successful.

• A negative number if the method fails (check the LastErrorMessage property for error message).

Comments

None.