Navigation:  PeerLink Help > Getting Started >

Terminology

Previous pageReturn to chapter overviewNext page

Introduction

 

Before getting started, it is important to have a good understanding of key concepts and terminology used throughout this help document.

 

 

Terms

 

File Collaboration Session

A communication session made up of two or more hosts, each with a designated root of folders and files that are to be shared or collaborated on. A collaboration session coordinates the primary functions of file locking and synchronization.

Participating Host

A host that is participating in a file collaboration session.

Directory Watch Set

The configured root folder and all sub folders that are being watched and collaborated on for a participating host.

Source Host

The host where a file access or change event originated from.

Target Host

One or more hosts where file access and change events will be propagated to.

Initial Synchronization Process

The background process that occurs at the start of a file collaboration session, where the directory watch set is recursively scanned on all participating hosts, file conflict resolution is performed, and any files that require updating are synchronized with the most current copy of the file.

File Access Event

An event that is triggered from the opening or closing of a file.

File Change Event

A event that causes a file to be changed in some way, for example: file modify, file delete, file rename, file attribute change, etc.

File Lock Conflict

A file collaboration condition that exists when two users open a file at the same time and both hold exclusive locks on the file.

Quarantined File

A file that has been removed from a file collaboration session as a result of a file lock conflict that could not be resolved. This file will remain quarantined until the user manually removes it from quarantine.

Peerlet

A solution built for the PeerLink framework. An Peerlet is a distributed application containing various parts, some of which function at a focal point called the PeerLink Hub and others invoked at remote points designated as PeerLink Agents.

File Collaboration Job

A specific instance of a Peerlet that can be created, saved, modified, and run. A Peerlet represents a type of Job.

 

In the case of File Collaboration, a File Collaboration Job represents a single configurable file collaboration session. The two terms may be used interchangeably throughout the interface and this document.

PeerLink Hub

The focal software component where Peerlets are installed, configured and ran. The PeerLink Hub can host Peerlets of various types and is where the components of a centralized solution function. The PeerLink Agent is invoked by Peerlets', distributing components with messages sent through the PeerLink Broker.

 

The PeerLink Hub runs as two parts: a Windows Service that is set to run all the time, and a client application that connects to the service for configuration and monitoring.

Views

Individual sections of the PeerLink Hub's user interface, each providing unique information and control.

 

Examples: Main View, Job View, Agent Summary View, Alerts View, Job Alerts View, etc.

Peerlet Editor

A container within the user interface of the PeerLink Hub which shows runtime and configuration information for a single file collaboration job. A Peerlet Editor is represented by a single tab, typically in the large center section of the PeerLink Hub's interface. The editor itself consists of multiple sub-tabs, with various runtime and configuration information dispersed amongst the sub-tabs. For more information, see the help section on Runtime Job Views.

 

Editors for multiple file collaboration jobs can be opened in several different editor tabs, allowing for quick movement between jobs.

 

The Peerlet Editor area of the PeerLink Hub will be referred to as the File Collaboration Runtime View throughout this document.

PeerLink Broker

The central messaging system of the Peerlet framework. The PeerLink Broker serves to connect the PeerLink Hub and the Agents, forming a PeerLink "network" that can be cast over local- or wide-area networks via TCP/IP. A PeerLink environment will deploy one or more PeerLink Brokers.

PeerLink Agent (or "Agent")

A lightweight, distributed component that is used to perform operations on the host on which it is running. A PeerLink environment will typically contain several Agents, one per participating networked host. Agents invoke the distributed portions of a Peerlet, and will often run near resources of interest, such as collaborated files. The Agent is designed to be purposed across the entire PeerLink solution suite, and will normally be directed to perform functions with messages received from Peerlets through the PeerLink Broker.

Heartbeat

A communication mechanism used between the the PeerLink Hub and all connected PeerLink Agents to ensure that Agents are alive and responsive. Heartbeats share information about the Agent's host server with the PeerLink Hub, aid in verifying when an Agent is no longer available, and signal when a disconnected Agent has reconnected. All heartbeat information is sent through the PeerLink Broker.