: Customizing Candidate Stages
This article applies to ATS v2s using the ATS v2 data model only.
Overview
There are several customizations available for Candidate Stages within including adding, removing, and renaming stages. This article walks you through how to add, remove, and rename stages.
Add a New Stage
- Add the new stage name as a picklist value in the TR1__Stage__c picklist field within the object.
-
Enable the new picklist value for all relevant Record Types
The package includes the following Record Types:
Consulting
Fixed Term BookingClosed
Permanent
Retained
If any custom JobClosed Record Types have been added in your Org, ensure that you also add the same Record Type to the ApplicationClosed V2 object and the Closing ReportClosed object. Then, enable your new stage picklist value for the custom record type(s)
- Run the following line of script in the Developer Console by clicking the Setup icon at the top right of screen, and then Developer Console. Go to Debug > Open Execute Anonymous Window and enter the following: TR1.RecordTypePicklistDescriber.refreshPicklistMetadata();
-
The stage sequence is defined in the following location:Permanent .
Entry per Record Type (EX: -
If the above setting is not configured for the Record Type, the sequence of the picklist values in the TR1_Stages_c field on the Application
V2 object is used.
- Go to Application page layout in object and create a new section with Stage Name Details. After doing this, add the related fields under this section.
- Set up a data entry page for the newly created stage (if required):
- Create a new Field Set in the object and add the required fields to the Field Set for the data entry page.
- Create a new ATS New Stage Config Custom Metadata Type entry with the following:
- Label: Any Label name
- FieldSetName: API
Name of the new Field Set
- StageName: Stage Name
- Add the appropriate Job stage banner (stage icon) for the newly created stage in Setup > Static Resources.
- Create a new static resource with the name ATSv2
_ + your new stage name.
- Upload the banner image for your new stage under the Static Resource.
- If the stage name includes two words (such as Final Decision), then combine both words and add a prefix string in the Static Resource name (ATSv2_FinalDecision).
- Create a new static resource with the name ATSv2
Remove an Existing Stage
- Remove the Stage Name from the TR1__Stage__c picklist values in the object.
- Go to the Application page layout in the object and remove the related section.
- Run the following line of script in the Developer Console by clicking the Setup icon at the top right of screen, and then Developer Console. Go to Debug > Open Execute Anonymous Window and enter the following: TR1.RecordTypePicklistDescriber.refreshPicklistMetadata();
-
The stage sequence is defined in the following location:Permanent .
Entry per Record Type (EX:-
If the above setting is not configured for the Record Type, the sequence of the picklist values in the TR1_Stages_c field on the Application V2 object is used.
-
- After running the script, check the log for a success message.
- Refresh the page to view the update.
Rename an Existing Stage
Via Translation Workbench
- Go to Setup >Translation Workbench and click Translate:
- Select the appropriate language.
- In the Setup Component drop-down, select Picklist Value.
- In the Object drop-down, select .
- Click the plus icon (+) next to a stage to expand the view.
- Add a new label for each stage in the Picklist Value Label Translation column.
- Save the changes.
- Update the relevant Custom Labels by going to Setup > Custom Labels to find the related custom label for the stage.
Below are all the Custom Labels created for each stage.
- Custom Label Name Value:
- ATS_Submittal
_Stage Submittal
- ATSv2_Offer
_Stage Offer
- ATSv2_Send_Out_Stage Send Out
- ATSv2_Closing_Report_Stage Closing Report
- ATSv2_Application_Stage Application
- ATSv2_Internal_Interview
_Stage Internal Interview
- ATS_Submittal
- Custom Label Name Value:
Via Database
- Go to the object and search for the Stage__c field and click on it.
- Every stage appears here so click Edit next to the desired stage name.
- Add the new value for the stage.
- Save the changes.
- Update the relevant Custom Labels by going to Setup > Custom Labels to find the related custom label for the stage.
Below are all the Custom Labels created for each stage.
- Custom Label Name Value:
- ATS_Submittal_Stage Submittal
- ATSv2_Offer_Stage Offer
- ATSv2_Send_Out_Stage Send Out
- ATSv2_Closing_Report_Stage Closing Report
- ATSv2_Application_Stage Application
- ATSv2_Internal_Interview_Stage Internal Interview
- Custom Label Name Value:
Closing Report Stage
If you are renaming or translating the Closing Report stage, you will also need to add the new Closing Report stage name to the following Custom Labels:
- ATSv2_Inline_Action
_disabled
- ATSv2_Mass_Actions_disabled
Add Banner
- Go to Setup > Static Resources.
- Create a new static resource with the name ATSv2_ + your new stage name.
- Upload the banner image for your new stage under the Static Resource.
- If the stage name includes two words (such as Final Decision), then combine both words and add a prefix string in the Static Resource name (ATSv2_FinalDecision).