Guided Work Repositories

The repositories are listed below. Under each repository is a list of available properties.

ApplicationConfig

ApplicationSchemeChoice

Determines licensing, template storage/retrieval, and logging methods.

Value

  • VoiceConsoleBased
  • MicroserviceBased
  • VoiceConsoleSaaSBased

Notes

  • VoiceConsoleBased: The device connects to a VoiceConsole on Prem deployment for licensing, templates are retrieved from and saved to VoiceConsole On Prem and logs are stored on the file system as well as sent to VoiceConsole On Prem when logging is enabled. Also see VoiceConsoleConfig properties.
  • MicroserviceBased: The device connects to Enterprise Voice for licensing, templates are retrieved and saved using Enterprise Voice and logs are stored on the file system. Also see SentienceIAMConfig properties.
  • VoiceConsoleSaaSBased: The device connects to VoiceConsole Cloud SaaS Deployment (version 6.1 or later) for licensing, templates are retrieved from and saved to the VoiceConsole SaaS deployment and logs are stored on the file system as well as sent to the VoiceConsole SaaS deployment when logging is enabled. Also see Also see VoiceConsoleCloudConfig properties.

AutomaticReleaseLeaseOnHomeScreenChoice

When true, allows the app to automatically release the lease and retrieve a new one when the ready button is pressed on the home screen.

Value

  • True
  • False

Notes

Only available to be set when ApplicationSchemeChoice has a value of VoiceConsoleBased or MicroserviceBased

ApplicationPreferences

PauseOnMicRaise

When true, the application enters standby when a user raises the headset microphone arm.

Value

  • True
  • False

PromptCaptioning

When true, the application transcribes prompts spoken by the app onto the screen.

Value

  • True
  • False

AllowScreenshots

Value

  • True
  • False

AsrEngineConfig

PickUpAndGo

When false, the speaker dependent BlueStreak recognizer is used for speech recognition. When true, the speak independent Pick Up & Go (PnG) recognizer is used for speech recognition.

Value

  • True
  • False

Notes

Pick Up & Go does not require voice training; however, recognition accuracy may be affected.

PreferSRCOMM

When set to true SRCOMM is enabled (if available) for communication between the drive and headset. When set to false, SRCOMM is not used. The default is false. SRCOMM can only be enabled when Pick Up & Go is disabled (see parameter above).

SRCOMM is Honeywell's application level protocol between a device and a Honeywell wireless headset.

Value

  • True
  • False

BTScannerConfig

Use the Scanner Configuration properties to configure the Bluetooth scanner.

ScannerConfig

Use the Scanner Configuration properties to configure the internal scanner.

SentienceIAMConfig

Used when ApplicationConfig.ApplicationSchemeChoice is MicroserviceBased.

Host

Host URL

Value

Can be set to the domain name or IP address of the host server.

Notes

Do not include protocol (e.g., http://, https://).

Port

Server Port number

Value

Defaults to 80 for http and 443 for https

Notes

This is optional

User

Value

Users username

Password

Value

User's password

Realm

Value

Additional property required by microservices.

Customer

Value

Customer name

SerialNumberConfig

AccurateSerialNumberEnabled

Select between using the accurate serial number or a secure unique identifier string.

Value

  • True (use device serial number)

  • False (use legacy unique identifier string)

ServerConfig

Use when ApplicationConfig.ApplicationSchemeChoice is ServerBased.

SecureConnections

Enables or disables SSL for the connection.

Value

  • True
  • False

Host

Host URL

Value

Can be set to the domain name or IP address of the host server.

Notes

Do not include protocol (e.g., http://, https://).

Port

Server Port number

Value

Defaults to 80 for http and 443 for https

Notes

This is optional

WorkerID

Value

Worker ID

WorkerName

Value

Worker name

SiteID

Value

Site ID

ApplicationName

Value

Application name

CustomerName

Value

Customer name

SiteName

Value

Site name

CurrentWorkflowName

Value

Current workflow name

PublicKeyPinning

Value

  • True
  • False

WebRequestTimeout

Set the allowed timeout in seconds between the execution of a server request and the server's response to the device

Value

Timeout in seconds. The default is 30.

SettingsLockdown

See Settings Lockdown.

VoiceAndAudioConfig

TtsSpeedSetting

Text to speech speed setting defines how quickly words are spoken to the user.

Values

Dependent on OS. Android values are 1-10.

SuppressRecognition

When true this disables speech recognition. When false it is enabled.

Values

  • True
  • False

ReportProblemOverflowVoiceEnabled

When true Report Problem is available from the voice overflow menu. When false it is not available.

Values

  • True
  • False

NoisesSampleOverflowVoiceEnabled

When true Noise Sample is available from the voice overflow menu. When false it is not available.

Values

  • True
  • False

AdjustTtsSpeedOverflowVoiceEnabled

When true Faster and Slower are available from the voice overflow menu. When false they are not available.

Values

  • True
  • False

VoiceConsoleCloudConfig

Used when ApplicationConfig.ApplicationSchemeChoice is VoiceConsoleSaaSBased.

Enabled

Must be set to true if using VoiceConsole SaaS deployment.

Values

  • True
  • False

Host

Host URL

This value is provided by Honeywell upon registration for VoiceConsole SaaS deployment.

Values

Set to the domain name or IP address of the VoiceConsole SaaS deplyment.

Notes

Do not include protocol (e.g., http://, https://).

Port

Server port number

Values

Defaults to 443 for https.

Notes

Optional.

User

Set to the User ID provided by Honeywell upon registration for VoiceConsole SaaS deployment.

Value

User ID

Password

Set to the password for VoiceConsole Saas deplyment.

Value

Password

TenantID

Set to the Tenant ID provided by Honeywell upon registration for VoiceConsole SaaS deployment.

Value

Tenant ID

Customer

Set to the Customer name provided by Honeywell upon registration for VoiceConsole SaaS deployment.

Value

Customer Name

VoiceConsoleCloudPeriodicPollingInterval

Set the interval for the device to call VoiceConsole to check for pending action items.

Value

The interval in seconds. The minimum is 60, the maximum is 120. The default is 120.

VoiceConsoleConfig

Used when ApplicationConfig.ApplicationSchemeChoice is VoiceConsoleBased.

Enabled

Must be set to true if using VoiceConsole.

Values

  • True
  • False

SecureConnections

Enables or disables SSL for the VoiceConsole connection.

Values

  • True
  • False

Host

Host URL

Values

Set to the domain name or IP address of the VoiceConsole server.

Notes

Do not include protocol (e.g., http://, https://).

Port

Server port number

Values

Defaults to 80 for http and 443 for https.

Notes

Optional.

SiteID

Set to the Site number seen in the VoiceConsole URL, from the View Site screen for the intended site.

Value

Site ID