Fairsail. Implementer. Fairsail to Active Directory Synchronization. Version 1.0 FS-PS-FSAD-IG R001.00

Transcription

1 Fairsail Implementer Fairsail to Active Directory Synchronization Version 1.0 FS-PS-FSAD-IG R001.00

2 Fairsail All rights reserved. This document contains information proprietary to Fairsail and may not be reproduced, disclosed, or used in whole or in part without the written permission of Fairsail. Software, including but not limited to the code, user interface, structure, sequence, and organization, and documentation are protected by national copyright laws and international treaty provisions. This document is subject to U.S. and other national export regulations. Fairsail takes care to ensure that the information in this document is accurate, but Fairsail does not guarantee the accuracy of the information or that use of the information will ensure correct and faultless operation of the service to which it relates. Fairsail, its agents and employees, shall not be held liable to or through any user for any loss or damage whatsoever resulting from reliance on the information contained in this document. Nothing in this document alters the legal obligations, responsibilities or relationship between you and Fairsail as set out in the contract existing between us. This document may contain screenshots captured from a standard Fairsail system populated with fictional characters and using licensed personal images. Any resemblance to real people is coincidental and unintended. All trademarks and service marks mentioned in this document belong to their corresponding owners. FS-PS-FSAD-IG R Fairsail to Active Directory Synchronization Fairsail

3 Contents Contents Introduction 4 Pre-requisites 5 Sample Script 7 Overview 7 Sample Script Summary 8 Declare Parameters 8 Define Query 9 Write Data to XML 9 Create Data Object for CSV 10 Populate CSV Data Object 10 Export Data to CSV FIle 11 Import CSV File to Active Directory 12 Index 13 Fairsail to Active Directory Synchronization Fairsail

4 Introduction Fairsail provides customized Windows PowerShell scripts to enable you to synchronize your Active Directory content with Fairsail. Fairsail, as the HR system of record, acts as the master source of data. Typically, scripts are automated to run at a regular interval to ensure that your Active Directory is kept up to date as Team Members leave, and new hires join. Scripts handle authentication to enable the safe acquisition and import of data through your firewall. The outline process is: 1. Ensure pre-requisites are met (see page 5). 2. Install the script on a server with Active Directory. 3. Schedule and run the script 4. The script extracts data from Fairsail and writes it to a.csv file. 5. The script imports the.csv file into Active Directory. An indicative overall process flow is: Fairsail to Active Directory Synchronization Fairsail

5 Pre-requisites Action Why How Fairsail Actions Set up a User Account with remote access privileges. Set up a Remote Access app for curl. Install curl (with SSL) on the server that will host the script. To enable the script to authenticate Fairsail. Fairsail login details are set as parameters in the script. To enable access to curl on the Active Directory server. curl is used by the script to provide data access. Go to Setup > Administration Setup > Manage Users > Users Go to Setup > App Setup > Create > Apps Ensure client id and secret are set. Download from: Ensure you have the correct version! curl requires a security certificate in the same directory. You can download from here: Customer Actions Set up or designate a User Account with Administrator privileges. Ensure PowerShell is installed on the Active Directory server and runs in an elevated environment, configured to allow the use of scripts. Install Quest Active Directory plugins for PowerShell. List the Active Directory fields that must be synchronized with data drawn from Fairsail. Set up or designate a place in an LDAP form to act as a container for new accounts. Specify the domain name to be appended to accounts. To provide the account that accesses Active Directory for synchronization activity. The account must have permission to create and modify user accounts. By default, PowerShell execution policy is Restricted and will not run scripts. Extends PowerShell scripting with Active Directory specific cmdlets These fields must be included in the script. Enables the accounts to be correctly defined in Active Directory. The domain name is included in the script. Set-ExecutionPolicy Unrestricted Download from iveroles-server.aspx Fairsail to Active Directory Synchronization Fairsail

6 Pre-requisites Overview Action Why How Specify the standards to be followed for accounts. For example: Naming standard: Surname, FirstName, Middle Name; or FirstName, Surname. Password policy Ensures that newly downloaded data conforms to existing Active Directory standards. Fairsail Actions Write the PowerShell script in line with customer requirements. Test the PowerShell script. Ensures that customer expectations are met. Fairsail to Active Directory Synchronization Fairsail

7 Sample Script Each PowerShell script is written by Fairsail to match individual customer requirements. This sample script is representative and includes a number of commonly occurring elements summarized in the Overview (see page 7). Overview Fairsail to Active Directory Synchronization Fairsail

8 Sample Script Sample Script Summary Sample Script Summary Declare Parameters Fairsail to Active Directory Synchronization Fairsail

9 Sample Script Define Query Define Query Write Data to XML Fairsail to Active Directory Synchronization Fairsail

10 Sample Script Create Data Object for CSV Create Data Object for CSV Populate CSV Data Object Fairsail to Active Directory Synchronization Fairsail

11 Sample Script Export Data to CSV FIle Export Data to CSV FIle Fairsail to Active Directory Synchronization Fairsail

12 Sample Script Import CSV File to Active Directory Import CSV File to Active Directory Fairsail to Active Directory Synchronization Fairsail

13 Index C Create Data Object for CSV 14 D Declare Parameters 11 Define Query 12 E Export Data to CSV FIle 16 I Import CSV File to Active Directory 17 Introduction 4 O Overview 8, 9 P Populate CSV Data Object 15 Pre-requisites 5, 6 S Sample Script 8 Sample Script Summary 10 W Write Data to XML 13 Fairsail to Active Directory Synchronization Fairsail