Finding Merge Codes
The first step to take when building a Merge Document is attaining the Merge Codes. These codes (once placed in the Merge Document), will instantly insert the information you require.
There are 2 different types of codes you can use: Standard and Custom. The Standard Codes cover the basic information about the candidate or job (i.e. Candidate Name and Job Reference number). Custom Codes on the other hand cover the fully-configurable elements of the system (including Global Questions for jobs and candidates, i.e. Job Department or Candidate Addresses).
Standard Codes
[NGA_CANDIDATE_CANDIDATEID] | ID of the Candidate |
[NGA_CANDIDATE_EMAIL] | Email address of the Candidate |
[NGA_CANDIDATE_TITLE] | Title of the Candidate |
[NGA_CANDIDATE_FIRSTNAME] | First Name of the Candidate |
[NGA_CANDIDATE_SURNAME] | Surname of the Candidate |
[NGA_CANDIDATE_APP_STATUS] | Application Status of the Candidate |
[NGA_CANDIDATE_GROUP_NAME] | Group Name of the Candidate |
[NGA_JOB_JOBID] | JobID of the Job |
[NGA_JOB_NAME] | Name of the Job |
[NGA_JOB_REFERENCE] | Reference No. of the Job |
[NGA_JOB_DESCRIPTION] | Description of the Job |
[NGA_DATE_TODAY] | Today's Date |
Custom Codes
When using the Custom Codes, you need to use the following code templates:
[NGA_GLOBAL_QUESTION|APP(ID)] | The result of the global question for this Application |
[NGA_GLOBAL_QUESTION|JOB (ID)] | The result of the global question for Job |
[NGA_GLOBAL_QUESTION|CANDIDATE(ID)] | The result of the global question for this Candidate |
[NGA_OOM_CRITERIA_PROCESSSTEP(ID)] | Order of merit on a particular Approval step (ID) |
[NGA_OOM_CRITERIA_PROCESSSTEPTEMPLATE(ID)] | Order of merit on a particular Approval step template (ID) |
[NGA_COUNT_PROCESSSTEP_SUCCESSFUL(ID)] | Count of successful executions for a particular step (ID) |
[NGA_COUNT_PROCESSSTEPTEMPLATE_SUCCESSFUL(ID)] | Count of successful executions for a particular step template (ID) |
[NGA_JOB_ROLE_USER(ID)] | User for a particular job role (ID) |
[NGA_ROLE_DESCRIPTION(ID)] | Description for a particular role (ID) |
[NGA_SELECTIONCRITERIA(n)] | Description for a particular Job Selection Criteria ( n ) |
Of these, the codes that are most used for Merge Documents are the Global Question codes for APP and JOB. These are different based on the context in which they are used. A JOB code is based on a field completed on a Requisition, Job Details or Approval form; however APP code is based on an Application or Assessment form answer for the candidate.
Note: When using the APP or JOB codes, it will extract the most recent answer.
The (ID) section of the code is where you place the unique instance code for the required Global Question or Process.
For example, after you get the unique ID number for the merge code (in this case a Job code), it will look like this:
[NGA_GLOBAL_QUESTION|JOB(c9265f2c-fbe8-668d-c4dd-52557da45846)]
If we break this down, [NGA_GLOBAL_QUESTION|JOB( )] is the basic code (which must never be changed), whilst the c9265f2c-fbe8-668d-c4dd-52557da45846 is the unique ID number.
How do we get that ID Number? Here is how we do it:
How to Locate Global Question ID numbers
- Log into the system and click the Analytics tab at the top of the page.
- This will take you to the Reports Dashboard screen. Click on the Browse link at the top of the screen.
- This will take you to the Report list, enter Merge Document Report in the search field, and then select the Merge Document Report that is displayed.
- This will then give you the ability to find specific Global Questions using filters:
Note: Here you can use filters to find a specific Global Question using the ID, Reference or actual Question Text (label). If you would like to see all the Global Questions, don’t apply any filters to the report.
- Once you have applied any filters, click the icon in the bottom right hand corner of the screen to run the report.
- This will then run a report showing you a list of all your Global Questions and their unique ID numbers
- Click the Export button at the top of the screen to Export to Excel.
- This will open up a spreadsheet with every global question in your system, including the Question Reference, Question Text (or Label) and more importantly, the ID Number (or GlobalQuestionID).
- Now that you have all the Global Question codes, you will need to start constructing a Merge Code Library.
Using a Group Question in a Merge Document
If you would like to merge out information based on a Group Question, it is slightly more complex than using one merge ID code. You will need to find the ID codes for not only the question, but for the actual fields (or cells) within the group question you wish to use.
Below are the codes to be used to merge out specific Group Question data.
[NGA_GROUP_GLOBAL_QUESTION|APP(ID, O_ID, CQ_ID)] | The result of the group global question for an Application |
[NGA_GROUP_GLOBAL_QUESTION|CANDIDATE(ID, O_ID, CQ_ID)] | The result of the group global question for a Candidate |
[NGA_GROUP_GLOBAL_QUESTION|JOB(ID, O_ID, CQ_ID)] | The result of the group global question for a Job |
So how do these codes work?
The ID represents the actual question (taken from the Global Question Library); however the O_ID and CQ_ID codes represent the individual cells within the group question. You are able to get this code using the traditional method laid out earlier in the guide.
The O_ID represents the Parent Answer option (the options in the left hand column of this group question – in this example: Mon and Tues).
The CQ_ID represents the Child Question option (the options in the row across the top of the answers – in this example: Finish Time, Start Time and Total Hours).
Finding the codes for the O_ID and the CQ_ID has to be done in a different manner as the method shown previously. To get the ID for each column, you will need to edit the question itself in the Global Question library.
- Click the System icon at the top of the screen.
- Click the Global Questions link under the System heading.
- This will take you to the Global Question Library.
- Locate the Group Question you wish to use (either using the filters or search), and click the Edit link under the Action(s) column.
- This will take you to the Global Question screen. Click the Answer Options tab at the top of the screen.
- This will present you with all the Parent Answers and Child Questions.
To get the ID codes, right mouse click on the Edit link (under the Action column) and choose Copy Shortcut, Copy Link, Copy link address, or Copy Link Location from the popup menu. (See options below for various browsers):
Microsoft Internet Explorer Microsoft Edge Google Chrome Mozilla Firefox - Paste this link into a Notepad file.
- Take the first Code in the pasted link (in this case the Option ID – O_ID), and this will be the ID code you will be using for the Merge Code.
Note: Take the code between the OptionID= and the &mainMenuItem area of the link.
- This process is exactly the same as getting the codes for the Child Questions.
- Take the first Code in the pasted link (in this case the ChildGlobalComponent ID – CQ_ID), and this will be the ID code you will be using for the Merge Code.
Note: take the code between the OptionID= and the &mainMenuItem area of the link.
The completed Group Question code string should look something like this:
Constructing a Merge Code Library
Acendre can provide you with Merge Code Library; this is a notepad document which you will use to copy and paste merge codes into the Merge Document template. You must always use the notepad document format when inserting the Merge Codes into the Merge Document template. As notepad text is completely unformatted it reduces the likelihood of Merge Code errors in your system.
- Open up the Merge Document Code Library you have been provided by Acendre. It will look like this:
- In this document, there are the Standard Codes and the Custom Codes. Scroll down the document to find the Custom Codes section.
These codes will act as templates for all the Global Questions you wish to insert into a merge document.
- Copy and paste (Ctrl + C and Ctrl + V on your keyboard) whichever code you wish to use directly below the template code like so:
You will now need to go and attain the Global Question ID from the exported spreadsheet.
- Select and copy the Global Question ID by holding down Ctrl + C on your keyboard (or highlight the text, then right mouse click and choose Copy).
- Paste the Global Question ID between the (ID) sections of the code in the Library (using the Ctrl + V on your keyboard), and the finished result will look like this:
Note: It is best practice to type in the name of the Global Question next to the Merge Code making it easier for future use.
- Repeat this process for all the Merge Codes you wish to use. Your Merge Code Library should look like this:
- Save this file onto your Hard Drive, as you will be able to use this file each time you amend or build new Merge Documents in the future.
Now you are ready to start inserting the Merge Codes into the Merge Document.