Basic Features of an ILIAS Repository Object

1 Guideline

This guideline lists the features that are considered as basic features of a repository module or repository plugin and have to be implemented for every object type.

1.1 Current Situation

At the time being, there is no defined minimum of features that have to be implemented with a new repository object type. This leads to unconsistent behaviour of objects (bad usability) and can cause problems, e.g. an export function is missing and content cannot be transfered to another installation.

1.2 Guideline Text

Guideline for Basic Features of an ILIAS Repository Object Type

Every repository object type has to have the following features implemented for being accepted as a core feature in ILIAS:

1. Basic RBAC permissions that have to be implemented:
   • Visible
     • Exception: objects that shall not appear in object lists and explorers, e.g. Webfeed. Needs to be accepted by Jour Fixe.
   • Read
     • Exception: container reference objects where read permission is checked for refered object
   • Copy
   • Edit Settings
   • Delete
   • Change Permissions
     • Default global roles and role templates have to get initial permissions according to Initial Permissions Guideline.
2. Basic actions in ListGUI that have to be implemented:
   • Edit Content (only when object type comes with different views for presentation and editing, e.g. ILIAS Learning Module)
   • Settings
   • Info (as long as general info page is not deprecated)
   • Delete (see also Action menu Guideline)
   • Link
     • Exception: object type is a container and therefore cannot be linked
   • Move
   • Copy
   • Add to Desktop
   • Comments (see also Top Actions Guideline)
   • Notes
3. Tabs:
   • Presentation and position of tabs has to be implemented according to Tabs Guideline.
4. Export:
   • Export of object and import has to be supported according to General Export Guidelines and General Export Guidelines: Enhancement/Clarification.
5. Settings:
   • Presentation and editing of title and description has to be implemented according to Settings Screen Guideline.
   • Activation of additional features in repository objects has to be implemented in Settings screen according to guideline Activation of Services in Modules.
6. Redirecting user after having created object:
   • ILIAS should always redirect user to "Settings" screen after object has been created, see Guideline 'Creation of Repository Objects'.

2 Status

• Effective from release: 5.4
  
• Approved by Jour Fixe at: JourFixe-2018-04-09
• Implementation status:  needs to checked
  
• Funding for streamlining existing features: { name of organisation }
• Implementation of guideline: { all developers | name of responsible developer }

3 Components that are not compliant with the Guideline

• …

4 Discussion

JourFixe, ILIAS [jourfixe], 09 APR 2018 : We highly appreciate this guideline. It is effective from now on for all upcoming developments in 5.4 and higher. Matthias will integrate the guidelines from the linked guideline pages into this document. For the future we would like to have a better format for documenting development requirements like this. Offering related interfaces could be one solution.