Documentation

Institution

An institution's units and staff — synchronised from its own system and directory, published as a unit tree, a staff directory and a phonebook, with each unit's sets of documents.

Everything below is declared by Institution itself, so it describes this deployment rather than a manual — and it is rewritten whenever the program changes.

What it is

  • Its key is Institution, which is also the prefix of every component it owns.
  • It is bought: a site has it only when the registry records that this customer bought it.

What it may be allowed to do

These are the permissions it declares. A person sees one of its screens only where his role carries the matching permission.

  • institution.manage
  • institution.setup
  • institution.view

What it puts on a page

4 components, each of which can be dropped onto a page in the composer.

Phonebook

Every unit with its people and their internal numbers.

Placed as Institution.Phonebook.

3 settings:

  • Which units — chosen from All, Academic, Administrative.
  • Only people with an extension — a switch, left alone it is true.
  • Show the search — a switch, left alone it is true.

Staff directory

The people who work here — searched by name and narrowed by unit.

Placed as Institution.Staff.

5 settings:

  • Which staff — chosen from All, Academic, Administrative.
  • Only this unit's staff — chosen from a list this site's own data fills.
  • Include the units under it — a switch, left alone it is true.
  • How many on a page — a number, left alone it is 30.
  • Show the search — a switch, left alone it is true.

Unit page

One unit in full, reached by its address: its units, its staff and its documents.

Placed as Institution.Unit.

2 settings:

  • Show the staff — a switch, left alone it is true.
  • Show the documents — a switch, left alone it is true.

Units

The institution's units as a tree, each leading to its own page.

Placed as Institution.Units.

2 settings:

  • Which units — chosen from All, Academic, Administrative.
  • How many levels — a number, left alone it is 4.

Comments

Nobody has written yet. Be the first.

This article is not taking comments.