Document import
- Raoul Huisman
- Mike Zuydendorp (Unlicensed)
- Ivo Korteweg (Unlicensed)
Target release | Jan 15, 2022 |
|---|---|
Epic | |
/Document status | DRAFT |
Document owner | @Raoul Huisman |
Designer |
|
Tech lead | @Arnaud Dusseldorp |
Technical writers | @ writers |
QA |
|
Objective
Solution for importing multiple files in one time using a ZIP file.
Success metrics
Goal | Metric |
|---|---|
Simplify uploading multiple documents | Upload speed is increasing |
Upload compliance documents and set directly the activity status and new planned date | Handling of compliance activities will speed up |
Assumptions
An existing HUMBLE User must upload the ZIP file
The import uses a queuing mechanism so it will be running asynchronous
Brief description
A HUMBLE user must be able to upload a ZIP File that contains a set of files to import at once.
There are two possible ways:
simple ZIP with or without a directory structure
with a file which describes the filenames and the relations to entities in HUMBLE (like asset, building)
When there is no existing filename (description.csv), the importer acts the simple way (bullet 1). When the description.csv is in the ZIP it will use theses descriptions to import and link the documents
Simple ZIP
The files in the ZIP are all uploaded to HUMBLE and related to the given location. The document tab-page has a new button called upload ZIP
When the ZIP file contains a directory structure the importer will create a Tag for each directory. When a directory has sub-directories it will create one tag for the combination of directory and subdirectories divided by a '/' character
The tag is related to the document.
Example ZIP Structure
- Dak
File1.pdf
- Dak links
File Dak links.pdf
- Dak Rechts
File Dak rechts.pdf
- Plattegrond
Plat1.pdf
Plat2.pdfCreates
Tags
Dak
Dak / Dak Links
Dak / Dak Rechts
Plattegrond
With description file
The ZIP file must contain a file called ‘description.csv’ with a layout defined below
Layout columns:
Filename - Name of the file
Resource - relation to the HUMBLE entity
Id - Humble ID for the related record of the specified entity (id)
Code - Unique code of the related record of the specified entity (short_label)
Description - Description for the document
Status - Status for the document
WarningDays - Number of days for pre-warning
Supplier - Reference to supplier (short_label)
Tags - Divided by ','
Remark - Remark for a document
DocumentDate - Date of document (used for specific entities)
ComplianceSet
ComplianceRule - Rule code for the compliance rule
RevisionCode - Code to the revision
Customfields - bij system_label
Filename | Resource | Id | Code | Description | Status | WarningDays | Supplier | Tags | Remark | DocumentDate | ComplianceSet | ComplianceRule | RevisionCode |
1006400.pdf | locations/floors |
| V-00000D00 | Plattegrond verdieping 1 | Gereed | 60 | 00006 | Plattegrond |
| 01-01-2020 |
|
|
|
1006400.pdf | locations/buildings |
| G-00000001 | Gebouw contract brandblusmiddelen | Gereed | 30 | 00003 | Algemeen,Contract |
| 05-12-2021 |
|
|
|
1006400.pdf | assets | 312345 |
| Handleiding CV ketel | Gereed | 10 | 00003 | Handleiding | Van leverancier | 01-04-2019 |
|
|
|
1007930.pdf | assets |
| 0003000 | Onderhoudsrapport LBK | Gereed | 40 | 00004 | Rapportage | rapport oh 1 jaar | 12-01-2020 | NL-STD3 | W.LBK.2 |
|
User interaction and design
Just an extra button on the document tab page
Open Questions
Question | Answer | Date Answered |
|---|---|---|
Out of Scope