Automic Workload Automation

 View Only
Expand all | Collapse all

overwriteLinks parameter of ImportObject class is named & documented incorrectly

  • 1.  overwriteLinks parameter of ImportObject class is named & documented incorrectly

    Posted Apr 06, 2017 05:43 AM
    The overwriteLinks method of the ImportObject AE Java API class does not work as documented:
    overwriteLinks - If true Folderlinks will not be kept
    In fact, it works oppositely to the way described.

    Value of overwriteLinksBehavior
    false
    For objects that are replaced, the home folder locations of these objects are determined by the import location and any locations described in the FOLDER_STRUCT portion of the XML file. (The relative folder structure from the source AE system.) Any links to these objects are removed.
    true
    For objects that are replaced, the home folder locations of these objects are not changed. If  the objects’ home folders are different than the target import folder, then links to the replaced objects will be created in the target folder.
    In other words, the value of the overwriteLinks parameter corresponds directly to the state of the Keep existing folder links check box in the XML import UI dialog box.
    15xy6a7hlz1m.pngt0jw86c5rfq5.png
    XML import dialog box (JUI)
    XML import dialog box (AWI)

    Note that the language in the UI is exactly opposite to the language in the API.

    I suggest that Automic take one of the following courses of action:
    • Change the name of the parameter (e.g., topreserveLinks), or
    • Swap the behaviors oftrueandfalse.


  • 2.  overwriteLinks parameter of ImportObject class is named & documented incorrectly

    Posted Apr 06, 2017 07:08 AM
    I opened  INC00131956 about this.


  • 3.  overwriteLinks parameter of ImportObject class is named & documented incorrectly

    Posted Jun 07, 2017 09:54 AM
    This problem was fixed in version 12.0.2 of the AE Java Application Interface.

    Problem ID: PRB00132551
    Title: Different behavior in keeping links between Java API an UI
    Description: The overwriteLinks parameter was not correctly named, since the actual action that can be triggered from the UI is doing the opposite, keeping the links. For this purpose, the parameter has been renamed to keepFolderLinks.

    The documentation page of the ImportObject class has been updated accordingly.