Version 1.1. Release Date: May 10, 2015

Transcription

1 Version 1.1 Release Date: May 10, 2015 Table of Contents Copyrights... 2 Add User Permission... 3 File Format... 6 Upload File For Use... 7 Approach 1: Through the Portal... 7 Approach 2: Through the Web Service Approach 3: Automated Script Assign Group(s) to Plan(s) Audit Users The following guide will help walk you through the steps to enable your organization to upload user groups, and assign those groups to the plans available to your organization.

2 Copyrights Copyright RockDove Solutions, Inc. (RDS) previously a division of Irving Burton Associates, Inc. (IBA) PeopleSync Interface Reference Guide PeopleSync was originally termed the User Group Import Service This document is copyrighted and all rights are reserved. The distribution and sale of this product are intended for the use of the original purchaser only per the terms of the Agreement. This document may not, in whole or in part, be copied, photocopied, reproduced, translated, reduced, or transferred to any electronic medium or machine readable format without prior written consent, in writing, from RockDove Solutions, Inc. RockDove Solutions, Inc. and In Case of Crisis are trademarks of RDS. All other products and company names are marks of their respective holders. This document is the property of RDS and may not be distributed in any manner except with the express written permission of RDS. Software Version 1.1 Document Version 1.1 RockDove Solutions, Inc. 205 Van Buren St. Suite 150 Herndon, VA Attn: In Case of Crisis Phone: Fax: Website: [email protected]

3 Add User Permission In order to be able to take advantage of the User Group Insert Service, one of your portal users must be assigned the Data Administrator role within the Portal. Step 1 To do this, please log into the In Case of Crisis portal:

4 Step 2 Once you log in, please select Administer Portal Users under Administration on the Portal home page: Step 3 You can select a current user or add a new user to be a Data Administrator: 4 ICC User Group Import Service v1.1

5 Step 4 Once the required information is filled out (or checked for accuracy for a current user), check the box marked Data Administrator and click the Update Information Button: This should give your organization a user that will be able to upload files. ICC User Group Import Service v1.1 5

6 File Format In order to use User Group Import Service, a comma-separated values (CSV) file needs to be created. The format of this file should be the following: [user address],[group name] Here is an example below of what the file should look like: There should be no other information in this file. The file to be uploaded must have this format or the system will reject it.

7 Upload File For Use Once the CSV file has been created for use, there are 3 different ways to upload it to the In Case of Crisis Portal for use. Approach 1: Through the Portal Once the Data Administrator user is logged into the Portal, they can click on the Group List Upload button: From the Group List Upload page, please click the Upload CSV file link:

8 Click the Choose File button to select your CSV file then click Upload File Once the file has been processed, a status will display: Here is a successful upload status: 8 ICC User Group Import Service v1.1

9 Here is an unsuccessful upload status (note the errors): The user will receive an once the CSV file was received into the system and whether the system accepted the file or rejected it. If the system has accepted the file, the user can then proceed with assigning groups to plans. If the system has rejected, please correct the errors and re-submit. Here is a successful upload ICC User Group Import Service v1.1 9

10 And here is an unsuccessful upload Approach 2: Through the Web Service To bypass logging into the portal to upload the file, please go to: The Data Administrator will fill in their Login information and an OrgID (if applicable). They will then click the Choose File button, selecting their file, and click the Upload File button 10 ICC User Group Import Service v1.1

11 Just like in the portal, the user will get a status message for the upload, whether it s successful: Or unsuccessful, with details as to what the errors are: The user will also receive an with details of the upload. ICC User Group Import Service v1.1 11

12 Approach 3: Automated Script Users can write a script (using such tools as Powershell, Unix shell, Perl, etc.) to download the information needed to build the CSV file from their Active Directory, LDAP, or similar system. This enables easy automation and eliminates the need for this to be done manually. PowerShell Script example: By utilizing the PowerShell command Get-ADUser, the user can build a file directly from their Active Directory. In order for the In Case of Crisis portal to recognize the file, use the Get-ADUser command to pull addresses and group names. Generally, this can be achieved by filtering the memberof, mail ( address), and sn (surname) fields from Active Directory. Filtering by these fields ensures each of these fields have something in it. This helps eliminate the mailboxes that aren t attached to particular users or are distribution groups. If there are a large number of people that need to be loaded into the file, it is recommended to filter either more in depth or by more fields to refine the PeopleSync lists. This is achieved in the first line of the script shown below. In order to assure that each user in the list has the correct amount of groups, the second line of the opens the CSV file that is created in the first line, replaces the extraneous quotations marks with a comma (to push each memberof group into its own column) and save the CSV. Here is the example PowerShell script: Get-ADUser -Filter {(memberof -like "*") -and (mail -like "*") -and (sn -like "*")} -Properties * Select-Object -Property mail,@{l='memberof'; e= { ( $_.memberof % { (Get-ADObject $_).Name }) - join '","' }} Sort-Object -Property mail export-csv [File Name] -NoTypeInformation (Get-Content [File Name]) % {$_ -replace '"",""', '","'} Select-Object -Skip 1 out-file -FilePath [File Name] -Force -Encoding ascii curl Script example: The user can then use tools that support HTTPS client interface (curl, PowerShell, web browsers, etc.) to submit the CSV file into the portal as a multipart form POST request. The following fields are needed to submit via this method: upload: The file that you are uploading, for mail: address of the authorized user(s) pwd: Authorized user s password orgid: (optional) Organizational ID of the organization or sub-organization the user is uploading to. response: (optional) If the user would like to save the results to a log file (using 2 right arrows and giving a file name), this will allow the user to get the results as HTML (the same that is sent via ) or as JSON. URL: Here is an example of using curl to upload the file to the portal: curl -k -X POST -F "[email protected]" -F "mail=user@domain" -F "pwd=********" -F "orgid=000" -F "response=json" >> log.txt 12 ICC User Group Import Service v1.1

13 Assign Group(s) to Plan(s) Once a file has been successfully uploaded, the portal administrator can log into the Portal and start assigning the uploaded groups to each plan that needs to use this type of authentication. Once logged into the Portal, go to the My Plans page and select a plan. Once you ve done so (and you have no plan changes), click on the Publish Plan button: From here, change Plan Access Control to Listed Users and click the Save Changes button. After which you will click the Edit Listed Users button to start adding groups:

14 On the List Authentication page, use the Group List section to enable plan authentication with groups. The left hand column is groups available for this plan. Select the ones that you want to have access to the plan, and click the top >> button. Once you are done adding groups, click the Return to Publish Plan button. Once the groups are in place, publish the plan. This will ensure that only the users in the groups specified on the List Authentication page will have access to the plan. 14 ICC User Group Import Service v1.1

15 Audit Users One of the features we ve created with User Group Import Service is the ability to search what users are in which group(s), and what plan(s) they have access to. In order to do this, click on the User Audit button: Enter the user you would like to audit, and click the Search button. This will list the plans the user can access, as well as the groups they are currently in: