Component applications (plug ins), Attributes, Properties – Echelon LonWorks Network XML User Manual

Page 53: Component applications (plug-ins)

Advertising
background image

L

ON

W

ORKS

Network XML Programmer’s Guide

45

</DeviceTemplate>

Component Applications (Plug-Ins)

Component Application objects are reported on export at the system level (in which case they are
reported at the same level as the Channels, DeviceTemplates, ConnectDescTemplates, and
RootSubsystem elements), the DeviceTemplates level, and within the FunctionalBlocks property at
the DeviceTemplates level.

You can register plug-ins on import; however, you need consider the following:

• You must define the Register command within the System Component Applications collection

(defining the Deregister command in this collection is optional). This is because director
applications use the Register command within this collection to determine whether the plug-in
has already been registered. If the Register command is present in this collection, the plug-in is
assumed to be registered. If the Register command is not defined, the plug-in is assumed to be
not registered (even if other commands are specified for the plug-in elsewhere in the same
network database).

• To delete a component application object, you must remove the Register command from the

System Component Applications collection (as well as from all other locations). This enables
director applications to determine if the plug-in is no longer registered.

• You can register the commands that the component application object implements at the system,

device template, or device template/functional block level. The scope of the component
application object determines at which level its commands are registered.

• Component application objects at the global level (within the LCA Object Server object) are not

reported on exported, and you cannot register (add) or deregister (delete) them on import.

Attributes

Attribute

Applicable

Values

Description/Notes

Action

1 IGNORE
2 CREATE
3 CREATE_UNIQUE
4 UPDATE
5 MODIFY
6 DELETE

To create a new plug-in, you must specify the
Name, RegisteredServerName, and
ComponentClassID properties.

Properties

Supported by

Function?

Property

Export Import

Description/Notes

Name

Y

Y

The name of the plug-in is reported.

RegisteredServer

Y Y Specifies

the

registered ActiveX name for the

plug-in.

ComponentClassId

Y

Y

An enumerated value that specifies the type of
object that the plug-in acts upon. The possible
values are as follows:

1

Network

2

Networks

3

System

Advertising