Skip to content

TSTool / Command / SetPropertyFromDataStore

Overview

The SetPropertyFromDataStore command sets the value of a property used by the command processor by copying a property from datastore configuration. Typical uses of the command are:

  1. Set a web service API key as a property so that it can be used with the WebGet or other commands in web service requests. This ensures that the key is not hard-coded in command files.

Currently, properties are always of type string.

Command Editor

The command is available in the following TSTool menu:

  • Commands / Datastore Processing

The following dialog is used to edit the command and illustrates the command syntax for general parameters.

SetPropertyFromDataStore command editor

SetPropertyFromDataStore Command Editor (see full-size image)

Command Syntax

The command syntax is as follows:

SetPropertyFromObject(Parameter="Value",...)

Command Parameters

Parameter                           Description Default          
DataStore
required		 Datastore from which to copy the property. None - must be specified.
DataStoreProperty
required		 The datastore property name. None - must be specified.
PropertyName
required		 The name of the property to set. None - must be specified.
AllowNull Whether the property value is allowed to have a null value (True) or or not (False). False

Examples

See the automated tests.

Troubleshooting

See the main TSTool Troubleshooting documentation.

See Also