Configuring App-Specific Help

You can configure the app’s companion file so that when the user clicks the Help link in the web client they are directed to help relating to the app rather than Xpress Insight.

This only applies when the user is on the app page.

To enable app specific help, you need to add a line to the app’s companion file.

External URL example:

<?xml version="1.0"?> 
<model-companion 
 xmlns=”http://www.fico.com/xpress/optimization-modeler/model-companion” version="3.0"> 
 <help-url>https://my.external.help.url</help-url>
...

Note: A link is treated as absolute if it contains a scheme (such as https://). Otherwise it is treated as relative to client_resources.

Relative URL example:

<?xml version="1.0"?> 
<model-companion 
 xmlns=”http://www.fico.com/xpress/optimization-modeler/model-companion” version="3.0"> 
 <help-url>path/relative/to/client_resources</help-url>
...

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