Text file | Update Office 365 Users
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: You can also update user virtual attributes. For more details, review the Virtual Attributes article.
NOTE: The 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 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:
In the Query section, click the [...] button next to Select Data Source setting.
Open the Templates folder.
Select the AD Users Template CSV file.
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.comRule settings
Query section
| Setting name | Description |
|---|---|
Select data source |
Specify the text file to be imported. The […] (three dots) 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 |
Select a column in the data source that contains the attribute value for identifying and mapping a user. |
Office 365 anchor attribute |
Select a data source anchor attribute:
|
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 |
Each object property defined in this setting matches the column that will be displayed in the Web Portal for this web query. To display additional columns, add the required properties to the Properties to display list. To add extension attribute 1 that is synchronized from AD, you need to use a value like:
Copy
|
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, ignore this setting. 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, ignore this setting. Otherwise, use the Selector button to choose a field from the Data Source or just skip this setting. |
|
Display name
|
Specify the DislpayName format. |
Settings | |
Default password |
Specify the password for the updated Microsoft 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 Microsoft 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 | |
|
If the Data Source contains one of these field names, ignore this setting. 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 | |
|
If the Data Source contains a field with one of these names, ignore this setting. 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 and Other Attributes | |
Virtual attributes |
Map column names from the data source to the virtual attributes. |
Attribute mapping script |
If you want every provisioned user to have a virtual attribute populated with some string value then use this:
where 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:
since Example:
The same for regular attributes: Example:
|
Output section
This section defines the output format of this rule.
To get more information about this section, please see the Rule 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 Rule Enforce/Schedule section article.
Version history
| Version | Notes |
|---|---|
| 12.3 | The Office 365 anchor attribute setting has been updated to feature additional options. |
| 11.2.0 | The Attribute mapping script section has been updated to support regular attributes. |
| 7.1.0 | The Alternate email setting has been added. |
| 6.4.0 | The If the record contains empty fields, then overwrite fields with empty values setting has been renamed to Empty field in Data Source. |
| 6.3.1 | The rule has been introduced to Cayosoft Administrator. |
Comments
0 comments
Please sign in to leave a comment.