xpressinsight.AppInterface.set_scen_attach_tags
xpressinsight.AppInterface.set_scen_attach_tags |
Purpose
Update the tags of an existing scenario attachment.
Synopsis
set_scen_attach_tags(self, filename: str, tags: List[str]) -> None
Arguments
|
filename
|
The filename of the scenario attachment to update.
|
|
tags
|
The new tags to apply to the attachment. Any existing tags will be removed.
|
Example
Example of setting the tags of a scenario attachment
my_attach.dat to be "mytag1" and "mytag2"
>>> insight.set_scen_attach_tags('my_attach.dat',
... ['mytag1', 'mytag2'])
... if insight.attach_status == AttachStatus.OK:
... print("Attachment tags updated ok")
... else:
... print("Error updating attachment")
Further information
1. Check the attachment status code using
insight.attach_status to determine whether the new attachment tags were accepted.
2. The attachment will not be updated on the Insight server until the scenario completes.
3. Attempting to access attachments when the model is not being run through Xpress Insight will cause the model to abort with an error.
4. If any of the specified tags are single-file tags, they will be removed from other scenarios as part of this operation.
Related topics
