Actions - User & User Group Management

In this section, you will find all available actions for user & user group management.


Synchronize Users and User Groups with File 

This action can be used to synchronize users and user groups of a repository (see User and User groups) with a CSV file. The following attributes can be set:

File Path

The full path of the file to synchronisze with. The file path needs to include the file type extension. file will be saved to the file system by Mail & Deploy Server and therefore the following requirements have to be met: 

  • The user that runs Mail & Deploy Server needs to have sufficient user rights to read from the directory. 
  • The file path needs to be reachable from the computer on which Mail & Deploy Server runs; this might require to use UNC file paths in some cases. Please note that mapped network drive letters cannot be used, even if the user that runs Mail & Deploy Server has a mapped network drive set up. 

File Format

The CSV file to synchronize users and user groups with contains one entry per line.

User Group Entry

A user group entry has the following format, where the first value declares the line to be a user group entry:

usergroup;<name>
...

The values of each line are as follows:

User name
The name of the user (see User and User groups) for which the custom property value shall be added.

User Entry

A user entry has the following format, where the first value declares the line to be a user entry:

user;<id>;<name>;<role>;<language>;<timezone>;<culture>;<has_credentials>;<credentials_type>;<credentials_username>;<credentia ls_password>;<emailaddress>;<usergroup_name_1>;<usergroup_name_2>;...
...

The values of each line are as follows:

ID
The ID of the user. This identifies this user throughout the synchronization process.
Name
The name of the user.
Role
The role (see User and User groups) of the user. This can be one of the following values:

0. This value represents the role None.

1. This value represents the role Hub Consumer.

2. This value represents the role API Consumer.

3. This value represents the role Designer.

4. This value represents the role Administrator.
Language
The code of the language of the user. This can be one of the following values:

en. This value represents English.

de. This value represents German.
Time Zone
The name of the time zone of the user. If you leave this empty, the local time zone of Mail & Deploy Server will be used. Alternatively, you can provide the name of a windows time zone (Windows Default Time Zones) by using the column Timezone of the linked table.
Culture
The ID of the culture of the user. If you leave this empty, the local culture of Mail & Deploy Server will be used. Alternatively, you can provide the ID of a windows culture (Locale Codes) by using the column LCID Decimal of the linked table.
Has Credentials
Determines whether the user has credentials (see Credentials) or not.

False. This user does not have credentials.

True. This user does have credentials.
Credentials Type
The type of credentials of this user. This is only applicable if the user does have credentials. Can be one of the following values:

Custom. This user has custom credentials.

Windows. This user has windows credentials.
Credentials Username
The username of the credentials. This is only applicable if the user has credentials.
Credentials Password
The password of the credentials. This is only applicable if the user has custom credentials.
E-mail address
The e-mail address of the user.
User Group Names
An optional list of the names of all user groups to which the user belongs.

Synchronize Users and User Groups with Active Directory 

This action can be used to synchronize users and user groups of a repository (see User and User Groups) with an active directory or the local user and user group directory if the computer that runs Mail & Deploy Server is not a member of a domain. The following requirements need to be met in order to synchronize users and user groups with an active directory:

  • The computer that runs Mail & Deploy Server needs to be a member of a domain; if that is not the case, Mail & Deploy can only synchronize with the local user and user group directory of that computer. 
  • The repository needs to have valid active directory connection settings (see Active Directory Connection Settings). 


A synchronization action contains a list of active directory (or local) user groups which shall be synchronized with Mail & Deploy. You can manage these groups using the following buttons:

Click this button to create new settings for the synchronization of an active directory (or local) user group.
Click this button to edit the currently selected synchronization settings.
Click this button to create a copy of the currently selected synchronization settings.
Click this button to delete the currently selected synchronization settings.

For each synchronization settings, the following attributes can be defined:

Active Directory User Group
The active directory (or local) user group that shall be synchronized with Mail & Deploy.
Synchronize a User Group
This setting determines whether the active directory (or local) user group shall also be added as a user group in Mail & Deploy.

True.
All users of the active directory (or local) user group will be added as users in Mail & Deploy and a user group will be created in Mail & Deploy that contains the same users as the active directory (or local) user group does.

False.
All users of the active directory (or local) user group will be added as users in Mail & Deploy but no user group will be created in Mail & Deploy.
Role
The role to assign to users synchronized with the active directory (or local) user group
Default Language
The default language to assign to users synchronized with the active directory (or local) user group. This language is only used if the user does not have the preferred language property set in the active directory (or local) user record
Time Zone
The time zone to assign to users synchronized with the active directory (or local) user group.
CultureThe culture to assign to users synchronized with the active directory (or local) user group.
Custom Properties
The custom properties to assign to users synchronized with the active directory (or local) user group (see Custom Properties).


Import User Custom Properties from File 

This action can be used to import custom properties of users (see Custom Properties) from a file. It has the following attributes:

Active Directory User Group

The full path to the file you want to import from. The file path needs to include the file type extension. at the datasource will be saved to the file system by Mail & Deploy Server and therefore the following requirements have to be met: 

  • The user that runs Mail & Deploy Server needs to have sufficient user rights to write to the directory. 
  • The file path needs to be reachable from the computer on which Mail & Deploy Server runs; this might require to use UNC file paths in some cases. Please note that mapped network drive letters cannot be used, even if the user that runs Mail & Deploy Server has a mapped network drive set up.

File Format

The file has the following format:

<username>;<custompropertyname>;<custompropertydatatype>;<custompropertyvalue>
...

The values of each line are as follows:

User name
The name of the user (see User and User groups) for which the custom property value shall be added.
Custom Property Name
The name of the custom property.   
Custom Property Data Type
The data type of the value of the custom property.

String.
If the data type of the value of the custom property shall be in textual format.

DateTime.
If the data type of the value of the custom property shall be in date-time format.

Integer.
If the data type of the value of the custom property shall be an integer.

Decimal.
If the data type of the value of the custom property shall be a decimal.
Custom Property Value
The textual representation of the value of the custom property. This value will be converted into the actual data type according to the attribute Custom Property Data Type.

Each line represents one value for a custom property; thus, if you want to assign more than one value to a single custom property, you need to have one line for each value.

Please note, that before custom properties are imported from the file, all custom properties of users will be deleted. Deleted custom properties cannot be recovered, except by reverting to a backup of the repository.
T
Team is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.