Dependency Tag Info Gadget

Overview

Authority Level: All user levels by default; administrators may restrict access through access settings.

Dependency Tag Info Gadget

The Dependency Tag Info Gadget is a sidebar gadget that allows users to search for and display information about a dependency tag within all sites for an account. This gadget is useful for when a user is trying to locate all subscribers to a specific product or file. All dependency tag types are supported and the tag syntax is specific to the dependency type (file, page, directory, asset, or s-tag).

If the user does not know the dependency tag number, they can search for dependency tags by path, URL on production, or Asset name from within the gadget.

For more information about the Dependency Manager and dependency tags, visit the Dependency Manager page.

Performing a Dependency Tag Search

Users can search for dependency tags in the gadget by entering in the dependency tag itself or by entering the path to the file on staging, the URL of the file on production, or the Asset name (if searching for assets). The search field is case-sensitive.

Searching By Dependency Tag

When searching for information using a dependency tag, either the complete dependency tag with starting and ending double braces (e.g., {{x:123}}) can be used or shortened forms can be used. For example, using the letter and the number with the colon (e.g., f:456) or just the number associated with a dependency tag (e.g., 789) is valid. If curly braces are not entered as part of the search string, then the Dependency Tag Info Gadget searches all tag types in the following order: f, a, d, s.

After a search using a dependency tag, this information is displayed in the gadget:

  • Type: Shows the file type of the returned dependency tag: 
    • {{d:####}} = Directory
    • {{f:####}} = File/page; both files and pages use this syntax type
    • {{a:####}} = Asset
    • {{s:####}} = S-tag: Used with XML/XSL templating to pull content from a PCF file on staging for a triggered publish
  • Name: Displays the name of the file, asset, page, or directory. 
  • Staging Path: Displays the path from the site root. Path is shown for file or directory tags. Clicking this link will take the user to the file in OU Campus.
  • Site: Displays the site name in which the referred-to dependency resides.
  • Subscribers: Lists any pages that have subscribed to the image, asset, file, or link. Clicking any of the the linked filenames will take the user to the selected file in OU Campus.

Dependency Tag Info Gadget

Searching by Asset Name

Users can search for Assets by entering in all or part of the Asset name. When users search for Assets, the following information is displayed in the gadget:

  • Type: Type of file that was returned (in this case, "Asset").
  • Name: The full name of the Asset.
  • DM Tag: Dependency tag for the Asset. The tag will have the format of {{a:####}}.
  • Site: Site in which the Asset was created.
  • Subscribers: List of pages on which the Asset has been placed.

Searching by Asset Name

Searching by Staging Path

Users can search for files, pages, and directories in the gadget by typing the root-relative path of the page or file in question. Typing in a partial filename will return all results that match the partial filename.

If a user is viewing a directory in the Pages list view when the search is performed, then the gadget will return results that exist inside that directory. For example, if a user is in the /admissions/ directory of a site and searches for index, the search would return information for the /admissions/index.pcf page, and not index pages at the root of the site or in different directories.

When users search by staging path, and the file returned only has one dependency tag associated with it, the gadget will display the information found above in the Searching by Dependency Tag section. If there are multiple dependency tags associated with a file on staging (e.g., if publishing a page creates both an HTML and PDF file on production), the following information is displayed in the gadget:

  • Type: Type of file that was returned (in this case, file or directory).
  • Path: Directory-relative path of the file, using the currently-viewed directory as the root.
  • DM Tags: Dependency tags associated with the file. Multiple page products can exist for one page on staging, and each page product will have its own dependency tag.
  • Site: Site in which the file exists.
  • S Tag: S-Tag for the file on staging.

Searching by Staging Path

Searching by Production URL

Users can also search for files, pages, and directories in the gadget using the fully-qualified URL of a page, file, or directory that exists on production. Pasting such a URL into the gadget will return the same information as when a user searches by the staging path.

When searching by staging path, production URL, or Asset name, it's possible that multiple files/pages may return as matches. In this case, the gadget will display a list of all results, and users can click on the linked path of the file to view information about its associated dependency tags.

Multiple Results when Searching for a Dependency Tag

Finding Dependency Tags

There are many places in the system where users can find dependency tags in addition to searching for them in the Dependency Tag Info Gadget. Dependency tags can be found in the source code, from tools in the WYSIWYG Editor, or by running a custom report (available to level 9 and level 10 administrators). For example, when inserting a link to a file, the Insert/Edit Link or Insert/Edit Image tools will display dependency tags if the file/page exists on the staging server. The following reports supply a dependency tag:

  • Custom Reports > Pages, and select the Products checkbox (f-tags)
  • Custom Reports > Directories, and select the Dependency Tag checkbox (d-tags)
  • Custom Reports > Products, and select the Dependency Tag checkbox (f-tags)
  • Custom Reports > Assets, and select the Dependency Tag checkbox (a-tags)

Dependency Tag in the Insert/Edit Link Modal

Dependency Tag Example in Insert/Edit Link Modal

Dependency Tags in the Assets List View

Dependency Tags in the Assets List View

Dependency Tags in the Source Editor

Dependency Tags in the Source Editor

Video