MBSE Configuration APIs

MBSEConfigurations class

The MBSEConfigurations class contains data members and some exposed APIs that can be used to generate the configuration files needed for the integration tools to work. All the exposed APIs are non-static. You must create objects of this class to access the APIs. For data members, getter and setter methods are also available.

Constructor: MBSEConfigurations(String toolType) — checks if the configuration files are created. If the configuration files exist, the data members are assigned the appropriate values that are read from the configuration files.

• toolType — The application name to identify the integrating tool. For example, MATLAB, ECAD, MIG, Amesim. This value is used to identify the staging directory mentioned in the configuration file for the tool.

Constructor: MBSEConfigurations(String toolType, String configFilePath) — same behavior as above, plus:

• configFilePath — The path where the configuration files will be stored. If you do not specify this path, the configuration file will be saved in the location $USERPROFILE%\Siemens\cfg\MBSE\toolName\bhm.

Returns: MBSEConfigurations instance containing all the data members.

Methods

Method name	Description
setServerUrl(String serverUrl)	Sets the server URL.
getServerUrl()	Gets the server URL.
setFMSConfiguration(String bootStrpUrls, String tempFMSDir)	Sets the FMS configurations.
getFMSConfiguration()	Gets the FMS configurations.
setHostedActiveWorkspaceConfiguration(String awcHostURI, String awcHostUriKey)	Specifies the host URI and Host URI key for hosted Active Workspace.
getHostedActiveWorkspaceConfiguration()	Gets the host URI and Host URI key for hosted Active Workspace.
setTCCS(boolean isTCCS)	Sets the TCCS flag value.
getTCCS()	Gets the TCCS flag value.
setSSOConfiguration(String ssoLoginUrl, String ssoAppId, boolean ssoSessionFlag)	Sets the SSO environment configurations.
getSSOConfiguration()	Gets the SSO environment configurations.
setStagingDirectory(String tool, String toolStagingDir)	Configures the staging directory.
getToolStagingDir()	Gets the staging directory location.
setTeamcenterObjectCacheDirectory(String derbyCacheDir, boolean useDerbyCache)	Sets the Teamcenter Object Cache configurations.
getTeamcenterObjectCacheDirectory()	Gets the Teamcenter Object Cache configurations.
getTCRootEnv()	Gets the TC_ROOT environment variable.
saveConfigurations()	Creates the configuration files CommonClient.properties and BHMClient.properties.

setFMSConfiguration / getFMSConfiguration

• bootStrpUrls — You can specify multiple bootstrap URLs. These URLs can point to different servers.
• tempFMSDir — Temporary FMS directory where the files are downloaded during the FMS download.

Map<String,String> getFMSConfiguration() gets the FMS configurations consisting of bootstrap URLs and temporary FMS directory.

setHostedActiveWorkspaceConfiguration / getHostedActiveWorkspaceConfiguration

• awcHostURI — The URL required to host Active Workspace in any tool.
• awcHostUriKey — The key required to configure hosted Active Workspace.

Map<String,String> getHostedActiveWorkspaceConfiguration() returns a map with keys AWC_WEBLOGIC_HOST_URI (the hosting URL) and ACTIVE_HOST_URI_KEY (the configuration key).

setTCCS / getTCCS

• isTCCS — Flag is set to true if TCCS is configured. boolean getTCCS() returns the flag.

setSSOConfiguration / getSSOConfiguration

• ssoLoginUrl — The server URL of the SSO environment.
• ssoAppId — The application ID of the SSO environment.
• ssoSessionFlag — The flag indicating whether to use the SSO environment.

Map<String,String> getSSOConfiguration() returns a map with keys ssoLoginUrl, ssoAppId, ssoSessionFlag.

setStagingDirectory / getToolStagingDir

• tool — The application name.
• toolStagingDir — The staging directory where the tool artifact data is imported.

String getToolStagingDir() returns the staging directory location.

setTeamcenterObjectCacheDirectory / getTeamcenterObjectCacheDirectory

• derbyCacheDir — Client Cache location.
• useDerbyCache — Flag to determine if Derby should be used.

Returns a map mapTcObjectCacheDir with keys TC_CLIENT_CACHE (true if Derby is used) and CacheDir (client cache location).

getTCRootEnv()

String getTCRootEnv() returns the TC_ROOT environment variable if set. If TC_ROOT location does not exist, the variable is set in the following directories:

• Windows: C:\ProgramData\Siemens\MBSE\bhm
• Linux: /etc/Siemens/MBSE/bhm

saveConfigurations()

This API creates the configuration files CommonClient.properties and BHMClient.properties. These files contain the necessary configurations needed for the integrations to work.

If you use the MBSEConfigurations(String toolType) constructor, these files are copied to TC_ROOT\bhm location if TC_ROOT is set. If TC_ROOT is not set then they are copied to C:\ProgramData\Siemens\MBSE\bhm for Windows and to /etc/Siemens/MBSE/bhm for Linux.

If you use the MBSEConfigurations(String toolType, String configFilePath) constructor, these files are copied to the location of the configFilePath. If you do not specify the configFilePath, the configuration file will be saved in the location $USERPROFILE%\Siemens\cfg\MBSE\toolName\bhm.

The exceptions and status are logged in ConfigurationStatus.log. The APIs also copy the log4j2.xml and bhmcache_create_table.sql files to the TC_ROOT\bhm location if TC_ROOT is set, otherwise to the configured location.

String saveConfigurations()

Returns: tcRoot — the location where the configuration files are created.