Worker Library

The Worker Library tool contains a library of functional Workers (i.e. Workers with pre-developed functionality) that you can include in your applications. The Worker Library will add a copy of a selected Worker directly into your project.

The Workers in Library list shows a list of functional Workers in the Worker Library. Workers in this list can exist either as a class or as a library. Selecting a Worker from the list will then display information about the Worker or library, shown in the information box on the right.

The Worker Library also allows the inclusion of 3rd party Workers so that you can create your own libraries of functional Workers, either for use in your own projects, or for distribution to customers.

Options

Workers in Library

Shows a list of the available Workers in the Worker Library. Selecting a Worker in this list will populate the information box to the right with information about the selected Worker.

Open Example Project

If the selected Worker contains an example project then the Worker's example project will open.

Add selected Item to Project

A copy of the selected Worker or library will be made and added to your project.

+

Add a Worker source folder to the library. See Adding your own Workers to the Library.

-

Remove a Worker source folder from the library. See Removing your own Workers to the Library.

Adding your own Workers to the library

Pressing + will open the Add Worker Source Folder window.

This window allows you to add a folder which contain Worker Library configuration files.

The default path for Worker Library configuration files can be found in your installed LabVIEW directory: ...\LabVIEW 20XX\vi.lib\addons\_Workers\Worker Library

Any configuration files you add to this folder will be automatically detected by the tool.

Worker Library Configuration Files

A Worker Library configuration file is a LabVIEW configuration file that contains keys and values.

The purpose of the configuration file is to provide the Worker Library tool with the information it needs so it knows, for example, the path of the Worker or library, the path of an example project, a description about the Worker for the information box, etc.

An example of a configuration file (Message Pump.ini), is shown below.

[General]
Name = "Message Pump"
Library File Name = "Message Pump.lvclass"
Library Source Path = "..\..\..\..\user.lib\_Workers\Worker Library\Message Pump\Workers\Message Pump\_Message Pump.lvclass"
Example Project Path = "..\..\..\..\user.lib\_Workers\Worker Library\Message Pump\Message Pump Example.lvproj"
Company Logo Path = "..\..\..\..\user.lib\_Workers\Worker Library\sc logo.png"
Company Name = "Scarfe Controls"
Tree Level = ""
Version = "2.0"
License = "BSD-0"
Description = "This Worker sends a message periodically to the selected case of the calling Worker. The message is generated by the timeout event of an event structure.\n\nRT Compatible: Yes\n\nOther: The Worker used in this example is the same Worker that is copied into your project. Therefore modifying the Worker in this example will result in a modified copy in your project."

Section

[General]

Name

The name that will be displayed for the Worker or library in the Workers in Library list and in the Name field in the information box.

Library File Name

The name of the class or library that will be copied into your project. This can be different from the name of the source Worker or library itself.

Library Source Path

A relative path to the path of the configuration file, containing the source Worker or library.

Example Project Path

A relative path to the path of the configuration file, containing the source of the example project. This field is optional.

Company Logo Path

The logo of the company that is providing the Worker or library, to be displayed in the information box. The image needs to be a PNG file, of maximum size 100x64 pixels. This field is optional.

Company Name

The name of the company that is providing the Worker or library, to be displayed in the information box. This field is optional.

Tree Level

The level of the Worker or library name to be displayed in the Workers in Library list. An empty value will put the Worker or library under the 'Default' category. However you can add your Worker or library to your own category in the tree. The separator for levels is (;).

For example, if you have a Worker designed to run on a cRIO, you could write for this field:

Tree Level = "Company Name;cRIO"

This field is optional.