Toggle menu

Employer Organisation Objects

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:

FieldDescription
IDA unique ID for the organisation, this will be the article ID of the relevant contact article in the case of employers
NAMEThe organisation name
SITEUSERGROUPThe ID of the user group linked to this organisation
STARTDATE/ENDDATENot currently used

The standard employer definition also includes the following fields. These are populated when an employer is registered.

FieldDescription
CONTACTARTICLEIDThe ID of the contact article
LOGOThe ID of the image uploaded when the employer was registered
DESCRIPTIONA description of the employer
SECTORSSector metadata IDs
EMAILThe employer's email
TELEPHONEThe employer's land line
TWITTERLink to employer's Twitter page
FACEBOOKLink to employer's Facebook page
LINKEDINLink to employer's LinkedIn page
WEBLink to employer's website
ADDRESS1/2/3Address lines 1, 2 and 3
CITYTown or city
POSTCODEPostcode
REGIONCounty/region
COUNTRYCountry 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 goss.organisations.organisationTypeCreate end point.

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
}

Last modified on 9 September 2025