Feature Wiki
Tabs
TAC: Customizing Metadata of Export File for TestArchiveCreator
Page Overview
[Hide]1 Initial Problem
When creating an archive export, the export, which is often executed via a cron job at odd times, appears in the Export tab of a test. The name of this export file is typically cryptic and unique, much like many other ILIAS export files. This poses a problem for individuals responsible for performing multiple archive exports and storing them in another system. They have to locate these files in different places and they are not easily distinguishable. Additionally, since the exports are executed at unknown times, the individual triggering the exports does not know when they will be available for retrieval.
2 Conceptual Summary
To facilitate more convenient archiving processes, we propose the following enhancements:
a) Allow the user initiating the export to add a custom name to the start of the filename.
Note: Since the test archive export files of the TAC are not intended for reimport on a different ILIAS system, the file names do not need to follow a fixed schema.
b) Allow the user that set the archive to be created to receive a notification via internal mail system upon completion of the export file. This should be an optional e-mail. In the admin interface it should be possible to activiate this functionality globally (default off). If globally activated the GUI should automatically fill in the current users loginname to the address field. The current user then can decide and add additional loginnames to the field or remove his/her own. The mail notification must include a permalink to the test-object. If several exports are triggered by one user all links should be combined in one e-mail to reduce a possible flood of e-mails.
c) Provide a prefilled time of export execution that indicates when the export will be created (might be not necessary if users are informed via mail).
3 User Interface Modifications
3.1 List of Affected Views
- Admin: Plugin: TestArchiveCreator: Configuration
3.2 User Interface Details
3.2.1 Plugin Configuration (Mockup)

(the image above shows plugin-configuration in admin area)
- an option to activate a) or b) and depending on the chosen option
- an added field for name pre- or postfix (with limited amount of characters)
an added field where a ILIAS-folder can be chosen to store the exports to - and a prefilled time next to the plan to do an export button can be found
3.2.2 Edit Form for Archive Settings (Mockup)

(the image above shows the setting to the archive creator, visible and adjustable by users with access to TAC)
The text for the notification send via ILIAS internal mail service is stored in a language variable. The proposed standard text reads:
3.2.3 Mail-Templates
ENGLISH
Subject: ILIAS Test Archive Files created
The archive files have been created. You can download them here:
[PERMALINK-TO-TESTOBJECT]
DEUTSCH
Subject: ILIAS Test Archiv Dateien erstellt
Die Archivdatein wurden erstellt. Sie können sie hier herunterladen:
[PERMALINK-TO-TESTOBJECT]
3.3 New User Interface Concepts
- No new interface concepts.
3.4 Accessibility Implications
- No accessibility implications.
4 Technical Information
{ The maintainer has to provide necessary technical information, e.g. dependencies on other ILIAS components, necessary modifications in general services/architecture, potential security or performance issues. }
5 Privacy
{ Please list all personal data that will need to be stored or processed to implement this feature. For each date give a short explanation why it is necessary to use that date. }
6 Security
{ Does the feature include any special security relevant changes, e.g. the introducion of new endpoints or other new possible attack vectors. If yes, please explain these implications and include a commitment to deliver a written security concept as part of the feature development. This concept will need an additional approvement by the JourFixe. }
7 Contact
- Author of the Request: Sesterhenn, Fabian [sesterhenn]
- Maintainer: {Please add your name before applying for an initial workshop or a Jour Fixe meeting.}
- Implementation of the feature is done by: {The maintainer must add the name of the implementing developer.}
8 Funding
- …
9 Discussion
SIG TestArchiveCreator, 28 JAN 2025:
- It would be better to specify that the email-feature will always use the (internal) mail-system and respect the configuration set in the ILIAS mail administration. I.e. the mails send MUST only be forwarded to an external email address if forwarding for mails is enabled globally. We should not allow to address an email address directly via this feature as external sending may not be possible. Users can enter the userids/loginnames in the form.
- Please specify the mail template (inkluding all required lang vars) here.
Sesterhenn, Fabian [sesterhenn], 03 APR 2025:
- Edited with feedback/ input from SIG below.
10 Implementation
{ The maintainer has to give a description of the final implementation and add screenshots if possible. }
Test Cases
- {Test case number linked to Testrail} : {test case title}
Privacy
Information in privacy.md of component: updated on {date} by {user} | no change required
Approval
Approved at {date} by {user}.
Last edited: 3. Apr 2025, 12:21, Sesterhenn, Fabian [sesterhenn]