Document type: documents

A document consists of media, flow models and text. Templates are used to structure documents.

A template offers a predefined layout with fixed media and text boxes in a fixed position.

A document can consist of varying templates. To add a new template to the document, click the Add New Template button in the bottom left corner of the Document application. You can also click the Action menu to the right of a template to:

Add (a new template) before this template
Add (a new template) after this template
Change the template
Delete the template

To change the order of the templates, click and drag a template and move it to the desired position.

A standard package of ten templates is included in the RamBase QMS subscription. If you would like to order a customized template, you can contact us through our support portal.

Document Overview

Header

Icon name	Icon	Description
Document title		Displays the title of the document.
Document id and version		Displays the document's identification number and version.
Folder name		Displays the name of the folder the document belongs to. Click the folder name to navigate back to the folder.
Undo button (left)		Click to undo an action.
Redo button (right)		Click to undo a previously undone action.
View icon		Displays the document in view mode. It is not possible to edit in this view.
Change log		Displays the author, version, and timestamp of when the last edits were made to the document. This icon is only displayed in view mode.
Edit		To read more about document editing, click here. This icon is only displayed in view mode.
Send to		Depending on which step of the document approval process the document is in, the options for this icon will be either: Send to verifier Send to approver This icon is only displayed in view mode.
Send back to author		Click to send the document back to the author. This icon is only displayed in view mode and only for the verifier and approver of the document. To read more about the document verification and approval process, click here.
Send back to verifier		Click to send the document back to the verifier. This icon is only displayed in view mode and only for the approver of the document. To read more about the documentation and approval process, click here.
Print Document		Click to print the document. This icon is only displayed in view mode.
Action menu		Document properties Show document URL
Author		Displays the author and the timestamp of when the document was created.
Verifier		Displays the verifier and the timestamp of when the document was verified.
Approver		Displays the approver and the timestamp of when the document was approved.

Edit mode

The edit mode of a document is visible for users with the author role and edit permission. If a user does not have both the role and permission assigned to them, they will not be able to edit documents.

The edit view is divided into three main areas:

Quality Template Browser

The Quality template browser displays the templates used in the document. A single document can include many different types of template. When a template is selected, it is highlighted in orange. The Action menu to the right of a template provides the following options:

Add before this template:
Click this option to add a new template before the selected template.
Add after this template:
Click this option to add a new template after the selected template
Change template:
Click this option to change the template type of the selected template. NOTE ABOUT WARNING WHEN CHANGING TEMPLATE TYPES WITH DIFFERENT LAYOUT
Delete template:
Click this option to delete the selected template. This option is only visible when there is more than one template used in the document.

A. Add new template button

The Add new template button opens the Add template popup window. On the right hand side, you have a preview of all available templates. When you click on a template, a larger preview of that template is displayed on the left. After selecting the template you want, click the Create button to edit the document.

Media and diagram box

The media and diagram box is where you can create or insert diagrams and media.

A. Browse media

Media is defined as a picture or video. To add new media to a document, you can either:

(a) add media directly into the media frame by drag and dropping a file from your computer or

(b) click the Browse media button to add previously uploaded media from the Media application.

In the Browse Media popup, use the Folder tree to find and select the folder where the desired media is. After selecting the correct folder, simply click the desired media to add it to the document.

Browse media popup

Columns and options	Icon	Description
Folder tree		To read more about the Folder tree, click here.
Custom filters bar		To read more about custom filters, click here.
Predefined filters icon		Active Media Archived Media
Column settings icon		Here the user can add and remove columns from view, Export to excel, and Reset to default view.
Upload files icon		Click to upload media saved on your computer.
Set view to list		Click to view the displayed media as a list.
Set view to grid		Click to view the displayed media in a grid.
Media preview column		Displays a preview image of the media.
Title column		Displays the title of the media.
Description column		Displays the description of the media.
Radio buttons		Used to navigate through media in the selected folder(s).

B. Add diagram

RamBase QMS utilizes draw.io for the creation of diagrams. The diagrams are then added and saved to the document.

To read more about the creating diagrams in draw.io, please visit their website (draw.io).

Back in the Document edit mode in RamBase QMS, after creating a diagram, the Diagram Options button appears in the top right corner of the diagram box. From the Diagrams Options you have three options:

Clear diagram: clicking this option deletes the diagram from the document.
Edit diagram: clicking this option takes you back to draw.io.
Browse diagrams: clicking this option opens a new pop-up window that displays diagrams created from the DIAGRAMS application. The Browse diagrams popup is detailed in the section below.
To read more about the DIAGRAMS application, click here.

C. Import diagram

Clicking the Import diagram option opens the Browse Diagram popup. The Browse Diagram popup window displays diagrams created from the DIAGRAMS application.

Columns and options	Icon	Description
Folder tree		To read more about the Folder tree, click here.
Search bar		Used to create a filter. To read more about filters, click here.
Predefined filters		To read more about predefined filters, click here.
Column settings		This button presents three options: Columns Export To Excel Reset To Default View
Set view to list		Click to view the displayed diagrams as a list.
Set view to grid		Click to view the displayed diagrams as a grid.
Diagram icon
Title column		Displays the title of the diagram.
Description		Displays the description of the diagram.
Radio buttons		Used to navigate the diagrams in the selected folder(s).
Cancel button		Click to close the popup window.

Text box

The Text box is where the written content of the document is placed. There are several formatting options available in relation to the header, body, and text formatting of the document.

A. Header

The table below describes the options available in the header of the text box.

Option	Icon	Description
Show duration
Hide duration
Update header symbol		Displays a list of the possible symbols that can be added to the header of the textbox.
Add safety symbol		Click to find and select symbols to the document. This option leads to a new popup window called Symbol Selector. To read more about the Symbol Selector, see the section below this table
Remove safety symbol		Click to remove the safety symbols. If there are multiple safety symbols, clicking this option will remove all of them. To remove individual safety symbols, hover over the symbol and click the X icon in the top right corner.
Add text symbol to the header		This option opens a new popup window called Symbol Selector. To read more about the Symbol Selector, see the section below this table.
Add text symbol		This option opens a new popup window called Symbol Selector. To read more about the Symbol Selector, see the section below this table.
Move textbox up		Click to move the textbox up.
Move textbox down		Click to move the textbox down.
Hide textbox header		Click to hide the header. This option will remove the safety symbols added to the header but not the text symbols
Remove textbox		Click to delete the textbox.

Symbol Selector

The Symbol Selector displays various symbols organized in groups.

Symbols can be managed in the QUALITYADMIN application. To read more about managing symbols, click here.

The available symbols have three options: link, disable, and select.

Link - Symbols can be linked to various objects in the system. The table below describes the various options:

Link options	Description
Diagrams	Search for diagrams or create a new one to link to the symbol.
Media	Search for media to link to the symbol
Internal Anchor
Folder	Search for a document, media, or diagram folder to link to the symbol.
Document	Search for a document to link to the symbol.
URL	Add a URL in the textbox to link to the symbol.

Disable - clicking this option will grey out the symbol. This option can be useful to distinguish between mandatory and non-mandatory procedures. Clicking the Display all symbols as disabled option in the top right corner of the window will set all symbols, in all groups, as disabled. When a symbol is disabled, the icon will have a slash through it.
Select - Click the check box in the bottom right corner of the symbol you want to select. You can also click directly on the symbol to select it. Multiple symbols can be selected at one time. Simply select as many symbols as desired then click the Submit symbols button to add them to the document.

B. Show additional options button

The table below describes the options available in the body of the text box.

Option	Icon	Description
Insert heading		Click to insert a new textbox with header.
Insert textbox		Click to insert a new textbox. The new textbox will appear under the current textbox.
Insert table		Hover over the icon and use your mouse to create the table structure.
Toggle textbox numbering		Click to number the textbox. It is possible to edit the numbering style Each new textbox under the same heading will be numbered.
Ordered list		Click to create an ordered list. Use the ENTER key on your keyboard to add to the list.
Bulleted List		Click to create a bulleted list. Use the ENTER key on your keyboard to add to the list.
Border bottom		Click to add a border under the selected textbox. To delete a border, hover over it and click the Delete icon to the right.

C. Text formatting options

Option	Description
Text color	Changes the text color.
Background color	Highlights the text
Bold
Italic
Underline
Strikethrough
Superscript
Subscript
Font size
Insert Link
Insert Special Character
Ordered List
Bullet List
Add indent
Remove indent
Align

In this section:

QMS (TEST)