Initializing help system before first use

Attachments

Topics covered in this chapter:

Types

insightattachment  : record
a record containing information about a single attachment
filename  : text
filename of the attachment
description  : text
description of the attachment
tags  : list of string
collection of tags associated with the attachment
size  : integer
size of the attachment, in bytes
lastModifiedUser  : text
name of the last Insight user to modify the attachment
lastModifiedDate  : datetime
date and time of last modification to attachment (UTC)
hidden  : boolean
whether the attachment is hidden from the UI
Note
Modifying an insightattachment record will not modify the attachment information on the server.
See also
insightlistappattach insightlistappattachbytag insightlistscenattach insightlistscenattachbytag insightscenattachinfo insightappattachinfo
insightattachmentrules  : record
a record containing information about the rules used by mminsight when verifying attachments.
maxsize  : integer
the maximum size, in bytes, that an attachment may have
maxattachcount  : integer
the maximum number of attachments that can be attached to a single scenario
maxfilenamelen  : integer
the maximum permitted length, in characters, of an attachment filename
invalidfilenamechars  : list of text
a list of characters that are not permitted in attachment filenames. Must be a list of single-character text values.
maxdescriptionlen  : integer
the maximum permitted length, in characters, of an attachment description
Note
This record is used only in test mode.
See also
insightsetattachrules insight_testmode
insightattachmenttag  : record
a record containing information about a tag defined in the app's companion file
name  : string
name of the tag
description  : string
description of the tag
mandatory  : boolean
whether the tag is mandatory
usage  : string
tag usage restrictions, either 'single-file' or 'multi-file'
Note
Modifying an insightattachmenttag record will not modify the attachment tag information on the server.
See also
insightlistattachtags

Subroutines

insightappattachinfo
Retrieves information about a given app attachment
insightattachstatus
Indicates the status of the most recent attempt to access or modify an attachment.
insightdeletescenattach
Deletes a scenario attachment.
insightgetappattach
Retrieves an app attachment from the Insight server, placing it in the Mosel working directory where it can be read by the model.
insightgetattachbytag
Searches the scenario and the containing app for an attachment or attachments with the given tag, and retrieves them from the Insight server, placing them in a directory where they can be read by the model. If any scenario attachments with the given tag are found, these are retrieved without searching the app. If no scenario attachments with the given tag are found, then the search continues at the app level.
insightgetattachrules
Retrieves the the 'rules' used to validate attachments and attachment meta-data.
insightgetscenattach
Retrieves an attachment from the Insight server for a given scenario, placing it in the Mosel working directory where it can be read by the model.
insightlistappattach
Retrieves a list of all the files attached to the app.
insightlistappattachbytag
Retrieves a list of all the files attached to the app with the given tag.
insightlistattachtags
Retrieves a list of the attachment tags defined in the companion file
insightlistscenattach
Retrieves a list of all the files attached to a given scenario.
insightlistscenattachbytag
Retrieves a list of all the files attached to a scenario with the given tag.
insightputscenattach
Uploads an attachment for the current scenario to the Insight server
insightrenamescenattach
Renames an existing scenario attachment.
insightscenattachinfo
Retrieves information about a given scenario attachment
insightsetscenattachdesc
Update the description of an existing scenario attachment.
insightsetscenattachhidden
Mark an existing scenario attachment as hidden or visible in the Xpress Insight UI.
insightsetscenattachtags
Update the tags of an existing scenario attachment.

Covered Topics
Parent Topic Insight 5 Mosel Reference

© 2001-2025 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.