Show Advanced KnowledgeHide Advanced Knowledge

General Export Guidelines: Enhancement/Clarification

1 Description

The General Export Guidelines are not clear when it comes to implementing import/export functionality for features that are added to existing repository objects. The implementation of the guideline only defines how the import/export has to be implemented, but not if it is mandatory for all repository objects or features of repository objects. In addition, the guideline does not cover cases where import/export cannot be implemented due to technical limitations and how these cases should be dealt with.
 
Because of this ILIAS does not handle the import/export of repository objects consistently. For instance see issue Mantis#12818. Hints for test-questions have been implemented without import/export functionality.
 
To improve this, I would like to make the following suggestions:
 

• The Import/Export guideline for trunk integration should clearly state if import/export functionality is mandatory for new features
• if import/export is not a mandatory part of new features for repository objects or if import/export cannot be implemented due to technical limitations (or missing funding?) it should cleary state how this should be communicated
  • i.e. the export tab of a given repository object should contain a list of object-features that will not be covered by the export

1.1 JF 2 Mar 2015, Proposal

All repository objects must implement an import and export following the guidelines in the development guide. All data that is contained in the object or its context (this includes e.g. a subtree in a container object) should be exported and imported. Exceptions are all cases where data comes from outside the context, e.g.

• user data (global user administration)
• skill assignments (global administration)
• preconditions related to objects outside of the exported context (e.g. precondition relation between an object within and outside of an exported course).

If any other data is to be left out of the import/export the reasons have to be discussed in the Jour Fixe.
 
Export import must at least work between the same major releases. Import from older releases should be possible for the last two major releases, e.g. 5.3 imports 5.3, 5.2 and 5.1 export files.

2 Status

• Scheduled for: Release 5.1
• Funding: Required / Partly funded by / Funded by ... (please indicate if you have funding for feature)
• Maintainer: (will be set by Jour Fixe)
• Implementation of the feature is done by (company, developer)
• Contract settled: (fill in "Yes" if a contract is already settled, otherwise "No" )
• Tested by / status: (name, e-mail), (status information set after implementation)

3 Additional Information

Contact the following persons if you want to know more about this feature, its implementation or funding:

• Information about concept: Fabian Sesterhenn (sesterhenn @ qualitus.de) / Björn Heyser (bheyser @ databay.de)
• Information about funding: (name, e-mail)
• Information about implementation: (name, e-mail)

4 Discussion

fsest, 15 May 2014:
@Heyser: If you have anything to add to my draft, feel free to do so.

Matthias Kunkel, 02 March 2015: There is already a suggested guideline Basic Features of an ILIAS Repository Object which could be extended.

JF 2 Mar 2015: We schedule this guideline (JF proposal today) for 5.1 and open the discussion.

5 Implementation

...