Deputy Integration Settings

How to manage the settings for your Deputy Integration. You must have the Account Owner or IT Support user roles assigned to access this integration.

Once your Deputy account is synced with your WhosOnLocation account, there are a few settings that you can configure. You can also re-sync your account at any time and change the matching of locations and employees.

There are four sections to the Deputy Integration:

Settings

Locations

Employees

Rules

Navigating to Deputy Integration

If you are not currently in the Deputy integration you will need to go there to access the settings.

  1. Go to Tools > Account
  2. Select Integrations from the left-hand menu
  3. Select the Deputy icon
  4. Click Settings

2017-09-19_11-21-58.png

Settings

The settings screen contains your Deputy Configuration Overview where you can manage the authorization settings between Deputy and WhosOnLocation; and two settings which you can toggle on or off, Adding Deputy staff to WhosOnLocaion and Deactivating Staff.

2018-02-16_12-00-00.png

Resync Employees - Force a sync of your employees' information from Deputy to WhosOnLocation.

Configure OAuth - View or change your Client ID and Client Secret from Deputy and View your WhosOnLocation Redirect URI.

2018-02-08_15-56-42.png

Re-Authorize - If you are experiencing issues receiving data from Deputy you can re-authorize WhosOnLocation to receive data. Select Re-Authorize, then Authorize Again. You will be redirected to Deputy to authorize WhosOnLocation in the same way as it was done during the Wizard.

Wizard - Selecting this will take you back through the setup wizard. If you need to update information or want to force a full sync of data, you can go back through the Wizard.

Add Deputy Staff to WhosOnLocation - Select Yes if you want new staff entered into Deputy to be automatically added in WhosOnLocation

Deactivate Staff - Select Yes if you want any staff in WhosOnLocation that are not in Deputy to be automatically removed when the account is next synced.

Back to Top

Locations

The Locations page lets you view and edit the matches of your WhosOnLocation and Deputy locations.

2018-02-08_15-58-05.png

Deputy Name - The names of your locations in Deputy.

WhosOnLocation - The WhosOnLocation location that is matched with the Deputy location.

Click Assign to choose a different WhosOnLocation location for your Deputy location to sync with.

Back to Top

Employees

The Employees page lets you view and edit the matches of your WhosOnLocation and Deputy employees. If you did not import any employees from Deputy, and have added them into WhosOnLocation separately, they will be synced automatically within an hour. You can also match them manually here or go through the Wizard again to sync them automatically.

2018-02-08_15-51-00.png

Deputy Name - The name of the employee it appears in Deputy.

WhosOnLocation Assignee - The name of the employee in WhosOnLocation that is matched with the Deputy employee.

Sync Status - The import status of the record.

  • Duplicate - There was another record using the same unique identifier in Deputy so this record was not imported.
  • Excluded - A rule excluded this record from being imported.
  • Failed - The record was not imported due to an error with the data.
  • Imported - A new employee was added in WhosOnLocation with this data.
  • Not Changed - The record in WhosOnLocation matched the data in Deputy.
  • Pending - Is still processing.
  • Updated - The record in WhosOnLocation was changed to match the data in Deputy.

Click Assign to change or add the WhosOnLocation employee that is matched with the Deputy employee.

Back to Top

Rules

Rules are used in your Deputy integration to manage the import of employee data into WhosOnLocation. They can be used to exclude people, set additional settings based on sync information, and trigger information updates.

You can create Rule Groups to apply rules to a group of people with specific attributes. And you can create FilterLookup, and Update rules.

To create, view, and edit your Sync Profile's rules, you must navigate to your Deputy integtration.

  1. Go to Tools > Account.
  2. Select Integrations from the left-hand menu.
  3. Select the Enabled Integrations tab.
  4. Click Manage Settings next to Deputy.
  5. Select Sync Rules from the left-hand menu.

2018-02-16_11-54-25.png

Rule Groups

Rules can either be applied to all employee data being imported or only to data which meets certain conditions. To apply rules to specific data only, you need to create Rule Groups specifying those conditions and then add rules to the group.

  1. Click Add Rule Group.
  2. Add a Rule Group Name to identify it.
  3. Set the Rule Status to Active, or set to Disabled if you do not want to apply the Rule Group.
  4. Click Create a New Condition for as many conditions as you want to set up for this group.

    If conditions are created under the ALL section, then all conditions must be met for the rules to apply.
    If conditions are created under the ANY section, then any one of the conditions can be met for the rules to apply.
    The Attributes for conditions are the fields imported from Deputy. You can set these to be exact, partial, inclusive, or exclusive.

    2018-02-15_15-03-48.png
  5. Click Add Group when you have set up your conditions.

The Rule Group will appear on the page in green if activated, or red if disabled, with an empty grey field to drag rules into.

2018-02-16_11-53-50.png

Rules

A rule is something you want the data to do when it is importing. There are three types of rules which perform different tasks; Filter, Lookup, and Update.

2018-01-05_9-39-52.png

When creating a rule, you can always name it, set the status, and set the conditions for the rule to apply; you can then add different attributes depending on the rule type.

Adding a rule

  1. Click Add Rule.
  2. Select the Type.
  3. Add a Rule Name to identify it.
  4. Set the Rule Status to Active, or set to Disabled if you do not want to apply the rule.
  5. Click Create a New Condition for as many conditions as you want to set up for this rule.

    If conditions are created under the ALL section, then all conditions must be met for the rule to apply.
    If conditions are created under the ANY section, then any one of the conditions can be met for the rule to apply.
    The Attributes for conditions are the information being imported from Deputy. You can set these to be exact, partial, inclusive, or exclusive.
  6. Add any special attributes based on the type. See more details on rule types below.
  7. Click Add Rule when you are finished.

The rule will appear on the page in blue if activated, or red if disabled, and when activated will apply from the next import. Each rule type has its own icon to help you identify it.

2018-02-16_11-15-40.png

Filter

A filter rule will exclude items matching conditions from importing. This is used if you have employees that you do not want added to your WhosOnLocation account for any reason.

2018-02-15_15-15-26.png

Filter rules will not delete existing employees, they will only prevent new employees with those conditions from being imported.

Lookup

A lookup rule will lookup a value being imported and change it to another specified value. This is commonly used to match locations or departments from Deputy to the correct values in WhosOnLocation.

2018-02-15_15-20-04.png

You can create list lookups or one-to-one lookups by selecting either Create a New List Lookup or Create a New 1:1 Lookup. You can add as many lookups to a rule as required, including both list and 1:1.

A list lookup will check for a list of different options from a Deputy attribute and set it to a single WhosOnLocation attribute. E.g. Any of a series of location names in Deputy will be set to a single location in WhosOnLocation

A 1:1 lookup will check for a single attribute in Deputy and set it to a single attribute in WhosOnLocation. E.g. Any employee with the location HQ in Deputy can be set to Head Office in WhosOnLocation.

Update

An update rule will set or add details to attributes in WhosOnLocation, set Global Roaming rules, or set Employee Role Types. It is based solely off the conditions of the rule and will apply any updates to any employee that meets the conditions.

Updating Attributes

You can add a prefix or suffix to an attribute, or set an attribute, in WhosOnLocation

Adding a prefix will add details to the beginning of an attribute, e.g. a country code for cellphone numbers.

Adding a suffix will add details to the end of an attribute, e.g. adding a title to the end of a name.

Setting an attribute will simply set a WhosOnLocation attribute to a specified value for all that meet the condition of the rule.

2018-01-05_9-59-07.png

Global Roaming

Choose Set Global Roaming Locations to configure any rules for Global Roaming for your employees, e.g. employees in corporate locations have Global Roaming to any locations.

Global Roaming is not something that you can set through your Deputy import so if you want employees to have access to multiple locations you will need to add rules to set Global Roaming rights.

2018-02-15_16-09-16.png

Click here to find out more about Global Roaming.

Employee Role Types

Choose Assign Role to set employees' role types. Employee Role Types are used in WhosOnLocation for a combination or identifying an employee's role in the organization and special features for that employee, e.g. Non-Host will hide that employee from being selected as a host during visitor sign in.

You cannot assign Role Types through the information imported directly from Deputy, if you want to assign specific role types to employees, you need to add rules to do so, e.g. employees with the department Warehouse Operations Management will have the Role Type of Safety Operator.

2018-02-15_16-12-57.png

Click here to find out more about Employee Role Types.

Move, Edit, and Delete

You can order your rules to determine which rules are applied to your sync first, by moving them up and down, and you can move your rules inside Rule Groups. You can edit any rules that are currently set up to change the details, enable/disable them, or delete them.

Move

To move your rules and change their order, click and hold the icon in the top-left corner of the rule and drag it up and down. You can also drag a rule inside a Rule Group to add it to that group, and change the order of rules inside a group.

Edit and Delete

To edit or delete a rule, click on the rule anywhere other than the movement icon, this will open the rule's setup. Edit the rule by making any changes and clicking Save. Or delete the rule by clicking Delete and selecting Yes on the confirmation pop-up.

2018-02-16_11-49-23.png

Back to Top

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request