Use documents
You can use further functionality in the repository. You can describe database and model items (models, objects, groups, etc.) using formatted documents or other files and save these documents in the Documentation attribute. If you are using the Microsoft® Word file formats DOC and DOCX, a preview is available and the
Edit button is available. You can also create the documents directly from the Documentation attribute.
You can upload documents to ARIS document storage and assign them to models and objects in order to supplement these with detailed descriptions and graphics, for example. We strongly recommend that you check documents for malicious software before uploading.
Prerequisite
The filter in use allows the ARIS document storage Link attribute.
Open the relevant model.
Display the Properties tab of the
Details bar if it is not already open.Show the ARIS document storage Link attribute.
In the editing cell of the ARIS document storage Link attribute, click
Select document. The dialog opens.Select ARIS document storage if it is not yet selected.
Select the folder in which you want to save the document.
Click
Upload new document. The dialog opens.Click Select file. The dialog opens.
Navigate to the relevant document, select it, and click Open.
The dialog closes and you may enter the document's title, a description, as well as tags (keywords) enabling the document to be identified in ARIS document storage.
Click Upload.
Once the upload of the document is complete, you can assign it to models and objects and users can obtain the information.
You can supplement individual models and objects with, for example, detailed information and graphics by assigning documents available in ARIS document storage to them.
Prerequisite
The filter in use allows the ARIS document storage Link attribute.
Open the relevant model.
Select the object to which you want to assign a document, or ensure that no object is selected if you want to assign the document to the model.
Display the Properties tab of the
Details bar if it is not already open.Show the ARIS document storage Link attribute.
In the editing cell of the ARIS document storage Link attribute, click
Select document. The dialog opens.Select ARIS document storage if it is not yet selected.
Select the folder containing the relevant document.
Enable the option button of the document you want to assign.
Click OK.
The document is assigned to the item and users can obtain the specific information.
On the Documents tab, a document with the ARIS document storage Link attribute is marked with
for objects and
for models. If a document title was specified, it is shown, otherwise the complete link to the document in ARIS document storage. You can place the attribute. To ensure that the name you specify is placed in the model instead of the link, you can show the ARIS document storage Title attribute from the Attributes tab (Properties bar). If you specify a name for the attribute, this name is displayed in the model instead of the contents of the placed ARIS document storage Link attribute.
You can link documents available in ARIS document storage directly with individual models and objects and thus supplement them with detailed descriptions and graphics, for example.
Open the relevant model.
Select the object for which you want to create a link to a document, or ensure that no object is selected if you want to link the document with the model.
Click
Details.Activate the Documents bar.
Click
Add.In ARIS document storage, click the folder containing the relevant document.
Enable the check box for the required document, and click OK.
The document is linked with the item and users can access the information.
On the Documents tab, a mark is shown:
for objects and
for models. If a document title was specified, it is shown, otherwise the complete link in ARIS document storage.
You can easily open an assigned document.
Click
Details.Activate the Documents bar.
Click a document.
You can either open or save the linked document.
Double-click the placed ARIS document storage Link attribute.
Display the Properties tab of the
Details bar if it is not already open.Show the ARIS document storage Link attribute.
Click the entry in the editing cell.
Prerequisite
You are using Microsoft® Word.
In an open model, select the item to which you want to assign the description and which does not yet have an external description.
Activate the Properties tab of the Details bar and show the Documentation attribute. It is displayed in the Other attributes section.
Click
Edit external document in the attribute row. Microsoft® Word opens with a blank document.Enter your description and click Save.
The description is assigned to the item. When you click
Edit external document again, the document opens and you can edit it.
Create an external description and save it, for example, in Microsoft Word.
Start ARIS Advanced and open the modeling component.
Activate the Properties tab of the Details bar and show the Documentation attribute. It is displayed in the Other attributes section.
Click
Import external document in the attribute row. The Select document dialog opens.Click Select file and select the external document in the dialog.
Click Open.
The document is inserted in the Documentation attribute.
If you are using the Microsoft® Word file formats DOC and DOCX, a preview is available and the
Edit button is available.
Warning
Due to technical restrictions external descriptions cannot be locked if they are open in the editor. Therefore, it is possible that a user deletes an external description in ARIS Advanced while it is being edited by another user in the text editor. In this case, all changes of the description are deleted without the editing user being notified.
Open the relevant model.
If the attribute is not displayed: Activate the Properties tab of the Details bar and show the Documentation attribute. It is displayed in the Other attributes section.
Click
Edit external document in the attribute row. The word processor is launched and the document opens.Edit and save the document.
Close Microsoft® Word and activate ARIS Advanced.
If necessary, click
Refresh external document.
The document is added to the Documentation attribute and a preview is displayed.
Open the relevant model.
Select the item the description of which you want to display.
Activate the Properties tab of the Details bar and show the Documentation attribute. It is displayed in the Other attributes section.
Click
View external document. Depending on your browser, you may be asked whether you want to save or open the file.Select Open. The corresponding program launches and the file opens in read-only mode.
You can now find out about the content of the document.
If you decide to save the document, you must save it with a name that differs from its previous name. Thus, a copy is created. It is, however, not inserted into the Documentation attribute.
Open the relevant model.
Select the item the description of which you want to display.
Activate the Properties tab of the Details bar and show the Documentation attribute. It is displayed in the Other attributes section.
Click
Refresh external document.
The display of the Documentation attribute is updated so that the changes you have made will be displayed.