Articles in this section

See more
Print

Text file | Update Office 365 Users rule

  • Updated
Follow

Rule description

This rule queries the specified text file data source that is in a comma-separated variable format (CSV) and updates Office 365 user accounts according to the Action section settings.

Note 1: You can also update user virtual attributes. For more details, please see Configuring Virtual Attributes artic
Note 2: CSV-file should be in UTF-8 format in case of using letters with an accent: á, ä, é, í, ö, ü and etc.

 

When to use this rule

Use this rule when you need to perform bulk user account update from HR/ERP/SIS system into Microsoft Office 365.

This rule requires a source text file in the comma-separated variable format (CSV). You can use the template CSV file provided with the rule, or create a file in Microsoft Excel and export as CSV.

To use a template CSV file: 

  1. In the Query section, click the [...] button next to Select Data Source setting

  2. Open Templates folder

  3. Select AD Users Template CSV file

  4. Click Open 

The Query's source text file requires the following CSV (comma separated value) format:

FirstName,LastName,Description,EmailAddress
Joe,Smith,test user,joe@domain.com
Kelly,Jones,test user,kelly@domain.com

 

Rule Settings

Query Section

Setting name Description

Select data source

Specifies the text file to be imported.

The […] button allows the user to browse for the file and the Create/Edit button allows the creation or editing of the existing file in the built-in Data Source editor.

Data source anchor attribute

UserPrincipalName must be used as a DataSource Anchor attribute. It must be a unique value.  

Office 365 anchor attribute

UserPrincipalName must be used as a DataSource Anchor attribute. 

Note: Microsoft best practices assume the Active Directory and Office 365/Azure AD UPNs will match. 

More Options

 

Filter CSV data

This setting specifies the filter that can remove data rows from the imported text file that satisfies the specific condition.

Properties to display

To display additional properties for each object found by the query, add those properties to the list.

Filter Office 365 users

To hide unwanted data set the filtering conditions here.

Empty field in Data Source

If the record in the CSV file column is empty, you can skip updating the attribute or clear its value.

 

Action Section

Setting name Description
Account  

First name (FirstName)

If the Data Source contains a field named FirstName, do nothing. Otherwise, use the Selector button to choose a field from the Data Source or just skip this setting.

Last name (LastName)

If the Data Source contains a field named LastName, do nothing. Otherwise, use the Selector button to choose a field from the Data Source or just skip this setting.

Display name

 

Specify DislpayName format.

Settings

 

Default password

Specify the password for the updated Office 365 user account. This value can be static text or a field from the Data Source chosen using the Selection button or just skip this setting.

Usage location

Specify the usage location for the updated Office 365 user account or just skip this setting.

Must change password at next logon

 

Specify if a user must change password at next logon or just skip this setting.

Account enabled

Specify if an updated user account will be enabled or disabled or just skip this setting. 

Organization

 

Office

Job title (Title)

Department

 

If the Data Source contains one of these field names, do nothing. Otherwise, manually enter a static text value or use the Selector button to choose a field from the Data Source or just skip this setting.

Contact Info

 

Country

Office phone (telephoneNumber)

Mobile phone (mobile)

Fax

Street address

City

State

Postal code

Alternate email 

If the Data Source contains a field with one of these names, do nothing. Otherwise manually enter a static text value or use the Selector button to choose a field from the Data Source or just skip this setting.

 

Virtual Attributes

 

Virtual attributes

 If you want every provisioned user to have a virtual attribute populated with some string value then use this:
{@{'csvaAttribute1'='YourString'}}, where csvaAttribute1 is a name of a virtual attribute in 
HOME > CONFIGURATION > Virtual Attributes in Cayosoft Administrative Console.

If you want every provisioned user to have a virtual attribute populated with the corresponding value from the column in your data source, then use this:
{@{'csvaAttribute1'=$_.VAName}}, since VAName is the name of the column from your data source.
Example: {@{'csvaAttribute1'='YourString1';'csvaAttribute2'='YourString2'}}

 

Output Section

This section defines the output format of this rule.

To get more information about this section, please see the Output section article.

 

Enforce/Schedule section

This section defines the schedule for how often to run the rule.

To get more information about this section, please see the Enforce/Schedule section article.

 

 Change History

Version Notes
7.1.0 Alternate email setting is added.
6.4.0 If the record contains empty fields, then overwrite fields with empty values setting is renamed to Empty field in Data Source.
6.3.1 The rule is introduced in the product.

 

Related articles

Comments

0 comments

Please sign in to leave a comment.