Use documents

ARIS document storage enables you to propose documents or to submit a change request for a document. You can use further functionality in the repository.

Upload documents

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.

Procedure

  1. Open the relevant model.

    You can open models in different ways.

    Prerequisite

    • You have the ARIS Connect Designer license privilege.

    • The model type is allowed by the method filter in use.

    Procedure

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click Application launcher Application launcher > Published content Published content.

    3. Click Groups in the Classic or Processes in the Default configuration set.

    4. Select the group or process area containing the required model. The content of the selected group or process area is listed.

    5. Click the name of the relevant model.

    6. Click Diagram if you want to display the model graphically.

    7. Click Edit Edit > Edit model Edit model.

    1. Click Application launcher Application launcher > Models and objects Models and objects. The Models and objects view in the repository is opened.

    2. In the database, select the group containing the relevant model. The content of the selected group is listed.

    3. Click the name of the model you want to open.

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click Application launcher Application launcher > Models and objects Models and objects. The Models and objects view in the repository is opened.

    3. Click Recent changes Recently used. All models are listed that have recently been changed or created.

    4. Click the tile of the model you want to open.

    You can select models in the Published content Published content view and open them for editing in a separate tab.

    Prerequisite

    You have the ARIS Connect Designer license privilege.

    Procedure

    1. Click Application launcher Application launcher > Published content Published content.

    2. Click Groups in the Classic or Processes in the Default configuration set.

    3. Navigate to the relevant model.

    4. Click the name of the model you want to edit.

    5. Click Edit Edit > Edit model Edit model. The model opens on an individual tab.

    6. Make the required changes.

    7. Click Save Save.

    Your changes are saved in the model.

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click the Find Search field and enter a term that is included in the model name. The search results list all models that have the term in their name.

    3. In the Models category, click the name of the model you want to open.

    The model opens on a separate tab.

  2. Open the Properties tab of the Properties Details bar if it is not open.

  3. Show the ARIS document storage Link attribute.

  4. In the editing cell of the ARIS document storage Link attribute, click Select document Select document. The dialog opens.

  5. Select ARIS document storage if it is not yet selected.

  6. Select the folder in which you want to save the document.

  7. Click Upload Upload new document. The dialog opens.

  8. Click Select file. The dialog opens.

  9. Navigate to the relevant document, select it, and click Open.

  10. 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.

  11. Click Upload.

Once the upload of the document is complete, you can assign it to models and objects and users can obtain the information.

Assign documents

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.

Procedure

  1. Open the relevant model.

    You can open models in different ways.

    Prerequisite

    • You have the ARIS Connect Designer license privilege.

    • The model type is allowed by the method filter in use.

    Procedure

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click Application launcher Application launcher > Published content Published content.

    3. Click Groups in the Classic or Processes in the Default configuration set.

    4. Select the group or process area containing the required model. The content of the selected group or process area is listed.

    5. Click the name of the relevant model.

    6. Click Diagram if you want to display the model graphically.

    7. Click Edit Edit > Edit model Edit model.

    1. Click Application launcher Application launcher > Models and objects Models and objects. The Models and objects view in the repository is opened.

    2. In the database, select the group containing the relevant model. The content of the selected group is listed.

    3. Click the name of the model you want to open.

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click Application launcher Application launcher > Models and objects Models and objects. The Models and objects view in the repository is opened.

    3. Click Recent changes Recently used. All models are listed that have recently been changed or created.

    4. Click the tile of the model you want to open.

    You can select models in the Published content Published content view and open them for editing in a separate tab.

    Prerequisite

    You have the ARIS Connect Designer license privilege.

    Procedure

    1. Click Application launcher Application launcher > Published content Published content.

    2. Click Groups in the Classic or Processes in the Default configuration set.

    3. Navigate to the relevant model.

    4. Click the name of the model you want to edit.

    5. Click Edit Edit > Edit model Edit model. The model opens on an individual tab.

    6. Make the required changes.

    7. Click Save Save.

    Your changes are saved in the model.

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click the Find Search field and enter a term that is included in the model name. The search results list all models that have the term in their name.

    3. In the Models category, click the name of the model you want to open.

    The model opens on a separate tab.

  2. 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.

  3. Open the Properties tab of the Properties Details bar if it is not open.

  4. Show the ARIS document storage Link attribute.

    In an open model, you can add model attributes and the attributes of objects or connections.

    Procedure

    1. Open the Properties tab of the Properties Details bar if it is not open.

    2. If you want to edit model attributes, ensure that no model item is selected.
      If you want to edit object or connection attributes, select the corresponding object or connection.

    3. Click Attributes Add attributes on the Properties tab. The Select attribute dialog opens.

    4. If you want to see only attributes with assigned values, enable the Show specified attributes only check box. You can use a search term to restrict the attributes displayed.

    5. Enter a search term for the attributes you want to display. The attribute type groups that contain attributes whose names contain the term you entered are expanded and the attributes are displayed.

    6. Enable the check boxes of the relevant attributes.

    7. Click OK.

    The Select attributes dialog is closed, and the selected attributes are added to the OTHER ATTRIBUTES category of the Properties tab. You can hide attributes of the OTHER ATTRIBUTES category.

    1. On the Properties tab, move the mouse pointer over the row of the attribute you want to hide.

    2. Click the Actions three dots at the end of the row. The attribute menu opens.

    3. Click Hide always Hide always if you want to hide the attribute, even if it has a value.
      Click Hide, if not specified Hide, if not specified if you want to hide the attribute if it is not specified, but should be displayed if a value has been entered.

    The attributes that you always hide remain hidden even if they have values.

    The attributes you hide with the Hide, if not specified Hide, if not specified option are hidden if they have no value or when you delete their values. If a value is entered for them, for example, in the modeling area, they are displayed again on the Properties tab.

  5. In the editing cell of the ARIS document storage Link attribute, click Select document Select document. The dialog opens.

  6. Select ARIS document storage if it is not yet selected.

  7. Select the folder containing the relevant document.

  8. Enable the option button of the document you want to assign.

  9. 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 Object attribute for objects and Model attribute 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.

Open assigned document

In an open model, you can easily open an assigned document.

Procedure

Double-click the placed ARIS document storage Link attribute.

  1. Open the Properties tab of the Properties Details bar if it is not open.

  2. Show the ARIS document storage Link attribute.

    In an open model, you can add model attributes and the attributes of objects or connections.

    Procedure

    1. Open the Properties tab of the Properties Details bar if it is not open.

    2. If you want to edit model attributes, ensure that no model item is selected.
      If you want to edit object or connection attributes, select the corresponding object or connection.

    3. Click Attributes Add attributes on the Properties tab. The Select attribute dialog opens.

    4. If you want to see only attributes with assigned values, enable the Show specified attributes only check box. You can use a search term to restrict the attributes displayed.

    5. Enter a search term for the attributes you want to display. The attribute type groups that contain attributes whose names contain the term you entered are expanded and the attributes are displayed.

    6. Enable the check boxes of the relevant attributes.

    7. Click OK.

    The Select attributes dialog is closed, and the selected attributes are added to the OTHER ATTRIBUTES category of the Properties tab. You can hide attributes of the OTHER ATTRIBUTES category.

    1. On the Properties tab, move the mouse pointer over the row of the attribute you want to hide.

    2. Click the Actions three dots at the end of the row. The attribute menu opens.

    3. Click Hide always Hide always if you want to hide the attribute, even if it has a value.
      Click Hide, if not specified Hide, if not specified if you want to hide the attribute if it is not specified, but should be displayed if a value has been entered.

    The attributes that you always hide remain hidden even if they have values.

    The attributes you hide with the Hide, if not specified Hide, if not specified option are hidden if they have no value or when you delete their values. If a value is entered for them, for example, in the modeling area, they are displayed again on the Properties tab.

  3. Click the entry in the editing cell.

You can either open or save the assigned document.

Link documents

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.

Procedure

  1. Open the relevant model.

    You can open models in different ways.

    Prerequisite

    • You have the ARIS Connect Designer license privilege.

    • The model type is allowed by the method filter in use.

    Procedure

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click Application launcher Application launcher > Published content Published content.

    3. Click Groups in the Classic or Processes in the Default configuration set.

    4. Select the group or process area containing the required model. The content of the selected group or process area is listed.

    5. Click the name of the relevant model.

    6. Click Diagram if you want to display the model graphically.

    7. Click Edit Edit > Edit model Edit model.

    1. Click Application launcher Application launcher > Models and objects Models and objects. The Models and objects view in the repository is opened.

    2. In the database, select the group containing the relevant model. The content of the selected group is listed.

    3. Click the name of the model you want to open.

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click Application launcher Application launcher > Models and objects Models and objects. The Models and objects view in the repository is opened.

    3. Click Recent changes Recently used. All models are listed that have recently been changed or created.

    4. Click the tile of the model you want to open.

    You can select models in the Published content Published content view and open them for editing in a separate tab.

    Prerequisite

    You have the ARIS Connect Designer license privilege.

    Procedure

    1. Click Application launcher Application launcher > Published content Published content.

    2. Click Groups in the Classic or Processes in the Default configuration set.

    3. Navigate to the relevant model.

    4. Click the name of the model you want to edit.

    5. Click Edit Edit > Edit model Edit model. The model opens on an individual tab.

    6. Make the required changes.

    7. Click Save Save.

    Your changes are saved in the model.

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click the Find Search field and enter a term that is included in the model name. The search results list all models that have the term in their name.

    3. In the Models category, click the name of the model you want to open.

    The model opens on a separate tab.

  2. 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.

  3. Click Properties Details.

  4. Activate the Documents bar.

  5. Click Add Add.

  6. In ARIS document storage, click the folder containing the relevant document.

  7. 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: Link of the object for objects and Link of the model for models. If a document title was specified, it is shown, otherwise the complete link in ARIS document storage.

Open linked document

You can easily open an assigned document.

Procedure

  1. Click Properties Details.

  2. Activate the Documents bar.

  3. Click a document.

You can either open or save the linked document.

Use the Documentation attribute

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 Edit button is available. You can also create the documents directly from the Documentation attribute.

Procedure

Prerequisite

You are using Microsoft® Word.

Procedure

  1. Open a model.

  2. Select the item to which you want to assign the description and which does not yet have an external description.

  3. Activate the Properties tab of the Details bar and show the Documentation attribute. It is displayed in the Other attributes section.

  4. Click Edit Edit external document in the attribute row. Microsoft® Word opens with a blank document.

  5. Enter your description and click Save.

The description is assigned to the item. When you click Edit Edit external document again, the document opens and you can edit it.

  1. Create an external description and save it, for example, in Microsoft Word.

  2. Start ARIS and open the modeling component.

  3. Activate the Properties tab of the Details bar and show the Documentation attribute. It is displayed in the Other attributes section.

  4. Click Import Import external document in the attribute row. The Select document dialog opens.

  5. Click Select file and select the external document in the dialog.

  6. 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 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 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.

Procedure

  1. Open the relevant model.

    You can open models in different ways.

    Prerequisite

    • You have the ARIS Connect Designer license privilege.

    • The model type is allowed by the method filter in use.

    Procedure

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click Application launcher Application launcher > Published content Published content.

    3. Click Groups in the Classic or Processes in the Default configuration set.

    4. Select the group or process area containing the required model. The content of the selected group or process area is listed.

    5. Click the name of the relevant model.

    6. Click Diagram if you want to display the model graphically.

    7. Click Edit Edit > Edit model Edit model.

    1. Click Application launcher Application launcher > Models and objects Models and objects. The Models and objects view in the repository is opened.

    2. In the database, select the group containing the relevant model. The content of the selected group is listed.

    3. Click the name of the model you want to open.

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click Application launcher Application launcher > Models and objects Models and objects. The Models and objects view in the repository is opened.

    3. Click Recent changes Recently used. All models are listed that have recently been changed or created.

    4. Click the tile of the model you want to open.

    You can select models in the Published content Published content view and open them for editing in a separate tab.

    Prerequisite

    You have the ARIS Connect Designer license privilege.

    Procedure

    1. Click Application launcher Application launcher > Published content Published content.

    2. Click Groups in the Classic or Processes in the Default configuration set.

    3. Navigate to the relevant model.

    4. Click the name of the model you want to edit.

    5. Click Edit Edit > Edit model Edit model. The model opens on an individual tab.

    6. Make the required changes.

    7. Click Save Save.

    Your changes are saved in the model.

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click the Find Search field and enter a term that is included in the model name. The search results list all models that have the term in their name.

    3. In the Models category, click the name of the model you want to open.

    The model opens on a separate tab.

  2. 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.

  3. Click Edit Edit external document in the attribute row. The word processor is launched and the document opens.

  4. Edit and save the document.

  5. Close Microsoft® Word and activate ARIS.

  6. If necessary, click Refresh Refresh external document.

The document is added to the Documentation attribute and a preview is displayed.

  1. Open the relevant model.

    You can open models in different ways.

    Prerequisite

    • You have the ARIS Connect Designer license privilege.

    • The model type is allowed by the method filter in use.

    Procedure

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click Application launcher Application launcher > Published content Published content.

    3. Click Groups in the Classic or Processes in the Default configuration set.

    4. Select the group or process area containing the required model. The content of the selected group or process area is listed.

    5. Click the name of the relevant model.

    6. Click Diagram if you want to display the model graphically.

    7. Click Edit Edit > Edit model Edit model.

    1. Click Application launcher Application launcher > Models and objects Models and objects. The Models and objects view in the repository is opened.

    2. In the database, select the group containing the relevant model. The content of the selected group is listed.

    3. Click the name of the model you want to open.

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click Application launcher Application launcher > Models and objects Models and objects. The Models and objects view in the repository is opened.

    3. Click Recent changes Recently used. All models are listed that have recently been changed or created.

    4. Click the tile of the model you want to open.

    You can select models in the Published content Published content view and open them for editing in a separate tab.

    Prerequisite

    You have the ARIS Connect Designer license privilege.

    Procedure

    1. Click Application launcher Application launcher > Published content Published content.

    2. Click Groups in the Classic or Processes in the Default configuration set.

    3. Navigate to the relevant model.

    4. Click the name of the model you want to edit.

    5. Click Edit Edit > Edit model Edit model. The model opens on an individual tab.

    6. Make the required changes.

    7. Click Save Save.

    Your changes are saved in the model.

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click the Find Search field and enter a term that is included in the model name. The search results list all models that have the term in their name.

    3. In the Models category, click the name of the model you want to open.

    The model opens on a separate tab.

  2. Select the item the description of which you want to display.

  3. Activate the Properties tab of the Details bar and show the Documentation attribute. It is displayed in the Other attributes section.

  4. Click Display View external document. Depending on your browser, you may be asked whether you want to save or open the file.

  5. 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.

  1. Open the relevant model.

    You can open models in different ways.

    Prerequisite

    • You have the ARIS Connect Designer license privilege.

    • The model type is allowed by the method filter in use.

    Procedure

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click Application launcher Application launcher > Published content Published content.

    3. Click Groups in the Classic or Processes in the Default configuration set.

    4. Select the group or process area containing the required model. The content of the selected group or process area is listed.

    5. Click the name of the relevant model.

    6. Click Diagram if you want to display the model graphically.

    7. Click Edit Edit > Edit model Edit model.

    1. Click Application launcher Application launcher > Models and objects Models and objects. The Models and objects view in the repository is opened.

    2. In the database, select the group containing the relevant model. The content of the selected group is listed.

    3. Click the name of the model you want to open.

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click Application launcher Application launcher > Models and objects Models and objects. The Models and objects view in the repository is opened.

    3. Click Recent changes Recently used. All models are listed that have recently been changed or created.

    4. Click the tile of the model you want to open.

    You can select models in the Published content Published content view and open them for editing in a separate tab.

    Prerequisite

    You have the ARIS Connect Designer license privilege.

    Procedure

    1. Click Application launcher Application launcher > Published content Published content.

    2. Click Groups in the Classic or Processes in the Default configuration set.

    3. Navigate to the relevant model.

    4. Click the name of the model you want to edit.

    5. Click Edit Edit > Edit model Edit model. The model opens on an individual tab.

    6. Make the required changes.

    7. Click Save Save.

    Your changes are saved in the model.

    1. If you are authorized to use multiple databases, select the database containing the contents you want to access.

    2. Click the Find Search field and enter a term that is included in the model name. The search results list all models that have the term in their name.

    3. In the Models category, click the name of the model you want to open.

    The model opens on a separate tab.

  2. Select the item the description of which you want to display.

  3. Activate the Properties tab of the Details bar and show the Documentation attribute. It is displayed in the Other attributes section.

  4. Click Refresh Refresh external document.

The display of the Documentation attribute is updated so that the changes you have made will be displayed.

You have described a database or model item with a formatted document.