VBOs overview

The tables below provide an overview of the Visual Business Objects (VBOs) used in Service Assist.

TrustPortal VBOs

These are listed under Objects > TrustPortal in Blue Prism Studio.

VBO Description

Examples – TrustPortal – Destination Parameters

Includes actions for retrieving the TrustPortal queues and destination users from a credential, and validating the received destination users.

Examples – TrustPortal – Shared Functions

Includes actions which are shared functions that can be used in the examples, for example, Submit Tiles and Submit Form for Static Button Tile.

Form Fields – Form Containers

Includes actions for creating containers for controls, for example, Accordions, Field Table, Fieldset, and Tabs.

Form Fields – Form Controls

Includes actions for creating form controls, for example, Attachment, Button, Dropdown, Section, Slider, and Text Field.

Forms – Actions

Includes actions for TpActions, for example, Create Action Payload, Get Action by Id, and Send Action.

Forms – Messages

Includes actions for creating TpMessages, for example, Create Message Payload, Get Message by Id, and Send Message.

Schemas – Access Tokens

Includes actions for creating access tokens, for example, Create Access Token Payload, Get Access Token, and Send Access Token.

Schemas – Actions Includes actions for TpActions, for example, Create Action Payload, Get Action by Id, and Send Action.
Schemas – Action Details

Includes actions for TpActionsDetails for example, Create ActionsDetails Payload, Get ActionDetails by Id, and Send Action.

Schemas – Forms

Includes actions for creatingTpForms, for example, Create Form Payload, Get Form by Id, and Send Form.

Schemas – Files

Includes actions for creating TpFiles, for example, Create File Payload, Get File by Id, and Send File.

Schemas – Menu Items Includes actions for TpMenuItems, for example, Create MenuItem Payload, Get MenuItem by Id, and Send MenuItem.
Schemas – Messages Includes actions for creating TpMessages, for example, Create Message Payload, Get Message by Id, and Send Message.
Schemas – Pages

Includes actions for creating TpPages, for example, Create Page Payload, Get Page by Id, and Send Page.

Schemas – Queue Items

Includes actions for creating TpQueueItems, for example, Create QueueItem Payload, Get QueueItem by Id, and Send QueueItem.

Schemas – Queues

Includes actions for creating TpQueues, for example, Create Queue Item, Get Queues, and Send Queues.

Schemas – Tags

Includes actions for creating TpTags, for example, Create Tag Payload, Get Tags, and Send Tag.

Schemas – Themes

Includes actions for creating TpThemes, for example, and Get Themes.

Schemas – Tiles

Includes actions for creating TpTiles, for example, Create Tile Payload, Get Tile by Id, and Send Tile.

Utility – TrustPortal – BP Queues Wrapper

Wrapper for the Work Queues Internal Business Object in Blue Prism.

Utility – TrustPortal – Collection Manipulation

Includes utility functions for manipulating collections that expands on Blue Prism's Utility - Collection Manipulation VBO, for example, Filter Collection.

Utility – TrustPortal – Environment

Includes utility functions to check components in a TrustPortal environment, for example, Get TrustPortal Environment Status and Get Schema Objects by Conditions.

Utility – TrustPortal – Form Control Functions

Includes utility functions for form controls, for example, Convert Options Collection to Options JSON.

Utility – TrustPortal – JSON and Utility – TrustPortal – JSON Manipulation

Include actions which enable users to manipulate JSON, expanding on Blue Prism's Utility - JSON Manipulation VBO, for example, Query JSON and Add Property to JSON.

Users

Includes actions used to manage users in the TrustPortal database,  for example, create and delete users, get users' profile information, reset and update passwords, get password policy, validate password against a given policy, and replace or remove users' roles.

Blue Prism VBOs

These are listed under Objects > Default in Blue Prism Studio.

VBO Description

Utility – Collection Manipulation

Includes functions for manipulating collections.

Utility – JSON

Used as an object for parsing JSON into a collection and turning a collection into JSON.

Utility – HTTP

Used to communicate with web services using the HTTP protocol.

Utility – Environment

Used to interact with the environment, for example, to read the screen resolution or determine the operating system used.

Utility – File Management

Used to interact with the file system, for example, add or delete files and folders, add or delete directories.

Backwards compatibility VBOs

The following VBOs are only used for backwards comparability with previous versions of Service Assist.

VBO

Description

AccessTokens

Includes actions for Direct URL functionality, for example, Delete, Generate, GetAll (access tokens) and Navigate (to a given URL in a user's default browser). Access tokens are used to associate Direct URLs with a particular form.

Attachments

Includes actions used to interact with files linked to attachments in TrustPortal, for example, getting files attached to a submitted form, attaching files to a form, base64 encoding/decoding of files, and creating unique file names.

Interactive Forms

Includes actions for creating form objects, for example, process tiles, text fields, and buttons, check boxes, dropdowns, accordions, or tabs.

QueueItems

Includes actions for interacting with TrustPortal queue items from the TrustPortal database, for example, GetQueueItemByID, GetMetadataByID, and UpdateStatus for a given queue item's ID.

Themes

Includes actions for creating TpThemes, for example, Get Themes.

TrustPortalEvents

Includes actions for Blue Prism interactions with the TrustPortal agent such as creating, updating, and deleting TrustPortal objects (for example, tiles, forms, actions, or messages), polling for queue items, sending replies back to the TrustPortal agent and getting the agent status.

VBO documentation

The VBO documentation is available from the main help menu and from the help menu in Process and Object Studio. Select API Documentation and choose the required VBO from the Visual Business Objects drop-down list to display the associated help page.

Alternatively, you can click the Information icon in an Action Properties window of a VBO which will open the documentation for that specific VBO.