Bay templates

An Bay template is related to a Bay drawn in the Single Line.

The library also has the provision to reuse entire bays as templates. However, due to the frequent requirement to share functionality across multiple bay templates, the functions and equipment of a bay are typically stored as library elements of their own, and can be used independently of the bay template. Creating a bay from the library will then reference these independent library elements.

Modifying element template that is used by composite library element (e.g. function or equipment) will affect all composite library elements (Bays, IEDs, Processes) that use them!

Content

All the following information related to Bay are store in the library:

• Single line related child element (Equipment)

• Bay properties

• Contained Function template and Equipment function template

Then Bay Template can be composed of other library element (Function template, Equipment template, IED template)

Representation on library

The Bay is exposed on the library within the Library Manager over the Bays tab.

Add to library

The add process is done with a right mouse click on the Bay and using the contextual menu “add to library”.

Because this element can be composed of other element (Function template, Equipment template)

adding a bay to the library is a more complex operation, as the library keys of the contained element must be managed as well:

As with other library element a library key must be specified in the ‘Add Bay to Library’ dialog. In addition, there is a list of the components of the bay - the non-equipment Functions and the Equipment.

Each of the displayed elements will be added to the library according to the ‘Status’ column:

• New
  This component does not yet have a library key and will be newly added to its respective library.

• Update
  This component already has a library key, and the corresponding element will be updated.

• Overwrite
  The library key that is entered for this component is already in use, and differs from the library key that the component uses. The element in the library corresponding to this key will be overwritten.

• Intrinsic
  This component is not intended to be shared - it will be added to the library as an integral part of the bay, but not as an independent library element in the respective Function or Equipment library.

The ‘Used by’ column contains the names of other composite library elements that also use this component.

Re-adding a Bay to the library will overwrite the library definition with the current state of the Bay

Update from library

Changes to the library element can be manually propagated to other instantiated element that use the same template by selecting the action ‘Update from Library’ in their right-click menu.

The “update from library” should be seen has a complete override of the existing element instance by the current version of the element template from the library.

Note that the ‘Template’ field in the properties of a element is editable, and the ‘Update from Library’ action will refer to the current value of that field.

Currently there is no Template versioning concept and automatic template changes propagation concept. If you update a template and you would like to propagate this change to all instances element of this template. You should apply again this template to the already created element or simply recreate said element.

Usage

After an Bay has been added to the library, its ‘Template’ property will show the library key, and the Bay becomes available in the area of the editing palette under Bay & Bus Bar Templates :

When a bay library element is used, a dialog is shown to customize the new bay. This dialog shows a list of element that can be instantiated as part of the bay.

Deselecting checkmarks in this dialog will omit the deselected element from the new bay.

In this case, the library element should contain the superset of all elements that are used by variants. For this reason, ‘Update from Library’ will only update existing element to preserve the variant. Should a new element be added to an existing library element, it will need to be created manually for all element instances that require it.