This functionality was modified in an update. For more information, see ConnectToiHubProject method for ISPClientApplicationNoUI (modified).
Connect to the SDx project.
When connecting through the Common UI adapter, any out-of-date copy of the CommonSchema.xml file in the following location on the connecting machine <SPClient User Folder path set in DebugUtility>/CommonSchemaCache/<Server>_<Site> is replaced automatically.
To determine if the local common schema file is out-of-date, older than the one on the server, the Common UI adapter compares the following two property values in the local common schema file and in the database.
-
SchemaVersion
-
SPFAutoGenSchemaVersion
If these values for the local CommonSchema.xml are not the same as for the file on the server, the common schema file is downloaded from the server and replaces the CommonSchema.xml file in the temporary location.
If both these values are same for the two files, then the adapter compares the LastUpdatedDate property on the file in the database with the creation date of the local file. If the local file is not the latest copy the CommonSchema.xml file is downloaded.
The design tool must call this method before calling any other method on this interface.
The design tool must call RegisterToiHub, currently only available from ISPClientApplicationUI,
before calling this method.
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
pstrSDxURL |
String (maximum 128 characters) |
Input |
SDx server URL. |
|
pstrSDxPlant |
String (maximum 254 characters) |
Input |
SDx plant name. |
|
pstrSDxProject |
String (maximum 254 characters) |
Input |
Tool project name. This should match the project name in SDx to establish a connection. |
|
pstrToolID |
String (maximum 32 characters) |
Input |
Design tool name. For example, Smart 3D |
|
pstrToolSPAdapterAssemblyPath |
String |
Input |
Absolute path to the SmartPlant Adapter assembly. |
|
pstrToolSPAdapterTypeName |
String |
Input |
The name of the type of the SmartPlant Adapter. |
|
pobjToolParameters |
ISPToolParameters |
Input |
Collection of tool parameters that will be passed to the tool adapter. Arguments, such as tool site and tool plant, as well as other tool-specific parameters, can be passed using this argument. |
|
pblnFileMode |
Boolean |
Input |
Indicates whether ‘Publish/Retrieve to File Mode’ should be turned on. A "True" value in this parameter is not currently supported. |
|
pstrSDxAuthCCIDClientID |
String |
Input |
Identifies the client ID for the Client Credentials (CCID) authentication and directs the tool to the applicable authentication server. |
|
pstrSDxAuthCCIDClientSecret |
String |
Input |
Identifies the client secret for the CCID authentication, allows it to access Smart API, and redirects the tool to the applicable authentication server. |
|
pstrSDxAuthCCIDScope |
String |
Input |
Determines the level of access needed by a user. |
|
pstrSDxAuthCCIDAdditionalParameters |
Dictionary(Of String, String) |
Input |
Selects the token audience for CCID authentication. |
|
pstrEngChangeNo |
String |
Input |
Engineering change action identifier. |
Return Value
-
0 if method is successful.
-
A negative number if the method fails (check the LastErrorMessage property for error message).
Comments
None.
A publishing tool should connect once per session to avoid spending time re-connecting.