Initializing help system before first use

Context

Topics covered in this chapter:

Types

insightcontext  : record
a record containing information about the context in which the app is executing.
insighturl  : string
the URL of the Insight component executing the app.
traceid  : text
the B3 Propagation TraceId value; every span in a trace shares this ID.
spanid  : text
the B3 Propagation SpanId value.
parentspanid  : text
the B3 Propagation ParentSpanId value, or an empty string if not present.
sampled  : text
the B3 Propagation Sampled value; either "1", "0" or empty string if not present.
dmp  : insightdmpcontext
record containing context information relating to DMP.
Note
Use the ispopulated field of the dmp record to distinguish between an app executing within DMP ( true) and on-premise ( false).
See also
insightdmpcontext  : record
a record containing information about the context in which the app is executing in DMP.
ispopulated  : boolean
whether the other fields of this record have meaningful values. false when the app is executing outside DMP.
managerurl  : string
the URL of DMP Manager, which can be used to call DMP Manager webservice endpoints.
environment  : string
the lifecycle environment of the component instance exeucting the Insight app, e.g. "design".
tenantid  : string
the ID of the DMP tenant to which the Insight component belongs.
solutionid  : string
the ID of the DMP solution to which the Insight component belongs.
componentid  : string
the ID of the Insight component that is executing the app.
compinstid  : string
the ID of the Insight component instance that is executing the app.
soltoken  : text
a bearer token that can be used to authorize requests to this component and other DMP resources, under the authority of the solution user.
soltokenexpiry  : real
the expiry time of the given solution token, expressed in milliseconds since 1/1/1970.
soltokenenv  : string
the lifecycle environment for which the solution token was authorized, e.g. "design".
pftoken  : text
a bearer token that can be used to authorize requests for the platform resources, under the authority of the platform client id.
pftokenexpiry  : real
the expiry time of the given platform token, expressed in milliseconds since 1/1/1970.
Notes
1. The ispopulated field of this record can be used to distinguish between an app executing within DMP ( true) and on-premise ( false).
2. Where a specific environment was passed to insightgetcontext, the returned solution token will be a token for that environment. Otherwise, it will be a token for the component's current environment.
See also
insightsoldb  : record
a record containing information about the solution database in the DMP solution in which the app is executing.
drivername  : string
the name of the ODBC driver that can be used to connect to the solution database.
server  : string
the hostname of the solution database server.
port  : integer
the port on which to connect to the solution database server.
username  : string
the username to use for accessing to the solution database.
password  : text
the password to use for accessing to the solution database.
database  : string
the name of the solution database.
odbcparams  : array(set of string) of text
additional parameters that Insight recommends be used in the ODBC connnection string.
See also

Subroutines

Get information about the context in which the app is executing (e.g. information about Insight server and any DMP solution), including an authorization token for any DMP solution.
Get information about the solution database for the current DMP solution.
Get an ODBC connection string for the solution database in the current DMP solution.

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