Initializing help system before first use

The Attachments API

The attachments on an app or scenario can only be accessed from within a scenario observer.
To observe attachments, call the withAttachments method when constructing the observer. Optionally, a list of filenames or tags to observe can be provided, in which case, the callback will only be called when attachments that match the given filenames or tags are modified: 
var view = insight.getView();
view.withFirstScenario()
    .withAttachments()
    .notify(function (scenario) {
       var attachments = scenario.getScenarioAttachments();
       console.log('The scenario has ' + attachments.length +
          ' attachments');
    })
    .start();
view.withFirstScenario()
    .withAttachments({
        tags: ['input-sheet']
    })
    .notify(function (scenario) {
        var attachments =
           scenario.getTaggedScenarioAttachments('input-sheet');
        if (attachments.length) {
            var filename = attachments[0].getFilename();
            console.log('The input sheet was replaced with ' +
                filename);
        } else {
            console.log('The input sheet has been removed');
        }
    })
    .start();
Covered Topics
  • Downloading Attachments
    Most of the attachment methods on scenarios return an Attachment or list of Attachments.
  • Editing Attachment Properties
    The Attachment.openProperties() method opens the attachments dialog and automatically navigates to the given attachment so that it can be reviewed or edited.
  • Opening the Attachments Dialog
    The attachments dialog can also be opened in its usual form, allowing the user to upload, download, edit and delete attachments using the familiar web client user interface.
  • Uploading Attachments
    The attachments dialog can also be opened in a special mode which allows a user to upload a file and then have that file automatically tagged with a given attachment tag.
Parent Topic Working with Attachments

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.