Configuration Tips - Manage Configuration Utility

From MicroStation Update 17 we include the new Manage Configuration utility. Further updates to the utility were made from Update 17.2, see below. This enables MicroStation to switch between multiple configurations allowing further control and separation of standards for organizations working with serial clients or on major projects that require specific CAD/BIM standards.

This is equally beneficial for smaller organizations as this feature can support accessing, with minimal technical input, an entirely self-contained configuration supplied by a third-party.

For administrators, even when they are only managing a single configuration, it enables them to easily switch between production and development configurations.

Where a Custom Configuration is already used by Update 16, during an upgrade to Update 17 MicroStation picks up the path to this configuration from ConfigurationSetup.cfg and will list it with the Example configuration in the new Configuration panel:

If you install Update 17 and do not see your previous configuration, either nothing:

or only the Example configuration:

this will be because the previous ConfigurationSetup.cfg was not found. This can happen if a previous version is uninstalled and all remaining folders and files are deleted, whether manually or by an IT system process.

In this case simply launch Manage Configuration and click Add following the steps in this video (once the new configuration is created in the first few seconds the video goes on to show switching between configurations):

The required inputs, shown in this video, are a name and description that will appear in the UI, the choice of Custom Configuration location, the path to the Custom Configuration. This path is to the Custom Configuration root folder that contains WorkSpaceSetup.cfg. Ensure 'Visible' is ticked, if it is not the configuration will not be listed in the UI.

Clicking the Workspace Setup toggle displays the active configuration variables in the existing WorkSpaceSetup.cfg. These do not need to be changed to use an existing Custom Configuration.

Documentation is here for Update 17: Creating and Managing Configurations.

Where are the Manage Configuration settings stored?

Configurations are stored in C:\Users\...\AppData\Local\Bentley\MicroStation\10.0.0\prefs\configuration.xml.

This file can be copied to any users provided that the path(s) stored in the XML for each configuration is/are valid for each user.

From MicroStation 2023 a new variable MS_CONFIGURATIONXML_PATH can be used to point at a shared copy of configuration.xml, e.g.:

MS_CONFIGURATIONXML_PATH = D:/_CONFIG_XML/M23/

This should be located in configurationSetup.cfg.

Manage Configuration XML Syntax

Each configuration is contained in a <ConfigurationModel> tag pair. The values entered in the Manage Configuration utility are stored in a similar order to the dialog:

Configuration Name: <Title>SMB Config</Title>
Description: <Description>SMB Demo Config</Description>
Set by application: <ConfigurationVariable>_USTN_CONFIG_SMB_Config</ConfigurationVariable>
Type: <Type>Local</Type>
Visible: <IsActive>true</IsActive>
Configuration Folder: <Path>D:\_SMB\SMB_Resources\</Path>
<IsSelected>true</IsSelected>
<IsEditable>true</IsEditable>

Additional values set by the application are IsSelected, which identifies the user selected configuration and ConfigurationVariable, which is is an an identifier used by the application.

IsEditable is set by default to true for new configurations but set to false for the Example configuration to ensure new users have access to the examples for learning purposes.

The example configuration can be hidden by editing the XML, set the IsActive statement to false:

<IsActive>false</IsActive>

Hide Configuration Manager (from MicroStation 17.2 onwards)

From MicroStation 17.2 we added _USTN_RESTRICT_MANAGE_CONFIGURATION, setting this to '1' will hide the Manage Configuration option:

This could be used with only one configuration where appropriate so that only a single configuration was shown in the UI.

The next question is where to set _USTN_RESTRICT_MANAGE_CONFIGURATION?

One candidate is setting it as a Windows Environment Variable which has the advantage that it can be implemented by Windows policies:

Otherwise it would need to be added to "C:\ProgramData\Bentley\<applicationName>\Configuration\ConfigurationSetup.cfg" (but note that this file can be edited by the knowledgeable user).

From MicroStation 2023 this can be added alongside MS_CONFIGURATIONXML_PATH to redirect MicroStation to a shared configuration.xml and prevent editing of the configuration, e.g.:

MS_CONFIGURATIONXML_PATH = D:/_CONFIG_XML/M23/
_USTN_RESTRICT_MANAGE_CONFIGURATION = 1

Hide Configuration Manager (for MicroStation 17 and 17.1)

In MicroStation 17.1 we can use _USTN_USER_CONFIGURATION to hide the Configuration Manager and all configurations listed in configuration.xml. This was an interim step. 

When _USTN_USER_CONFIGURATION is directed to a configuration path that configuration is the only one that will be visible in the UI, similar to its previous behaviour. The 'User Configuration' label cannot be changed at present.

Parents
  • I think this option should only be available to administrators as users generally do not want to be involved with setting the configuration.

    I set up a deployment image that had our configuration location included and it did not appear in the workspace options until I clicked on one of the options in the left pane, once I was able to select one of our workspaces it all came good and showed all our custom options. This situation could lead to a user getting completely lost when the update is opened the first time.

    Why did it not show the redirected configuration options when opened the first time?

Comment
  • I think this option should only be available to administrators as users generally do not want to be involved with setting the configuration.

    I set up a deployment image that had our configuration location included and it did not appear in the workspace options until I clicked on one of the options in the left pane, once I was able to select one of our workspaces it all came good and showed all our custom options. This situation could lead to a user getting completely lost when the update is opened the first time.

    Why did it not show the redirected configuration options when opened the first time?

Children
  • Hi John, Hiding the Manage Configuration tools is in our plan for Update 17.1. Personally, once the Mange Configuration button and the right-click menu are hidden, I think it would be still be useful if we displayed the active configuration for consistency of UI appearance and for confidence that the correct configuration is active.

    I'm looking into the "Why did it not show the redirected configuration options when opened the first time" question with the developers.