Configuring External Document Links and Maintenance Manuals in APL Faceplate Memo Views

In SIMATIC PCS 7 Advanced Process Library (APL) faceplates, the Memo View allows operators and maintenance technicians to access external equipment documentation—such as PDF operating manuals, P&ID drawings, and electrical schematics—directly from the runtime interface. Configuring document links requires assigning file paths to block parameters or custom script triggers in the faceplate Memo view and establishing a shared, authorized network directory accessible across all OS clients.

Role of the Memo View in SIMATIC PCS 7 APL Faceplates

The Advanced Process Library (APL) standardizes operator navigation across motors, valves, analog loops, and complex units through structured multi-view faceplates:
* Standard View: Primary operation and setpoint control.
* Alarm View: Message history and active interlock alarms.
* Trend View: Real-time and historical process curves.
* Parameter View: Engineering limits, tuning gains, and tracking parameters.
* Memo View: Designed as a digital shift logbook and technical repository. Operators can type shift handover notes, and maintenance personnel can open external engineering documentation (e.g., standard operating procedures, maintenance datasheets, manufacturer manuals) tied directly to that physical asset.

Architecture of Document Linking in WinCC OS Runtime

Document linking in PCS 7 relies on interaction between the WinCC Graphics Designer template and the underlying Automation Station block:
* Block Attribute / Internal Tag: In the CFC chart, the block instance can store a file path string or document ID parameter.
* Graphic Object Trigger: The Memo view template (@pg_apl_memo.pdl or @pg_apl_memo_view.pdl) incorporates a Document button or hyperlinked text field.
* Windows Shell Execution: When clicked, a local C-Script or VBScript invokes ProgramExecute() or the Windows Shell API (ShellExecute) to open the target document using the default viewer application (such as Adobe Acrobat Reader or a lightweight PDF viewer).

Step-by-Step Procedure to Link PDF Documents to Technological Blocks

To configure document launching from an APL Memo view:
1. Centralize Plant Documentation:
* Create a dedicated shared directory on the OS Server or central file server (e.g., D:/PlantDocs/Equipment/).
* Organize documents systematically using the plant Technological Hierarchy tag name (e.g., D:/PlantDocs/Equipment/M01_FEED_PUMP.pdf).
2. Configure Technological Block / Tag in CFC:
* If your library version includes a string parameter for documentation (e.g., DocPath or UserDoc), enter the document file name in the block properties.
* If using standard APL without custom block pins, use the equipment Tag Name (TagName) as the dynamic filename key.
3. Customize Memo View Script (if necessary):
* Open @pg_apl_memo.pdl in Graphics Designer on the Engineering Station.
* Locate the Document Link button or insert a standard Windows button labeled Open Manual.
* In the button's click event, add a VBScript action:

Dim objWshShell, sTagName, sFilePath
sTagName = HMIRuntime.Tags(".TagName").Read
sFilePath = "\\OS_SERVER01\PlantDocs\Equipment\" & sTagName & ".pdf"

Set objWshShell = CreateObject("WScript.Shell")
objWshShell.Run  & sFilePath & , 1, False
Set objWshShell = Nothing

Compile and Distribute: Save the picture, run the OS Project Editor, and compile/download changes to all OS servers and clients.

Network Share Configuration and OS Client Viewer Prerequisites

For document viewing to operate reliably across distributed control room architectures:
* UNC Pathing: Always reference documents using Universal Naming Convention (UNC) paths (e.g., \SERVER\Docs\...) rather than local mapped drive letters (e.g., Z:\Docs\...), as Windows service sessions do not consistently preserve mapped drive letters.
* Folder Permissions: Grant Read access to the shared folder for the SIMATIC HMI and Everyone local groups.
* PDF Reader Deployment: Ensure a certified PDF viewer (such as Adobe Acrobat Reader DC) is installed on every OS client workstation and configured as the default Windows application for .pdf files.
* Kiosk / Lockdown Mode: If OS clients operate in WinCC Kiosk / locked-down mode, ensure the Windows Group Policy allows launching external document viewer executables.

Verification

In WinCC OS runtime, click an APL pump block icon (MotL) to open its faceplate.
Navigate to the Memo View tab.
Click the Open Manual button.
Confirm that the PDF viewer launches immediately and displays the correct equipment operating manual.
Verify that closing the document returns the operator focus smoothly to the active WinCC process display.

Limitations and Operational Precautions

Avoid opening multi-gigabyte engineering 3D CAD files directly from operator faceplates; large files can consume client workstation memory and slow runtime graphics.
Ensure document files cannot be deleted or overwritten by operators; set read-only file permissions on the server share.
In Web Navigator client environments, opening local server shares requires configuring client-side browser download permissions or publishing documents via HTTP web URLs.

Engineer FAQ

What is the primary purpose of the Memo View in APL faceplates?
It serves as an electronic notepad for operator shift handover notes and provides access to external equipment documentation.
Where are operator shift notes stored in PCS 7?
Notes typed into the Memo view text field are stored in the WinCC runtime database and persist across client sessions.
Can I link multiple documents (e.g., electrical drawing and mechanical manual) to one block?
Yes, by configuring a drop-down selection list in the Memo view or linking to an HTML index page containing multiple links.
Why did clicking the document button fail with 'File not found'?
The file name did not match the tag name, the UNC share path was incorrect, or network share permissions blocked the client account.
Does linking documents to APL faceplates consume AS Process Objects?
No, document linking is implemented entirely at the WinCC OS visualization layer and consumes zero AS Process Objects.
What user authorization is required to edit Memo view text?
Authorization Level 5 (Process Controlling) is typically required to modify memo text, while Level 1 allows reading.
Can I open web-based maintenance URLs instead of local PDF files?
Yes, modify the script to call a web browser opening an intranet URL: objWshShell.Run "http://intranet/docs/" & sTagName.
What happens if Adobe Reader displays an update prompt on an operator station?
Disable automatic updates and splash screens in Adobe Reader preferences to prevent operator interface interruptions.
Can Web Navigator clients open documents from the Memo view?
Yes, if documents are hosted on an IIS web virtual directory and opened using HTTP/HTTPS hyperlinks.
Where is the system template picture for the APL Memo view located?
In the WinCC project directory under <Project Path>/GraCS/@pg_apl_memo.pdl.

Technical References

SIMATIC PCS 7 Advanced Process Library (APL) Function Manual (V9.0 / V9.1)
SIMATIC PCS 7 OS Process Control System Operating Manual
Siemens Industry Online Support Entry: Linking Documents in WinCC APL Faceplates (Entry ID 299108)
SIMATIC HMI WinCC V7.5 Scripting: VBScript and ANSI-C Reference

Related Tags

PCS 7, APL, Faceplates, Memo View, Documentation, PDF, Maintenance, WinCC, GraCS, ShellExecute

Configuring External Document Links and Maintenance Manuals in APL Faceplate Memo Views