Add document and drawing number generation

[stefi07]

Summary

For change controlled entries of type "drawing", the "Number" field will guide the user through building the appropriate number for the entry according to the drawing tree structures.

For all entries of type "document", the "Number" field will autogenerate a alphanumeric string.

Entries with an Associated Number can also have additional Associated Handles (to support alternate numbering systems), but these would not be add-able or editable by the user.

A new "Assigned Numbers" page will show the list of already generated numbers.

Drawings

Number structure

Drawing numbers will follow the FOA & AOA trees as described in the Drawing Tree Structure (GitLab link). The string elements of the number will be selected by the user as below and the numerical part of the number will be autogenerated (incrementally) to ensure uniqueness.

Adding a new entry and generating a new number

1. Clicking the "Add Document" button (name needs updating) and setting the "Change controlled" field to "Yes" and the "Type" to "Drawing" opens the "Number" field
2. Each node in the drawing tree structure translates to a panel where the user chooses which branch of the tree to go down on.
3. Once the final choice is made, a "Confirm" button prompts the user to validate the generated number for this new controlled drawing
4. The user cannot save the new drawing entry without having confirmed the new number.
5. When the user clicks the save button on the new drawing both the entry and the new number are saved into the database and a link is created between them.

Documents

Number structure

Document numbers will be represented by an alphanumeric string PRL-DOC-#####, where # is a number from 0-9. These numbers will be autogenerated (incrementally) to ensure uniqueness. All documents (change controlled or not) will have a Document Number.
To support existing alternate numbering systems (e.g. halcyon), each Document Number could have additional Associated Handles. These cannot be added or edited by the user, but would be listed in the entry's '#' column and would retrieve the entry's details page.

Adding a new entry and generating a new number

1. Clicking the "Add Document" button (name needs updating) and setting the "Change controlled" field to "Yes" and the "Type" to "Document" opens the "Number" field
2. On opening, the "Number" field is pre-populated with the next available document number.
3. When the user clicks the save button on the new drawing both the entry and the new number are saved into the database and a link is created between them.

• No user interface would be available for handles and they would need to be added directly in the database (to avoid validation rabbit-hole).

Editing and existing entry

• When editing an existing document / drawing entry and setting the "Change controlled" field to "Yes" that will also open the "Number" field
• The rest of the workflow will follow steps 2-5 above for a Drawing or 2-3 for a Document.

Existing Assigned Numbers

A new "Assigned Numbers" page will show the list of already generated numbers (grouped by type - "document" and "drawing") in a table with the columns:

1. Number
2. Associated Identifier (the Identifier of the associated document / drawing entry) and any Associated Handles
3. Title (of the associated document / drawing entry)
4. Author (of the associated document / drawing entry)
5. Maintained By (email of user responsible for the associated document / drawing entry)

Properties

• Entries can be filtered by Assigned Number, Associated Handles, as well as by Identifier.
• An entry's Details page can be retrieved via its Assigned Number, Associated Handles, as well as its Identifier.
• An entry with Yes for Change Control can only be modified to "No" by Admin-level users.
• An entry with an Assigned Number can only be deleted by Admin-level users.
• An entry's Assigned Number cannot be removed.
• Existing Assigned Numbers cannot be deleted.