Publishing Using PML Macros

You can publish grids, DB views, drawings and datasheets using PML functions as well. To do this, you must first create a macro file that contains the commands to publish. Then, you must run the macro file by dragging it to the command window in AVEVA Engineering.

Selection Methods

Get Methods

Clear Methods

Options Methods

Publishing Methods

General Methods

The following table lists the options available with the SetOption() command.

The following table lists the commands for publishing reports.

The following is an example of the contents of a macro file.

import 'AVEVA.NET.Gateways.IED.PmlExtensions'

handle any

endhandle

using namespace 'AVEVA.NET.Gateways.IED.PmlExtensions'

!publisher = object IEDPublisher()

--(APS) Centrifugal Pumps

!publisher.SelectElement('=23997/1366')

--(APS) Filters

!publisher.SelectElement('=23997/1330')

--(APS)P1501A_CENTRIPUMP_DST

!publisher.SelectElement('=23997/988')

--(APS)P1501B_CENTRIPUMP_DST

!publisher.SelectElement('=23997/989')

!publisher.SelectConfiguration('T1')

!publisher.SetOption('itemProcessDatasheets', false)

!publisher.SetOption('itemProcessGrids', true)

!publisher.SetOption('itemProcessDrawings', false)

!publisher.SetOption('drawingProcessConnectedDrawings', false)

!publisher.SelectDbView('CENTRIFUGALPUMP_View')

--(APS project) Selects DbView using it's unique name

!publisher.Publish()

!errorsNo = !publisher.ErrorsNo()

-- Include sub-grids when publishing grids

!publisher.SetOption('gridProcessSubGrids', 'true')

-- Publish all element attributes from grid scope, grouped by element type

!publisher.SetOption('itemDataPublishScope', 'Attributes')

Select Grids by Name or Glob Pattern

You can use SelectGrids() to select grids for publishing by their exact name (lstnam attribute) or by a glob pattern that matches their full hierarchy path (for example, Mechanical/Centrifugal_Pumps).

Note: A grid is published only if it exists and its lstpub (can be published) attribute is set to true. Grids with lstpub set to false are not published even if they match the selection.

Note: If a grid name or any segment of a glob pattern contains a special glob character (such as *, ?, or /), the special character must be escaped by enclosing it in square brackets []. For example, a grid named Centri*fugal/Pumps must be written as Centri[*]fugal[/]Pumps.

The following is an example macro that selects grids using a combination of exact name and glob pattern:

import 'AVEVA.NET.Gateways.IED.PmlExtensions'

handle any

endhandle

using namespace 'AVEVA.NET.Gateways.IED.PmlExtensions'

!publisher = object IEDPublisher()

!publisher.SelectConfiguration('TTY')

-- Select a specific grid by exact name

!publisher.SelectGrids('Mechanical/Centrifugal_Pumps')

-- Select all grids under the Mechanical hierarchy

!publisher.SelectGrids('Mechanical/*')

-- Publish

!publisher.Publish()

To retrieve the currently registered selections:

!selectedGrids = !publisher.GetSelectedGrids()

q var !selectedGrids

To clear all registered grid selections and start again:

!publisher.ClearSelectedGrids()

-- Register a new selection after clearing

!publisher.SelectGrids('Mechanical/Centrifuges')

!publisher.Publish()

Glob Pattern Syntax

Glob patterns match grids by their full hierarchy path, for example Mechanical/Centrifugal_Pumps.

The following wildcards are supported:

For a full reference on glob syntax, see Glob (programming)