The design tools implement either the Set or Get method for these properties, making them WriteOnly or ReadOnly, as specified under each property below. For the properties that ISPCLServiceManager needs to communicate to the design tool, the design tool implements the properties as read-only properties. For the properties that a design tool needs to communicate to ISPCLServiceManager, the design tool implements them as write-only. The only property that a design tool needs to implement as read-only is Signature. All other properties should be implemented as write-only by the design tool. The implementation of the write-only property in the Adapter should store the values in local variables for tool reference.
Tools will set the tool-specific properties, such as tool site or tool plant, in the ToolParameters collection before calling the Connect method of the ISPClientApplicationNoUI or ISPClientApplicationUI interface. (See the SmartPlant Common UI .NET Interfaces References Guide for details.) ISPCLServiceManager sets the ToolParameters on the ISPAdapter before calling any method on the ISPAdapter. The design tool must read the properties in the ToolParameters collection to set the right context of tool site or plant.
MapSchemaIContainer
Description
IContainer with mapping schema loaded. ISPCLServiceManager sets this property before calling PublishDocument. Tools implement this property as write-only, and maintain a local variable to keep a reference of the map schema container so that they can use the mapping to publish data and to access it when needed in subsequent calls, such as RelationshipExistsInTool.
Data Type
IContainer
Comments
ISPCLServiceManager sets it. Tool should not set it.
MessageIContainer
Description
A message container object tools use to store error and warning messages generated in the PublishDocument and RetrieveDocument methods. The ISPClientApplicationUI and ISPClientApplicationNoUI reports these messages to the end user. ISPCLServiceManager sets this property before calling any method. Tools implement a write-only property to keep a reference of the message container so that they can use it in subsequent calls. This object supports the IMsgContainer interface of the Schema Component. This interface is used to write messages to the message container.
After the PublishDocument and RetrieveDocument methods are called, ISPCLServiceManager checks for tool error and warning messages in the MessageIContainer.
Data Type
IContainer.
Comments
ISPCLServiceManager sets it. Tool should not set it.
Signature
Description
Signature is a read-only property. Value is the unique signature obtained by the tool in a plant. When a tool registers its database with the SmartPlant Foundation database, it gets a unique string from SmartPlant Foundation and stores the string in its database. Tools should have used the Register method to obtain a unique signature for every plant they want to integrate.
Tools will implement this property as read-only to return the signature for the given plant. In their implementation, Tools will look at the Plant properties for plant names, which are set by ISPCLServiceManager.
Data Type
String (maximum 4 characters).
Comments
None.
SPFPlant
Description
The name of the SmartPlant Foundation plant to which the tool is currently connected.
Data Type
String (maximum 256 characters).
Comments
ISPCLServiceManager sets it.
SPFURL
Description
The URL of SmartPlant Foundation to which the tool is currently connected.
Data Type
String (maximum 128 characters)
Comments
ISPCLServiceManager sets it.
ToolID
Description
The tool ID that the tool passed in ISPClientApplicationUI/ISPClientApplicationNoUI Connect call. It is a string that specifies what the tool will call itself in an integrated environment. For example, for Intergraph Smart® P&ID it could be Smart P&ID.
A tool will implement this property as write-only and save its ID in a local variable for its reference.
Data Type
String (maximum 24 characters)
Comments
ISPCLServiceManager sets it.
ToolParameters
Description
A collection of tool parameters that the design tool needs to know in the Adapter code. This is the same object that the design tool has passed in the ISPClientApplicationUI/ISPClientApplicationNoUI Connect call. The property type is ISPToolParameters. The ISPToolParameters is a collection of ISPToolParameter. ISPToolParameter describes a data class with properties Name (String) and Value (Object).
Data Type
ISPToolParameters
Comments
ISPCLServiceManager sets it.