Initializing help system before first use

Attachments

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
hidden  : boolean
whether the attachment is hidden from the UI
Note
Modifying an insightattachment record will not modify the attachment information on the server.
insightattachmenttag  : record
a record containing information about a tag defined in the project's companion file
name  : string
name of the tag
description  : string
description of the tag
mandartory  :
whether the tag is mandatory
usage  : string
tag usage restrictions, either 'single-file' or 'multi-file'
mandatory  : boolean
Note
Modifying an insightattachmenttag record will not modify the attachment tag information on the server.

Subroutines

insightattachstatus
Indicates the status of the most recent attempt to access or modify an attachment.
insightdeletescenattach
Deletes a scenario attachment.
insightgetattachbytag
Searches the scenario and the containing project for an attachment or attachments with the given tag, and retrieves them from the Insight server, placing them in the Mosel working 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 project. If no scenario attachments with the given tag are found, then the search continues at the project level.
insightgetprojattach
Retrieves a project attachment from the Insight server, placing it in the Mosel working directory where it can be read by the model.
insightgetscenattach
Retrieves an attachment from the Insight server either for a given scenario, placing it in the Mosel working directory where it can be read by the model.
insightlistattachtags
Retrieves a list of the attachment tags defined in the companion file
insightlistprojattach
Retrieves a list of all the files attached to the project.
insightlistprojattachbytag
Retrieves a list of all the files attached to the project with the given tag.
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.
insightprojattachinfo
Retrieves information about a given project attachment
insightputscenattach
Uploads a scenario attachment to the Insight server, reading it from the Mosel working directory.
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.