Searching for or Entering an mxLink Value

When creating or editing an item, you can include a special type of hyperlink, an mxLink, to a specific object as part of the description or other free text field. You can search for a link or manually type the syntax for the link. Anyone who views that page can click the hyperlink to open the linked item.

The mxLink keyword defines the hyperlink. In a create or edit dialog box, the mxLink looks like:

"mxLink:Part|Part-5000|2|eService Production"

In the view page, the mxLink looks like any other hyperlink.


Before you begin: Open the create or edit page where you need to enter a link to a different item.
See Also
Copying the URL for the Page
  1. To search for the mxLink value:
    1. Click on the page toolbar. The Search page opens.

      Note: This type of search only displays objects in vaults for which you have access. This search does not display objects in vaults if you do not have access to the vault.

    2. Enter criteria and click Search. The Search Results page opens.

      The mxLink column shows the link format for locating this object in this format:

      mxlink:|Type|Name|Revision

    3. To filter the list of items, select an option from the drop-down at the top right of the page:

      • Revision Specific mxLinks. Shows the revision value in the mxLink column
      • Latest Revision mxLinks. Shows the latest revision in the mxLink column

      If you need more details about an item, click its Name.

    4. Highlight the text in the mxLink column on the line for the item you need and use your browser's copy function.
    5. Click Close.
    6. Use your browser's paste function to paste the mxLink code at the necessary location.
  2. To manually enter an mxLink value:
    1. In a description or other text box, enter the mxLink: keyword, followed by the details of the item you want to link to. You must specify enough details to uniquely identify the intended item. You can use any of the formats shown in this table.

      The system determines the end of the mxLink value when it finds a space after the last | symbol. If the last item defined in the mxLink could contain a space, such as the "eService Production" vault, you need to enclose the entire definition in double-quotes as shown above. Spaces in the type or name do not require double-quotes around the mxLink.

      If the app cannot locate a single object that corresponds to what you entered (or for each item when using the Mass Update for structured content), it displays an error message indicating the problem. You can:

      • Click OK to save what you entered anyway (if not fixed, anyone who clicks the link gets an error)
      • Click Cancel and fix the mxLink value(s) before continuing

      If you entered many mxLinks that could not be resolved, the message lists the first 10 errors, and indicates there are additional errors.