Connectivity Server: Standard Modules

From FactorityWiki

Contents 1 Low-level modules 1.1 DatapointHolderModule: Allows defining datapoints 1.2 DatapointMapperModule: Mapping datapoints from remote machines to local datapoints 1.3 ExecutorModule: Executes a java class or external process 1.4 LoggerModule: Logging datapoint in a file 1.5 LogSpoolerModule: Replaying a datapoint log file 1.6 QueueModule: A fifo queue of integer datapoints 1.7 StepSequenceModule: (deprecated) 1.8 TimeCounterModule: Counting time triggered by a datapoint 1.9 LockL1: For exclusive locking a machine by a single client application 2 Connector modules 2.1 OpcMapperModule: Maps OPC items from external systems 3 Generic MES modules 3.1 BackendEventHandler: Sending events to the application server 3.2 ContainerSingleContentsModule: Helper module for visualizing container contents 3.3 FaultModule: Providing a fault state for a machine object 3.4 ModuleASPlusSession: Providing a logon session to the application server 3.5 ModuleBackendFault: Sends fault informations to the application server 3.6 ModuleBackendMde: Generates machine data aquisition events 3.7 ModuleSecondaryTerminal: Keeps track of connected terminals 3.8 SimpleWatchdogModule: Simple monitoring of Connectivity Server 3.9 StatisticsModule: (deprecated) 4 Modules for creating a simple soft plc based on the Connectivity Server 4.1 Axis: For controlling a single machine axis 4.2 Logic: Defines logic, which is executed in the background 4.3 PcModule: Basic module for controlling the soft plc 4.4 Process: Defines and executes an action sequence

Low-level modules

DatapointHolderModule: Allows defining datapoints

Class: de.wireware.plc.DatapointHolderModule

This module allows defining datapoints, which can be used by other modules. It is does not implement any logic.

DatapointMapperModule: Mapping datapoints from remote machines to local datapoints

Class: de.wireware.plc.DatapointMapperModule

This module is able to map datapoints from remote machines to the local machine. It provides a simple way to connect machine objects.

ExecutorModule: Executes a java class or external process

Class: de.wireware.plc.ExecutorModule

This module can start a java or native process on certain conditions.

LoggerModule: Logging datapoint in a file

Class: de.wireware.plc.LoggerModule

This module traces the state of specific datapoints and logs it to a file. The state can be replayed by the LogSpoolerModule.

LogSpoolerModule: Replaying a datapoint log file

Class: de.wireware.plc.LogSpoolerModule

A datapoint trace, which was created by the LoggerModule, can be replayed by this module. After tracing and logging the state of a real machine it is possible to simulate the process later by using this module.

QueueModule: A fifo queue of integer datapoints

Class: de.wireware.plc.QueueModule

This implements a fifo queue of integer datapoints

StepSequenceModule: (deprecated)

Class: de.wireware.plc.StepSequenceModule

This is deprecated and should not be used anymore.
Replacement: com.factority.floor.wireware.pcmodule.Process

TimeCounterModule: Counting time triggered by a datapoint

Class: de.wireware.plc.TimeCounterModule

This module counts the time while a specified boolean datapoint was true. The time is stored in another datapoint.

LockL1: For exclusive locking a machine by a single client application

Class: de.wireware.plc.modules.LockL1

This module keeps a lock level which is associated to a single client application. Only one client application can hold the lock. Any commands (with specified exceptions), which are sent by other clients, are blocked by this module.

Connector modules

OpcMapperModule: Maps OPC items from external systems

Class: de.wireware.opc.OpcMapperModule

This module allows defining datapoints, which are directly mapped to external OPC items.

Generic MES modules

BackendEventHandler: Sending events to the application server

Class: com.factority.floor.wireware.genmodule.BackendEventHandler

This module asynchronously sends events to the application server, which are generated by other modules. If the application server is offline, all events are cached and sent later.

ContainerSingleContentsModule: Helper module for visualizing container contents

Class: com.factority.floor.wireware.genmodule.ContainerSingleContentsModule

This module queries the backend for the contents of a container. Using this is a good choice for easy visualising a machine location container in an MES terminal.

FaultModule: Providing a fault state for a machine object

Class: com.factority.floor.wireware.genmodule.FaultModule

This module can be configured for producing fault informations, which are signaled by other datapoints. Further this module takes care for sending the fault informations to the application server using the ModuleBackendFault.

ModuleASPlusSession: Providing a logon session to the application server

Class: com.factority.floor.wireware.genmodule.ModuleASPlusSession

This module opens a connection the the application server, which can be used by other modules.

ModuleBackendFault: Sends fault informations to the application server

Class: com.factority.floor.wireware.genmodule.ModuleBackendFault

This module sends fault informations, which are generated by other modules (eg. FaultModule), to the application server. This module depends on the BackendEventHandler.

ModuleBackendMde: Generates machine data aquisition events

Class: com.factority.floor.wireware.genmodule.ModuleBackendMde

This module gathers machine events and sends it to the application server. This module depends on the BackendEventHandler.

ModuleSecondaryTerminal: Keeps track of connected terminals

Class: com.factority.floor.wireware.genmodule.ModuleSecondaryTerminal

This module keeps track of terminals, which are connected to the machine. If no terminals are attached, which are classified as primary terminals, terminals which have the machine configured as secondard terminal, may show this machine using this module.

SimpleWatchdogModule: Simple monitoring of Connectivity Server

Class: com.factority.floor.wireware.genmodule.SimpleWatchdogModule

This module monitors the executing cycle of the Connectivity Server and terminates the server if no cycle executed for a specified time. In a normal Factority runtime environment, the server is restarted immediately.

StatisticsModule: (deprecated)

Class: com.factority.floor.wireware.genmodule.StatisticsModule

This module is deprecated and should not be used anymore.
Right now there is no replacement.

Modules for creating a simple soft plc based on the Connectivity Server

Axis: For controlling a single machine axis

Class: com.factority.floor.wireware.pcmodule.Axis

Using this module a single machine axis can be configured for manual setup operation.

Logic: Defines logic, which is executed in the background

Class: com.factority.floor.wireware.pcmodule.Logic

This allows defining logic conditions (logic networks), which are executed in the background in every plc cycle.

PcModule: Basic module for controlling the soft plc

Class: com.factority.floor.wireware.pcmodule.PcModule

This implements the basic functionality of the soft plc. This module is not optional.

Process: Defines and executes an action sequence

Class: com.factority.floor.wireware.pcmodule.Process

This allows defining an action sequence, which consists of actions and wait conditions. A process definition is very comparable to a workflow definition.