Skip to content

The Agreement model

Agreements are managed as objects stored in Auth DB. Those objects may be viewed, added, edited and deleted using the Admin Panel.

Agreement’s fields

  • label (string, required) – primary key, a string value; it may also be used to briefly describe this agreement for the n6 instance’s administrators.
  • en (string, required) – the English description of the agreement as seen in the Registration and Organization Agreements forms. Limited to 255 characters.
  • pl (string, required) – the Polish description of the agreement as seen in the Registration and Organization Agreements forms. Limited to 255 characters.
  • url_en (string, optional) – a link (URL) to an external website (a See more hyperlink) with additional information for this agreement when English language is used. This link must use the HTTP or HTTPS protocol.
  • url_pl (string, optional) – a link (URL) to an external website (a See more hyperlink) with additional information for this agreement when Polish language is used. This link must use the HTTP or HTTPS protocol.
  • default_consent (boolean, default=True) – a flag used to determine whether this agreement should be pre-selected by default in the Registration form (note: the flag concerns only the Registration form, not the Organization Agreements form).

Agreement’s relations

Agreement as an Auth DB model exists independently of other models, so its instances are not deleted by cascade when a related object is being removed. There are two Auth DB models in relation with Agreement:

  • Org – agreements related with an Org are binding for the organization and can be managed client-side using the Organization Agreements page in n6 Portal. If an Agreement is in the Org’s agreements list, it means that the organization has accepted it.
  • RegistrationRequest – during registration, it is possible to check or un-check each of available agreements, so when a RegistrationRequest is accepted by an administrator, a new Org is immediately created with the checked agreements.