Alpaca 4.0

Alpaca

Release Notes

Last Updated: 5/04/2016

The ECG team is pleased to announce the release version 4.0.0 of Alpaca.

This version includes support for the R20sp1 and R21sp1 versions of the BroadWorks API.

The complete list of changes is at the bottom of this page.

Upgrading from a previous version of Alpaca Library involves a set of required changes. Please refer to the installation details. We strongly recommend that you back up your alpaca home directory, configuration files, and licenses before upgrading.

4.0.0

What's New

For Shell Users

  • Support for multiple simultaneous BroadWorks and TimesTen connections has been added.
  • New Shell Commands
    • User Export - Outputs the complete User details as JSON.
    • Group Export - Outputs the complete Group details as JSON.
    • Connect - Opens a new connection to BroadWorks.
    • Disconnect - Disconnects a currently running connection to BroadWorks.
    • Tree - Lists the command tree.

For Developers

  • Maven support across all Alpaca modules.
  • New interfaces to clarify object types and allow easier typed usage - BroadWorksTableRow, BroadWorksService, BroadWorksUserService, and BroadWorksGroupService.
  • Serialization support across the entire Alpaca library.
  • New classes to handle the retrieval of complete details about BroadWorksObjects.
    • UserInformationBuilder
    • GroupInformationBuilder
    • ServiceProviderInformationBuilder
  • Added GroupService classes with allow import and export of Group service level information.

What's Changed

For Shell Users

  • Integration with the Profile Server and Times Ten is now required.
  • The entry location now lists the connected BroadWorksServers rather than the Service Providers.
  • Command changes
    • System
      • report userdetails - Added virtual users to the report. i.e. CallCenter, MeetMeConferencing, AutoAttendant, and HuntGroup.
    • GroupAccessDevice
      • modify type - Checks if the desired device type is available before attempting modification.
    • User
      • reset authentication - The generated password for the User is now displayed on the console.

For Developers

  • The Alpaca project has been split into multiple modules: Generator, Library, and Core.
    • Alpaca Generator - This module performs the parsing of the BroadWorks OCI schema and generates coresponding Java code.
    • Alpaca Library - This is the BroadWorks release specific library.
    • Alpaca Core - This is the set of tools built on top of the Alpaca Library. This includes helpers, the shell, migration tools, and reports.
  • Due to the serialization changes in the Alpaca Library there are no longer proxy POJO objects for all BroadWorksObject types and Responses.
  • OCI Tables no longer have a stand alone datatype. Methods such as .getTableA() now return a List of TableARow.
  • Empty requests are not created through the method call 'getEmptyObject'. This has been done to clarify that the object has been intentionally left in an invalid state. e.g. GroupAccessDeviceAddRequest14 addRequest = GroupAccessDeviceAddRequest14.getEmptyObject(bws);
  • UserServices now contains a .waitForLoad() method that waits for all underlying Services to be populated.
  • Services that can be retrieved with a user now implement BroadWorksUserService.
  • Adding and modifying a Service for a user now uses a single method call .push(user).

Fixed

  • Removed the '&' character from generated passwords to resolve encoding issue.
  • Fixed issue with error messages on the shell being displayed incorrectly.
  • HTTP GET requests now properly follow redirects when uploading device files.
  • Fixed issue with certain SSL handshakes failing during file retrieval.
  • The reset authentication command now correctly works with Groups and Service Providers.

3.2.4

What's New

  • Added Support for migration of device files that use HTTP digest authentication (Library).
  • Added internal documentation support to each Shell Command.

Changed

  • None

Fixed

  • Corrected issue with Service Provider level authorize service shell command which prevented authorization of group Services at the Service Provider level.
  • Minor bugfixes.