Adding Some Initial Annotations

Below, some initial annotations are added to the example model.

Change the declarations sections of the example so that they now read:

declarations
  !@insight.manage input
  !@insight.alias Set of all shares
  SHARES: set of string      ! Set of share types
  
  !@insight.manage input
  !@insight.alias Set of high risk shares
  RISK: set of string        ! Set of high-risk share types
  
  !@insight.manage input
  !@insight.alias Set of all North American shares
  NA: set of string          ! Set of shares issued in N. America
  
  !@insight.manage input
  !@insight.alias ROI per share type
  RET: array(SHARES) of real ! Estimated return on investment
 end-declarations

and

declarations
  !@insight.manage result
  !@insight.alias Outcomes
  frac: array(SHARES) of mpvar       ! Fraction of capital used per share
end-declarations

All entities have had aliases applied, and all have also been identified as either input entities or result entities.

It is good practice to use these and other comments and annotations when relevant as they make model code more readable—after all, they are comments—and help people who are unfamiliar with your app to quickly identify and categorize the key entities.

If you rebuild and republish the app to Xpress Insight, the entity explorer reveals that the changes have been applied:

Results of Adding some Initial Annotations

Selecting and deselecting the Show Aliases checkbox toggles the displayed entity names between their original model names and their aliases.

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