Skip to content

Documents Integration User Guide

Overview

The Documents integration allows documents and files held in an external web application to be linked to objects in a FieldTwin project.

This list of related documents can be viewed within FieldTwin Design, and you can click on a document's link to view it in the external application.

The Documents integration can also provide a link to perform a search in an external repository for documents related to a FieldTwin object.

Using the integration

Start by selecting the Related Documents tab in the bottom row of tabs in FT Design. If it is not shown, press the Layout button and select it to show it.

Starting point

Viewing documents

Click on an asset, connection, well, or layer in FieldTwin Design. The integration will automatically perform a search for related documents and show the results as a list of links. Click on the title of a document to view it in a new browser window.

Search results

You can sort the list of results by title or ID by clicking on the appropriate column header. The results are sorted by title initially.

Linking to a document

The document must have its own unique web address (URL, hyperlink, or link). In some applications you can copy this from the address bar in your web browser, but many applications provide a proper function for copying the link to your clipboard. For example in an Office 365 document, click Share and then Copy link:

Copy link to document

With this done, switch back to FieldTwin Design and click on an asset, connection, well, or layer. This sets the object that the document will be linked to. Next click the Add Link button inside the integration.

Adding a link

In the Add Link form:

  • Optionally enter an ID or reference for the document
    The reference value can be anything that is meaningful to your organization's documentation structure or process; it is only used for display
  • Enter a description for the document as you want it to appear in the search results
  • Paste the document's link into the URL / Link box
    Press ctrl + v on your keyboard to paste from the clipboard

Lastly click the Add button on the form.

From the search results, click the pencil icon to change the details for a link, or the trash can icon to delete a link.

Deleting a link does not remove the document from the other application.

A title name and (optional) an icon image can be configured for the document links display using the Account Settings page.

In the Account Settings page, select the Related Documents tab.

Search link

Select the Configure Database Provider tab. * Enter the name to be used for the document links This will be displayed as a title on the Related Documents page. * Optionally enter a URL address for an icon image to display with the title. * Press Save to enter the configuration settings.

Selecting the Reset button in the configuration page will clear the document links configuration settings.

If the document links configuration is clear, then the Document Links tab will not be displayed in the Related Documents frame when a FieldTwin object is selected.



Overview

The Documents integration can also be configured to provide a link for searching an external repository for documents related to the currently selected FieldTwin object.

For example, a search link could be configured for searching Microsoft Sharepoint for items matching the current selected object in FieldTwin.

The search link is configured to include a reference to the selected FieldTwin object such as a tag number or other identifier to be used for the search.

Selecting an object in FieldTwin will generate the search link. Clicking on the link will then open a new browser tab showing the list of matching search results in the external repository for the selected FieldTwin object.

Search link


The Documents Integration search link is configured using the Account Administration setting page.

Administration settings

In the Account Settings page, select the Related Documents tab.

In the Search Link Configuration tab: * Enter the name of the external repository for the search link. This will be displayed as a title on the Related Documents page. * Optionally enter a URL address for an icon image to display with the title. * Enter a template for the search URL. This should include placeholders for the FieldTwin attribute(s) that will be used for the search. These should be enclosed in '%'s for example %operatorTags% * Press Save to enter the configuration settings.

The search URL template can include more that one FieldTwin attribute. The attribute names enclosed in '%'s act as placeholders in the URL.

When an Asset, Connection or Well is selected in FieldTwin, the search link is generated. The placeholders are replaced with the values for the selected object. This will create a specific link to the external repository to search for the selected object.

The placeholders can be either a defined FieldTwin attribute (such as %operatorTags%), or can be a specialised metadata attribute - for example %vendorId:Doc.tagNumber%. (The use of vendorId: identifies the placeholder as a metadata value)

Selecting the Reset button in the configuration page will clear all of the Search Link configuration settings.

If the search link configuration is clear, then the Search Link tab will not be displayed in the Related Documents when a FieldTwin object is selected.