TAC: Customizing Metadata of Export File for TestArchiveCreator

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 human initiating the export to add a custom name (either at the beginning or end) to the filename.

b) Allow the user that set the archive to be created to receive an e-mail 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 user should be able to set a personal default in the TAC settings, and that setting should be used to prefill the option for future exports. The e-mail should include a link to the test-object where the TAC-export was performed. 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. Deeplinks are not necessary.

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

• 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.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

If you are interest in funding this feature, please add your name and institution to this list.

• …

9 Discussion

10 Implementation

{ The maintainer has to give a description of the final implementation and add screenshots if possible. }

Test Cases

Test cases completed at {date} by {user}

• {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}.