Creating and Linking Documents

As shown in the Use Case Overview section, there are several different ways to use the Aras Workspace Productivity Connector to create and save documents. This section describes the procedures associated with these different use cases.

Creating a new Aras Document allows the creation of a new Workspace file while using company-standard processes such as templates and numbering.

To create a new Aras Document:

  1. Click the New button in the Aras ribbon and select New Aras Document. This opens the New Document task pane.

  1. Choose the right Document Type by clicking the down arrow in the Document Type field.The Document Type you select controls how the rest of the form behaves. Administrators decide which types are available. Some common examples include:
    • Document / Product – for documents related to a product you’re designing
    • Document / Project – for documents related to a project
    • Document / General – for general-purpose documents

Here’s what the Document Type selection list might look like:

  1. Click the ellipsis (...) button in the Document Template field to browse for a template. The following is an example of the search dialog:

The entries in the list show the available templates in Aras that correspond to the selected Document Type. Additional search filtering can be performed by entering values in the search bar.

Templates need to be defined prior to using New Aras Document and may be defined by the administrator or by other users. For details on creating templates, refer to the Creating Document Templates section.

Note
The administrator can define specific Document Types that require a template. If this is the case, the dialog cannot be exited from without selecting a template.

  • Link to

Based on the Document Type selection, the selection list for Link to shows the available Aras ItemTypes that can be linked to a document. For example, a user can link a Product Document to only Parts, and a Project Document to Projects and Activities.

In Aras terminology, links are also known as Relationships. The advantage of creating them at the time of document creation is that the item linked to can drive numbering.

For example, if a Product Document is created and linked to Part P12345, the File Name could be automatically set to something like P12345-DOC-1.docx.

Note
An administrator can set Link to as required for a given Document Type, meaning a linked Item must be selected before proceeding.

An example of the selection list for Link to is shown here:

Once the Item Type to link to is selected, click the ellipsis (...) button to open a search dialog to select the specific item in Aras:

This Search dialog allows users to: Enter search criteria in the top search row. Execute a search with the Search button. Clear search criteria with the Clear button.

Once the desired Item is located, select it and click Select. It will appear in the main dialog as the Link to Item.

After making selections in the left column of the dialog, the New Document task pane appears as shown here:

  • Title and Other Properties
  1. Enter a title for the document and, optionally, any other Properties configured in the environment.
Note
Workspace and Aras use different nomenclature for standard property names, so the value you enter for Title may appear as the Name in Aras.

The values displayed when selecting Properties reflect the Workspace naming.

An administrator may define properties in Aras as “required”. Creating a new document cannot continue until all required properties are entered. An administrator can also pre-define default values for properties in Aras.

Click OK to complete the process. The connector then generates PDF version of the Google document and links it to the Aras Document.

Note
The File Name displayed by the Workspace application is determined by the Workspace application. When saving the file to Aras, the Connector will automatically determine the File Name.

If you use a template, the file’s initial content comes from the template file.Otherwise, it will be blank.

Note
The Aras Workspace Productivity Connector populates a property on the Document based on the Microsoft Application that authored the file. By default, this is the Authoring Tool property. An administrator may configure the Aras Workspace Productivity Connector to use a different property for this value. For the purposes of the Aras Workspace Productivity Connector 32 – User Guide, the default name for the Authoring Tool property will be assumed.

Save the file into Aras. Click the Save button, thenselect Save from the menu. The task pane will appear to confirm the file to be saved. Click OK. You’ll see a confirmation when the document is saved successfully.

The properties are updated because the file is saved into Aras.

If the Document is in Aras Innovator, the Form below is displayed:

Manual File Naming Option

A File Name can be manually entered for the new file depending on the Document Type selected. An administrator sets this option. Typically, this will be for document types like Ad Hoc that don’t need to be highly controlled. The File Name field will appear in the dialog when this option is enabled. After clicking OK, the file is created with the File Name entered.

Filtering by Link To Selection

If there are many Document Types in the Aras environment, one way to quickly find the desired type is to select the Link to the item type. This automatically filters the Document Type list to those valid for the selected Item Type.

Attaching a Workspace File to an Existing Aras Innovator Document

Note
Before this feature can be used, the administrator must enable the Allow Select Existing Document checkbox on the appropriate Workspace Document Type.

To attach a file to an existing Aras Innovator Document, create a New Aras Document as described in the Creating a New Aras Document section. Before selecting OK, follow these steps:

  1. Click the ellipsis (...) button in the Document Number field. The Search dialog box appears.

  1. Click the Search button to see a list of existing documents without an attached file.

  1. Select the existing document and click OK. The Document Number is applied to the new document.

An existing Workspace file can still be saved to Aras, but the options will be slightly different from those when creating it in Aras. To save an existing file to Aras, open it in the Workspace application and save it. After saving to Aras, the Aras ribbon is updated. The options compared to creating a new document are:

  • Document Type: Document Types that do not require a template will be shown since a template cannot be used for an existing file.
  • Document Template: Not selectable since the file already exists.
  • Link to: Any Item to link to can be selected based on valid Item Types for the selected Document Type.
  • Title and Properties: All capabilities are the same.
  • File Naming: The File Name field will not appear regardless of Document Type. If the Document Type does not automatically rename the file, it will use the existing File Name.

The Aras Workspace Connector includes a Release Claim command indicating that work is complete on a particular file and control is given back to Aras.

Use the New, Save As command to perform a Save As on a file already managed in Aras and have it become a new file also managed in Aras. When using Save As, the same dialog appears as when saving a new file, but with different available options. Behaviors compared to creating a new document are:

  • Document Type: The Document Type of the original document appears. If this original Document Type requires a template, it cannot be changed. If it does not require a template, it can be changed.
  • Document Template: The Document Template, if any, is displayed but cannot be changed since the file already exists.
  • Link to: Any item can be selected to link to based on the valid Item Types for the Document Type.
  • Title and Properties: Properties from the original file will initially be displayed and can be edited if desired.
  • File Naming: The File Name field will appear only if the Document Type does not automatically rename the file. In this case, a File Name can be entered for the new file. Otherwise, the renaming logic for the specific Document Type will be used.