Manage Data Worksheets

This feature is available only in Enterprise Edition.

Manage Data Worksheets in script by using the :worksheet or equivalent :ws command. See Prepare Your Data for information about Data Worksheets in the User Portal.

Optional parameters should be provided in a key-value pair with a preceding double-hyphen (--). For example: --organizationid organization0.

List Available Data Worksheets

The list action lists the available Data Worksheets. Note: You must first connect to a repository. See Connect to a Repository.

Parameters

organizationid: Organization ID for multi-tenant environment. (See Enable Multi-Tenancy.) (optional)

Examples

// List all Data Worksheets in environment
:ws list

// List all Data Worksheets in organization0
:ws list --organizationid organization0

Get Data Worksheet Parameters

The parameters action returns the parameters defined in the Data Worksheet. Note: You must first connect to a repository. See Connect to a Repository.

Parameters

id: Data Worksheet ID

Examples

// Get a parameters for Call Center Monitoring Data Worksheet
:ws parameters '1^2^__NULL__^Examples/Call Center Monitoring'

Get Data Worksheet Metadata

The metadata action returns the Data Worksheet metadata. Note: You must first connect to a repository. See Connect to a Repository.

Parameters

id: Data Worksheet ID

Examples

// Get a metadata for Hurricane Data Worksheet
:ws metadata 1^2^__NULL__^Examples/Hurricane

List open Data Worksheets

The list-open action returns a list of currently open Data Worksheets. Note: You must first connect to a repository. See Connect to a Repository.

Parameters

organizationid: Organization ID for multi-tenant environment. (See Enable Multi-Tenancy.) (optional)

Examples

// List all open Data Worksheets
:ws list-open

Open Data Worksheet

The open action opens a Data Worksheet for editing in Visual Composer. Note: You must first connect to a repository. See Connect to a Repository.

Parameters

id: Data Worksheet ID
parameters: Parameter values to pass to Data Worksheet (optional)

Examples

// Open Call Center Monitoring for editing, and pass 2035 as parameter
:ws open '1^2^__NULL__^Examples/Call Center Monitoring^host-org' 2035

Get Data Worksheet

The get action obtains a handle to a Data Worksheet. Note: You must first connect to a repository. See Connect to a Repository.

Parameters

id: Runtime Data Worksheet ID

Examples

// Get handle to Data Worksheet 2
:ws get 2

Close Data Worksheet

The close action closes an open Data Worksheet. Note: You must first connect to a repository. See Connect to a Repository.

Parameters

id: Runtime Data Worksheet ID

Examples

// Close Data Worksheet 2
:ws close 2

Return Data Worksheet Data

The data action obtains data from the primary data block of a Data Worksheet. See Data Block Properties for more information about the primary data block. Note: You must first connect to a repository. See Connect to a Repository.

Parameters

id: Runtime Data Worksheet ID
from: Start row for data retrieval
rows: Number of rows to retrieve

Examples

// get data from Data Worksheet 2, starting with row 3 and continuing for four rows
:ws data 2 3 4