Lanteria HR Technical Documentation AD Integration Guide

Transcription

1 Lanteria HR Technical Documentation AD Integration Guide Copyright 2016 Lanteria

2 Table of Contents 1 Introduction Technical requirements AD rules Lanteria AD Integration Feature Activation Running the timer job... 7 Copyright 2016 Lanteria

3 1 Introduction AD Integration functionality is used to populate Lanteria HR employee database with information from Active Directory and/or update Active Directory information after changes have been made in the Lanteria HR employee database. Copyright 2016 Lanteria Page 3 of 7

4 2 Technical requirements If the AD information is to be uploaded to Lanteria HR, SharePoint Timer Service Account should have permissions to read information from AD. If the information in AD is to be updated as well, then SharePoint Timer Service Account should have read/write permissions. Copyright 2016 Lanteria Page 4 of 7

5 3 AD rules AD Integration rules are set up in Lanteria HR Settings and Configuration. Go to Settings > Settings and Configuration > General and click the Development tab. Enter the rules into the AD Integration Rules field. The rules are set in XML format. <ADRules login= password= domainnameorip= IntegrationBy = > <rule direction='out' ADField='title' ESField='JobRole'/> </ADRules> Header attributes: login, password credentials for accessing AD. Leave login and password empty if you want to use the Timer Service account to access AD. Otherwise, specify credentials of some account with proper permissions. domainnameorip domain name or IP address of AD server. IntegrationBy parameter used as key during the integration. If left empty or set to login, the integration is performed by login, i.e. AD account. Other options are: globalid, which means that integration is performed based on Lanteria HR Global ID, and , which means that integration is performed based on employees addresses stored in Employee Cards. Please note: the values used by the IntegrationBy attribute must be unique. AD integration rules themselves are defined as follows: <rule direction='out' ADField='title' ESField='JobRole'/> direction attribute determines where the changes are made. Acceptable values are in for changes in AD to be populated to Lanteria HR and out for changes in Lanteria HR to go to AD ADField attribute is the internal name of an AD field ESField attribute is the internal name of a field from the Employees list. Any field from the Employees list can be integrated. The fields lastname, fullname, location, , workphone, homephone, cellphone, city, zip, state, address, country, jobposition, jobrole, department, legalentity, manager can be listed using only their internal names, for example, ESField='manager'. All the other fields must be listed as Employee:{InternalFieldName}, for example, ESField='Employee:BusinessCardTitle'. Please note: Field names listed as Employee:{InternalFieldName} ARE case-sensitive. There can be as many rules as needed. Copyright 2016 Lanteria Page 5 of 7

6 4 Lanteria AD Integration Feature Activation Connect to the SharePoint server and run PowerShell as Administrator. Run the following commands: - add-pssnapin Microsoft.sharepoint.powershell For SharePoint enable-spfeature identity Lanteria.EffectiveStaff2010.SharePoint_es2010_AD_Integration url Lanteria URL For SharePoint enable-spfeature identity Lanteria.ES.SharePoint_ADIntegration url Lanteria URL Now that the Lanteria HR AD feature is activated, the AD Integration timer job is available in SharePoint Central Administration > Monitoring > Review Job Definitions. The AD Integration timer job is aimed to synchronize the items in the Employees list of Lanteria HR with AD. Copyright 2016 Lanteria Page 6 of 7

7 5 Running the timer job The timer job for AD integration is run on schedule. It can be re-scheduled, disabled or run manually from Lanteria HR Settings and Configuration. Go to Settings > Settings and Configuration > System Settings > System Jobs. To run the job manually, click the Run Now link. After the job has run, its results, including errors, if any, will be available in Site Content -> Application Log list. To re-schedule the job, click the link in the Schedule column. To disable the job, click the Disable link. Copyright 2016 Lanteria Page 7 of 7