Troubleshooting P3000 Cross Reference and Tag Descriptions

Brian Holt8 min read
AutomationDirectHMI ProgrammingTroubleshooting
Licensed PE Working through this on a live machine? A Maine-licensed engineer can take it from here — included with IMD hardware, by the hour for everything else. Book an engineer

A tech who lives in the DirectSOFT5 Xref window opens the Productivity Suite for a P3000 and finds nothing that behaves the same way. There is no live pane that jumps to whatever element is selected in the ladder. Tag descriptions also run as one long line and stretch every rung across the screen. Neither problem stops the processor, but both slow down live troubleshooting. Get it running with the tools that exist, then fix the tag structure properly.

Stop Hunting for the DirectSOFT5 Xref Pane

The first move is usually to dig through every menu and dockable window for a DS5-style Xref pane. That pane is the one that auto-indexes to the selected element, updates instantly, and shows every use of that element while you are online.

Why it fails:

  • The Productivity Suite already has a cross reference, but it is a different tool. It is not a docked, selection-following pane.
  • A request to revamp that cross reference had been logged in AutomationDirect's future improvement database. Treat the DS5-style behavior as a feature request, not a hidden setting.
  • No option turns the existing cross reference into the DS5 window. Time spent looking for one is time the line stays down.

What works: use the built-in cross reference as a lookup tool. The procedure is below. The source material dates from 2012, so check the Help file for your installed release. The cross reference may have been reworked since.

Stop Forcing Line Breaks into Tag Descriptions

The second move is to press Enter, or a modifier plus Enter, inside a tag description to stack it on several lines the way DS5 did.

Why it fails:

  • Carriage returns cannot be entered in Productivity Suite tag names or tag descriptions. The field takes a single line of text.
  • The description field accepts a lot of text. A long description does not wrap into a tidy block. It turns into one long sentence that widens the rung.
  • Pasting text that already contains line breaks from another editor is the same fight. The field does not store it as a multi-line block, so do not build a workflow around it.

Carriage returns in descriptions were also logged as a feature request. Until your installed version supports them, keep descriptions short and move the detail elsewhere.

Stop Porting DS5 Nicknames One-for-One

The third move is to carry DS5 habits straight across. In DS5 a nickname of 16 characters or fewer sits on top of a three-line description. That description reads as area on top, action in the middle, and identifier at the bottom. Short nickname plus layered description gave compact, readable rungs.

Why it fails in the Productivity Suite:

  • The three-line description has nowhere to land. Without carriage returns, the three layers collapse into one wide line.
  • A cramped 16-character name loses its partner. The layered description used to explain the short name, and that explanation is gone.
  • You end up with the worst of both: cryptic tag names and long single-line descriptions.

The fix is to move the layering out of the description and into the tag name. The steps are in the tag structure section below.

Know Why the Two Packages Behave Differently

DirectSOFT5 is built around fixed memory addresses. Nicknames and descriptions are labels attached to those addresses. The Xref window can index instantly because every rung points at a known address, and the editor always knows which address is selected.

The Productivity Suite is tag-based. The tag is the primary identity, and logic is organized into tasks. A cross reference there is a query: find every place this tag is used. It is not a live mirror of the cursor position. That design difference explains why the tool feels like a search result rather than a companion pane.

Descriptions work the same way. A single-line text attribute rendered beside the ladder element grows horizontally. The rung has to make room, so a long description widens it.

Symptom Cause What restores productivity
No pane follows the selected contact or coil The cross reference is a lookup tool, not a selection-tracking window Open the cross reference per tag and work from its usage list
Enter does nothing useful in the description field Carriage returns are not supported in tag names or descriptions Keep descriptions to one short line; put detail in rung comments or project documentation
Rungs run far off the right edge of the screen Long single-line descriptions widen each element Shorten descriptions and move the context into the tag name
Migrated tags are cryptic and hard to read online DS5 short nicknames lost their three-line descriptions Rename tags using an area, action, identifier pattern
Behavior differs from what older notes describe Notes predate later software releases Check the Help file and release notes for your installed version

Trace a Tag Live with the Built-In Cross Reference

This gets you most of what the DS5 Xref gave you for live fault-finding. Menu names and placement vary by release, so find the cross reference entry in your version's Help first.

  1. Go online with the P3000 and open the task that contains the misbehaving output or bit.
  2. Pick the tag you are chasing. Start with the output coil or the final permissive, not an intermediate bit.
  3. Open the cross reference for that tag. List every task and rung where it is written and where it is read.
  4. Sort or group the results by task, or by logic block if your version supports it. Find the writers first. Most faults are two writers fighting, or one writer that never gets scanned.
  5. Jump to each writing location and watch power flow while online. Note which condition is holding the rung false.
  6. Take the blocking condition's tag and repeat from step 3. Work backward one tag at a time until you reach a field input or a fault bit.
  7. Keep a short paper list of the tags you have already traced. Without an auto-indexing pane, it is easy to loop back to a tag you cleared ten minutes ago.

Stop here if the cross reference shows a tag written in more than one task and you did not write the program. Confirm the intended ownership with whoever owns the code before you change any logic.

Restructure Tag Names and Descriptions

Do this properly after production is back, and preferably before a DS5 migration rather than during one.

  1. Decide the three layers you used to put on three description lines: area, action, identifier.
  2. Build those layers into the tag name in that order. Use the separator your tag naming rules allow. The name now carries the context the DS5 description used to hold.
  3. Trim each description to one short line: the one fact the tag name cannot express, such as a field device number or a normal state.
  4. Move long explanations to rung comments or to the project documentation, not to the tag description.
  5. Apply the same pattern to every tag in the project. The pattern only pays off when it is consistent.
  6. Open a few dense rungs online and check that they fit on screen without horizontal scrolling at your usual zoom.

The trade-off is the reverse of DS5. There, a short name plus a long layered description kept rungs compact. Here, a longer structured name plus a short description does the same job. If you prefer short names with rich descriptions, that only becomes practical once carriage returns in descriptions are supported in your release.

Verify Before You Call It Done

  • Cross reference test: pick three outputs at random and trace each one back to its field inputs using only the cross reference. If any trace dead-ends, a tag is used in a way the list is not showing you. Find out why before the next breakdown.
  • Rung width test: scroll through the busiest task online. No rung should need horizontal scrolling because of description text.
  • Readability test: have someone who did not write the program read five rungs aloud using only tag names. If they cannot say what the rung does, the naming pattern is not carrying enough context.
  • Version check: record the installed Productivity Suite version in the project notes. Cross reference and description behavior can change between releases.

Stop and Escalate

Stop if the cross reference in your installed release returns incomplete usage lists, or if you need a behavior the Help file does not document. Contact AutomationDirect technical support with your software version and the exact tag and task involved. Submit missing DS5-style features, such as a selection-following cross reference or multi-line descriptions, through AutomationDirect's official channels as feature requests.

FAQ

Why does Productivity Suite not have a DirectSOFT5-style Xref window?

The Productivity Suite has its own cross reference, which works as a per-tag lookup rather than a pane that auto-indexes to the selected ladder element. A revamp of that cross reference had been logged as a future improvement. Check the Help file for your installed release to see its current behavior.

Why does pressing Enter not add a line break to a P3000 tag description?

Carriage returns cannot be entered in Productivity Suite tag names or descriptions. The field holds one line of text. Put the area, action, and identifier layers in the tag name, and keep the description to one short line.

Why do my rungs get so wide after migrating from DirectSOFT5?

DS5 three-line descriptions become single-line descriptions in the Productivity Suite, and long text widens each ladder element. Shorten descriptions and move the context into structured tag names. If rungs still overflow after that, contact AutomationDirect technical support with your software version.

Back to blog