Skip to content

Commit

Permalink
PLM documents update
Browse files Browse the repository at this point in the history
  • Loading branch information
春伟 鞠 committed Mar 18, 2022
1 parent b56c0a5 commit 62fc101
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 60 deletions.
42 changes: 22 additions & 20 deletions docs/en/PLM/ChangeOrder.md
View file
Original file line number Diff line number Diff line change
@@ -1,35 +1,37 @@
## Change order

1. Create a new Change order.
1. Fields:
1. Change order type: The system generate the order number base on the setting of the selected [Change order type](ChangeOrderType.md).
1. Folder: Please refer [Folder](Folder.md).
1. Generate the Document Veriosn.
2. Get the default workflow.
3. The filter for the `Document` column in the line table.

1. Lines:
1. Create lines and then choose the `Document`. The document list base on the selected Folder.
2. Update the other colums if need.
1. Attachments:
1. Choose a line, then click the `Attachments` tab.
2. Click the <font color="blue">+</font>button on the header, choose a file upload.
2. Fields:

| Field | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Change order type | The system generate the order number base on the setting of the selected [Change order type](ChangeOrderType.md). |
| Folder | - Please refer [Folder](Folder.md). - Generate the Document Veriosn.<br/>- Get the default workflow.<br/>- The filter for the `Document` column in the line table. |
| | |

1. Save the order and click `Workflow` button -> Submit. The status of the Change order changed to Pending.
2. The user selected in the workflow who need review the change order, will get the notification to approve it.
3. Lines:

- Create lines and then choose the `Document`. The document list base on the selected Folder.
- Fill out the other colums if need.

4. Attachments:

- Choose a line first, then click the `Attachments` tab.
- Click the <font color="blue"><b>+</b></font> button on the attachments table header, choose a file upload.

5. Save the order and click `Workflow` button -> Submit. The status of the `Change order` changed to Pending.

![Change Order](../images/PLM/change-order.png)
6. The user selected in the workflow who need review the change order, will get the notification to approve it.

![Change Order](../images/PLM/change-order.png)

The notification:

1. Click the notification, the system will redirect to the `Change order` page.
1. Click `Workflow` button, to Approve or Reject.
1. Email notification:
1. Go to Administration->Settings->Email(SMTP), setup the email sender information.
2. Edit the user and check `Enable email notification`.

2. Click `Workflow` button, to Approve or Reject.
3. Email notification:
- Go to Administration->Settings->Email(SMTP), setup the email sender information.
- Edit the user and check `Enable email notification`.

![Changeorder Workflow](../images/PLM/changeorder-workflow.png)
4 changes: 2 additions & 2 deletions docs/en/PLM/ChangeOrderType.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Change order type

The `change order type` used for the `change order`, to genarate the order number base on the `Number sequence` filed.
You can create more `Chang order type` if you need different order number format, and then choose it on the `Change order` page.
The `change order type` used for the `change order`, to genarate the order number base on the `Number sequence` field.
You can create more `Chang order type` if you need different order number format, and then choose it on the [Change order](ChangeOrder.md) page.

![Change Order Type](../images/PLM/change-order-type.png)
18 changes: 9 additions & 9 deletions docs/en/PLM/DocumentType.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ The `Document type` is the common settings of the `Folders` which belong to this
![Document Type](../images/PLM/document-type.png)

Fields:
1. Type: Document.
1. Number Sequence: The default number sequence (document No.) of the document, the `Number sequence` on the [Folder](Folder.md) will override this.
1. Version: For example A1-,A2-,A3-
1. Edition:
1. For example 1,2,3,4...
2. This combine with the Version, the first version of the document will be A1-1, the `Edition` will change to the next for each change order, A1-2,A1-3,A1-4...
3. Once the Edition reached the last number, the Version will change to the next(A2-), and the document version will be A2-1.
1. Workflow: The default workflow of the change order, the `Workflow` on the [Folder](Folder.md) will override this.
1. Need change order. This should be checked if the document need `Change order`.

| Field | Description |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Type | Please choose <mark>Document</mark> |
| Number Sequence | The default number sequence (generate the document No.) of the document, the `Number sequence` on the [Folder](Folder.md) will override this. |
| Version: | For example A1-,A2-,A3- |
| Edition | - For example 1,2,3,4...<br/>- This combine with the Version, the first version of the document will be A1-1, the `Edition` will change to the next for each change order, A1-2,A1-3,A1-4...<br/>- Once the Edition reached the last number, the Version will change to the next(A2-), and the document version will be A2-1. |
| Workflow | The default workflow of the change order, the `Workflow` on the [Folder](Folder.md) will override this. |
| Need change order | This should be checked if the document need `Change order`. |
28 changes: 17 additions & 11 deletions docs/en/PLM/Documents.md
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
## Document



1. Click the 'New` button to create a document.
2. The No. field, can enter it manually. If it's blank, the system will genarate a number base on the setting on the [Folder](Folder.md) or [Document type](DocumentType.md).
2. Folder: It's mandatory.
2. Name: the document name.
2. Document owner.

| Field | Description |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| No. | Can enter it manually. If it's blank, the system will genarate a number base on the setting on the [Folder](Folder.md) or [Document type](DocumentType.md). |
| Folder | It's mandatory. |
| Name | The document name. |
| Document owner. | |

2. The lifecycle phase is <mark>Prototype </mark>when the new document saved.

![Document](../images/PLM/document.png)

The fields in the list:
1. Version: Automatically assigned once the [Change order](ChangeOrder.md) workflow complete. From the settings on the [Document Type](DocumentType.md).
1. Lifecycle phase: It's Prototype for a new document, will be changed once the `Change order` workflow complete.
1. Pending: It's true if the document in a pending [Change order](ChangeOrder.md), will change to false once the [Change order](ChangeOrder.md) workflow complete.
1. Attachment: View or download the approved attachment.
1. Change order: View the change order history.

| Field | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Version | Automatically assigned once the [Change order](ChangeOrder.md) workflow complete. From the settings on the [Document Type](DocumentType.md). |
| Lifecycle phase | It's <mark>Prototype</mark> for a new document, will be changed once the `Change order` workflow complete. |
| Pending | It's true if the document in a pending [Change order](ChangeOrder.md), will change to false once the [Change order](ChangeOrder.md) workflow complete. |
| Attachment | View or download the approved attachment. |
| Change order | View the change order history. |

![Documents](../images/PLM/documents.png)
29 changes: 11 additions & 18 deletions docs/en/PLM/Folder.md
View file
Original file line number Diff line number Diff line change
@@ -1,28 +1,21 @@
## Change order type

The `change order type` used for the `change order`, to genarate the order number base on the `Number sequence` filed.
You can create more `Chang order type` if you need different order number format, and then choose it on the `Change order` page.

![Change Order Type](../images/PLM/change-order-type.png)

## Folder

## Folder

![Folder](../images/PLM/folder.png)

Fields:
1. Document type: Ther `version` of the documents which belong to this folder, will use the Version settings of the [Document type](DocumentType.md).
1. Parent: The parent folder.
1. Workflow:
1. The workflow of the change order, this will override the `Workflow` on the [Document type](DocumentType.md).
2. Leave it empty if you want to use the settings on the folder.
1. Number Sequence:
1. The number sequence (document No.) of the document, this will override the `Number sequence` on the `Folder`.
2. Leave it empty if you want to use the settings on the folder.

| Fields | Description |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Document type | Ther `version` of the documents which belong to this folder, will use the Version settings of the [Document type](DocumentType.md). |
| Parent | The parent folder. |
| Workflow | - The workflow of the change order, this will override the `Workflow` on the [Document type](DocumentType.md).<br/>- Leave it empty if you want to use the settings on the folder. |
| Number Sequence | - The number sequence (document No.) of the document, this will override the `Number sequence` on the `Folder`.<br/>- Leave it empty if you want to use the settings on the folder. |

1.

### Permissions

1. Choose one or more folders in the list, and then click the `Permissions` button.
1. The user can't see the folder in the `Documents` page if no permissions.
2. The user can't see the folder in the `Documents` page if no permissions.

![Folders](../images/PLM/folders.png)

0 comments on commit 62fc101

Please sign in to comment.