BASICS

ADMINISTRATION

DEVELOPMENT

SUPER ADMIN

  LAST UPDATED
8/30/2013

Using Dependency Manager

The Dependency Manager will automatically insert Dependency tags after it been activated by an administrator and the scan run. Please note that upon initial scan (or rescan) of multiple sites within an account, two Dependency Manager scans are required of each site with the exception of the last site scanned, which only requires one scan. The first pass should scan each site one after the other, and the second pass should start from the first site scanned and scan each one again with the exception of the last site. For example, if an account includes 10 sites, 19 total scans would need to be performed in order to ensure that all links among sites include the correct dependency tags.

When using Dependency Manager, links are inserted as usual. However, when the link is inserted, it will appear with a dependency tag, which will start with a “d” or an “f”. These appear similarly to those of Assets. The Dependency Manager supports linking from within an asset; dependency tags can be added when creating and using assets.

Links can be inserted using the WYSIWYG Editor, the Source Editor, and file choosers. Once the appropriate page is selected, a dependency tag will appear instead of the page path. Dependency links can be selected across publish targets if Multi-Target Publish is configured and in use for the account. Depending upon the configuration in the site record (Setup > Sites), Dependency Manager can generate root relative links or fully qualified URLs (Short URL is set to Absolute), and to the correct target. Dependency Manager only pertains to pages maintained within OU Campus.

Tags will appear as follows:

  • {{d:####}} -- Directory tag
  • {{f:####}} -- File/Page tag
  • {{a:####}} -- Asset tag
  • {{s:####}} -- S-tag: Used with XML/XSL templating to pull content from a PCF file on staging

Example of a Dependency Tag

Inserting Link - WYSIWYG

The actual path to which the link will be pointed will appear below the Dependency tag.

Dependency tags can also be inserted when editing in Source Editor or using a file chooser:

  1. First click on the File Path icon.
    Adding a Link in Source
  2. Then use the file chooser to find the appropriate page to which the link should be pointed.
    File Chooser
  3. This inserts the tag.

    Remember that the appropriate coding tag needs to be configured by the user. This process will not insert the coding.

The Dependency tag will appear as a tag in the source, regardless of how the source is viewed (either through the WYSIWYG Editor or the Source Editor).
Link Configuration

 

About Triggered Publish

A tag, which appears similarly to a Dependency tag but is preceded with s: instead of d: or f:, is accessible through filechoosers, which are commonly used in Page Properties. When using the tag on a page, that page will have a triggered publish when the source file is republished. The XSL can use the path generated by the tag to display content being maintained on a different page. This is similar in concept to an include file or an asset. When the original file is updated, the page containing the content is also published automatically. One example of how this is used is when using content from the main web site on a mobile page. When the content on the main web site is updated and published, the mobile page is also published with the updated content.

 

 

Next Page

 

Renaming or Moving a Directory or File

When a file or directory is either moved or renamed, a prompt that all dependent pages will be republished will appear. This will republish the page based on the current version of the page on the live Production Server with the new Dependency links. If changes have been made but not published to the live site, those changes will still not be published to the live Production Server but will be available in OU Campus and still saved on the Staging Server. This includes backed up versions.

Renaming a File or Directory:
Renaming a File or Directory

Moving a File or Directory:
Moving a File or Directory

 

Previous PageNext Page

 

Revert Scan

It is possible to conduct a Revert scan on any site that has been previously scanned. It is important to note that a Revert scan is not a revert process. It will not restore the pages, nor the links, to their states prior to the initial scan. Instead it will replace the Dependency tags with root relative URLs (e.g. /folder/file.html) or absolute URLs (e.g., http://www.college.edu/folder/file.html), depending on the site settings.

To conduct the Revert scan:

  1. Simply go to Setup > Sites and click the icon under Revert column for the site on which the revert scan should be performed. 
    Revert Scan
    Note that the Revert icon and column will only appear if Dependency Manager has been enabled.
  2. A prompt will appear confirming that the intended action is to have the dependent tags removed and all dependent links converted to root relative or absolute URLs, depending on the site settings.
    Start Reverse Scan
  3. As the scan completes, a progress bar will appear on the screen.
    Reverse Scan Pass
  4. Once completed, a dialog box will appear indicating that the process has finished.
    Completed Scan

Previous PageNext Page

 

Broken Links

If a directory or file is deleted, a broken link will be created. The system has various indications of a broken link.

*** Broken a:21230 documentation: Dependency Manager Broken Link Tags ***

If a recycle bin has been set up for the site, when recycling a file, a prompt will appear indicating how many links will be broken if the page is recycled.
Reclycling File

Keep in mind that the warning will not appear prior to deleting a directory or file if the recycle bin has not been configured.

After the file is recycled, the system will display which pages have broken links as a result.
Broken Link Alert

In addition to the above information, for users with Source Editor access, when in the Source Editor, if broken links exist on the page, they will be displayed at the top of the page.
Source Editor View

This will make changing or fixing the links easier, but it is limited to being on a page-by-page basis.

When previewing a page, a broken link is displayed in the status bar (if the status bar is turned on) when the cursor hovers over the link.
Broken Link Hover

OU Campus indicates that a link is broken is within the WYSIWYG Editor as well. When on the link in question, click on the link icon, and this will bring up the Insert Link dialog box. It is within this pop-up that the broken link will be displayed below the Link URL box.
Link Dialog Broken Link

It is possible to configure the URL on the page to indicate that the link is broken when in the WYSIWYG. In this case, a broken link will appear similarly to that of an Asset with hash marks. In order for this option to be available, the URL will have to be displayed as part of the page content.

  1. To get the Dependency tag ID, simply create a link on the page as described above.
  2. Access the source, either through the HTML button in the toolbar, or via the Source Editor.
  3. Find the Dependency tag and link.
  4. Replace the text being displayed on the page with the Dependency tag.
  5. Save the changes.
  6. This will display the URL on the page.

    Keep in mind that the Dependency tag will render the root relative URL if that is the selection that has been made in the site settings, and in this case, it is advised that the HTTP root be appended to before the Dependency tag in the content portion. Adding the root to the tag text should the desired effect be that the whole URL appears on the page.

To display the link on the page, configure it as seen here:
Display Dependent Link

This will then create an Asset-like hash box around the dependent part of the link in the WYSIWYG view:
Result of Displaying Dependent Links

If the linked page is deleted, broken link Dependency tag is shown within the hash marks for easy identification:
Hash Box with Broken Link

One way to avoid broken links is to utilize the Include unpublished dependencies checkbox during the publish to publish the unpublished content. Dependency Manager reports at page publish time if there is dependent content that has not been published to the target server. This includes content that is linked or referred to by the page that is being published, as well as any unpublished assets. By selecting to include the unpublished dependencies, those unpublished files are published as well. This action prevents broken links (for example) from existing on the current page being published.

This checkbox is only shown if the Dependency Manager is being used on the site, dependency tags are used in the page being published, and one or more of those dependency tags refer to files that have not been published to the target yet.

 

Previous PageNext Page

 

Additional Scenarios and Considerations

When a directory with Dependency tags pointing to files within the same directory is copied, the links in the files of the copied directory either have to be manually updated or OmniUpdate Customer Support can be contacted to help with this scenario.

This may include:

  1. Copying a directory to create a new directory within the same site with the same starting content.
  2. Copying a directory's files to convert it into a new site.

To take a directory from an existing site that is using Dependency tags and make it into a new site of its own (e.g., http://www.college.edu/athletics/ is to become http://athletics.college.edu/), specific steps must be taken to obtain the desired outcome. It is important to note that most of the following steps are necessary for this process with sites that do not use Dependency tags. The instructions below add the steps needed when Dependency Manager is used on the source site.

  1. Perform the process during a downtime (evening or weekend).
  2. In the Setup > Sites view, select the Revert tool to remove all Dependency tags from the source site.
  3. Use the Zip Export tool to download a copy of the site from OU Campus.
  4. Create the new site record the same way sites are normally created in OU Campus.
  5. On the workstation being used, open the exported zip file and extract the folder desired to be the source of the new site.
  6. Create a new zip file of just the directory that is the origin of the new site.
  7. In the new site in OU Campus, from the top Content > Pages view, use the Upload tool to import the zip file just created (select the Ignore containing folder check box of the Zip Import, if there is one).
  8. Once the files are uploaded, on the new site use the Global Find and Replace from the Content tab to search for the paths that have the containing folder, which was ignored upon import, and remove the now incorrect folder name (e.g., Find: /athletics/; Replace with: /).
  9. Use the Global Find and Replace to correct the links from the new site to the source site, usually found in header and footer navigation and links (e.g., any paths that are not on the new site, such as /admissions/... would become http://www.college.edu/admissions/...).
  10. On the source site, use the Global Find and Replace from the Content tab to search for the paths that have the now removed folder and change them to the new site URL (e.g., Find: /athletics/...; Replace with: http://athletics.college.edu/...).
  11. Use the scan tool from the Setup > Sites view to scan the new and old sites to create new Dependency tags for each site.
  12. On the source site, delete the now obsolete /athletics/... directory.
  13. If any URL paths were missed in step 10, any pages on the source site with links to the now deleted directory will appear in the Dashboard > Broken Pages screen.
  14. Fix the pages that appear in the Broken Pages screen; the two sites will now have correct Dependency tags for each site and cross-site links.
  15. Populate the new site's Production Server with any needed binaries to support the new site.
  16. Continue to setup and configure the new site as would be done for any other site.

For questions regarding this process or to have only the individual directory being copied Revert scanned, contact Support

Previous PageNext Page

 

Important Information and Reminders

  1. Dependency Manager tracks and updates links within the following file types and extensions:
    - PCF: ".pcf"
    - XML: ".xml"
    - XSL: ".xsl", ".xslt"
    - HTML: ".html", ".htm", ".xhtml", ".shtml", ".shtm", ".jsp", ".php", ".php3", ".phtml", ".asp", ".chtml", ".dna", ".cfm", ".inc", ".aspx", ".mht", ".cshtml"

  2. Dependency Manager does not track binary files, such as images, with the exception of those that are products of a PCF. If the binary is created based on editable file, such as PDFs created by a PCF, a Dependency tag will be created.

    Any changes (file moves or renaming) to binary files, with the exception of those that are products of a PCF, will require that any links be updated manually.

    Dependency Manager works with anything editable from within OU Campus or generated by an editable file from within OU Campus.

  3. Dependency Manager does not track links to pages or sites not under management by OU Campus. This also applies to sites that are not in the same Account as the current site under OU Campus Management. The Dependency Manager is Account bound and can only track and manage URL changes to pages or directories that are within sites in the same OU Campus Account.

  4. To utilize Dependency tags when using the file choosers, dependency=yes needs to be entered into the filechooser parameter or variable tag.

    Example:
    <variable name="leftnav_include" prompt="Left Nav" alt="Choose your left nav" type="filechooser" path="/includes/navs" dependency="yes">/includes/navs/default.html</variable>

  5. It is suggested that a complete site export is completed on each site prior to activating Dependency Manager to allow for an immediate and complete reversal via Zip Import if the end result is not desired.

  6. If a directory or file is uploaded or deleted via FTP, run the scanner on the affected directories or entire site to avoid publishing issues.

  7. The following regex can be used to see which links have been replaced with Dependency tags.
    \{\{[fd]:\d+\}\}

  8. The Dependency Manager supports linking from within an assets; dependency tags can be added when creating and using assets.

  9. Dependency Manager links are case sensitive. As such, it is advised that paths for links to pages managed in OU Campus are always inserted using the browse functionality.

  10. Dependency Manager inserts Dependency tags into <a> and <link> tags at the “href” attribute automatically, both when the Dependency Manager Scanner is run and when new links are created. However, tags can be manually included elsewhere as desired.

    Dependency Manager will not automatically add Dependency tags to any other types of tags, including php, asp, and JavaScript.

    Important Exception: Dependency tags cannot be placed within processing instructions or the prologue, which is the instructions prior to the opening XML comment. Entering in Dependency tags within these will cause an error as they will not be able to be rendered.

  11. Dependency tags are used across sites within one account.

  12. Dependency Manager renders root relative links (i.e. /directory/page) and absolute links (i.e. http:www.college.edu/directory/page), depending on the site settings. The rendered URL to the Production Site cannot and will not be page relative (i.e., ../page).

    If there is Production Side processing that requires certain formatting of paths, be aware of how the paths will render and either avoid using Dependency Manager where it might be adversely affected or change the Production Side processing.

    If page relative URLs currently exist on any of the pages and it is required that they remain page relative, the Dependency Manager Scanner should be run on a per directory basis, not a site-wide basis.

    If page relative URLs are required going forward, these will need to be added manually without using the WYSIWYG Editor and Source Editor browse functions or the file chooser.

    If the HTTP Root setting is changed in the site settings, the entire site should be republished.

  13. Run the Dependency Manager Scanner if a page to which others are dependent is restored from the Trash, or if a directory or file is uploaded or deleted via FTP.

    The scan can be run on only the affected directory or directories. 

  14. The Revert scan is not reverting the site to its state prior to Dependency Manager being utilized and the site being scanned. It is replacing the Dependency tag with the root relative or absolute URL, dependent on the site settings.

  15. Dependency Manager will not scan or update files within the following folders:

    -- OMNI_RESOURCES at root
    -- OMNI_ASSETS at root
    -- Trash (if defined) at root
    -- OMNI_INF at all levels

  16. OU Campus does not contain any tracking of which sites have been scanned. If this is desired, it is recommended that it be completed internally.

  17. Reporting is available with details on which Dependency tags refer to which pages, and which pages are currently subscribing to those pages. Read the documentation here.
  18. Dependency tags will not be referenced in the Custom Reports if the page or directory was deleted.

  19. Please note that upon initial scan (or rescan) of multiple sites within an account, two Dependency Manager scans are required of each site with the exception of the last site scanned, which only requires one scan. The first pass should scan each site one by one, and the second pass should start from the first site scanned and scan each one again with the exception of the last site. For example, if an account includes 10 sites, 19 total scans would need to be performed in order to ensure that all links among sites include the correct dependency tags.

  20. Dependency tags are supported across Publish Targets.

Previous Page



  

 

 


Was this page helpful?

Additional Comments:


(Include your email address if you would like a reply)

Procede to http://support.omniupdate.com/