IBM Support

PI77089: DXL REF ERROR IN THE DESCRIPTION OF THE PARAMETERS OF DXL PERM ADDLINKSET

Subscribe

You can track all active APARs for this component.

APAR status

  • Closed as documentation error.

Error description

  • The DXL reference manual is incorrect about the DXL perm below:
    
    string addLinkset(PartitionModule, string, string)
    
    It states that the second and third parameters should be the
    name of the source and target modules of the linsket to add to a
    partition.
    But in fact, it should be the absolute paths not including the
    project name.
    For instance:
    If the source and target modules are
        "/my_project/sub_folderA/source_module"
        "/my_project/sub_folderB/target_module"
    
    Then, the parameters passed to addLinkset should be:
        "sub_folderA/source_module"
        "sub_folderB/target_module"
    
    
    Note: the documentation about the function removeLinkset is
    correct:
    removeLinkset
    Declaration
    PartitionLinkset removeLinkset(PartitionModule pm, string
    source, string target)
    
    Operation
    Removes a particular linkset from the information to be included
    with partition module pm, which must be a link module.
    The names specified for both the source and target modules must
    be absolute paths from the containing project (not including the
    project name).
    
    
    Here is what the DXL reference manual says about the addLinkset
    perm:
    
    addLinkset, addAwayLinkset
    Declaration
    string add[Away]Linkset(PartitionModule pm, string srcName,
    string trgName)
    
    Operation
    Adds a linkset to a partition definition containing pm, which
    must be a link module in the partition definition.
    The linkset has source srcName and target trgName in module pm.
    Use the function addAwayLinkset when adding information in the
    away database.
    For addLinkset the module name must be specified without a full
    path name. Only the module name is required.
    For addAwayLinkset the module name must be specified relative to
    the folder in the away database created when the partition was
    accepted. If successful, returns a null string; otherwise
    returns a string containing an error message.
    

Local fix

Problem summary

  • ****************************************************************
    * USERS AFFECTED:                                              *
    * All users.                                                   *
    ****************************************************************
    * PROBLEM DESCRIPTION:                                         *
    * The description of the parameters for the DXL perm           *
    * addLinkset is incorrect in the DXL reference manual.         *
    ****************************************************************
    * RECOMMENDATION:                                              *
    ****************************************************************
    

Problem conclusion

  • This has been resolved in the DOORS 9.6.1.9 release.
    

Temporary fix

Comments

APAR Information

  • APAR number

    PI77089

  • Reported component name

    TLOGIC DOORS

  • Reported component ID

    5724V61DR

  • Reported release

    961

  • Status

    CLOSED DOC

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    NoSpecatt / Xsystem

  • Submitted date

    2017-02-23

  • Closed date

    2017-12-20

  • Last modified date

    2017-12-20

  • 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



Document information

More support for: Rational DOORS

Software version: 961

Reference #: PI77089

Modified date: 20 December 2017