24
VoiceArtisan 2.1 Release Notes

VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

  • Upload
    others

  • View
    5

  • Download
    0

Embed Size (px)

Citation preview

Page 1: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

VoiceArtisan 2.1 Release Notes

Page 2: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

ContentsVoiceArtisan 2.1 Release Notes 1

Contents 2

Copyright 3

New Features in VoiceArtisan 2.1 3

Signed jar Files 3

System Requirements for the VoiceArtisan Bundle 4

Operating Systems 4

Hardware 4

Software 4

Installing the VoiceArtisan Plugin Independently 5

Installing the VoiceArtisan Plugin 5

General Considerations and Limitations 7

General VoiceArtisan IDE Limitations 7

Security Considerations 9

Known Python Vulnerabilities 9

Known VoiceArtisan IDE Vulnerabilities 14

Previous Release Notes 15

New Features in VoiceArtisan 2.0 15

New Features in VoiceArtisan 1.3.2 15

Vocollect VoiceArtisan® Release Notes: Features in 1.3.1 17

Vocollect VoiceArtisan® Release Notes: Features in 1.3.0 17

Fixes and Enhancements in 1.3.0 18

Features in 1.2.0 19

Features in 1.1.0 21

Features in 1.0.1 23

Page 3: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Copyright©Copyright 2019 Honeywell International Inc. All rights reserved. Honeywell and its productnames are among the trademarks and/or service marks owned by Honeywell International, Inc., orits subsidiaries.

Vocollect Voice Solutions703 Rodi RoadPittsburgh, PA 15235+1 412 829-8145fax +1 412 829-0972http://www.honeywellaidc.com

Honeywell International Inc. (“HII”) reserves the right to make changes in specifications and otherinformation contained in this document without prior notice, and the reader should in all casesconsult HII to determine whether any such changes have been made.

The information in this publication does not represent a commitment on the part of HII. HII shallnot be liable for technical or editorial errors or omissions contained herein; nor for incidental orconsequential damages resulting from the furnishing, performance, or use of this material.

This document contains proprietary information that is protected by copyright. All rights arereserved.

No part of this document may be photocopied, reproduced, or translated into another languagewithout the prior written consent of HII.

New Features in VoiceArtisan 2.1Signed jar FilesFor this release, all new plugins added to the update site are provided as signed jar files.

Note: To use version 2.1 of VoiceArtisan, you will need a new 2.1 license.

Page 4: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

System Requirements for the VoiceArtisan BundleOperating Systems

l Windows 7 Professional 64-bit

l Windows 10 Professional 64-bit

HardwareTo test a voice application on your computer, you will need a Vocollect wired headset.

We recommend you use a CMedia CM108 USB Virtual 7.1 Channel Sound Adapter for your head-set. This adapter has been tested by Honeywell and is recommended for testing applicationsthrough VoiceCatalyst Emulator.

Software

Eclipse version 4.7.3a

provided in zip file

PyDev 6.2.0

provided in zip file

Java version 8 or higher

not provided--you must supply

must be a 64-bit version to be compatible with Eclipse

Page 5: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Installing the VoiceArtisan Plugin IndependentlyThe bundle provided by Vocollect is the tested and supported version of VoiceArtisan. It is pos-sible to install the VoiceArtisan and library plugins to an alternate Eclipse environment providedminimum criteria are met. Support and troubleshooting for environments other than the bundledzip will be limited.

l Eclipse minimum version 4.7.3a

l Java version required by the specific Eclipse version chosen

l PyDev exact version 6.2.0

l This exact requirement is due to VoiceArtisan needing to tie into non-publicPyDev API calls which are not guaranteed to be consistent in future versions.

Installing the VoiceArtisan Plugin1. Unzip or install Eclipse, currently at https://www.eclipse.org/

2. Install the Java version required by Eclipse.

3. Add the PyDev 6.2.0 update site under Help > Install New Software > Add.

a. Currently listed at http://www.pydev.org/ as http://www.pydev.org/update_sites/6.2.0

b. If the update site is available, the VoiceArtisan plugin will automaticallyinstall PyDev during the VoiceArtisan installation.

c. If the update site is taken down in the future, you may need to obtain thePyDev 6.2.0 drop-in files. See eclipse.org for information on how to deploythe drop-in.

d. If neither the update site nor the drop-in is available in the future, use theofficial bundle containing the prerequisite PyDev 6.2.0.

4. Add the VoiceArtisan Update site under Help > Install New Software > Add. This is loc-ated at Vocollect Voice Updates - https://s3.amazonaws.com/update-site-2/.

5. Working with the Vocollect Voice Updates site, install the Vocollect VoiceArtisan plugin.

a. This is currently unsigned content, click Install anyway to proceed withinstallation.

b. Restart.

6. Import a valid license under Window > Preferences > VoiceArtisan > License.

7. Install any examples, libraries, Voice Applications, and VoiceCatalyst Emulators* fromthe Vocollect Voice Updates site

Note:

The current VoiceCatalyst Emulators, versions 1.0.0 through 2.3.1, which includeboth the Python environment and an executable to run a project as a VoiceCatalystApplication, are only available for Windows environments. This prevents the abilityto run anything that requires the voice API or mock_catalyst module (which itselfdepends on the voice API in order to override it) on other operating systems.

Page 6: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

It may be possible to run a MockCatalyst test file in the console, but not a project as a VoiceCata-lyst Application, on other Operating Systems by:

1. Installing a general Python 3.1.2 and/or Python 3.6.6 installation, currently athttps://www.python.org/

2. Configuring the Python installation for PyDev 6.2.0 in Eclipse under Window > Prefer-ences > PyDev > Interpreters > Python Interpreters > New.

3. From a Windows installation of VoiceCatalyst Emulator, copy:

l The stubbed contents of voice.py and its subpackages, under VCE > vce/Vo-collectVoice/Lib, when used by a VoiceArtisan VoiceApplication in the ProjectExplorer View.

l mock_catalyst.py from VCE > System Libs.

4. Create a new netadapters.py implementing a get_adapters function returning anempty dictionary.

This is a compiled extension created by Vocollect, used in the HTTP Library udp-broadcast.py.

Page 7: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

General Considerations and LimitationsGeneral VoiceArtisan IDE Limitations

Do Not Add Update Site to Earlier VoiceArtisan Instances

Do not add the new update site to an existing VoiceArtisan 1.x Eclipseenvironment. Dependency issues will result and you may be unable toinstall plugins from the old update site.

VoiceCatalyst on Device Not Supported with A700x

Running VoiceCatalyst on Device is not supported with the A700x.

Viewing Error MarkersA new setting in Eclipse for PyDev causes error markers to not show whenthe file containing the error is closed. To have the error markers appeareven when the file is closed:

1. From the Window menu, select Preferences.

2. Select PyDev.

3. Select Builders.

4. Deactivate the Remove errors when editor is closed check box.

Python Debugger Not Stopping at Break PointsOn occasion, the Python debugger will not stop at break points. If thisoccurs, right-click the project you are running and select Pydev... >Remove *.pyc, *.pyo and *$py.class files. This will ensure that during thenext run, .pyc files are recreated with the appropriate break points.

License Warning Does Not AppearIf your license is nearing expiration and you start Eclipse and a VoiceAr-tisan-specific view does not have focus, you will not receive a warningthat the license is about to expire. The message will only appear when youopen a VoiceArtisan view or VoiceArtisan preferences.

RBIRD-220

Cannot Edit File Added to ProjectIf you are using a source control system and have your voice applicationprojects under team management in Eclipse, if you add a file to the pro-ject, you cannot edit that file. To edit the file, you must either add it tosource control or change the file properties to remove the read onlystatus.

RBIRD-178

Prompt to Save When Switching Between Run ConfigurationsIf you open an existing run configuration and click on the Device Prop-erties or Project Properties tab without changing anything in those tabs,then click on a different run configuration, you will be prompted to savedue to unsaved changes. Dismiss the message dialog box by clicking oneof the buttons.

RBIRD-232

Install Microsoft Language Packs

Page 8: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Note that if you are using a TTS in an Asian, East Asian or any right-to-left language, you must install the appropriate Microsoft language packin order to properly view the characters.

Page 9: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Security ConsiderationsDevelopers should be aware of the following known security vulnerabilities in Python version 3.1.2distributed as part of the VoiceCatalyst Emulators 1.0.0 through 2.3.1 for VoiceArtisan.

Known Python Vulnerabilities

Issue Summary Discussion

VARTSEC-38

Component xmlsec-javaversion 1.4.0 was detec-ted in com.-vocollect.voiceartisan_2.1.0.201908230755.jarhas 1 vulnerability.

CVE: CVE-2013-6440

The (1) BasicParserPool, (2) Stat-icBasicParserPool, (3) XML Decrypter, and (4)SAML Decrypter in Shibboleth OpenSAML-Java before 2.6.1 set the expandEntityRe-ferences property to true, which allows remoteattackers to conduct XML external entity(XXE) attacks via a crafted XML DOCTYPEdeclaration.

VARTSEC-43

Simultaneous login ses-sion for single user isallowed in an applic-ation.

VARTSEC-39

It is observed that fileupload functionality inthe application is notvalidating for mal-ware/virus beinguploaded. It is recom-mended to perform vir-us/malware scan whena file is being uploadedor else the target sys-tem/environment couldget infected with mal-ware.

VARTSEC-40

It is observed thatapplication is not val-idating files in side thecompressed folder.Intruder can compressany type of file format(php, exe, jar...) andupload.

Upload functionality isalso not verifying the

It is recommended to verify the file size andtype of file within compressed folder.

Page 10: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Issue Summary Discussion

size of file before beinguploaded. The file spaceof the Web server couldbe exhausted by theattacker uploading ahuge file. Tested with2GB file.

VARTSEC-32

It has been observedthat MD5 hashingalgorithm is used in thelibraries. PFA POC

VARTSEC-36

Component opensaml-java version 1.1 wasdetected in com.-vocollect.voiceartisan_2.1.0.201908230755.jarhas 1 vulnerability.

CVE: CVE-2013-4517

Apache Santuario XML Security for Javabefore 1.5.6, when applying Transforms,allows remote attackers to cause a denial ofservice (memory consumption) via craftedDocument Type Definitions (DTDs), related tosignatures.

VARTSEC-42

It is observed that thereis no server-side val-idation implemented forverifying input to createrules. It is possible tobypass client-side val-idation using proxy andenter random charactersof no length restrictions.

Application is not val-idating the length andspecial characters of theinput.

VARTSEC-44It is observed thatSecure Flag is missingin the cookie

When a cookie is set with the Secure flag, itinstructs the browser that the cookie can onlybe accessed over secure SSL/TLS channels.

This is an important security protection forsession cookies.

VARTSEC-26

It has been observedthat VoiceArtisan lib-raries HTTP, LUT/ODRmakes use of ports

Page 11: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Issue Summary Discussion

80,9001,15008,15009 .When the voice applic-ation runs on the Talk-man device , it will openthe respective ports forcommunication. Com-munication over theseports is not on securechannel.

VARTSEC-25

It has been observedthat web url used to pullthe plugins from thecloud server is runningover HTTP. PFA. POC

VARTSEC-22

Validate URI inputs forinjected URLs orattempt to use the URLto directly affect assets.Error output should notcontain information use-ful to attackers.

An http parameter over {VoiceAr-tisan<=>WarehouseManagementSys:HTTP}

may contain a URL value and could cause the[VoiceArtisan] to redirect the request to thespecified URL. By modifying the URL value toa malicious site, an attacker may successfullylaunch a phishing scam and steal user cre-dentials. Because the server name in the mod-ified link is identical to the original site,phishing attempts have a more trustworthyappearance.

VARTSEC-9

Use strong passwordpolicy, secure channelsused in authentication.Pass-word/AuthenticationPolicy and Man-agement. Limit numberof sessions a single useris allowed.

Store Salted Hashed credential (PBKDF2,bcrypt) or encrypt private keys. If possible useLDAP like technologies for storage. Have anaccount per user and associated process.Assure that authentication channel is secure,i.e.: local connection, SSH, VPN, or TLS. Imple-ment a credential update policy i.e, changedefault PW, minimal length and mix of chars,change often, don’t save PW in the clear. Docu-ment the password management con-figuration for the (preferably automatic)installation and the recommended settings inthe Security Manual.

VARTSEC-21

Protect network con-nections from DoS; pre-vent resources frombeing consumed; a plan

Rate limit connections and data transfers to{VoiceAr-tisan<=>WarehouseManagementSys:HTTP}

Page 12: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Issue Summary Discussion

to recover from crashedsystems as quickly aspossible; system failuresfail safe.

(if possible). Prevent the users of the [VoiceAr-tisan] from exhausting storage space,memory, network ports, processes or otherresources. The Security Manual must specifybackup, recovery, etc. policies and planning.Any DOS failure, especially a 'hung' systemshould fail safe and not allow damage topeople or equipment.

VARTSEC-20

Protection of auditinformation, timestamps, non-repudiationin logs.

Log access to {VoiceArtisan}

and other requests to assets, especially failedattempts to access any asset. Assure suf-ficient storage, indicate when near full orwrapped, programmatic access and centrallymanage if possible

Issue #11662: Redir-ect vulnerability inurllib/ urllib2. Bugreport http://bug-s.python.org/issue11662

The urllib and urllib2modules in Python 2.xbefore 2.7.2 and 3.xbefore 3.2.1 processLocation headers thatspecify redirection tofile: URLs, which makesit easier for remoteattackers to obtain sens-itive information orcause a denial of service(resource consumption)via a crafted URL, asdemonstrated by thefile:///etc/passwd andfile:///dev/zero URLs.

l The bug could disclose sensitiveinformation in the following scen-ario: In your Python program, sup-pose you are using the urllibmodule to retrieve a web page froma remote server and display it tothe user of your program. Supposethat the remote server, instead ofreturning a web page to you, sendsa redirect 302 HTTP response, andit redirects you to a local file inyour environment. If that file con-tains sensitive information and youdisplay it, the user of your programcould see the sensitive information.

l Notice, however, that nobody at theremote site (potentially outside thetrust zone) can see the information,just the user of your program. ForVoiceCatalyst, that would be theuser of the mobile device with anattached display of some kind. ForVoiceArtisan, it would only be theapplication developer.

l In either case, the "attacker" or therecipient of the sensitive inform-ation would be an insider (eitherthe developer of the app or a

Page 13: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Issue Summary Discussion

mobile worker). Thus this is ahighly unlikely and low-risk scen-ario, in addition to the fact that ourdevice does not contain sensitiveinformation files.

Issue #13703: Hashcollision securityissue. Bug report:http://bug-s.python.org/issue13703

Python before 2.6.8,2.7.x before 2.7.3, 3.xbefore 3.1.5, and 3.2.xbefore

3.2.3 computes hash val-ues without restrictingthe ability to triggerhash collisions pre-dictably, which allowscontext- dependentattackers to cause adenial of service (CPUconsumption) via craf-ted input to an applic-ation that maintains ahash table.

l Hash collisions can be exploitedvia denial of service attacks in webframeworks that automaticallyparse input forms into dictionaries.

l As you can see in the discussion ofthe bug at the specified link, it isquite obscure and difficult toexploit.

l It is unlikely that an attacker wouldbother to attack a Talkman device,but it is easily preventable by run-ning devices on a security- enabledWi-Fi network so the built in webserver on the device is not access-ible outside of your security realm.

Issue #14579: Vul-nerability in the utf-16 decoder

after error handling.Bug report:http://bug-s.python.org/issue14579

The utf-16 decoder inPython 3.1 through 3.3does not update thealigned_end variableafter calling the uni-code_decode_call_errorhandler func-tion, which allowsremote attackers toobtain sensitive inform-ation (process memory)or cause a denial of ser-vice (memory corruptionand crash) via unspe-cified vectors.

The bug is easily avoidable by using utf-8encoding/ decoding in your application. It isthe encoding we recommend and you canencode any localized text using utf-8.

Issue #20246:

Buffer overflow insocket.recvfrom_into.Bug report:http://bug-s.python.org/

Buffer overflow in thesocket.recvfrom_into function in Mod-ules/ socketmodule.c inPython

2.5 before 2.7.7, 3.x

In order to be attacked by the bug, an applic-ation running on the mobile device wouldhave to be opening a raw listen socket andnot an HTTP port. None of our library orexample applications do this.

If you need to create such an application, if

Page 14: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Issue Summary Discussion

issue20246

before 3.3.4, and 3.4.xbefore 3.4rc1 allowsremote attackers toexecute arbitrary codevia a crafted string.

you run your devices in a secure Wi-Fi envir-onment, no clients outside the security zonewould be able to exploit the weakness.

Known VoiceArtisan IDE Vulnerabilities

Issue Summary Discussion

VARTSEC-38

Component xmlsec-java ver-sion 1.4.0 was detected incom.- vocollect.voiceartisan_2.1.0.201908230755.jar has 1vulnerability.

CVE: CVE-2013-6440

The (1) BasicParserPool, (2) Stat-icBasicParserPool, (3) XML Decrypter, and (4)SAML Decrypter in Shibboleth OpenSAML-Javabefore 2.6.1 set the expandEntityReferences prop-erty to true, which allows remote attackers to con-duct XML external entity (XXE) attacks via acrafted XML DOCTYPE declaration.

VARTSEC-36

Component opensaml-java ver-sion 1.1 was detected in com.-vocollect.voiceartisan_2.1.0.201908230755.jar has 1vulnerability.

CVE: CVE-2013-4517

Apache Santuario XML Security for Java before1.5.6, when applying Transforms, allows remoteattackers to cause a denial of service (memoryconsumption) via crafted Document Type Defin-itions (DTDs), related to signatures.

VARTSEC-20

Protection of audit information,time stamps, non-repudiationin logs Detail

Log access to {VoiceArtisan}

and other requests to assets,especially failed attempts toaccess any asset. Assure suf-ficient storage, indicate whennear full or wrapped, pro-grammatic access and cent-rally manage if possible.

Page 15: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Previous Release NotesNew Features in VoiceArtisan 2.0Data Collection Support

This release of VoiceArtisan includes support for data collection. This allows you to create tasksthat send data that you choose to Honeywell, where it can be used to generate reports andinsights.

Support for A700x Devices

This release of VoiceArtisan includes support for the latest Vocollect devices, the A700x series.

Note: To use version 2.0 of VoiceArtisan, you will need a new 2.0 license.

New Features in VoiceArtisan 1.3.2Response Expressions Enhancements

This release includes enhancements that update the response expressions:

l when the recognizer is still waiting for the operator response

l when the operator speaks through a phrase without pausing

l when the operator speaks part of a phrase and pauses before finishingUpdating response expressions during these times allows for the recognizer to better adapt to anoperators speech patterns and reduce insertions. See About Response Expressions for moreinformation.

You can now use wildcard characters in response expressions to be used for adaptation, therebyeliminating the need to specify every combination of words that can be spoken. Now a developercan use an asterisk (*) to match a single vocabulary item. Each asterisk must match exactly onerecognized one vocabulary item to be considered a match. For example, if the user can say anyalpha after a three digit check digit (for example, for a tote ID), the hint may be specified as"123*". Wildcards can be specified in any position in the utterance, and there is no limit on thenumber allowed.

Important: Because of this feature, you can no longer use an asterisk as a vocabulary item.

For more information, see Using Response Expressions in the online help.

Define Recognizer Sensitivity By Word

You now have the ability to adjust the sensitivity of specific vocabulary words by setting the para-meter BlueStreak_Decode_Sensitivity_<word>=<threshold>. This enhancement is recommended foruse to reduce insertions when operators speak infrequently used words, such as pass assignment,repick skips, and short product. However, it may also be used to increase the likelihood of accept-ance for some words.

Page 16: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

The default sensitivity threshold is 0. You can set this parameter to achieve the appropriate bal-ance in recognizer sensitivity for specific words based on your application workflow:

l Increasing the sensitivity reduces insertions by requiring the recognizer to be more con-fident of what the user spoke. This makes the recognizer more likely to accept the cor-rect word and ignore an incorrect word.

l Decreasing the sensitivity reduces repeating by enabling the recognizer to accept aword with less confidence thus reducing the likelihood the operator may need to repeatwords. Decreasing sensitivity, however, may increase insertions and is typically notrecommended.

Note: When set, this parameter overrides the previously released BlueStreak_Decode_Sens-itivity parameter, which sets a global threshold for sensitivity.

For example, to reduce insertions of the infrequently used vocabulary word "sign off," set the para-meter BlueStreak_Decode_Sensitivity_sign_off=2 to increase the sensitivity of "sign off." When anoperator speaks "sign off," the recognizer will only accept the word and move on with the task if ithas a higher level of confidence the operator actually spoke "sign off."

Vocollect recommends setting the threshold between 1.5 and 2 for infrequently used vocabularywords. This setting eliminates most insertions of the word while only having a minor impact torejecting words that should have otherwise been accepted thus creating a balance of per-formance. A setting higher than 3 is likely to cause significant repeating and is not recommended.This parameter should be set within the default task package or added to the task package duringimplementation.

Note: To further reduce insertions and repeating of specific words, the number of discrete repe-titions during enrollment training can be increased to improve performance with a bettervoice template. The more times a word is trained, the more likely the recognizer will accept itwhen first spoken or ignore it due to other noises. To increase the number of iterations of aword during enrollment training, either modify the Embedded Training within the task pack-age in VoiceConsole or update VoiceApplication settings within VoiceArtisan adding an addi-tional row for each new iteration the operator should train of that word. In addition, forparticularly problematic words, the operator may always retrain a word via the menu optionsto force a retrain with 10 iterations.

Ability to Obtain Task Configuration

With this release, we added an API, get_task_configuration(), which returns the config.xmlfile in the task package in a DOM tree structure. See the VoiceCatalyst Emulator online help formore information.

Rebuild the Last Prompt Spoken

When a user says "say again" or the application transitions from "sleep" to "on", the text that isspoken is the last TTS string that the application generated. The new APIs allow you to modifythis remembered text or control whether a generated prompt will be remembered in thelastPrompt variable.

get_last_prompt()

Returns the last prompt spoken string value

set_last_prompt(prompt_string)

Page 17: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Set last prompt spoken string value

See the VoiceCatalyst Emulator online help for more information.

"Say Again" Processed by Voice Application

With this release, if you add "say again" as a vocabulary item on a vocabulary link, it will be recog-nized and processed by the voice application.

Callback For Any Callable Object

A new API, set_event_callback(generic_callback, eventType), was added. You can nowregister a callback function for existing event types as well as the following new event types:

l Operator Load

l Device Sleep

l Device Wake up

l Locale Change

The voice API has also enumerated all supported event types. The enumerations begin with EVT_,for example, voice.EVT_OPERATOR_LOAD_CB for the operator load event.

Vocollect VoiceArtisan® Release Notes: Features in 1.3.1Updates to Support VoiceCatalyst 2.1

This version of VoiceArtisan contains updates to support the development of applications onVoiceCatalyst 2.1. To support Croatian and Serbian TTSs, the Phonetics tab of the Voice Con-figuration Editor includes these two languages in the language drop down lists.

Vocollect VoiceArtisan® Release Notes: Features in 1.3.0Add Vocabulary from Python Code

If you typed a new vocabulary item into Python code, you would also need to add it to the Vocab-ulary tab in the Voice Configuration Editor. You can now add vocabulary in a Python file directlyto the project's vocabulary. For more information, see ../tasks/add_vocab_python.htm in theonline help.

Record and Playback for Creating Personal Voices

Vocollect Personal Voices are high-definition human voices that are an alternative to the stand-ard text-to-speech voices. Personal Voices can be created in VoiceArtisan through the record andplayback functions.

The Voice Configuration Editor now has a Record/Playback tab that lets you enter any recordedaudio files and the phrases they represent. You have the option to extract phrases from an exist-ing properties file.

When the distributable file is created, these files will be transformed into the Vocollect Audio Fileformat and compressed.

Page 18: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Map Responses in Mock Catalyst

Mock Catalyst lets you type rather than speak responses to prompts. If you want to type differentvocabulary items in response to prompts than those defined in the task, you can now map vocab-ulary items to words you would prefer.

Library Dependencies

With this release, if you are extracting a VoiceArtisan application project to your workspace, youwill be notified if libraries on which that application are dependent are not installed.

User Interface Enhancements

The Phonetics tab of the Voice Configuration editor has been updated to let you remove a phrasefrom a single locale or from all locales by pressing buttons at the bottom of the tab.

The VoiceArtisan Libraries view can now be sorted by any of the visible columns by clicking theheader of the column by which you want to sort.

Fixes and Enhancements in 1.3.0VoiceArtisan Fixes

UTF-8 Characters Read Properly

In the previous release, if your test file referenced a LUT responsedata file containing UTF-8 characters, it would not be read with theproper encoding. This has been fixed.

VSCVAIDE-25

Correct "No Log Selected" Message Displays

Previously, if you attempted to create a script from the Voice Logsview, or if you tried to generate LUTs from that view, but no log filewas selected, you would incorrectly receive a message prompting youto select a VCE instance. This message now correctly reads: No logfile(s) selected.

VSCVAIDE-40

Test Script Confirmation Now Correct

In the previous release, when you generated a script from a log file inthe Voice Logs view, when the script was generated, the confirmationmessage would incorrectly read: Don't show this message again. Thishas been fixed; the message now reads: log_test.py generated suc-cessfully.

VSCVAIDE-32

Project Name Mismatch No Longer Occurs

In the previous release, if the name of the project extracted into yourworkspace did not match the project name defined in the .project fileand you ran Python unit tests, you would receive a key error. This hasbeen fixed.

VSCVAIDE-33

Progress Reported When Adding Library VSCVAIDE-34

Page 19: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

When you are adding a library to your VoiceArtisan workspace fromthe Libraries view, a progress bar is now displayed while the library isbeing added.

Features in 1.2.0Support for Eclipse 3.7

You can now use Eclipse version 3.7 with the VoiceArtisan plug-in.

Support for PyDev 2.6

With this release, support for PyDev 2.6 has been added.

Important: We have released new versions of VoiceCatalyst Emulator 1.0.0, 1.0.1, and 1.1.0 withthe dependency on PyDev removed. If you want to upgrade to PyDev 2.6 and already haveVoiceCatalyst Emulator installed, do one of the following:

l Install or upgrade the VoiceCatalyst Emulator versions before upgrading VoiceArtisan

l Uninstall the VoiceCatalyst Emulators, upgrade VoiceArtisan, then reinstall theVoiceCatalyst Emulator versions.

Import .zip Files into Voice Logs View

With this release, you can import compressed (.zip) log files into the Voice Logs view in additionto clear text files.

Full Method in Tooltip

Previously, when you hovered over a conditional link, a tooltip would appear, displaying the nameof the method associated with the link. With this release, the tooltip also displays the method'scode.

Alternate Methods For Changing Plug-in to Project

Now you can do one of these in the VoiceArtisan Libraries view to extract a project from a down-loaded plug-in library, voice application or example:

l Double-click on the plug-in

l Right-click on the plug-in and select Add as Project

These methods are in addition to the VoiceArtisan Libraries view's drop-down menu and the Addas Project toolbar button that existed in previous versions.

Priority Prompts in Output

When you run MockCatalyst, the output in the Console view will now display <pp> at the end ofpriority prompts.

Page 20: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

System Requirements for the VoiceArtisan Bundle

Operating Systems

l Windows 7 Professional 64-bit

l Windows 10 Professional 64-bit

Hardware

To test a voice application on your computer, you will need a Vocollect wired headset.

We recommend you use a CMedia CM108 USB Virtual 7.1 Channel Sound Adapter for your head-set. This adapter has been tested by Honeywell and is recommended for testing applicationsthrough VoiceCatalyst Emulator.

Software

Eclipse version 4.7.3a

provided in zip file

PyDev 6.2.0

provided in zip file

Java version 8 or higher

not provided--you must supply

must be a 64-bit version to be compatible with Eclipse

Fixes and Enhancements in 1.2.0

VoiceArtisan Fixes

In the previous release, you were unable to enter UTF-8 encoded char-acters into the Console view. This has been fixed. UTF-8 encodedcharacters are now accepted.

RBIRD-412

In the previous release, you were unable to import all of an operator'stemplates from VoiceConsole version 4.1. This has been fixed; youcan now import templates from or export templates to VoiceConsole4.0 or 4.1 (HTTP only) or 4.2 (HTTP or HTTPS).

VSCVAIDE-4

Core Library Fixes

In the previous release, scanned data were not being cleared from thebuffer, causing errors. This has been fixed.

RBIRD-407

The default timeout for digits has been changed from .600 ms to .700ms. The default timeout for alphas and alphanumeric entries has beenchanged from .700 to .800 ms.

RBIRD-392

In the previous release, prompt_digits_required was prone to inser-tions. This has been fixed.

RBIRD408

Page 21: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

LUT/ODR Library Fixes

Fixed an issue that would cause the LED to be solid red and would cause thedevice to reboot.

PyDev Fixes

In the previous release, setting a break point and running a voice application indebug mode would VSCVAIDE-9 cause an error when opening the file. This hasbeen fixed in PyDev 2.6. For a full list of fixes in PyDev 2.6, see http://py-dev.org/

Features in 1.1.0VoiceLink Voice Application Now a Plugin

The VoiceLink application source can now be installed as an Eclipse plugin. Note that you mustobtain a new license with the VoiceLink feature enabled to download this project. In addition, youmust install VoiceArtisan 1.1.0 before attempting to download the VoiceLink voice application, orthe download will fail.

Project Selection in Export Wizard

If you didn't select a project before attempting to create a distributable file, the Export wizard willdisplay a page containing a list of all VoiceArtisan projects in your workspace. You can select theproject to export at this point.

Wizard for Creating TaskBase Classes

The New wizard now has an option for creating an extension to the TaskBase class in the CoreLibrary. The wizard lets you enter parameters and states that are then incorporated into the gen-erated script. For more information, see the online help.

Specify Version of VoiceCatalyst Emulator When Creating New Project

You can now select which installed version of VoiceCatalyst Emulator you want to use for a par-ticular project in the New Project wizard.

Note that you can always change the version you are using for a given project in the project'sproperties or in the run configurations.

Anchor Words for Digit Prompts

Currently, if the max_length parameter in a prompt is set to None, an anchor word (for example,"ready") is required. With this release, setting min_length or max_length to None causes an anchorword to be required. Setting max_length to None will also disable the timeout.

Selected Filters Appear in Voice Device View

The filters you select to use for the Voice Device view will now appear in a pane to the right of theVoice Device view.

Page 22: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Changes to the Project Properties Tab in the Voice Configuration Editor

Project properties are now inherited from referenced projects. We updated the Project Propertiestab of the Voice Configuration Editor to indicate which properties came from your current projectand which ones are inherited from referenced projects.

We also revised the user interface to make it easier to add properties and you can now search fora selected property in the source code.

Fixes and Enhancements in 1.1.0

VoiceArtisan Fixes

When you export a VoiceArtisan voice application, the process will no longer compilePython files. That is, the files in the voice application distributable will have a .pyrather than .pyc extension. This will allow you to upgrade to a newer version of Pythonwhile maintaining compatibility with older versions.

Note that if you use VoiceArtisan 1.1 and build the application for a 1.0 version ofVoiceCatalyst and you select Unprotected, the Python files will be uncompiled.

RBIRD-385

In the previous release, special characters in XML data generated from log files werenot being properly encoded, so the LUT/ODR Server was unable to properly parse thedata. This has been fixed; special characters are now encoded properly.

RBIRD-374

In the Voice Logs view, Python script generated from log files included invalid vocab-ulary for responses. Invalid responses are now ignored.

VoiceArtisan will now run on a 64-bit platform (Windows 7). To run the Eclipse versionwe provide, you will need to install a 32-bit version of the Java Runtime Environment.

RBIRD-378

Previously, the LUT Data File Generator in the Voice Logs view would misinterpret cer-tain data in the log file, causing it to create incorrect LUT responses. This has beenfixed.

RBIRD-372

Previously, the LUT Data File Generator in the Voice Logs view would create responsesto ODRs. This has been fixed.

RBIRD-364

In the previous release, VoiceArtisan would terminate unexpectedly while debugging avoice application with multiple threads. This is an issue with the PyDev plugin thatrequires editing the PyDev code to work around the issue. This has now been fixed inthe base VoiceArtisanEclipse.zip.

In the previous release, the Voice Device view did not display the help message at thepick prompt even when the view was properly filtered to do so. This has been fixed.

If a project references a library with an different version of VoiceCatalsyt Emulator andthe two versions of VoiceCatalyst Emulator are potentially incompatible, you willreceive a warning.

RBIRD-376

With this release, if you delete templates from the Operator view in VoiceArtisan, thesame template will be removed from its location in VoiceCatalyst Emulator so that youwill be forced to retrain the template. In previous releases, you had to delete the tem-plate in both locations.

Page 23: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

You will now receive a warning if a word you enter in the Embedded Training tab of theVoiceConfiguration Editor is not currently in the project's vocabulary items.

VoiceCatalyst Emulator Fixes

RBIRD-376

With this release, if you delete templates from the Operator view in VoiceArtisan, thesame template will be removed from its location in VoiceCatalyst Emulator so that youwill be forced to retrain the template. In previous releases, you had to delete the tem-plate in both locations.

RBIRD-391

In the previous release of MockCatalyst, if you returned from a global word to a nodewith a prompt, the prompt would not be spoken. This has been fixed; the prompt willnow be spoken.

RBIRD-356

With this release of MockCatalyst, if you use the open_vad_resources function andthe file is not found, an IOError will be thrown just as it is when running VoiceCatalyston a device.

General Library Fixes

RBIRD-386

With this release, each library has a uniquely named unit test package. This preventsconflicts caused when trying to import several packages with the same name.

Core Library Fixes

RBIRD-387

Previously, dialogs.runner did not work across multiple threads. This was fixed bymoving the variable to the TaskRunnerBase class.

RBIRD-392

In the previous release, there could be recognition problems because the speechtimeout would happen more quickly than it did with tasks developed in TaskBuilder.With this release, BaseDialogs defaults the timeout to 700ms, and the two alpha func-tions (prompt_alpha and prompt_alpha_numeric) are set to 800ms.

RBIRD-284

Previously, digit prompts would ignore scans after any digits were spoken or inserted.With this release, if scanning is done after digits are spoken, the digits are ignored andonly the scan is accepted.

Features in 1.0.1Localization

The VoiceArtisan and VoiceCatalyst Emulator user interfaces and the online help are available inJapanese.

Copy Vocabulary into Voice Configuration Editor Phonetics Tab

With this release, you can copy all vocabulary added to a voice application into the Phonetics tabof the Voice Configuration Editor, so you don't have to enter each word into the phonetics userinterface.

Page 24: VoiceArtisan 2.1 Release Notes - Amazon S3 · SystemRequirementsfortheVoiceArtisanBundle OperatingSystems l Windows7Professional64-bit l Windows10Professional64-bit Hardware Totestavoiceapplicationonyourcomputer

Enter Multiple Phonetic Substitutions for a Phrase

The Phonetic Words tab in the Voice Configuration editor was redesigned. You can now add aphrase and enter phonetic substitutions for that phrase in all languages you want your voiceapplication to support.

Headless Build

You can now build VoiceArtisan voice applications using command line arguments or Ant. Formore information, see the online help.

Export an Application Package for Testing

With this release, you can export a project as a Mock Catalyst archive file that can be testedwithout a Talkman® device or the VoiceArtisan IDE. This may be helpful for testing a voice applic-ation against a WMS vendor's system.

New Device Support

With this release A500 joins T5 and T5m in supporting the Vehicle Mount configuration. A500devices can now be mounted to a vehicle, such as a forklift or pallet jack, and use the vehicle'sbattery to power the device.

See Vocollect's Hardware Documentation for more information.

Plugin Release Notes

We have now included release notes for each of the plugins, so you can determine beforehandwhether you want to download the update.

To access the release notes, in the Available Updates dialog box, select the plugin. In the Detailssection, click the More... link and select General Information.