Organisation objects link employers, employer articles, and the publisher site user groups together. An object is created each time a new employer is registered.
Before any employers can be registered (and their corresponding objects created), the organisation object type definition needs to be created as part of the framework installation. Each type of organisation also needs a form to create and update those organisations - these forms start the "contribute article" process.
Currently, only the Job Advert Framework makes use of organisation objects, so you will only have a single organisation object type, and single set of create/update forms.
Organisation Definition Form
Organisations are defined using a form, which generates the object type definition.
The EXTORGANISATIONSBLUEPRINT blueprint provides the basic fields needed for an organisation. Use this blueprint to create a new type of organisation.
The blueprint fields are:
| Field | Description |
|---|---|
| ID | A unique ID for the organisation, this will be the article ID of the relevant contact article in the case of employers |
| NAME | The organisation name |
| SITEUSERGROUP | The ID of the user group linked to this organisation |
| STARTDATE/ENDDATE | Not currently used |
The standard employer definition also includes the following fields. These are populated when an employer is registered.
| Field | Description |
|---|---|
| CONTACTARTICLEID | The ID of the contact article |
| LOGO | The ID of the image uploaded when the employer was registered |
| DESCRIPTION | A description of the employer |
| SECTORS | Sector metadata IDs |
| The employer's email | |
| TELEPHONE | The employer's land line |
| Link to employer's Twitter page | |
| Link to employer's Facebook page | |
| Link to employer's LinkedIn page | |
| WEB | Link to employer's website |
| ADDRESS1/2/3 | Address lines 1, 2 and 3 |
| CITY | Town or city |
| POSTCODE | Postcode |
| REGION | County/region |
| COUNTRY | Country selection |
Create and Update Forms
The create and update forms are customised versions of the Contribute forms. They create articles using the Contact template, and pass the contribute process the names of two custom end points used to create employer contact articles, organisation objects, and publisher user groups:
processVars.CONTRIBUTEARTICLE_CREATEARTICLE_EP = "goss.jobs.employer.createEmployer";
processVars.CONTRIBUTEARTICLE_ARCHIVEARTICLE_EP = "goss.jobs.employer.archiveEmployer";
End Point
When a new type of organisation is created, it needs to be added to the list of organisation types.
Find the
On the testing tab, enter the following parameters:
{
"objectType": "FORM_", //The name of the form created above to define the organisation
"name": "", //A name for this type or organisation eg employers
"createForm": "", //The name of the form used to create organisations of this type
"editForm": "" //The edit form above
}
