Configuration for creating employers and job adverts is held in two end points, following the usual
Standard Contribute Configuration
The forms used to create employers and job adverts create articles in iCM using the Contribute product (one instance for employers, one for jobs). Each contribute instance needs to have the standard contribute configuration set up, plus the extra properties described below.
Employer Configuration
Namespace:
Employer articles use the Contact template, with mappings set up between the form fields and Contact article extras. The configuration also includes the IDs of Metadata properties used in the contribute forms and the name of the Employer Organisation Objects that links employers and users together.
Properties
As well as the standard Contribute configuration, these additional properties are specific to employers.
| Name | Type | Description |
|---|---|---|
| employerHubName | String | The name of the employer hub which will be used in the Email Templates |
| employerHubURL | String | The URL of the employer hub which will be used in the Email Templates |
| fromEmail | Object | Emails sent out for approvals and confirmation will appear to come from this address. The object has two properties, |
| organisationObjectType | String | The object type definition that defines the type of employer. These objects are defined using forms, as described in Employer Organisation Objects, so will have a |
| sectorMetadataID | Integer | The ID of the metadata property that describes the sector/services the employer operates in/provides. The values in this property appear on the contribute form |
| templateID | Integer | The ID of your Contact template |
| approvalUserGroup | String | The name of the site user group responsible for approving employers |
Example Employer Configuration
This example shows a full configuration end point for creating employer articles.
function(params, credentials) {
return {
"fromEmail": {
"name": "Jobs Admin",
"address": "[email protected]"
},
"organisationObjectType": "FORM_EXTORGANISATIONSCAREEMPLOYERS",
"sectorMetadataID": 62,
"apiKey": "0674B01C-xxx-AC9946FD33FF",
"rootArticleID": 3732,
"rootContributeGroupID": 18,
"templateID": 33,
"rootMediaGroupID": 448,
"approvalUserGroup": "STAFF",
"mediaGroupStructure": [
String(new Date().getFullYear()),
String(new Date().getMonth() + 1),
String(new Date().getDate())
],
"articleToFormMapping": [{
"from": "ArticleHeading",
"to": "form_NAME"
},
{
"from": "ArticleText",
"to": "form_EMPLOYERDESCRIPTIONTEXT"
},
{
"from": "Extension.WEB",
"to": "form_EMPLOYERURL"
},
{
"from": "Extension.EMAIL",
"to": "form_EMPLOYEREMAIL"
},
{
"from": "Extension.TELEPHONE",
"to": "form_EMPLOYERPHONENUMBER"
},
{
"from": "Extension.FACEBOOK",
"to": "form_FACEBOOK"
},
{
"from": "Extension.TWITTER",
"to": "form_TWITTER"
},
{
"from": "Extension.LINKEDIN",
"to": "form_LINKEDIN"
},
{
"from": "Extension.SUMMARYMODE",
"to": "form_SUMMARYMODE"
},
{
"from": "Extension.ADDRESS1",
"to": "form_ADDRESSLINE1"
},
{
"from": "Extension.ADDRESS2",
"to": "form_ADDRESSLINE2"
},
{
"from": "Extension.ADDRESS3",
"to": "form_ADDRESSLINE3"
}, {
"from": "Extension.CITY",
"to": "form_CITY"
},
{
"from": "Extension.POSTCODE",
"to": "form_POSTCODE"
},
{
"from": "EXTENSION.REGION",
"to": "form_REGION"
},
{
"from": "RelatedMetaDataList",
"to": "form_SERVICE"
}
],
"formToArticleMapping": [{
"from": "form_NAME",
"to": "ArticleHeading"
},
{
"from": "form_EMPLOYERDESCRIPTIONTEXT",
"to": "ArticleText"
},
{
"from": "form_EMPLOYERURL",
"to": "Extension.WEB"
},
{
"from": "form_EMPLOYEREMAIL",
"to": "Extension.EMAIL"
},
{
"from": "form_EMPLOYERPHONENUMBER",
"to": "Extension.TELEPHONE"
},
{
"from": "form_FACEBOOK",
"to": "Extension.FACEBOOK"
},
{
"from": "form_TWITTER",
"to": "Extension.TWITTER"
},
{
"from": "form_LINKEDIN",
"to": "Extension.LINKEDIN"
},
{
"from": "form_SUMMARYMODE",
"to": "Extension.SUMMARYMODE"
},
{
"from": "form_ADDRESS1",
"to": "Extension.ADDRESS1"
},
{
"from": "form_ADDRESS2",
"to": "Extension.ADDRESS2"
},
{
"to": "form_ADDRESS3",
"from": "Extension.ADDRESS3"
}, {
"from": "form_CITY",
"to": "Extension.CITY"
},
{
"from": "form_POSTCODE",
"to": "Extension.POSTCODE"
},
{
"to": "form_REGION",
"from": "EXTENSION.REGION"
},
{
"from": "form_SERVICE",
"to": "RelatedMetaDataList"
}
],
"RelatedMedia": [{
"type": "image",
"files": [{
"fileType": "variant1",
"fieldName": "form_IMAGE"
}],
"formToMediaMapping": [{
"from": "form_NAME",
"to": "Title"
}, {
"from": "form_NAME",
"to": "Description"
}]
}]
};
}
Jobs Configuration
Namespace:
Job advert articles use the Job Template, with mappings set up between the form fields and Job article extras. Most of the additional configuration provides the metadata property IDs used to generate options in the Creating and Updating Job Adverts forms.
Properties
As well as the standard Contribute configuration, these additional properties are specific to jobs.
| Name | Type | Description |
|---|---|---|
| employerHubName | String | The name of the employer hub which will be used in the Email Templates |
| referencePrefix | String | Prefix used for automatically geerated reference numbers (if one is not set by the user when creating the job advert) Format is |
| allowDocuments | Boolean | Whether or not document uploads are allowed on the job creation form |
| personalCareMetadataID | Integer | A metadata property ID. Values in this property provide options in the job creation form. See Metadata for a full description |
| oSLicenceMetadataID | Integer | A metadata property ID. Values in this property provide options in the job creation form. See Metadata for a full description |
| drivingLicenceMetadataID | Integer | A metadata property ID. Values in this property provide options in the job creation form. See Metadata for a full description |
| salaryRateMetadataID | Integer | A metadata property ID. Values in this property provide options in the job creation form. See Metadata for a full description |
| categoryMetadataID | Integer | A metadata property ID. Values in this property provide options in the job creation form. See Metadata for a full description |
| servicesMetadataID | Integer | A metadata property ID. Values in this property provide options in the job creation form. See Metadata for a full description |
| benefitsMetadataID | Integer | A metadata property ID. Values in this property provide options in the job creation form. See Metadata for a full description |
| areaMetadataID | Integer | A metadata property ID. Values in this property provide options in the job creation form. See Metadata for a full description |
| serviceUsersMetadataID | Integer | A metadata property ID. Values in this property provide options in the job creation form. See Metadata for a full description |
| workingPatternMetadataId | Integer | A metadata property ID. Values in this property provide options in the job creation form. See Metadata for a full description |
| archiveRootID | Integer | An article ID to act as the parent of archived jobs. When creating a job, the "Close date" is used as the article archive date. On that date the article will be moved beneath this article ID |
| vacancyNameLabel | String | Throughout the form used to create jobs, this value is used as the variable in the "Add a new vacancyName vacancy". It can be left blank |
| organisationObjectType | String | The object type definition that defines an employer. These objects are defined using forms, as described in Employer Organisation Objects, so will have a |
| approvalUserGroup | String | The name of the site user group responsible for approving jobs |
| fromEmail | Object | Emails sent out for approvals and confirmation will appear to come from this address. The object has two properties, |
Example Jobs Configuration
This example shows a full configuration end point for creating job adverts.
function(params, credentials) {
return {
"personalCareMetadataID": 67,
"oSLicenceMetadataID": 66,
"drivingLicenceMetadataID": 65,
"salaryRateMetadataID": 58,
"categoryMetadataID": 57,
"servicesMetadataID": 62,
"benefitsMetadataID": 60,
"areaMetadataID": 61,
"serviceUsersMetadataID": 63,
"archiveRootID": 3731,
"vacancyNameLabel": "adult social care",
"organisationObjectType": "FORM_EXTORGANISATIONSCAREEMPLOYERS",
"approvalUserGroup": "STAFF",
"fromEmail": {
"name": "Jobs Admin",
"address": "[email protected]"
},
// The API key to use for creating/updating the article and media
"apiKey": "0674B01C-xxx-AC9946FD33FF",
// The article under which locations will be added (if a parent article ID is not supplied)
"rootArticleID": 3730,
// Article creation is handled across subsites. Select an article ID from the following:
"rootArticleIds": [{
env: "Jobs",
articleId: "3730"
}],
"rootContributeGroupID": 18,
// The ID of the Template to use for this article
"templateID": 74,
// The media group under which related media will be created (if a group ID is not supplied)
"rootMediaGroupID": 449,
// The media group structure to create below the rootMediaGroup, omit or use an empty
// array to add media directly to rootMediaGroup
"mediaGroupStructure": [
String(new Date().getFullYear()),
String(new Date().getMonth() + 1),
String(new Date().getDate())
],
"formToArticleMapping": [{
"from": "form_NAME",
"to": "ArticleHeading"
}, {
"from": "form_SUMMARY",
"to": "ArticleIntroText"
}, {
"from": "form_VACANCYDESCRIPTION",
"to": "ArticleText"
}, {
"from": "form_METADATA",
"to": "RelatedMetaDataList"
},
{
"from": "form_RELATEDARTICLEID",
"to": "RelatedArticleList"
},
{
"from": "form_ARCHIVEDATE",
"to": "ArchiveDate"
},
{
"from": "form_ARCHIVE",
"to": "Archiveable"
},
{
"from": "form_ARCHIVEPARENTID",
"to": "ArchiveParentID"
},
{
"from": "form_APPLICATIONURL",
"to": "Extension.APPLYLINK"
},
{
"from": "form_APPLICATIONEMAIL",
"to": "Extension.APPLYEMAIL"
}, {
"from": "form_APPLICATIONPHONENUMBER",
"to": "Extension.APPLYNUMBER"
},
{
"from": "form_SALARY",
"to": "Extension.SALARY"
},
{
"from": "form_HOURSDISPLAY",
"to": "Extension.HOURS"
},
{
"from": "form_VACANCYREFERENCE",
"to": "Extension.REFERENCE"
},
{
"from": "form_MISCSHOW",
"to": "Extension.MISCSHOW"
},
{
"from": "form_MISCHEADER1",
"to": "Extension.MISCHEADER1"
},
{
"from": "form_BENEFITSDISPLAY",
"to": "Extension.MISCTEXT1"
},
{
"from": "form_MISCHEADER2",
"to": "Extension.MISCHEADER2"
},
{
"from": "form_LOCATIONADDITIONALINFORMATION",
"to": "Extension.MISCTEXT2"
},
{
"from": "form_ADDRESS1",
"to": "Extension.ADDRESS1"
},
{
"from": "form_ADDRESS2",
"to": "Extension.ADDRESS2"
},
{
"from": "form_ADDRESS3",
"to": "Extension.ADDRESS3"
},
{
"from": "form_CITY",
"to": "Extension.CITY"
},
{
"from": "form_REGION",
"to": "Extension.REGION"
},
{
"from": "form_POSTCODE",
"to": "Extension.POSTCODE"
},
],
"articleToFormMapping": [{
"to": "form_NAME",
"from": "ArticleHeading"
}, {
"to": "form_SUMMARY",
"from": "ArticleIntroText"
}, {
"to": "form_VACANCYDESCRIPTION",
"from": "ArticleText"
}, {
"to": "form_METADATA",
"from": "RelatedMetaDataList"
},
{
"to": "form_RELATEDARTICLEID",
"from": "RelatedArticleList"
},
{
"to": "form_ARCHIVEDATE",
"from": "ArchiveDate"
},
{
"to": "form_ARCHIVE",
"from": "Archiveable"
},
{
"to": "form_ARCHIVEPARENTID",
"from": "ArchiveParentID"
},
{
"to": "form_APPLICATIONURL",
"from": "Extension.APPLYLINK"
},
{
"to": "form_APPLICATIONEMAIL",
"from": "Extension.APPLYEMAIL"
}, {
"to": "form_APPLICATIONPHONENUMBER",
"from": "Extension.APPLYNUMBER"
},
{
"to": "form_SALARY",
"from": "Extension.SALARY"
},
{
"to": "form_HOURSDISPLAY",
"from": "Extension.HOURS"
},
{
"to": "form_VACANCYREFERENCE",
"from": "Extension.REFERENCE"
},
{
"to": "form_MISCSHOW",
"from": "Extension.MISCSHOW"
},
{
"to": "form_MISCHEADER1",
"from": "Extension.MISCHEADER1"
},
{
"to": "form_BENEFITSDISPLAY",
"from": "Extension.MISCTEXT1"
},
{
"to": "form_MISCHEADER2",
"from": "Extension.MISCHEADER2"
},
{
"to": "form_LOCATIONADDITIONALINFORMATION",
"from": "Extension.MISCTEXT2"
},
{
"to": "form_ADDRESS1",
"from": "Extension.ADDRESS1"
},
{
"to": "form_ADDRESS2",
"from": "Extension.ADDRESS2"
},
{
"to": "form_ADDRESS3",
"from": "Extension.ADDRESS3"
},
{
"to": "form_CITY",
"from": "Extension.CITY"
},
{
"to": "form_REGION",
"from": "Extension.REGION"
},
{
"to": "form_POSTCODE",
"from": "Extension.POSTCODE"
},
],
// File upload to related media mapping
"RelatedMedia": [{
"type": "pdf",
"files": [{
"fileType": "pdf",
"fieldName": "form_SUPPORTINGPDF0"
}],
"formToMediaMapping": [{
"from": "form_NAME",
"to": "Title"
},
{
"from": "form_NAME",
"to": "Description"
}
]
},
{
"type": "pdf",
"files": [{
"fileType": "pdf",
"fieldName": "form_SUPPORTINGPDF1"
}],
"formToMediaMapping": [{
"from": "form_NAME",
"to": "Title"
},
{
"from": "form_NAME",
"to": "Description"
}
]
},
{
"type": "pdf",
"files": [{
"fileType": "pdf",
"fieldName": "form_SUPPORTINGPDF2"
}],
"formToMediaMapping": [{
"from": "form_NAME",
"to": "Title"
},
{
"from": "form_NAME",
"to": "Description"
}
]
},
{
"type": "pdf",
"files": [{
"fileType": "pdf",
"fieldName": "form_SUPPORTINGPDF3"
}],
"formToMediaMapping": [{
"from": "form_NAME",
"to": "Title"
},
{
"from": "form_NAME",
"to": "Description"
}
]
},
{
"type": "pdf",
"files": [{
"fileType": "pdf",
"fieldName": "form_SUPPORTINGPDF4"
}],
"formToMediaMapping": [{
"from": "form_NAME",
"to": "Title"
},
{
"from": "form_NAME",
"to": "Description"
}
]
},
{
"type": "word",
"files": [{
"fileType": "doc",
"fieldName": "form_SUPPORTINGWORD0"
}],
"formToMediaMapping": [{
"from": "form_NAME",
"to": "Title"
},
{
"from": "form_NAME",
"to": "Description"
}
],
},
{
"type": "word",
"files": [{
"fileType": "doc",
"fieldName": "form_SUPPORTINGWORD1"
}],
"formToMediaMapping": [{
"from": "form_NAME",
"to": "Title"
},
{
"from": "form_NAME",
"to": "Description"
}
],
},
{
"type": "word",
"files": [{
"fileType": "doc",
"fieldName": "form_SUPPORTINGWORD2"
}],
"formToMediaMapping": [{
"from": "form_NAME",
"to": "Title"
},
{
"from": "form_NAME",
"to": "Description"
}
],
},
{
"type": "word",
"files": [{
"fileType": "doc",
"fieldName": "form_SUPPORTINGWORD3"
}],
"formToMediaMapping": [{
"from": "form_NAME",
"to": "Title"
},
{
"from": "form_NAME",
"to": "Description"
}
],
},
{
"type": "word",
"files": [{
"fileType": "doc",
"fieldName": "form_SUPPORTINGWORD4"
}],
"formToMediaMapping": [{
"from": "form_NAME",
"to": "Title"
},
{
"from": "form_NAME",
"to": "Description"
}
],
}
]
};
}
