VB Scripts Configuration - System Administration - Cloud - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Premier - Essential

Cloud System Administration

Platform
OnBase
Product
System Administration - Cloud
Release
Foundation 23.1
License
Standard
Premier
Essential

VB Scripts provide the ability to manipulate documents and their associated Keyword Values when functionality outside the provided user interface is required.

Note:

VB Scripts are not supported on the Data Capture Server. For more information, see the Data Capture Server Deployment Guide.

VB Scripts are capable of the following:

  • Invoke fragments of BASIC code to perform user-customized operations on selected documents.

  • Execute customized processing within OnBase.

  • Interact with other programs that are integrated with OnBase.

Note:

If a VB Script makes certain API calls, the appropriate privileges may be required for the API calls to function. For more information, contact your first line of support.

VB Scripts are configured from the Queries menu option in the Configuration module. They are executed from the OnBase Client by using the Run Script... right-click option from an open document or from the document retrieval hit list, by clicking a configured VB Script toolbar button or shortcut key, or through Workflow actions.

To configure a VB Script, select VB Scripts from the Queries menu in the Configuration module. The VB Scripts dialog box is displayed:

The following options are available from the VB Scripts dialog:

Option

Description

Settings

Select this option to open the VB Script Settings dialog box. This dialog contains the following options:

Retain VB Script History- select this option to enable VB Script History for the selected script. For more information, see History.

Retain Wildcard Symbols in “_filter_” Search String- select this option to automatically replace asterisk characters ( * ) with percentage characters (%) in your VB Script. This may make it easier to create your VB Script.

Edit Script

Make changes to the selected script. See Editing a VB Script.

User Group

Modify the user groups able to run the selected script.

Visible Scope

Limit the selected script to be available only in certain situations or menus. See Visible Scope.

History

If the Retain VB Script History option is enabled for the selected script, use this option to rollback to previous versions of the script. See History.

Create

Create a new VB Script. See Create a New VB Script.