This document contains a list of all the business process logic (BPL) that is available and accesible for scripting. Please see the appliance archiver details for a high level description and a small example. All the BPL is typically accessible thru the following process
  1. Construct a URL (pointing to the mgmt web app) using the list below. For most BPL, you can point to any appliance in the cluster.
  2. Use a HTTP client to get the contents of this URL. For example, in python you can use httplib or urllib2
  3. The contents of the response are typically JSON and can be parsed using a standard JSON parser. For example, in python you can use the standard json package.

/getAllPVs

- Get all the PVs in the cluster. Note this call can return millions of PVs

For more details, please see the javadoc
pv
An optional argument that can contain a GLOB wildcard. We will return PVs that match this GLOB. For example, if pv=KLYS*, the server will return all PVs that start with the string KLYS. If both pv and regex are unspecified, we match against all PVs.
regex
An optional argument that can contain a Java regex wildcard. We will return PVs that match this regex. For example, if pv=KLYS*, the server will return all PVs that start with the string KLYS.
limit
An optional argument that specifies the number of matched PV's that are retured. If unspecified, we return 500 PV names. To get all the PV names, (potentially in the millions), set limit to –1.

/getAllExpandedPVNames

- Get all expanded PV names in the cluster. This is targeted at automation and should return the PV's being archived, the fields, .VAL's, aliases and PV's in the archive workflow. Note this call can return 10's of millions of names.

For more details, please see the javadoc

/getPVStatus

- Get the status of a PV.

For more details, please see the javadoc
pv
The name(s) of the pv for which status is to be determined. If a pv is not being archived, you should get back a simple JSON object with a status string of "Not being archived." You can also pass in GLOB wildcards here and multiple PVs as a comma separated list. If you have more PVs that can fit in a GET, send the pv's as a CSV pv=pv1,pv2,pv3 as the body of a POST.

/getPVTypeInfo

- Get the type info for a given PV. In the archiver appliance terminology, the PVTypeInfo contains the various archiving parameters for a PV.

For more details, please see the javadoc
pv
The name of the pv.

/archivePV

- Archive one or more PV's.

For more details, please see the javadoc
pv
The name of the pv to be archived. If archiving more than one PV, use a comma separated list. You can also send the PV list as part of the POST body using standard techniques. If you need to specify different archiving parameters for each PV, send the data as a JSON array (remember to send the content type correctly).
samplingperiod
The sampling period to be used. Optional, default value is 1.0 seconds.
samplingmethod
The sampling method to be used. For now, this is one of SCAN or MONITOR. Optional, default value is MONITOR.
controllingPV
The controlling PV for coditional archiving. Optional; if unspecified, we do not use conditional archiving.
policy
Override the policy execution process and use this policy instead. Optional; if unspecified, we go thru the normal policy execution process.
appliance
Optional; you can specify an appliance in a cluster. If specified (value is the identity of the appliance), the sampling and archiving are done on the specified appliance.

/pauseArchivingPV

- Pause archiving the specified PV. This also tears down the CA channel for this PV.

For more details, please see the javadoc
pv
The name of the pv. You can also pass in GLOB wildcards here and multiple PVs as a comma separated list. If you have more PVs that can fit in a GET, send the pv's as a CSV pv=pv1,pv2,pv3 as the body of a POST.

/resumeArchivingPV

- Resume archiving the specified PV.

For more details, please see the javadoc
pv
The name of the pv. You can also pass in GLOB wildcards here and multiple PVs as a comma separated list. If you have more PVs that can fit in a GET, send the pv's as a CSV pv=pv1,pv2,pv3 as the body of a POST.

/getStoresForPV

- Gets the names of the data stores for this PV. Every store in a PV's typeinfo is expected to have a name - this is typically "name=STS" or something similar. This call returns the names of all the stores for a PV.

For more details, please see the javadoc
pv
The name of the pv.

/consolidateDataForPV

- Consolidate the data for this PV until the specified store. The PV needs to be paused first.

For more details, please see the javadoc
pv
The name of the pv.
storage
The name of the store until which we'll consolidate data. This is typically a string like STS or MTS. To get a list of names of stores for a PV, please see /getStoresForPV

/deletePV

- Stop archiving the specified PV. The PV needs to be paused first.

For more details, please see the javadoc
pv
The name of the pv.
deleteData
Should we delete the data that has already been recorded. Optional, by default, we do not delete the data for this PV. Can be true or false.

/abortArchivingPV

- Abort any pending requests for archiving this PV.

For more details, please see the javadoc
pv
The name of the PV.

/changeArchivalParameters

- Change the archival parameters for a PV.

For more details, please see the javadoc
pv
The name of the pv.
samplingperiod
The new sampling period in seconds.
samplingmethod
The new sampling method For now, this is one of SCAN or MONITOR.

/getPVDetails

- Get a lot of detailed statistics for a PV. The returned JSON is very UI friendly; but should be usable in a scripting environment.

For more details, please see the javadoc
pv
The name of the pv.

/getApplianceInfo

- Get the appliance information for the specified appliance.

For more details, please see the javadoc
id
The identity of the appliance for which we are requesting information. This is the same string as the identity element in the appliances.xml that identifies this appliance.

/getAppliancesInCluster

- Get the appliance information for all the appliances in the cluster that are active.

For more details, please see the javadoc

/renamePV

- Rename this pv to a new name. The PV needs to be paused first.

For more details, please see the javadoc
pv
The current name of the PV.
newname
The new name of the PV.

/reshardPV

- This BPL reassigns the PV to another appliance. This is a complex BPL that also moves data over to the other appliance. For more details on the sequence of steps, see the Javadoc for the BPL.

For more details, please see the javadoc
pv
The name of the pv. The PV needs to be paused first and will remain in a paused state after the resharding is complete.
appliance
The new appliance to assign the PV to. This is the same string as the identity element in the appliances.xml that identifies this appliance.
storage
The name of the store until which we'll consolidate data before resharding. The data is moved over to the store with the same name on the new appliance. This is typically a string like LTS.

/addAlias

- Add an alias for the specified PV.

For more details, please see the javadoc
pv
The real name of the pv.
aliasname
The alias name of the pv. Note, we cannot have a PVTypeInfo mapped to the alias name.

/removeAlias

- Remove an alias for the specified PV. This is only supported for PVs who have completed their archive PV workflow.

For more details, please see the javadoc
pv
The real name of the pv.
aliasname
The alias name of the pv.

/skipAliasCheck

- For PVs that are still in the archive PV workflow, skip the alias check where we examine the .NAME field to determine the real name. This is useful if you have pCAS servers that overload the .NAME field for something else.

For more details, please see the javadoc
pv
The name of the pv as it is in the archive PV workflow.

/changeTypeForPV

- Change the type of the PV to the specified type. The PV needs to be paused first. For best results, consolidate all the data to one store. Note, this is actually changing the data so you should make a backup just in case. There is every chance that this may leave the data for this PV in an inconsistent state. It is also possible that the plugin may do nothing in which case you may have to rename the existing PV to a new PV; delete this PV and issue a fresh archival request.

For more details, please see the javadoc
pv
The name of the pv.
newtype
The new type one of the ArchDBRTypes. For example, DBR_SCALAR_DOUBLE.

/getVersions

- Get the versions of the various components for this appliance.

For more details, please see the javadoc
id
The identity of the appliance for which we are requesting information. This is the same string as the identity element in the appliances.xml that identifies this appliance.

/modifyMetaFields

- Modify the fields (HIHI, LOLO etc) being archived as part of the PV. PV needs to be paused first.

For more details, please see the javadoc
pv
The real name of the pv.
command
A command is a verb followed by a list of fields, all of them comma separated. Possible verbs are add, remove and clear. For example add,ADEL,MDEL will add the fields ADEL and MDEL if they are not already present. clear clears all the fields. You can have any number of commands.

/getNamedFlag

- Get the value of the named flag specified by name

For more details, please see the javadoc
name
the name of the named flag.

/setNamedFlag

- Set the value of the named flag specified by name

For more details, please see the javadoc
name
the name of the named flag.
value
Either true of false; something that Boolean.parse can understand.

/getNeverConnectedPVs

- Get a list of PVs that have never connected.

For more details, please see the javadoc

/getMetaGets

- Get a list of PVs that are currently in METAINFO_REQUESTED state.

For more details, please see the javadoc

/getCurrentlyDisconnectedPVs

- Get a list of PVs that are currently disconnected.

For more details, please see the javadoc

/getEventRateReport

- Return a list of PVs sorted by descending event rate.

For more details, please see the javadoc
limit
Limit this report to this many PVs per appliance in the cluster. Optional, if unspecified, there are no limits enforced.

/getStorageRateReport

- Return a list of PVs sorted by descending storage rate.

For more details, please see the javadoc
limit
Limit this report to this many PVs per appliance in the cluster. Optional, if unspecified, there are no limits enforced.

/getRecentlyAddedPVs

- Return a list of PVs sorted by descending PVTypeInfo creation timestamp.

For more details, please see the javadoc
limit
Limit this report to this many PVs per appliance in the cluster. Optional, if unspecified, there are no limits enforced.

/getRecentlyModifiedPVs

- Return a list of PVs sorted by descending PVTypeInfo modification timestamp.

For more details, please see the javadoc
limit
Limit this report to this many PVs per appliance in the cluster. Optional, if unspecified, there are no limits enforced.

/getLostConnectionsReport

- Return a list of PVs sorted by number of times we've lost/reestablished connections (descending) to the IOC hosting the PV. Can be used to determine if the IOC is being overloaded.

For more details, please see the javadoc
limit
Limit this report to this many PVs per appliance in the cluster. Optional, if unspecified, there are no limits enforced.

/getSilentPVsReport

- Return a list of PVs sorted by the timestamp of the last event received (descending).

For more details, please see the javadoc
limit
Limit this report to this many PVs per appliance in the cluster. Optional, if unspecified, there are no limits enforced.

/getPVsByDroppedEventsTimestamp

- Return a list of PVs sorted by number of times we've lost events because of incorrect timestamps.

For more details, please see the javadoc
limit
Limit this report to this many PVs per appliance in the cluster. Optional, if unspecified, there are no limits enforced.

/getPVsByDroppedEventsBuffer

- Return a list of PVs sorted by number of times we've lost events because of buffer overflows; perhaps from a mismatch between the event rate and the sampling rate (as determined from the sampling period).

For more details, please see the javadoc
limit
Limit this report to this many PVs per appliance in the cluster. Optional, if unspecified, there are no limits enforced.

/getPVsByDroppedEventsTypeChange

- Return a list of PVs sorted by number of times we've lost events because of changes in type of the underlying PV. This does not include PVs that have been paused.

For more details, please see the javadoc
limit
Limit this report to this many PVs per appliance in the cluster. Optional, if unspecified, there are no limits enforced.

/getPausedPVsReport

- Return a list of PVs that are currently paused.

For more details, please see the javadoc
limit
Limit this report to this many PVs per appliance in the cluster. Optional, if unspecified, there are no limits enforced.

/getArchivedWaveforms

- Get a list of waveform PVs that are currently being archived.

For more details, please see the javadoc

/getTimeSpanReport

- Archiving time span; when we first added the PV to the system, last known timestamp (if available), paused or not.

For more details, please see the javadoc

/getMatchingPVsForThisAppliance

- Get matching PV's for this appliance. Specify one of pv or regex. If both are specified, we only apply the pv wildcard. If neither is specified, we return an empty list.

For more details, please see the javadoc
pv
An optional argument that can contain a GLOB wildcard. We will return PVs that match this GLOB. For example, if pv=KLYS*, the server will return all PVs that start with the string KLYS.
regex
An optional argument that can contain a Java regex wildcard. We will return PVs that match this regex. For example, if pv=KLYS.*, the server will return all PVs that start with the string KLYS.
limit
An optional argument that specifies the number of matched PV's that are returned. If unspecified, we return 500 PV names. To get all the PV names, (potentially in the millions), set limit to 1.

/putPVTypeInfo

- Updates the typeinfo for the specified PV. Note this merely updates the typeInfo. It does not have any logic to react to changes in the typeinfo. That is, don't assume that the PV is automatically paused just because you changed the isPaused to true. This is meant to be used in conjuction with other BPL to implement site-specific BPL in external code (for example, python). This can also be used to add PVTypeInfo's into the system; support for this is experimental. The new PVTypeInfo's are automatically paused before adding into the system. Logically, you have to specify at least one of override or createnew.

For more details, please see the javadoc
pv
The name of the pv.
override
If the PVTypeInfo for this PV already exists, do you want to update it or return an error? By default, this is false.
createnew
If the PVTypeInfo for this PV does not exist, do you want to create a new one or return an error? By default, this is false.

/unarchivedPVs

- Given a list of PVs, determine those that are not being archived/have pending requests/have aliases.

For more details, please see the javadoc
pv
A list of pv names. Send as a CSV using a POST or JSON array.

/archivedPVs

- Given a list of PVs, determine those that are being archived.

For more details, please see the javadoc
pv
A list of pv names. Send as a CSV using a POST.

/archivedPVsNotInList

- Given a list of PVs, determine those that are being archived but are not in the incoming list.

For more details, please see the javadoc
pv
A list of pv names. Send as a CSV using a POST, or as a JSON.