Published Variable Lists Tool

This tool handles all .pvl files. It is used to manage variable lists exposed by the API. The intentions of these lists is to expose a set of variables for other services. The variables can be readable or writable or both.

Published variables

Each published variable is exposed as an item in an array of items in the API. See section about published variables in the API Variable Attributes

Name	Description	Default
`Name`	The technical name of the variable. Must be unique whithin the variable file context.	Mandatory
`Title`	The user friendly name of the variable.	`Name` value
`Description`	Helper text for integrator or 3^rd party	None
`Unit`	The unit for the variable	None
`Variable`	The bound controller variable, or a scalar value	None
`Writable`	If Yes, the variable is possible to write	No
`Read Access`	Lowest access for read	Guest
`Write Access`	Lowest access for write	Operator
`Comment`	Helper text for integrator, or internal text. Not exposed by the API	None

Example for API

In EXODesigner, create a folder called PvlFolder.
Navigate to the folder, and open Folder Tool.
Use the template and create a Published Variable List File with the name List1.
Navigate to the list and, in the Published Variables File attribute, select Create a new file in this user area...
Open the new file by rightclick on the attribute, or select Edit the file...
Create a new variable and name it Analogin1.
In the Value attribute, select an input from a connected controller.
Save and close the files.
Open up the Arrigo frontend and navigate to the PvlFolder.
Copy the folder id from the url (between the slashes in the url after the #: http://localhost/arrigo/#/[folderId]/[linkIconId]/
Open up the API endpoint playground on localhost
Log in with your credentials.

Enter following query in left panel (replace [folderId] with the copied string in earlier steps) and press play button.

graphQL

query {
    folder(id:"[folderID]"){
        ...on UserArea{
            publishedVariableLists{
                name
                variables
            }
        }
    }
}

View output in right panel. The only entry should be the List1 variable list. The result of the variables is present in the variables array.

Tip

Read more about the API and how to use it in the API docs.