Avid iNEWS Web Service

Determining the Version of iNEWS Web Service

The version number should match the version of Avid iNEWS web service you are running. Follow this procedure to get the version number:

Configuration

1. Open iNEWS client and add the Avid iNEWS Web Service version in first story of rundown SYSTEM.CLIENT.API-VERSIONS.
   The version number should match the version of Avid iNEWS web service you are running (see section Confirming the Version of iNEWS Web Service).
   For example:
   

   ;web services

    

   1.0.0.182

    

   1.1.1.49

    

   1.1.2.1

    

   1.6.0.5

    

   ; run offline; configure -n; online after doing changes in iNews server console

2. On the iNews server console, execute the following commands one by one:

   1. offline

   2. configure –n

   3. online
      
      

3. Enable Refresh for the rundown used for receiving status updates.

4. Click on the rundown name, choose Properties > User Interface.
   

   Note: From iNEWS Setup and Configuration Guide: Use the Refresh trait only on important queues, like rundown queues that are often modified by multiple users simultaneously.
   To automatically refresh a queue, your system must spend a lot of time monitoring workstations where users are viewing that queue.
   Assigning the refresh trait to too many queues that are often accessed at the same time greatly increases the amount of work your system has to do and may severely degrade its overall performance.

5. Configure the columns to receive status and air-date updates from Viz Mosart.
   By default, Viz Mosart uses the field types “event-status” (STATUS) and “air-date“ (AIR-DATE) for this purpose.
   

6. To enable the feature that allows Viz Mosart to send clip durations, configure a designated column in iNEWS to receive this information.

7. If the column type is set to 'Duration,' then iNEWS will be responsible for controlling the timecode format displayed in that column.

8. Alternatively, if the column type is 'Editbox,' Viz Mosart will send the clip duration in the timecode format specified within its own settings, calculated based on the frame rate configured in Viz Mosart.
   
   

API Session Limits

Web Services Connection

Other Manus Administrator Settings affecting NRCS Status Feedback

• Send Clip Status To NRCS (Default: false)
  Set to true to send clip status (Online/Offline) when Media Administrator is running.

• Send only availability status for clips to NRCS (Default: false)
  When enabled, this setting will restrict the statuses sent to NRCS to only the availability statuses for clips, specifically 'Online' and 'Offline'. Playback statuses such as 'Cue', 'Play', and 'Stop' will not be sent.
  If the rundown is in rehearsal mode, Viz Mosart will only send availability statuses for clips, regardless of how this setting is configured.

• Ignore Send Cue Status to NRCS for Offline Clips (Default: false)
  Select to prevent the NRCS receiving CUED or READY statuses of offline video clips for the first story set as next when the timeline is not running.

• Ignore Updates If No Changes (Default: false)
  If enabled, stories with no relevant changes will not be processed by Viz Mosart. This is to avoid issues with story updates from the Mosart GUI being ignored. Later changes in Viz Mosart iNEWS Web Services API prevented such problems, but for future changes is good to keep in mind this setting together with StoryCompareIgnoreAttributes which is explained below.

• Story Compare Ignore Attributes (Default: empty)
  List of xml attributes to ignore during comparison. Internally, the default list of attributes is set to [date_0, date_1, timestamp] and what is configured in this setting will be added to this list.
  
  When Viz Mosart receives a story in NSML format, it will parse the story and create its own XML format. When irrelevant updates come from NRCS, some attributes in the Viz Mosart XML story are updated. Currently these are date_0, date_1 and timestamp (see the format of a Viz Mosart XML story in any xml file in C:\manus folder). Attribute date_0 was recently added to the default attributes to be ignored due to the problems with updates caused by Viz Mosart iNEWS Web Services.
  In future if other attributes cause such issues, than they can be added to the list of attributes to be ignored.

• Refresh Media On NRCS Update (Default: false)
  If enabled, it forces updating clips when story is changed in NRCS. This is an old setting introduced before Viz Mosart iNEWS Web Services.

• Keep Story Status On NRCS Update (Default: false)
  If enabled, will keep the story status on an NRCS update, thus keeping the on-air status. The content of the story will be updated, but the story will be gray in the Mosart GUI. This is also an old setting introduced before Viz Mosart iNEWS Web Services.

Configurations in AvidInewsWebServiceConfig.xml

Copy the configuration file from in Mosart Installation folder\Mosart Server\ConfigurationFiles to the ChannelTemplates folder on C:\.

• SendUpdateStatusForAllItems (Default: false)
  By default, only status of items containing clips will be sent (Online/Offline/Cued/Play/Stop).
  Not only clips given through Package or Voiceover are taken into consideration, but also Adlibpix or other ways to insert clip into a story. So for example if a story contains a Camera and an Adlibpix, than the story gets status.

• StatusColId (Default: event-status) The id of the column to display the story item status sent by Viz Mosart.
  

• AirDateColId (Default: air-date) The id of the column to display the air-date sent by Viz Mosart.

• ClipDurationColId (default: empty) The id of the column to display the clip duration sent by Viz Mosart.

• ClipDurTcFormat This setting determines the timecode format used for displaying clip durations in the column specified by "ClipDurationColId". If the iNEWS column is not of type 'duration', the default format is 'mm:ss'. Other available formats include: 'ff', 'ss', 'hh:mm:ss:ff', 'mm:ss:ff', and 'ss:ff'. When the iNEWS column is of type 'duration', Mosart will transmit the duration in seconds. Conversion from frames to the selected timecode format is carried out based on the frame rate configured in the Manus Administrator settings.

• ClearStatusWhenReload (Default: false)
  If enabled, only status column is cleared on reload of the rundown. This is to avoid inconsistent status if, for example, stories failed to be updated because of a crash of Viz Mosart or iNEWS or Viz Mosart is closed while rundown is playing etc.

• ClearStatusWhenUnload (Default: false)
  If enabled, the status will be cleared when rundown is unloaded.

• SetStoryAirDate (Default: true)
  Set to false to disable setting the AIR-DATE field and moving the "aired line" (the blue line). Note that the color of the line can be changed from Tools/Options/Colors in the iNEWS client and choose “Aired” from drop-down box. By default this is blue.

• ClearAirDateWhenReload (Default: false)
  If enabled, the air-date field will be cleared during reload of the rundown (empty status). Note that this setting is taken into consideration only if SetStoryAirDate is true.

• ClearAirDateWhenUnload (Default: false)
  If enabled, the air-date field will be cleared during unload of the rundown (empty status). Note that this setting is taken into consideration only if SetStoryAirDate is true.

• Color index attributes
  The following parameters are colour index referring to values defined in SYSTEM.COLORS on the iNEWS system.
  The AIR-DATE field needs to be empty in order to see the correct color for the STATUS field:

  • UrgencyIndex (Default 1)

  • UrgencyIndexONLINE (Default 1) Set color for Online status.

  • UrgencyIndexOFFLINE (Default 4 - purple) Set color for Offline status.

  • UrgencyIndexCUED (Default 2 - green) Set color for Cued status.

  • UrgencyIndexPLAY (Default 3 - yellow) Set color for Play status.

  • UrgencyIndexSTOP (Default 1) Set color for Stop status.
    

• LockFormSectionOnly (Default: true)
  If true will issue a lock on the FORM section of a story, if false will lock the complete story.

• HeartbeatInterval (Default: 3 seconds)
  Interval to check Avid Web Service heartbeat.

• UpdateStoriesCacheInterval (Default: 1 second)

• RetryStoryUpdateStatusInterval (Default: 5 seconds)

• When a story failed to be updated (either because the story is locked for editing, the WebService is down or the iNEWS server is down), an error message will be displayed in console.
  The retrial to update the story status will continue until the problem is fixed or Manus Admin is closed.

• NoOfStoriesToGet (Default: 50) – number of stories to get from iNEWS for caching

Operational Status

The table below shows examples of status behavior for setting SendUpdateStatusForAllItems.

• If SendUpdateStatusForAllItems is false, the entire column “Story without video clips” will be cleared (no status sent for these stories).

• ClearStatusWhenReload should be set to true to clean up old history.

• The last row (Story has been On air) means that after the story has been run but the rundown is still on-air, the clip is no longer monitored.
  If the clip subsequently becomes available or unavailable, this is not reflected in iNEWS.
  Only after the rundown is reloaded, is clip status updated.

• Air-date is also updated to the NRCS if the parameter SetStoryAirDate is set to true in the AvidInewsWebServiceConfig.xml file.
  When the parameter for SendUpdateStatusForAllItems is false, only air-date for stories that do not contain any clips will be updated.

Below are examples of status behavior:

Above, the rundown is off-air. Stories S2, S3 and S4 were updated with status of the clip it contains.

Above, the rundown is on-air. Story S1 is currently playing, but the status was not sent to the NRCS. Since S2 contains a clip, its status is set to “CUED”.

In the illustration above, Story S2 is playing and S3 is “CUED”. Since the first item in S3 is a camera the “CUED” status is not sent unless SendUpdateStatusForAllItems is set to true.

Above, Story 3 is now playing and Story 5 is “CUED”. Clip thada5 for Story 4 is broken and will be failed during cuing

And finally, Story 5 is playing and clip from Story 4 should be cued. Zebra stripes in the Viz Mosart GUI indicate an issue with availability and Story 4 is marked as OFFLINE in iNEWS

Status for Stories Containing more than One Item

If a story has more than one item, the following statuses are sent when the story is on-air (keeping in mind that if SendUpdateStatusForAllItems is false the status is not sent if the story does not contain clips):

• PLAY for first item, CUED for next item. This means that the story status will be CUED (regardless of SendUpdateStatusForAllItems value)
  

Above illustrates that when the first item (camera) in S3 is playing, no “PLAY” status is sent. The Next item is a Package so “CUED” status is sent. In this case, even if SendUpdateStatusForAllItems is true, the “CUED” status will still be sent for the story.

• When F12 is pressed, STOP is sent for the first item, PLAY for the second item and CUED for the third item. This means that the story ends up with CUED status (regardless of SendUpdateStatusForAllItems value).
  This continues until we reach the last item in the story.

• It is only the last item that will send the status PLAY. At any time, it is possible to check the AIR-DATE to identify the story currently on-air.

Continuing this example (2 screenshots below), the story S3 has only two items, a Camera and a Package. When we play the clip in the Package, the story gets PLAY status.

The Package from S3 is playing, this is the last item in the story so “PLAY” status is set. Story S4 will get “CUED” because it contains a clip.

Status of an Off-air Story Containing Multiple Clips

The status of an off-air story that contains more than one clip is provided by the first clip in the story.

Clip Duration Feedback to iNEWS Server

• The clip duration sent to iNEWS will be in mm:ss timecode format by default. Other formats are possible to configure. A system-wide frame rate for conversion is assumed and can be configured in Mosart Manus Admin settings.

• iNEWS can only display information at story level and therefore rules have been defined when a story contains more than one clip. However, for optimal usage of this functionality, it is recommended to have stories containing only one clip.

• A column must be configured in iNEWS to show the duration of a clip found in the story. A column id must also be configured in Viz Mosart, in the file AvidInewsWebServiceConfig.xml.
  For status and air date, the default iNEWS columns have been used, but from Mosart 5.1.1, any column can be configured to show the status or the airdate.

• When a rundown is loaded/reloaded in Mosart, Mosart will update all the stories in iNEWS with the duration of the first clip found in each story, in addition to the already existing clip availability status.

• When a clip is offline, the default duration configured in Mosart will be sent.

• When a clip update is received in Mosart, Mosart will send the updated clip duration to iNEWS.

• In general, when a given story item is cued/played/stopped, Mosart will send the clip duration if that item is a clip.

• If the timeline is not running and the item following the current item cued is a clip, the story will be updated with CUED status and the duration of the clip.

• If a clip that is currently being recorded or copied to the MAM system is included in the rundown, its duration is automatically transmitted to iNEWS, assuming that Mosart supports the 'growing clip' functionality for the configured video server.

Not able to Access Web Service page after Installation

If you have problems accessing the Web Services page after installation and deployment (http://<server>:8080/inewswebservice/services), try to delete the Tomcat cache as follow:

1. Stop the Tomcat service.

2. Delete folder Tomcat installation\webapps\inewswebservice (only the folder, not the war file).
   You may replace the war file, for example, with a new one when upgrading (this solution is same as deploying from Tomcat Manager).

3. Delete folder Tomcat installation\work\Catalina\localhost\inewswebservice

4. Start the Tomcat service and try again to access the Web Services page.
   

The Connection to iNEWS Server Times-out

If the connection to the iNEWS server through the iNEWS Web Service times out, check first the iNEWS server logs for more details.

If the iNEWS server logs contain "SSL_access failed", check what version of Java you are using. SSLv3 is disabled in Java 8 by default.

A default Java 8 installation disables the SSLv3 algorithm, preventing WSAPI from connecting to the Newsroom Management Server.

• To re-enable SSLv3 algorithm, open as administrator the file java.security located in the lib/security or conf\security in your JRE or JDK installation folder

/user/lib/jvm/java-.1.8.0-openjdk-1.8.0.xxxxx/jre/lib/security

C:\Program Files\Java\jdk-20\conf\security\java.security

and comment out the lines that disables SSLv3. Restarting the Apache Tomcat service once the modifications are done.

"No sessions available on X” – Maximum session

If the above error is shown in Manus Admin’s console or the log (where X is the iNEWS server IP address or hostname), refer to the section API Session Limits.
If this is not the case, then most probably the issue is that the Manus Admin console failed to release the occupied API session to connect to iNEWS server through Avid Web Services, when the API session was closed.

Workaround: There are two solutions for this problem.

1. Either restart Apache Tomcat service or

2. Reduce the session timeout in Tomcat to 1 min, freeing-up the API session 1 min after Manus Administrator was closed.
   If Manus Admin is closed and opened more than maximum API sessions allowed in 1 min, it will reconnect automatically to Web Service after 1 min when at least one session has been released.
   To change the session timeout interval do the following:

   1. Stop the Tomcat service.

   2. Change Tomcat session timeout interval in Tomcat installation/conf/web.xml to 1 min:
      <session-config>
      <session-timeout>1</session-timeout>
      </session-config>

   3. Start the Tomcat service.
      

“Cannot write to iNews Webservice, connect before selectQueue”

If you get the error message “cannot write to iNews Webservice, connect before selectQueue” check that the version of Web Service running corresponds with the version set in iNEWS.
See section Checking the Current Version of Tomcat.

Cannot get any status feedback in iNEWS

If after setting up everything as described in the document, no status is written in the Status field,
check the following:

• The Status field has write permissions for the user that connects Viz Mosart to the iNEWS system.

• The type of the Status field is “event-status”
  

• The queue must not be monitored with the iNEWS Monitor tool.

Verify also the Mosart logs or the iNEWS Web service logs located under C:\Program Files\Apache Software Foundation\Tomcat 9.0\logs\iNEWS_WS for any error related to status feedback to iNEWS.

The Web Service version is not allowed to connect to iNEWS server

If you also encounter the issue "The Web Service version is not allowed to connect to…”, then disable the version check on the iNEWS server by executing workdebug nocheck noaddress on the iNEWS server: