UMC WEBUIUserManual
UMC WEBUIUserManual
05/2019
A5E47538013-AA
Guidelines
This manual contains notes of varying importance that should be read with care; i.e.:
Important:
Highlights key information on handling the product, the product itself or to a particular part of the documentation.
Note: Provides supplementary information regarding handling the product, the product itself or a specific part of
the documentation.
Trademarks
The remaining trademarks in this publication may be trademarks whose use by third parties for their own purposes
could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software
described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the
information in this publication is reviewed regularly and any necessary corrections are included in subsequent
editions.
Security information
Siemens provides products and solutions with industrial security functions that support the secure operation of
plants, systems, machines and networks. In order to protect plants, systems, machines and networks against
cyber threats, it is necessary to implement – and continuously maintain – a holistic, state-of-the-art industrial
security concept. Siemens’ products and solutions only form one element of such a concept.
Customer is responsible to prevent unauthorized access to its plants, systems, machines and networks. Systems,
machines and components should only be connected to the enterprise network or the internet if and to the extent
necessary and with appropriate security measures (e.g. use of firewalls and network segmentation) in place.
Additionally, Siemens’ guidance on appropriate security measures should be taken into account. For more
information about industrial security, please visit http://www.siemens.com/industrialsecurity.
Siemens’ products and solutions undergo continuous development to make them more secure. Siemens strongly
recommends to apply product updates as soon as available and to always use the latest product versions. Use of
product versions that are no longer supported, and failure to apply latest updates may increase customer’s
exposure to cyber threats.
To stay informed about product updates, subscribe to the Siemens Industrial Security RSS Feed under http://www.
siemens.com/industrialsecurity.
2 Quick Start to Using the User Management Component Web User Interface .................. 9
2.1 General Recommendations .............................................................................................. 9
2.2 Logging in to User Management Component Web UI .................................................... 10
2.3 UMC Web UI Home Page................................................................................................11
Important:
UM domains are different entities with respect to Windows domains that are defined at
operating system level.
Custom attributes can be associated with UM users. Example of custom attributes are common user
properties such as phone number, department, and so on.
To apply Secure Application Data Support (SADS), access to encrypted application data can be
granted to authorized users to allow them to decrypt it using specific Subject Keys.
UM User Types
UM User Passwords
Users created within UMC have also an associated password. Empty passwords are not allowed.
Users imported from Windows authenticate against Windows and do not have a UMC password.
Imported Windows local users authenticate only locally against Windows on the machine where they
are present. They can be used only for configuration purposes, for instance to be associated with a
Windows service running on the machine.
Offline Users
When you create a UMC user you can flag the user as offline. UMC provisioning service checks if the
offline user exists in Active Directory:
• if the user is present, user data are synchronized and the user becomes online,
• otherwise the user remains offline.
Important:
Users created as offline are enabled by design: they can therefore perform the actions
allowed by their function rights.
The user name of offline users must follow the AD pattern <domainName>\<ADuserName>. They do
not have a UMC password, as they cannot authenticate until they become online. The User Security
Identifier (SID, see Microsoft Documentation on Security Identifiers for more details) property is set to a
default value (S-1-0-0) that is synchronized with the actual AD value by the UMC provisioning service.
Users are also flagged offline if they are deleted from AD. In this case users are permanently deleted
from UMC database after an amount of time that can be configured (default is12 hours). See the
additional provisioning configuration in the User Management Component Installation Manual for more
details.
User Limits
Description Maximum
To apply Secure Application Data Support (SADS), access to encrypted application data can be
granted to authorized groups to allow them to decrypt it using specific Subject Keys.
UM Group Types
Offline Groups
When creating a UMC group, you can flag the group as offline. UMC provisioning service checks if the
offline group exists in Active Directory:
• if the group is present, group data are synchronized, the AD users members of the groups are
imported into UMC and the group becomes online,
• otherwise the group remains offline.
The group name of offline users must follow the AD pattern <ADdomainName>\<ADgroupName>.
Group Limits
Description Maximum
The following roles are automatically created by the system while configuring UMC:
• Administrator: built-in "root" role, can perform any operation. The user that has this role is a
root user that can perform any operation. This role cannot be associated with any group. It can
be associated with a user if the user performing the association has in turn the Administrator
role. The Administrator role cannot be deleted. Only users having the Administrator role can
modify other users having this role.
• UMC Admin: can manage users, groups and all the other UMC entities.
• UMC Viewer: can access the user management configuration without making modifications.
Name Description
UM_ADMIN Allows you to display the UMC database data and to configure the UMC
database, that is to create users, groups and so on, to import and export data
via file, to register UMC station clients. This function right allows you to execute
all umx commands.
UM_VIEW Allows you to display the UMC database data related to users, groups, roles
and account policies.
UM_RESETPWD The user can reset the password of another user. The user must also have
associated the UM_VIEW function right.
UM_UNLOCKUSR The user can unlock any other user. The user must also have associated the
UM_VIEW function right.
UM_ATTACH The user can attach a machine to a UM domain, the machine is promoted to the
UM agent role.
UM_JOIN The user can promote a machine to a UM server role. If the machine is not yet
attached to the UM domain, it is attached. This function right incorporates the
UM_ATTACH function right.
UM_RESETJOIN The user can downgrade a machine from the UM ring server or UM server role
to the UM agent role.
UM_IMPORT The user can import the UM Configuration via package. The user must also
have associated the UM_VIEW function right.
UM_EXPORT The user can export the UM Configuration into a package. The user must also
have associated the UM_VIEW function right.
UM_BACKUP The user can back up the UM Configuration (Full backup). This function right is
not used, as the functionality controlled by it has not yet been implemented.
UM_EXPORTCK The user can export Claim Key. This function right is not used, as the
functionality controlled by it has not yet been implemented.
UM_EXPORTDK The user can export Domain Key. This function right is not used, as the
functionality controlled by it has not yet been implemented.
UM_RA Login from Remote Authentication. This function right is not used, as the
functionality controlled by it has not yet been implemented.
UM_RINGMNG The user can promote a machine to a UM ring server role. If the machine is not
yet attached to the UM domain, it is attached.
UM_VIEWELG The user can display event logging data. The user must also have associated
the UM_VIEW function right.
Name Description
After you have configured the Web UI (for more details, see User Management Component Installation
Manual), you can open the login page of the Web UI at the following address: http://<myServer>/umc
or https://<myServer>/umc depending on the configuration.
You can also use a query string in order to automatically login using Windows Authentication, Custom
plugins or Teamcenter integration. See Logging in to User Management Component Web UI for more
information.
Before accesing UMC working environment, make sure you have followed a set of general
recommendations for the security and the correct usage of UMC.
Workflow
CAUTION:
Consider that when you login on UMC you are entering a protected environment. To exit
you must logout, because simply closing the browser does not guarantee you have exited
this protected environment. In addition, the following security information has to be taken
into account.
Security Information
In order to protect plants, systems, machines and networks against cyber threats, it is necessary to
implement – and continuously maintain – a holistic, state-of-the-art industrial security concept.
Siemens’ products and solutions only form one element of such a concept. For more information about
industrial security, please visit http://www.siemens.com/industrialsecurity.
• The browser used to display the UMC Web UI must allow the pop-up display.
• While using the UMC Web UI do not select the option Prevent this page from creating
additional dialogs. The selection of this option causes Web UI malfunctions.
• Disable the Autocomplete option in your browser settings.
• Disable the password saving option in your browser settings.
• Do not use the back and forward navigation buttons of the browser.
• Do not copy and paste a UMC Web UI url into another browser window.
• Empty passwords are not allowed.
Prerequisites
At least one of the following function rights has to be owned by the user to login to the UMC Web UI.
• UM_ADMIN: the user can perform all the available Web UI operations.
• UM_VIEW: the user can view the data displayed by the Web UI but cannot perform
modifications.
Depending on the function right owned by the user, some operations may be allowed or not.
Note that, if custom plugins are used to authenticate some may not have a sufficiently high security
level to log in to the web UI.
Note: The machine is automatically added to UMC whitelisting when you authenticate as
a user with the UMC Administrator role.
Procedure
Depending on the type of authentication method you have configured (smart card and/or plugin),
additional links may be displayed on the login page.
The login page (Identity Provider component) is displayed according to the language selected in your
browser settings. If no browser settings are defined, the default language is en-US.
From the menu on the upper right-hand corner of the page, you can change the language in which the
login page and related messages are displayed.
After you have logged in, the UMC pages are displayed according to the user language property of the
logged-in user. If the user language property has not been defined, the language of UMC pages is the
one of the login page.
Available Operations
From the menu on the upper right-hand corner of the page, you can select the following operations:
• logout;
• change password (empty passwords are not allowed).
In addition, depending on the function rights you own, you can access the Web UI pages from which
you can perform the following operations:
• Manage Users
• Manage Groups
• Manage Roles
• Manage Account Policies
• Display Event Log
Additional Operations
Under particular conditions (UMC installed software on the client machine and user access rights), on
the upper left-hand corner, the Register client button allows you to register the machine as a trusted
machine that can provide logon station information. Refer to the User Management Component
Installation Manual for more information on UMC station client.
From the menu on the upper right-hand corner of UMC Home page, select User Profile or click User
Profile link button on the welcome page. The User Profile page is displayed.
Prerequisites
• SADS has been enabled in Account Policies via Web or UMX, it is required for secret
protection.
• The Two Factor Authentication has been enabled as an authentication method via Web or
UMConf centralized configuration management.
• The Two Factor authentication has enabled for the user in their account policies via Web or
Encryption has been enabled for the user from UMX.
Procedure
From the menu on the upper right-hand corner of UMC Home Page, select Users. The Users page is
displayed.
Available Operations
Below each column name, a filter box allows you to filter the content of the selected column. In this
page you can perform the following operations:
• create a user;
• update a user;
• import a user from Active Directory;
• unlock a user;
• delete a user (users imported via an AD group cannot be deleted).
When you manage users, refer to the corresponding umx commands for field constraints (see UMX
User Manual).
Procedure
Important:
• The default domain for new users is UMC.
• if Must Change Password is selected the user must set a new password the next
time they login.
• if Can Change Password is selected the password can be re-set by the user.
• The password specified by an Administrator during the creation or update of a user
are not bound to password policies unless password the check has been enabled.
Important:
Imported AD and Windows Local users have editing restrictions, see Active Directory
Users and Windows Users for more details.
1. From the Users page, select a row and click Edit to edit the user main information directly in
the grid.
2. If you want to insert or edit additional user details, select a row and click Details in the upper
left-hand corner of the grid. Note that the password specified when editing a user is not bound
to password policies, unless the password policy check is enabled. The following dialog box is
displayed:
Available Operations
Each tab groups the user details that you can edit in that tab. Only specific properties whose editing
needs additional explanations are described. In the following tabs you can:
Important:
Imported fields are not editable. Only the following fields, which are not imported, can be modified:
All the other fields are imported from AD and cannot be modified via Web UI. They have to be modified
in AD and they are automatically synchronized by UMC.
Imported fields are not editable. Only the following fields, which are not imported, can be modified:
• Tab General: First Name, Full Name, Last Name, Initials, Language and Data Language.
• Tab Info: Mobile, Phone,Email1, Email2 and Email3.
• Tab Status: Enabled.
• Tab Attributes: UMC custom attributes can be created, modified and deleted.
• Tab Groups: for all the users this tab displays only the user group membership; to add a user to
a group see How to Manage Groups.
• Tab Roles: roles can be modified.
• Tab Account Policy: User expiration date, the alert fields and the Password expiration days
field are not applicable. Only the PKI Alias and the Authentication alias can be modified.
All the other fields are imported from Windows and cannot be modified via Web UI.
Procedure
Delete an attribute Select the row of the attribute you want to delete.
Click on the Delete button.
Edit the attribute name or Click on the attribute you want to modify.
value Insert the required modifications in the text box.
2. To make the attribute modifications (add/delete/edit) effective, click the Apply button.
3. Click Save.
The Roles tab allows you to associate roles with users. A number of predefined roles are provided by
UMC.
Procedure
1. Type the role name in the box at the top of the grid. This box provides the autocomplete
functionality so that only the first letters can be typed.
2. Select the required role and click Save.
Important:
• You can create new roles using the umx command. See the UMX User Manual for
more details.
• The Administrator role cannot be associated with groups.
The Account Policy tab allows you to edit the user account policies.
Procedure
• In the Autologoff box, you can enter a duration (in minutes) for the desktop session associated
to the selected user.
• If you select the Override Lock Policyon invalid credentials checkbox. In this case, even
though the user attempts to login with a wrong password a number of times that exceeds the
global account policy Maximum numbers of errors during login, it is not locked. This field can
be set only for users that are created from scratch within UMC, not for imported users;
• The maximum duration of a user password is 1827 days.
• in the field Authentication alias you can define the alias that is used to authenticate the user in
the following ways:
– via smart card authentication: in this case the PKI alias checkbox has to be selected and
smart card authentication has to be configured;
– via plugin authentication: in this case the PKI alias checkbox must not be selected and
plugin authentication has to be configured.
• If you select the Enable 2FA checkbox to enable 2 factor authentication you must enable 2FA
as an authentication method from authentication options and SADS in the global Account
Policies.
For more information on the configuration of the different types of authentication see User
Management Component Installation Manual.
General Recommendations
• Windows local users can be imported only using the umx command. See the UMX User Manual
for more details.
• Imported AD users and Windows Local users have editing restrictions, see updating a user.
• The import of users implies a search on Active Directory that can take a considerable amount of
time and can return zero results when exceeding AD administration limits. It is strongly
suggested that you perform restricted searches. To bulk import users, import them via the import
of an AD group.
Procedure
1. In the Users page, click Import Users: the following dialog box appears.
2. Enter the search criteria and click Search. The search criteria must contain at least the three
initial characters of the user name. If you want to search by inserting other characters
contained in the name, insert an * before the string. The search is perfomed in the following
Active Directory fields: user name (sAMAccountName), user full name (displayName), and
3. Select the users you want to import and click Add. The selected users are displayed as in the
following example:
4. Click Import to import the selected Active Directory users into the UMC database. Windows
groups associated with these users are not imported into UMC database. For imported users,
the user authentication is performed against the Windows System.
Important:
You cannot explicitly lock a user. To lock a user you have to insert a wrong password a
number of times which depends on the global account policies
SL_ENABLE_LOCK_AFTER_NATTEMPTS and SL_MAX_LOGIN_ERRORS. See the
UMX User Manual for more information on how to list and modify the account policies.
Procedure
From the menu on the upper right-hand corner of UMC Home page, select Groups. The Groups page
is displayed.
Available Operations
Below each column name, a filter box allows you to filter the content of the selected column. In this
page you can perform the following operations:
• create a group;
• update a group;
• import a group from Active Directory;
• delete a group.
When you manage groups, refer to the corresponding umx commands for field constraints (see UMX
User Manual).
Procedure
1. From the Groups page, select a row and click Edit to edit the group main information directly
in the grid.
2. If you want to insert or edit additional group details, select a row and click Details in the upper
left-hand corner of the grid. The following dialog box is displayed:
Available Operations
Each tab contains the group details that you can edit in that tab. Only specific properties whose editing
needs additional explanations are described. In the following tabs you can:
1. Type the user name in the box at the top of the grid. This box provides the autocomplete
functionality so that only the first letters of the name can be typed.
2. Select the required user and click Save.
Procedure
1. In the Groups page, click Import Domain Groups: the following dialog box appears.
2. Enter the search criteria and click Search. The search field is the group name (cn Common-
Name). The following dialog box appears.
3. Select the group you want to import and click Add. The selected groups are displayed as in
the following example:
4. Click Import to import the selected Active Directory groups and the associated Active
Directory users into the UMC database.
AD recursive groups are not supported. Only direct members are imported into UMC. For these users,
the authentication is performed against the Windows System and the imported fields are not editable.
As a result, the following rules are applied:
Important:
The import of all the Active Directory users belonging to a group may take a considerable
amount of time (usually in the order of minutes), depending on the number of members.
During the user import, the Web UI can be used to perform other operations.
CAUTION:
• If a group is created from scratch in the UMC database and has associated users,
all the associations are deleted. Users are not deleted.
• If a group is imported from Active Directory in the UMC database and has
associated users, all the users which do not belong to other groups are deleted.
Procedure
From the menu on the upper right-hand corner of UMC Home page, select Roles. The Roles page is
displayed.
Available Operations
Below each column name, a filter box allows you to filter the content of the selected column. In this
page you can perform the following operations:
• create a role;
• update a role;
• delete a role.
When you manage roles, refer to the corresponding umx commands for field constraints (see UMX
User Manual).
Procedure
Note: Due to a database constraint on the role identifiers, you may get an error message
saying that no more role identifiers are available. In that case, if you want to create new
roles, you must purge the existing role first using the corresponding umconf command.
See the User Management Component UMCONF User Manual for more details.
1. From the Roles page, select a row and click Edit to edit the role main information directly in
the grid.
2. If you want to insert or edit additional role details, select a row and click Details on the upper
left-hand corner of the grid. The following dialog box is displayed.
Available Operations
Each tab groups the role details that you can edit in that tab. In the following tab you can:
1. Select the Function Right check box to associate the corresponding function right with the
role.
2. Click on the Save button to save the modifications.
• user account policies that are defined at user level so that each user can have its own rules
on authentication;
• global account policies that are defined at system level and are the same for all the users.
When you manage account policies, refer to the corresponding umx command for additional field
constraints (see UMX User Manual).
Note: The maximum duration for the password expiration is 1827 days (approximately 5
years).
From the menu on the upper right-hand corner of UMC Home page, select Account Policies. The
Account Policies page is displayed.
Available Operations
In this page you can perform the following operations. Only specific fields whose editing needs
additional explanations are described.
In the Password Structure tab, fill the available fields with the values you want to set for your
passwords. You can also enable the administrative password policy check, so that administrative users
can only set passwords which meet the policy which have been set, this does not apply to password
reuse policies.
If the value in the Password Minimum Length and Password Maximum Length fields are set to 0,
the check is disabled. Empty passwords are not allowed.
1. In the Advanced tab, in the Pki area, from the Built-in filter or custom filter drop-down
menu, select the field to be used for user authentication via smart card; the following options
are available:
– Authenticate using CN
– Alias Authentication using CN
– Authentication using filter on Subject
– Alias Authentication using filter on Subject
– Authentication using filter on Alternate Subject
– Alias Authentication using filter on Alternate Subject
2. Select the Enable secure application data support for users and groups check box to
enable the SADS functionality. SADS capabilities at application level can be enabled via umx
or Web UI by modifying an account policy. For what concerns the subject level, this can only
be done via umx. For more details, see UMX User Manual.
3. Click Restore to default to restore the global account policy default values or click Save.
• Manage disclaimers and to customize the content of the disclaimer in: English, French, Spanish,
German, Italian and Chinese.
• Manage authentication options, for example enable specific types of authentication and set their
security level.
• Manage languages, enable or disable built-in languages and add custom languages not
provided by UMC.
Note: Enabling or modifying the disclaimer sets a centralized configuration if one is not
already present. If you performed specific configuration on the local file they may need to
be applied to the central configuration or overridden.
From the menu on the upper right-hand corner of UMC Home Page, select IDP Configuration. The
IDP Configuration page is displayed.
Note: Enabling or modifying the disclaimer sets a centralized configuration if one is not
already present. If you performed specific configuration on the local file they may need to
be applied to the central configuration or overridden.
Enabling Disclaimers
To enable the visualization of disclaimers select the Disclaimer Configuration tab and select the
Enable disclaimer when login request is performed checkbox.
Customizing Disclaimers
Procedure
Note: Only the html tags br (break) and b (bold) can be used in the disclaimer.
CAUTION:
The configuration which can be specified on this page can result in no longer being able
to login into the web UI even with the root user. Verify that at least one authentication
level is strong or that two factor authentication is configured and enabled, see UMC
Installation Manual for more information.
The enable checkboxes for built-in authentication methods enable the authentication methods and set
the value on the centralized configuration file. See UMC Installation Manual for more information.
Procedure
The enable checkboxes for additional authentication methods enable the authentication methods and
set the value on the centralized configuration file. See UMC Installation Manual for more information.
Procedure
The security level can be specified for the built-in authentication methods, except for smart card
authentication, to specify how securely information is passed in the IdP claim so that the third party
application can determine the authentication security level. In UMC Web UI, it can only be used if the
authentication is standard or strong. The possible values are:
• weak
• standard
• strong
Procedure
Autologin is a feature that allows to define one or more authentication methods with which the identity
provider tries to login automatically just after the loading of the authentication page.
Procedure
In the Built-in languages management area you can enable or disable the built-in languages
installed by UMC (English, French, Spanish, German, Italian and Chinese).
The list on the left displays the built-in disabled languages and the list on the right displays the enabled
languages. To enable or disable a built-in language, drag and drop a language from one list to the
other.
After configuring a new language, you have to install in the system the resources files that contain the
translations for the new languages.
It is necessary to provide two different resource files, one for the UMC webUI application and one for
the login page of the Identity provider. They must be copied in the following paths:
In these two paths you can find resource files for existing languages and use
them as template to create the new resource files for the custom language.
CAUTION:
• Each new resource file must be named like the resource files already present in
the paths, by including the language identifier inserted during the configuration. In
the example above, the file must be named umc.ja-jp.json.
• In the new resource file the value of the property language must match the value
of the Language identifier inserted in the Custom languages tab. See the
example below.
Example
"language": "ja-jp",
"keys": {
"sessionExpiredLabel": "Session Expired",
From the menu on the upper right-hand corner of UMC Home page, select Event Log. The Event
Log page is displayed.
Prerequisites
Users must have either the function rights UM_VIEW and UM_VIEWELG or UM_Admin to access the
Event Log page.
Procedure
1. Select a row and click Details to display the event log record details.
2. In the Log record detail dialog box, the Value tab displays the value in JSON format.
Generic Errors
Authentication Errors
SL_INVALID_LOCK_OPTION 0x108 264 The lock option has not been defined.
SL_INVALID_PROPERTY 0x109 265 The property has not been defined for
the object.
File Errors
SL_RESOURCE_NOT_FOUND 0x150 336 The user does not have the correct
function right to perform the
requested operation. This error has
the same meaning as the
SL_MISSING_FUNCTION_RIGHT
error.
SL_MISSING_FUNCTION_RIGHT 0x152 338 The user does not have the correct
function right to perform the
requested operation. This error has
the same meaning as the
SL_RESOURCE_NOT_FOUND
error.
Package Errors
Database Errors