Difference between revisions of "Document"
(Created page with "Documents are a type of object in Camotool that represent a real world document. These are often linked to other objects in the application, such as Work Orders, Bill Notes or...") |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | Documents are a type of object in Camotool that represent a real world document. These are often linked to other objects in the application, such as Work Orders, Bill Notes or even the current user. From a document, one may see and modify information related to the object itself, as well as view the original file that was uploaded. | + | |
| + | Documents are a type of object in Camotool that represent a real world document. These are often linked to other objects in the application, such as Work Orders, Bill Notes or even the current user. From a document, one may see and modify information related to the object itself, as well as view the original file that was uploaded. | ||
| + | |||
| + | = General view = | ||
| + | |||
| + | In the Document's screen, we can find various controls to interact with a Document. | ||
| + | |||
| + | [[File:Frame documentos doc.png|RTENOTITLE]] | ||
| + | |||
| + | #Enables/disables the editing functionalities of a Document for the current user. | ||
| + | #Saves the current Document. | ||
| + | #Deletes the current Document. This action only deletes the Document object, but any files uploaded to the application will remain in the Camotool servers. | ||
| + | #Allows the user to update a Document to a newer revision of the document. This action should be done when the file represented by the Document is modified and needs to be updated. | ||
| + | #Opens this same screen on a new browser tab. | ||
| + | #Displays the Document's file in the browser, or starts a download for the file if it can't be displayed in a browser. | ||
| + | #Allows the user to select a file to upload. This file will then be linked to the Document. It is only available when creating a new Document. | ||
| + | |||
| + | |||
| + | |||
| + | = Creating a new Document = | ||
| + | |||
| + | == From the Main Screen == | ||
| + | |||
| + | Creation of a Document can be done by clicking the Add button in the Documents list, available from Camotool's Main Page.<br/> Said list can be found by clicking on the Documents entry from the Main Page's sidebar. | ||
| + | |||
| + | [[File:Access document list.png|RTENOTITLE]] | ||
| + | |||
| + | From this list, clicking on the + button will open an empty Document template, on which the user can input any information that the Document requires. | ||
| + | |||
| + | [[File:List document create new document.png|RTENOTITLE]] | ||
| + | |||
| + | | ||
| + | |||
| + | == From a related object == | ||
| + | |||
| + | Most screens in Camotool have the option to create a new related Document by dragging and dropping a file into the screen.<br/> When done in a supported screen, a small prompt will appear requiring the user to input the desired name for the new Document. | ||
| + | |||
| + | [[File:Drag and drop document.png]] | ||
| + | |||
| + | [[File:Drag and drop document enter name.png|Example of Document name Prompt]] | ||
| + | |||
| + | Such Documents can later be edited to include all the required information. | ||
| + | |||
| + | | ||
| + | |||
| + | = Viewing the Document = | ||
| + | |||
| + | Documents can be accessed in various ways. The most common are through the Documents List screen and from a related object. | ||
| + | |||
| + | == Documents List == | ||
| + | |||
| + | The documents list can be accessed from the Main Page screen by clicking on the Document entry from the sidebar. | ||
| + | |||
| + | [[File:Access document list.png]] | ||
| + | |||
| + | == From related objects == | ||
| + | |||
| + | Since Documents are a special kind of object in Camotool, they can be linked to virtually anything inside the application. As such, these linked documents can be accessed and viewed from its related object.<br/> For example, we will show how to access documents from a Work Order Package. | ||
| + | |||
| + | [[File:Access document from related object.png]] | ||
| + | |||
| + | #Displays the documents related to the current object. | ||
| + | #Right clicking on a row displays a contextual menu with various actions. | ||
| + | #Opens a dialog with details from the Document. | ||
| + | #Opens a new tab in the browser with details from the Document. | ||
| + | #Opens the file related to the Document in the browser, or downloads the file if it can't be displayed. | ||
| + | #Removes the relation between the document and the current object. Changes must be saved to be applied. | ||
| + | |||
[[Category:Documents]] | [[Category:Documents]] | ||
Latest revision as of 10:10, 27 July 2020
Documents are a type of object in Camotool that represent a real world document. These are often linked to other objects in the application, such as Work Orders, Bill Notes or even the current user. From a document, one may see and modify information related to the object itself, as well as view the original file that was uploaded.
Contents
General view
In the Document's screen, we can find various controls to interact with a Document.
- Enables/disables the editing functionalities of a Document for the current user.
- Saves the current Document.
- Deletes the current Document. This action only deletes the Document object, but any files uploaded to the application will remain in the Camotool servers.
- Allows the user to update a Document to a newer revision of the document. This action should be done when the file represented by the Document is modified and needs to be updated.
- Opens this same screen on a new browser tab.
- Displays the Document's file in the browser, or starts a download for the file if it can't be displayed in a browser.
- Allows the user to select a file to upload. This file will then be linked to the Document. It is only available when creating a new Document.
Creating a new Document
From the Main Screen
Creation of a Document can be done by clicking the Add button in the Documents list, available from Camotool's Main Page.
Said list can be found by clicking on the Documents entry from the Main Page's sidebar.
From this list, clicking on the + button will open an empty Document template, on which the user can input any information that the Document requires.
Most screens in Camotool have the option to create a new related Document by dragging and dropping a file into the screen.
When done in a supported screen, a small prompt will appear requiring the user to input the desired name for the new Document.
Such Documents can later be edited to include all the required information.
Viewing the Document
Documents can be accessed in various ways. The most common are through the Documents List screen and from a related object.
Documents List
The documents list can be accessed from the Main Page screen by clicking on the Document entry from the sidebar.
Since Documents are a special kind of object in Camotool, they can be linked to virtually anything inside the application. As such, these linked documents can be accessed and viewed from its related object.
For example, we will show how to access documents from a Work Order Package.
- Displays the documents related to the current object.
- Right clicking on a row displays a contextual menu with various actions.
- Opens a dialog with details from the Document.
- Opens a new tab in the browser with details from the Document.
- Opens the file related to the Document in the browser, or downloads the file if it can't be displayed.
- Removes the relation between the document and the current object. Changes must be saved to be applied.
