IBM Support

PI43700: DEFAULT VALUE OF HEARTBEATINTERVAL

Subscribe

You can track all active APARs for this component.

 

APAR status

  • Closed as documentation error.

Error description

  • We have different definition for the default value of
    HeartBeatInterval in Knowledge Center documents.
    
    On IBM Knowledge Center: MFP 7.0
    http://www-01.ibm.com/support/knowledgecenter/SSHS8R_7.0.0/com.i
    bm.worklight.apiref.doc/html/refobjc-worklight-ios/html/interfac
    e_w_l_client.html%23a3a4daaf7155009891309e99de3bce39d?cp=SSHS8R_
    7.0.0%2F9-0-1-2-0-24-25
    It is defined as 420 seconds (7 minutes)
    
    One IBM Knowledge Center: Worklight 6.2
    http://www-01.ibm.com/support/knowledgecenter/SSZH4A_6.2.0/com.i
    bm.worklight.apiref.doc/html/refjavascript-client/html/WL.Client
    .html?cp=SSZH4A6.2.0%2F10-0-0-1-6
    It is defined as 420 seconds (7 minutes)
    
    However, on IBM Knowledge Center: MFP 7.0
    http://www-01.ibm.com/support/knowledgecenter/SSHS8R_7.0.0/com.i
    bm.worklight.apiref.doc/html/refjavascript-client/html/WL.Client
    .html%23init?lang=en
    This is defined as 1200 seconds (20 minutes)
    
    Correct information is:
    7.0 JavaScript code and the internal default
    HeartBeatInterval is still 7 minutes.
    This value is defined in
    /client-javascript/src/main/resources/jslib/wlclient/wlclient.
    js .
    
    The confusion comes from that when creating a default
    WL application it generates the initOptions.js file that
    contains those lines:
    
    // # How often heartbeat request will be sent to MobileFirst
    Server
    //heartBeatIntervalInSecs: 20 * 60,
    
    Note that those lines are commented out, so the facto value is
    the internal value of 7 minutes.
    

Local fix

  • 1. To fix the template initOptions.js
    (/com.worklight.studio.plugin/application/js/initOptions.js)
    to show:
    // # How often heartbeat request will be sent to MobileFirst
    Server
    //heartBeatIntervalInSecs: 7 * 60,
    
    2. To fix the documentation
    http://www-01.ibm.com/support/knowledgecenter/?lang=en#!/SSHS8R_
    7.0.0/com.ibm.worklight.apiref.doc/html/refjavascript-client/htm
    l/WL.Client.html%23init
    An integer value, denoting the interval in seconds between
    heartbeat messages automatically sent by WLClient to the
    Worklight Server.
    The default value is 420 seconds(7 minutes).
    

Problem summary

  • ****************************************************************
    * USERS AFFECTED:                                              *
    * MobileFirst hybrid application developers                    *
    ****************************************************************
    * PROBLEM DESCRIPTION:                                         *
    * The default value of the heartBeatIntervalInSecs parameter   *
    * specified in the WL.Client class of the JavaScript           *
    * client-side API manual reference is wrong.                   *
    *                                                              *
    * The same information is also provided in the generated       *
    * initOptions.js file when one creates a default MobileFirst   *
    * application.  The following lines are found in the js file:  *
    * // # How often heartbeat request will be sent to MobileFirst *
    * Server                                                       *
    * //heartBeatIntervalInSecs: 20 * 60,                          *
    *                                                              *
    * The correct value is 420 (7 minutes) and not 1200 (20        *
    * minutes).                                                    *
    ****************************************************************
    * RECOMMENDATION:                                              *
    * -                                                            *
    ****************************************************************
    

Problem conclusion

  • The WL.Client class of the JavaScript client-side API manual
    reference is fixed to state that the default value of
    heartBeatIntervalInSecs parameter to be 420 seconds.
    
    In the auto-generated initOptions.js template, the default value
    of heartBeatIntervalInSecs parameter is also corrected to 7
    minutes.
    // # How often heartbeat request will be sent to MobileFirst
    Server
    //heartBeatIntervalInSecs: 7 * 60,
    
    
    Knowledge Center was updated accordingly.
    

Temporary fix

Comments

APAR Information

  • APAR number

    PI43700

  • Reported component name

    WL/MFPF ENTERPR

  • Reported component ID

    5725I4300

  • Reported release

    700

  • Status

    CLOSED DOC

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    NoSpecatt

  • Submitted date

    2015-06-24

  • Closed date

    2015-11-04

  • Last modified date

    2015-11-04

  • APAR is sysrouted FROM one or more of the following:

  • APAR is sysrouted TO one or more of the following:

Fix information

Applicable component levels

[{"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"SSZH4A","label":"IBM Worklight"},"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"700","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
14 October 2021