App Interface Classes
|
This class represents the Xpress Insight application interface. Use this interface to access attachments and meta data like the scenario ID.
|
|
|
Adds the given ItemInfo object to the repository of item infos that are used in test mode.
|
|
|
Retrieves information about a given app attachment.
|
|
|
Property for the id of the Xpress Insight application which is the parent of the model.
|
|
|
Property for the name of the Xpress Insight application which is the parent of the model.
|
|
|
Read-only property indicating the status of the most recent attempt to access or modify an attachment.
|
|
|
Removes any ItemInfo objects previously added in test mode.
|
|
|
Deletes a scenario attachment.
|
|
|
Delete the internal working directory of the xpressinsight package.
|
|
|
Property for the execution mode in which Xpress Insight is running the model.
|
|
|
Retrieves an app attachment from the Insight server, placing in a location where it can be read by the model.
|
|
|
Gets Insight attachments by tag
|
|
|
Gets Insight attachments by tag
|
|
|
Retrieves the the 'rules' used to validate attachments and attachment meta-data.
|
|
|
Gets Insight attachments by tag.
|
|
|
Retrieves information about the context in which the app is currently executing (e.g. information about the Insight server and the DMP solution), including an authorization token if the app is executing in DMP.
|
|
|
Get information for a repository item with the supplied path.
|
|
|
Get information for items in the folder with the supplied path.
|
|
|
Returns a generator for reading the messages sent to the scenario.
|
|
|
Retrieves an attachment from the Insight server for a given scenario, placing it in a location where it can be read by the model.
|
|
|
Retrieves information about the solution database for the current DMP solution.
|
|
|
Retrieves a list of all the files attached to the app.
|
|
|
Retrieves a list of all the files attached to the app with the given tag.
|
|
|
Retrieves a list of the attachment tags defined in the companion file.
|
|
|
Retrieves a list of all the files attached to a given scenario.
|
|
|
Retrieves a list of all the files attached to a scenario with the given tag.
|
|
|
Appends one or more messages to the tail of the messages queue, in test mode. These messages will be retrieved by a future call to insight.get_messages.
|
|
|
Uploads a scenario attachment to the Insight server.
|
|
|
Renames an existing scenario attachment.
|
|
|
Resets the progress state for each Xpress Insight v4 progress metric back to their initial values.
|
|
|
Retrieves information about a given scenario attachment.
|
|
|
Property for the id of the Xpress Insight scenario.
|
|
|
Property for the name of the Xpress Insight scenario.
|
|
|
Property for getting the parent path of the Xpress Insight scenario.
|
|
|
Property for the path of the Xpress Insight scenario.
|
|
|
Stores the current values of the progress entities into the Xpress Insight v5 scenario.
|
|
|
Sets the 'rules' used to validate attachments and attachment meta-data.
|
|
|
Sets the list of tags that can be used in attachments
|
|
|
Sets the value that will be returned by queries for the InsightContext, in test mode. This value will be returned regardless of the environment requested by get_insight_context (since the environment only affects the solution token, not any of the other fields).
|
|
|
Update the description of an existing scenario attachment.
|
|
|
Mark an existing scenario attachment as hidden or visible in the Xpress Insight UI.
|
|
|
Update the tags of an existing scenario attachment.
|
|
|
Sets the value that will be returned by queries for the solution database, in test mode.
|
|
|
Property for the path to use for the attachments directory of the current app, when in test mode.
|
|
|
Property for the location to store mock attachments for app and scenario, when in test mode.
|
|
|
Property for the location of the app companion file to parse, when in test mode.
|
|
|
Read-only property to check whether the Insight application is running in test mode or in Insight.
|
|
|
Property for the path to use for the scenario attachments directory of the current scenario.
|
|
|
Sends a progress update notification for a single metric from the model to the Xpress Insight v4 system.
|
|
|
Property for the username of the Insight user that initiated the current scenario execution.
|
|
|
Property for the version number of the Insight server that is executing the scenario.
|
|
|
Read-only property for the internal working directory of the xpressinsight package.
|
|
|
An object containing information about the context in which the Insight app is executing.
|
|
|
An object containing information about the app's execution context within DMP.
|
|
|
Indicates the type of metric a progress update is providing.
|
|
|
Indicates the direction of optimization.
|
|
|
An object containing information about the shared MySQL solution database of the current DMP solution.
|
© 2001-2023 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.