Initializing help system before first use

Working with Attachments

The JavaScript API provides access to all of the attachments on the scenario and the app.

The attachments can be listed, downloaded, and information about them can be retrieved. Custom views can be notified whenever the attachments on the app or scenario change, so that parts of the view can be redrawn accordingly.

Attachments cannot be edited directly using the JavaScript API, but the API provides several methods which open the regular attachments dialog, allowing the intended action to be completed using the familiar web client user interface.

For general information about attachments and attachment tags, see Using Attachments in this document, and the Xpress Insight Web Client User Guide. For a complete description of the attachments API, see the JavaScript API documentation in http://www.fico.com/fico-xpress-optimization/docs/latest/insight/javascript_api/index.html.

Covered Topics
  • The Attachments API
    The attachments on an app or scenario can only be accessed from within a scenario observer.
  • The Attachment Tags API
    The JavaScript API provides methods to retrieve information about the attachment tags defined by the app.
  • Displaying Attachment Data with AutoText
    Information about attachments present on the app or scenario can be displayed in a custom view by using the AutoText component.
  • Displaying Attachment Tag Data with AutoText
    The data-text attribute can also be used to display information about an attachment tag itself, by using the tag: prefix in place of the attachment: prefix used above.
  • Image Attachments
    The ScenarioObserver.bindImageAttachments() method allows image files attached to the scenario or app to be displayed in a custom view.
Parent Topic Using the JavaScript API to Create Custom Views