Avid Interplay WS 2.6.1 Release Notes September, 2012 Overview Interplay Web Services is a server-based integration platform for Avid Interplay. It should be run on a modern Windows machine (~2GHz, 2 GB RAM) in the same network as the Interplay Engine. For testing and development, Interplay WS can run on the Interplay Engine itself, but this is not allowed in production environments. This readme contains information on the change history of Interplay WS, instructions on installation, and instruction on configuration. Note that starting with version 1.4, Interplay WS offers a new browser-based configuration. In addition, starting with Interplay WS 2.0, integrators who wish to submit Media Services jobs in Interplay 1.x environments will need to run a separate Interplay Web Services Updater installer. This is not necessary in Interplay 2.x environments. New in Avid Interplay WS 2.6.1 The Avid Interplay WS v2.6.1 release fixes the following bugs Duplicate: Fixed a bug where duplicated sequences via Web services lose the links to 3D Warp renders. The Avid Interplay WS v2.6 release fixes the following bugs AddRestriction: Fixed a bug where WS returned an error when parsing a valid frame number. CreateShotList: Fixed a bug where WS returned an incorrect duration for 50 fps master clips. GetUMIDLocator: Fixed a bug where subclips returned the wrong time code in some cases. SaveUMIDLocator: Fixed a bug where subclips returned an "out of range" error when the frame number was actually within the range. SaveUMIDLocator: Fixed a bug where subclips created the wrong offset for timecode locators. CreateShotlist: Fixed a bug where the system displayed an out of range time code in SD format when the input was in HD format. GetClipReadyForXfer: Fixed a significant memory leak. CreateMasterClip: Fixed a huge significant memory leak.
GetFileDetails: Fixed a bug where a "concurrent transaction exception" error occurred in some case. Move: Fixed a bug regarding moving a clip out of a folder. If you moved a clip out of a folder and then queried the folder contents, the results still contained the moved clip. This has been fixed. GetChildren: Fixed a bug where a clip's attributes contained stale attributes values. CreateMasterClip: Fixed a bug where creating a master clip with drop frame time code caused the newly created master clip to have the wrong duration. Supports attributes for 3D clips. SendToPlayBack: The "overwrite" parameter is now optional. CreateMasterClip: Supports TimeBase 24p and 23975p. Interplay 2.6 Client components: Interplay WS 2.6 uses the same internal client components as Interplay 2.6, thereby benefitting from its related bug fixes and performance improvements. New in Avid Interplay WS 2.5 The Avid Interplay WS v2.5 release fixes the following bugs AddReservation: Fixed a parsing error on the input TimeToExpireInSeconds parameter. SaveUMIDLocators: Fixed a performance issue when adding a large number of locators. SaveUMIDLocators: Allows adding UMID locator to sequences. CreateMasterClip: Report correct error message if the new clip name contains illegal characters and clean up temporary disk files. SetAttributes: Allows setting SYSTEM attribute on Non-Avid assets. The Avid Interplay WS v2.5 release contains the following new features: CreateMasterClip: The API will now accept new optional arguments clipid, sourcemoboffset, sourcemobtype, BoxX, BoxY, BoxWidth and BoxHeight. GetSegmentsFromComposition: New API to return all segments used by a composition asset. Interplay 2.5 Client components: Interplay WS 2.5 uses the same internal client components as Interplay 2.5, thereby benefitting from its related bug fixes and performance improvements. New in Avid Interplay WS 2.4
The Avid Interplay WS v2.4 release fixes the following bugs AddRestriction: The in/out point offset is now zero-based and allows you to add a restriction with a span of 1 frame. SaveUMIDLocators: Fixed a performance issue when adding a large number of locators. GetChildren: Fixed a bug regarding stale caches that caused incorrect GetChildren results. GetJobStatus: Fixed an incompatibility issue that caused the wrong transfer status to be reported from Airspeed devices.. GetStreamingURL: Added support for either Interplay v2.3 Streaming or Interplay v2.4 Direct Streaming to return the correct URL. The Avid Interplay WS v2.4 release contains the following new features: GetFileDetails: This is a new API that is available for Interplay Archive. Interplay 2.4 Client components: Interplay WS 2.4 uses the same internal client components as Interplay 2.4, thereby benefitting from its related bug fixes and performance improvements. New in Avid Interplay WS 2.3.x The Avid Interplay WS v2.3.2 release fixes the following bugs Allows clip Display Name contains special characters. The Avid Interplay WS v2.3.1 point release fixes the following bugs: CheckSequenceIsReadyForXfer falsely rejected valid sequences if a target resolution was specified (bug was for specific resolutions only). Installer did not install all Microsoft redistributable runtime DLLs that are necessary for some operations to function correctly. The Avid Interplay WS v2.3 release contains the following new features: Delete Media Only: Integrators can now choose to delete media only for a clip. Previous versions of Interplay WS always deleted the metadata too. Remove Reference Assets: Deleting a sequence will remove all unused reference assets in the same folder (Interplay 2.3+ environments only). Move: Optionally choose to override reservations when moving an asset. Avid Interplay WS v2.3 also contains the following minor bug fixes or enhancements: Rendered Effects: Correctly handles rendered effects in Interplay 2.3+ environments. Resolution Searches: Searches using ResolutionCondition will now search all resolutions of a clip (not just currently linked resolution). Custom Attributes: Does not perform unintended conversions on user attributes with date in their name. Interplay 2.3 Client Libraries: Interplay WS 2.3 uses the same internal client libraries as Interplay Access 2.3, thereby benefitting from its related bug fixes and performance improvements.
INSTALLATION NOTE: If you are upgrading from Interplay WS 1.x, you must do a full uninstall of Interplay WS 1.x before running the Interplay WS 2.x installer. If you do not do this, your installation may be corrupt. New in Avid Interplay WS 2.2 The Avid Interplay WS v2.2 release contains the following changes: Rename: Support for renaming assets and folders. Enhanced Search: Search by categories, resolutions, and usage. Avid Interplay WS v2.2 also contains the following bug fixes: CheckSequenceIsReadyForXfer: Improved stability and accuracy. Restrictions: Deleted restrictions are no longer returned. CreateShotlist: Outpoints are now exclusive (previously inclusive). Jobs Service: Login errors now correctly reported as INVALID_CREDENTIALS. CheckInAAF: Fixed rare check-in failures due to inconsistent caches. Caching w/ Interplay 2.1: Addressed a bug regarding stale caches that caused several isssues, including incorrect GetChildren results and check-in failures (only applies to Interplay Engine 2.1.x). ASF Service Config: Now reports correct Interplay WS version. INSTALLATION NOTE: If you are upgrading from Interplay WS 1.x, you must do a full uninstall of Interplay WS 1.x before running the Interplay WS 2.x installer. If you do not do this, your installation may be corrupt. New in Avid Interplay WS 2.0.1 The Avid Interplay WS v2.0.1 release contains the following changes: SendToPlayback: Masterclips and subclips can now be sent to playback. SubmitJob: The Jobs Service now supports submitting STP Encode and Copy jobs. Longevity: Cached connections will be cycled out every 12 hours. This addresses longevity issues that may occur after a connection has been in constant use for several weeks in a row. Logging: New log files are started every day and kept for a period of one week (after which they are deleted). Previously, log files were rotated and deleted based on the size of the file. Move: Interplay WS will no longer attempt to cleanup unused reference assets after a move. This is no longer necessary as it is now done on the Interplay Engine Server (starting with Interplay 1.4). Corrected error in Transfer WSDL: Removed incorrect reference to SOAP header in GetTransferDevices operation. INSTALLATION NOTE: If you are upgrading from Interplay WS 1.x, you must do a full uninstall of Interplay WS 1.x before running the Interplay WS 2.x installer. If you do not do this, your installation may be corrupt.
New in Avid Interplay WS v2.0 Avid Interplay WS 2.0 extends asset management capabilities and introduces Interplay Transfer and Interplay Media Services support. In addition, it adds support for the new Interplay 2.0 WAN proxies. With the exception of the GetStreamingURL (WAN proxy) operation, Interplay WS 2.0 is fully backwards compatible with Interplay 1.x systems. The Assets Service adds support to allow integrators to: Create sparse masterclips to be captured later Create simple cuts-only shotlists Retrieve Interplay Streaming URIs for published clips Manage UMID-based locators Retrieve the list of custom user properties for a workgroup. The Transfer Service adds support to allow integrators to: List the Interplay Transfer Engines in the workgroup List the configured devices on an Interplay Transfer Engine Send sequences to playback devices Send assets to remote workgroups The new Jobs Services allows integrators to: Submit Avid Interplay Media Services (DMS) jobs via profiles or parameters o Supports archive, restore, transcode, mixdown, and WAN publish jobs Manage Interplay Media Services and Interplay Transfer jobs o Media Services: Get status, cancel, and delete jobs o Transfer: Get status, cancel, pause, resume, and retry jobs Interplay WS 2.0 also addresses four specific bugs found in the field: Temporary AAF/JPG files are cleaned up to prevent overfilling disk space. Fixed bug that caused incorrect paths to be returned for new folders. The server's maximum memory has been increased from 512 MB to 1 GB. The AddReservations operation now handles unexpiring reservations correctly. The default Interplay WS 2.0 installation can only submit jobs to Interplay 2.x Media Services Engines. Submitting jobs to Interplay 1.x Media Services Engines is supported, but requires the additional Interplay Web Services Updater installer to be run after installation. Integrators should also be aware of future deprecation of functionality: The original locator operations will be deprecated in a future version of Interplay. We advise all integrators to begin using the new UMID based locator operations. In addition, we have also identified that user, group, and permission management may change in future versions of Interplay. Some aspects of the User Management Service may not be fully compatible with the next generation of Interplay. INSTALLATION NOTE: If you are upgrading from Interplay WS 1.x, you must do a full uninstall of Interplay WS 1.x before running the Interplay WS 2.x installer. If you do not do this, your installation may be corrupt.
New in Avid Interplay WS v1.5 Avid Interplay WS v1.5 adds the GetMetaSyncXML operation in the Assets Service and fixes several bugs found in the field: Non-default attributes were often exluded from responses, even when specifically requested. The browser-based configuration tester did not work correctly when a non-default port was used. SOAP Faults were not properly logged on the server. In addition, other minor bug fixes have been made. New in Avid Interplay WS v1.4 Avid Interplay WS v1.4 adds the following new functionality: Query and edit asset reservations, restrictions, and categories Query for asset links, relatives, and file details List indexed workspaces as UNC paths Query for web services configuration and version information View, edit, and test the configuration using a web browser Usage statistics via the Avid Service Framework Health Monitor The new operations for querying the web services configuration and version information are available in a new Interplay WS Infrastructure Service. In addition, minor bug fixes and performance enhancements have been made. New in Avid Interplay WS v1.3 Avid Interplay WS v1.3 adds the following new functionality: Query and update the Interplay Archive database Check if a sequence can be sent to playback via TM Automation API Expanded CreateFolders, Duplicate, and DeleteAssets calls Performance enhancements to Search and DeleteAssets In support of these operations, two new services have been added with their own WSDLs: Interplay WS Archive Service and Interplay WS Transfer Service. Please note that the ability to check if a sequence is ready for transfer requires the Interplay WS server to be connected to the workgroup s ISIS. New in Avid Interplay WS v1.2 Avid Interplay WS v1.2 adds the following new functionality: Delete assets Modify folder permissions User and group management. The user and group management operations are exposed in a new UserManagement service with a separate WSDL. In addition, common XML types have been extracted from the assets.xsd file and incorporated into a new common.xsd file for shared use among services.
New in Avid Interplay WS v1.1 Avid Interplay WS v1.1 adds several points of new functionality: Add, edit, get, and remove locators for masterclips Get and set headframes on masterclips, subclips, and sequences Create subclips based on existing masterclips Integrators should also be aware of a new 30-byte limit on attribute names. Please see the reference guide for more information on this as well as the features above. Upgrading from Avid Interplay WS v1.x If you are upgrading from Interplay WS 1.x to 2.x, you must do a full uninstall of Interplay WS 1.x before running the Interplay WS 2.x installer. If you do not do this, your installation may be corrupt. NOTE FOR INTERPLAY WS 1.0 USERS ONLY: An upgrade or uninstall of Interplay WS 1.0 will erase your current workgroup name to server mappings. Please write down your workgroup name to server mappings before performing an upgrade, and reconfigure them after the upgrade is complete. Interplay WS 1.1+ does not require this as it will retain your configuration settings.
Installation of Avid Interplay WS Interplay WS requires the installation of the Avid Service Framework client, an ISIS client (optional see below), and the Avid Interplay Web Services software itself. In addition, integrators who wish to submit Media Services jobs in Interplay 1.x environments will need to run a separate Interplay Web Services Updater installer for Media Services 1.x compatibility. Please ensure that the Avid Service Framework Client is installed and configured (with default workgroup and lookup server) on the host that is running Interplay WS. If your integration requires use of the CheckSequenceIsReadyForXfer operation, please install an ISIS client and configure it with read access to the workgroup s workspaces. Installation of Avid Interplay WS Server Software After the Avid Interplay Framework Client has been installed, we can now install Avid Interplay WS. This is a simple installation that you can run by double-clicking InterplayWS_Installer\setup.exe. WARNING: If you are upgrading from Interplay WS 1.x, you must do a full uninstall of Interplay WS 1.x before running the Interplay WS 2.x installer. If you do not do this, your installation may be corrupt. Installation of Interplay WS Updater for Interplay 1.x Media Services Integrators who wish to submit Media Services jobs in Interplay 1.x environments will need to run a separate Interplay Web Services Updater installer for Media Services 1.x compatibility. THIS SHOULD ONLY BE DONE FOR INTERPLAY 1.X WORKGROUPS! First we will need to stop the Avid Interplay WS service. You can do this via the Services console in Administrative Tools section of the Control Panel. Now we can run the Avid Interplay WS Updater. This is a simple installation that you can run by double-clicking InterplayWSUpdater_Installer\setup.exe. After updating Interplay WS, the installer will automatically restart the service. If the environment is updated to Interplay 2.x at a later date, you can revert to Interplay 2.x Media Services compatibility by uninstalling the Interplay WS Updater. Configuring the Avid Interplay WS Port If you are installing Avid Interplay WS on the same machine as an Interplay Engine (recommended for testing purposes only), or the same machine as another web server, you may need to change the port that Avid Interplay WS uses. For production environments, however, we highly recommend that no other web servers be running on the same machine. To test if the default port is working, go to http://localhost/ from the server machine. If you see an Avid Interplay WS home page, it is working as designed and you can skip to
the next section (Configuring the Workgroup Name to Server Mapping). If you see something else, then you need to disable the current web server or change the port that Interplay WS runs on. Many Windows servers have IIS running. If you do not need to run IIS, you can stop it and disable it via the Services console in the Administrative Tools section of the Control Panel (it's often listed as "WWW" or World Wide Web Publishing ). You'll then need to restart the Avid Interplay WS Service. You can also change the ports that Avid Interplay WS uses. If you do this, please note that developers will need to be told what ports the service is now using. You edit the ports in the following file (relative to the installation directory of Interplay WS): apachetomcat\conf\server.xml. Search for the phrase port="80" in the server.xml file and replace the port number with your desired HTTP port. Then search for the phrase port="443" and replace the port number with your desired HTTPS port. If you need more help with this, please contact 3 rd Party APIs support. After turning off a conflicting server or changing the ports of Avid Interplay WS, you'll need to restart the Avid Interplay WS service. You can do this via the Services console in Administrative Tools section of the Control Panel.
Configuring the Workgroup Name to Server Mapping (via Browser) Avid Interplay WS uses a workgroup name to map requests to the Interplay Engine. You need to configure this mapping to match your environment. This configuration can be done through a web browser or via the Avid Interplay Framework Client. The following steps show how to do this via a web browser. 1. Go to http://localhost/ on the Interplay WS Server (note that you will need to specify the port if you are not using the default port). 2. Click the Edit Configuration link near the bottom of the page. 3. In the Workgroup to Server Mappings, add the workgroup name, Interplay Engine, Archive Engine, and Media Services Engine mappings. For example, the following would signify a workgroup called "WGC" that maps to the Interplay Engine server "wgc-ie", Interplay Archive Engine wgc-ae, and Interplay Media Services Engine wgc-me. If you do not use Interplay Archive or Media Services, you can leave those entries blank. Click Submit to apply the changes. 4. Click Home to go back to the main Interplay WS web page. 5. To test the configuration, click on the Test Configuration link near the bottom of the page. 6. Type in a valid username and password for the Interplay workgroup, then click the Test button. 7. The resulting screen will display the results of the test. (NOTE: This does not test the connection to the Interplay Media Services Engine)
Configuring the Workgroup Name to Server Mapping (via ASF) Avid Interplay WS uses a workgroup name to map requests to the Interplay Engine. You need to configure this mapping to match your environment. This configuration can be done via the Avid Interplay Framework. (NOTE: If you ve already configured Interplay WS through the browser-based approach above, these steps are not necessary.) 1. Go to Start->All Programs->Avid->Avid Service Framework->Avid Service Configuration. 2. Select (or enter) the name of the workgroup that Avid Interplay WS is a part of. 3. Find the Avid Interplay WS service, and add the workgroup name, Interplay Engine, and Archive Engine mappings. For example, the following would signify a workgroup called "WGC" that maps to the Interplay Engine server "wgc-ie", Interplay Archive Engine wgc-ae, and Interplay Media Services Engine wgc-me. If you do not use Interplay Archive or Media Services, you can leave those entries blank. 4. Click Apply to apply the changes and then exit the service configuration tool. 5. If you wish to test the configuration, please see step 1 and steps 5 7 in the section titled Configuring the Workgroup Name to Server Mapping (via Browser). Conclusion Avid Interplay WS is now installed and configured. You can access online documentation by pointing to the server (and configured port, if applicable) in the browser. For most installations, this will be at http://localhost/.