Off Limits: Configuration Guide

Overview

This article guides you through how to configure an Off Limits Policy.

In this article, it is assumed all main BH4SF features are configured in the subscriber’s Org (ATS v2, 2020 Email Editor, relevant Search and Match integration etc).

The topics in this article are as follows:

Prerequisites

Page Layout Changes

  1. Add Off Limit Policies Related Lists to Account and Contact page layouts.
    • The New/Edit button on the Off Limit Policy object is already overridden by custom logic out of the box. No configuration is needed.
    • Account and Contact policies can be created from these related lists. Do not use the standard New button.
  2. Navigate to Setup > Object Manager > Off Limit Policy > Page Layouts.
  3. Click on Page Layout AssignmentClosed A Job position.
    • Assign the correct page layout per policy record type and profile.
  4. Navigate to Setup > Object Manager > Applicationv2.
  5. Add the TR1__Off_Limit__c field to these field sets:
  6. Navigate to an Account record and click on the Edit Page link on the top right corner.
  7. The fields displayed in this component can be customized.
  8. There is also an option to hide the Enable/Disable button based on User/Profile.
    1. Navigate to Setup > Custom Settings > Executive Search.
    2. Click on the Manage link2.
    3. Click on New/Edit in the bottom part of the setting.
      • What is configured here applies to the selected User or Profile and not to the whole Org.
    4. Click the Hide Disable Policies Button check-box .
    5. Click Save.
    6. Repeat the above steps for all the user/profile records, for which the 'Hide Disable > Policies Button' setting should be enabled.
  9. When the Edit Page opens, add Off Limit Policies custom component to the page layout.
    • Fields displayed in this component can be customized by navigating to the below:
      • Setup > Object Manager > Off Limit Line Item > Field Sets > List View Fieldset.
  10. Repeat the previous step for the Contact object.
  11. Navigate to Setup > Object Manager > Account > Page Layouts.
  12. Add the formula field TR1__Off_Limit__c to the relevant page layouts.
  13. Repeat the previous step for the Contact object.

To create ATS Stage policies and JobClosed A job (vacancy, position, role) is an opening for which a customer's client needs a placement. RoleClosed A job (vacancy, position, role) is an opening for which a customer's client needs a placement. policies, go to the Off Limit Policy tab. These need to be added in the subscriber’s Org.

  1. Navigate to Setup > Tabs > NewObject.
  2. Create your Off Limit Policy for the ATS Stage.
  3. Repeat the above steps to create your Off Limit Policy for the Job Role.

Org-level Settings Configuration

  1. Navigate to Setup > Custom Settings > Executive Search.
  2. Configure these fields:
    • Enable Off Limit Policies: Make sure this checkbox is selected.
    • Non Executive Job Field APIClosed API, or Application Programming Interface, is used by customers to create custom career portals or to take advantage of Data Mirror/DataMart. Bullhorn prefers to use REST API. Name: To mark jobsClosed A job (vacancy, position, role) is an opening for which a customer's client needs a placement. as ‘non-executive’ jobs and exclude them from the Off Limits logic, create a custom checkbox in the subscriber’s Org’ Job object then enter the API name of that field in this setting.
    • Default Off Limit Icon: This setting is pre-populated with the static resource value that results in the default Off Limits icon to be displayed (the key padlock). You can replace the out of the box value with a different value (same format) if you want to use a different Off Limits icon.
    • Line Item Batch Deletion Threshold: This setting should be used for Orgs where policies might have high volumes of line items associated with them. If a policy is deleted, the number entered in this field is the threshold number of associated line items, after which the delete operation should be performed asynchronously, to avoid errors.
      • Every time the batch is executed, a log (on success or on error) is created in the BHLO Log object (TR1__BHLO_Log__c).
    • Line Item Batch Deletion Chunk Size: Chunk size used for the batch operation described in the previous point.The default value is 200.
    • Override Reason with Reason Code: This setting is only relevant for Orgs that opt for using the Reason Code picklist instead of Reason text field on Off Limit Policy records.
  3. Navigate to Setup > Custom Metadata Types > Off Limit Policy Definitions.
    • These policy settings are configured and active out of the box, but you can make changes as required if you need to modify any of them.
  4. Navigate to Setup > Custom Metadata Types > Off Limit Configuration.
    • These policy settings are configured and active out of the box, but you can make changes as required if you need to modify any of them.
  5. Navigate to Setup > Custom Metadata Types > ATS Config per Job Record Type.
  6. Add TR1__Off_Limit__c to the Fields to Display field for each of the relevant job record types.

Off Limit Icon Configuration

Configuration Options for Off Limit Icon

Display different Off Limits icons for Warn and Block behaviors.

  1. Navigate to Setup > Custom Settings > Executive Search.
  2. In the Default Off Limit Block Icon field, enter the URL that links to a Salesforce image resource (preferably an SVG).
    • To do this, you must erase the default value "/resource/TR1__Lock_icon_svg".
      • Removing this value will remove the lock icon from policies where the Type is Block.
  3. In the Default Off Limit Warning Icon field, enter the URL that links to a Salesforce image resource (preferably an SVG).
    • To do this, you must erase the default value ":/resource/TR1__Warning_icon_svg".
      • Removing this value will remove the lock icon from policies where the Type is Warning.
  4. Click Save.

If you set overrides in the Checkpoint Configurator, the icon shown will depend on the behavior set in the Off Limit Policy Line Item. For more information, see Off Limits Policies and Off Limits Policy Line Items.

Alternative Configuration Options for Off Limit Icon

TR1__Off_Limit_Custom_Icon__c is the Off Limit Custom Icon field in the Contact object. This field is used for alternative configuration of the Off limit Icon. Populating this field with values allows specified ContactsClosed A contact (or client contact) is the person who the recruiter is working with at a Company. In Talent Rover a Contact can be either a Client Contact or a Candidate Contact. Both types of Contacts are stored in the same object (Contact). to display different Off Limit icons than the default icons.

The supported value in the Off Limit Custom Icon field is a relative URL that directs to a Salesforce image resource, preferably an SVG. For example, /resource/TR1__Lock_icon_svg.

If the Off Limit Custom Icon field is empty, BH4SF displays the default Off Limit icon based on the Executive Search custom setting's Default Off Limit Icon field.

Off Limit Icon Pop-Up Configuration

  1. Navigate to Setup > Object Manager > Off Limit Info.

  2. Click Field Sets.

  3. Click Off Limit Icon Hover-Over Pop-up.

  4. Add/remove fields as desired.

    • This customizes the data shown in the pop-up.

Due to Salesforce limitations, the Off Limit icon hover-over pop-up is shown in all places where the Off Limits icon is visible, except for the following:

  • Account Record detail and List View
  • Contact Record detail and List View

Off Limit Checkpoint Modal Configuration

To add data from Off Limit Policy/Off Limit Line Item objects:

  1. Navigate to Setup > Object Manager > Off Limit Line Item.

  2. Click Field Sets.

  3. Click Checkpoint Fieldset.

  4. Add remove fields from this field set as required.

  5. Click Save.

To add data from Contact/Off Limit Info objects:

  1. Navigate to Setup > Object Manager > Off Limit Info Item.
  2. Click Field Sets.
  3. Click Checkpoint Fieldset.
  4. Add remove fields from this field set as required.

Configure Org Defaults for Policy Type

  1. Navigate to Setup > Custom Metadata Types.
  2. Next to Off Limit Policy Definitions, click Manage Records
  3. If this is first configuration, you will need to pull the relevant fields onto the Off Limit Policy Definition page layout.

  4. Click the mdt record for the policy type you want to configure the Org level Default for.
  5. Click Edit.
  6. In the Default Behavior Type dropdown, choose your desired default off limit behavior.
    • Click either Warning or Block.
  7. Click Save.

Configure Org defaults for Policy Rank and Policy Rank + Type

  1. Navigate to Setup > Custom Metadata Types.
  2. Next to Off Limit Policy Definitions, click Manage Records.
  3. If this is first configuration, you will need to pull the relevant fields onto the Off Limit Policy Definition page layout.
  4. Click the Off Limit Policy Definition record you want to configure.
    • For example, to configure the defaults for the Contact Policy, click Contact Policy.
  5. Click Edit.
  6. To set the default Rank value for the Warning policy behavior type, enter a positive Integer value in the Default Rank On Warn Type field.
  7. To set the default Rank value for the Block policy behavior type, enter a positive Integer value in the Default Rank On Block Type field.
  8. Click Save.

Clone Off Limits Policy

You have the ability to clone any type of Off Limits policy record. You may add the Clone_Policy action to where you need it in the layout.

  1. Navigate to Setup > Object Manager.
  2. Next to Off Limit Policy, click the dropdown and select Edit.
  3. Click Buttons, Links, and Actions.
  4. Click the appropriate page (EX: Clone Policy) > Edit.
  5. Replace the standard Clone button with Clone_Policy button.
  6. Click Save.

Off Limits Policies Child Accounts Pop-Up

  1. Navigate to Setup > Object Manager > Account > Field Sets > Child Account.
  2. Add/ Remove any of the available fields as needed.

The Child Account pop-up is only available on an Account Policy record if an Account Hierarchy is present in the Org for that Account (i.e. if that Account has child accounts).

Successful Candidate Off Limit Policy Configuration

For more information on the Successful Candidate Off Limit Policy, see Off Limits Policies Successful Candidate.

Picklist

Add the Successful_Candidate_Policy picklist value to ensure the Classification picklist field is available for editing on the Successful Candidate Policy Record Type.

  1. Navigate to Setup > Object Manager.
  2. In the Off Limit Policy row click the dropdown and select Edit.
  3. Click Fields & RelationshipsClassifications.
  4. In the Values section click New.
  5. In the blank box, enter "Successful_Candidate_Policy".
  6. In the Record Type Name column, click the Successful Candidate Policy checkbox.
  7. Click Save.

Custom Setting

Update the Executive Search custom setting to include the desired configurations.

  1. Navigate to Setup > Custom Settings.
  2. Next to Executive Search, click Manage.
  3. Click Edit.
  4. Configure these fields:
  5. Click Save.

Page Layout

Assign

Assign the Successful Candidate Policy Page Layout to Off Limit Policy records with Successful Candidate record type. Adjust layout fields if needed.

  1. Navigate to Setup > Object Manager.
  2. In the Off Limit Policy row click the dropdown and select Edit.
  3. Click Page Layouts.
  4. Click Page Layout Assignment.
  5. Click Edit Assignment.
  6. Click the Page Layout to Use dropdown and select Successful Candidate Policy Page Layout.
    • Assign Successful Candidate Policy Page Layout to Off Limit Policy records with the Successful Candidate record type. 
    • Assign per policy record type and profile. For example, System Administrator.
  7. Click Save.

For more information on Page AssignmentsClosed Object. Its records store details about a Job position to be filled, see the Salesforce article Page Layouts and Record Types in Salesforce.

Configure

You will need to configure the Closing ReportClosed Fifth Stage of Job placement flow, a Candidate that reaches the Closing Report Placement stage has been assigned to a job. In BH4SF, a 'Closing Report' is a record that captures all the information related to the newly filled position (name of Candidate, position, salary, start date, which recruiter gets credit for the hire etc.) object page layouts.

  1. Navigate to Setup > Object Manager.
  2. Next to Closing Report, click the dropdown and select Edit.
  3. Click Page Layouts.
  4. Select the appropriate Record Type
  5. In the Fields section, drag and drop the following fields into the Closing Report Detail section:
    • Off Limits Duration
    • Extend to Job's Account Hierarchy
    • Include Billing Account Hierarchy
    • Withheld
  6. Click Save.
  7. Complete the above steps for all necessary record types.
While you are in Page Layouts, adjust layout fields, if needed

Edit Access

Assign Edit access to the Off Limits Duration field in the Closing Report to the relevant user profiles.

One way to do this is below:

  1. Navigate to Setup > Permission Sets.
  2. Next to an appropriate permission set you would like to add the permissions to (EX: ATSv2Closed In BH4SF, the newest version of the ATS tool (Application Tracking System)) click Clone.
  3. Enter a new unique label and API name for the cloned permission set.
    • For example, for the label enter "ATSv2 Off Limits Duration" and the API Name enter "ATSv2_Off_Limits_Duration"
  4. Enter a Description.
  5. Click Save.
  6. Click your newly created Permission Set. For example, ATSv2 Off Limits Duration.
  7. Click Object SettingsClosing Reports.
  8. Click Edit.
  9. For Off Limits Duration field, click the Edit Access checkbox.
  10. Click Save.

Create EditForm_Successful_Candidate Fieldset

  • While you are in the Object Manager's Off Limit Policy, you can also adjust the CreateEditForm_Successful_Candidate fieldset if you need to if need to display Create/Edit form fields for the Successful Candidate record type.
    1. Start in the same place as above:
      1. Setup > Object Manager > Off Limit Policy.
    2. Click Field Sets.
    3. In the CreateEditForm_Successful_Candidate row click the dropdown and select Edit.
    4. In the Off Limit Policy section, drag and drop any fields that you need to use into the In the Field Set section. Below are some fields we recommend:
      • Active
      • Closing Report
      • Description
      • Duration
      • End Date
      • Legal Reason
      • Rank
      • Reason
      • Start Date
      • Type
    5. Click Save.

    Job Off Limit Policy Configuration

    Assign Page Layout

    Assign the Job Policy Page Layout to Off Limit Policy records with Job Policy record type. Adjust layout fields if needed.

    1. Navigate to Setup > Object Manager.
    2. In the Off Limit Policy row click the dropdown and select Edit.
    3. Click Page Layouts.
    4. Click Page Layout Assignment.
    5. Click Edit Assignment.
    6. Click the Page Layout to Use dropdown and select Job Policy Page Layout.
      • Assign Job Policy Page Layout to Off Limit Policy records with the Job Policy record type.
      • Assign per policy record type and profile. For example, System Administrator.
    7. Click Save.

    For more information on Page Assignments, see the Salesforce article Page Layouts and Record Types in Salesforce.

    Create EditForm_Job Fieldset

  • While you are in the Object Manager's Off Limit Policy, you can also adjust the CreateEditForm_Job fieldset if you need to if need to display Create/Edit form fields for the Job record type.
    1. Start in the same place as above:
      1. Setup > Object Manager > Off Limit Policy.
    2. Click Field Sets.
    3. In the CreateEditForm_Job row click the dropdown and select Edit.
    4. In the Off Limit Policy section, drag and drop any fields that you need to use into the In the Field Set section.
    5. Click Save.

    Picklist

    Add the Job_Policy picklist value to ensure the Classification picklist field is available for editing on the Job Policy Record Type.

    1. Navigate to Setup > Object Manager.
    2. In the Off Limit Policy row click the dropdown and select Edit.
    3. Click Fields & RelationshipsClassifications.
    4. In the Values section click New.
    5. In the blank box, enter "Job_Policy".
    6. In the Record Type Name column, click the Job Policy checkbox.
    7. Click Save.

    Job Record Button

    Add the new Job record button New_Job_Off_Limit_Policy. This button will be used on the record Detail page of Job.

    List View Button

    Add the new List View button on Contact.

    To do this, the Create_Job_Off_Limit_Policyshould be used on the Contact List view and on Contact Related Lists (EX: Contacts Related List on Account records).

    Switch-Off Off Limits for Non-Executive Jobs

    1. Navigate to the Job object
    2. Create a new field with the field type of checkbox.
      • This will flag non-executive Job records.
    3. Ensure this checkbox is enabled on all non-executive search Jobs.
    4. Navigate to Setup > Custom Settings > Executive Search.
    5. Enter the API name of the Job field you just created in the Non Executive Job Field API Name field.

    Schedule Batch Jobs

    Daily

    Schedule the following classes as daily jobs:

    • OffLimitPolicyDisablePassedBatch: Batch for disabling policy when End Date is Today
      • Daily is required.
    • OLLineItemDisableExpiredBatch: Batch to update expired line items to Disable.
      • Daily is required.
    • OffLimitPolicyRecalcTodayStartDateBatch: Batch for enabling a policy when Start Date is Today.
      • Daily is required.
    • EmploymentHistoryUpdateCurrentBatch: Batch to mark Current__c is false when EmploymentHistory__cEnd_Date__c is before TODAY.
      • Daily is required.

    One-Time Execution

    One-time execution batches are available to update the Current checkbox on existing Employment History records.

    This can be helpful because some batches only batch in specific scenarios. For example, the EmploymentHistoryUpdateCurrentBatch happens only when an Employment Record is created/updated.

    1. Start the batch from a non-console.
    2. Enter the following:

      Copy
      Database.executeBatch(new EmploymentHistoryCheckCurrentBatch(), 2000);


    3. Use this information:
      • Class Name: EmploymentHistoryCheckCurrentBatch
      • Logic: BH4SF checks all existing Employment History records and identifies those for which Current should be ticked based on the following:
        • End Date is in the past: Exclude.
        • End Date is in the future: Mark as Current.
        • End Date is blank: If there is a Start Date, mark as Current .
        • End Date is a string: If there is a Start Date, mark as Current .
          • For example, "present" is a string.