Initializing help system before first use

dmpinitcomp

Purpose
Initialize a dmpresource to access a DMP component.
Synopsis
procedure dmpinitcomp(res:dmpresource, type:text)
procedure dmpinitcomp(res:dmpresource, id:text, type:text, name:text, env:text)
procedure dmpinitcomp(res:dmpresource, comp:dmpcomponent)
procedure dmpinitcomp(res:dmpresource, comp:dmpcomponent, env:text)
procedure dmpinitcomp(res:dmpresource, inst:dmpcompinst)
Arguments
res 
The dmpresource value to initialize.
id 
The ID of the component you want to access (or empty string)
type 
The type of the component you want to access (or empty string)
name 
The name of the component you want to access (or empty string)
comp 
Value containing the ID, type and name of the component
inst 
Value containing the component ID and lifecyce environment you want to access
env 
The lifecycle stage of the component instance you want to access (or empty string), one of:
DMP_ENV_DESIGN 
Design or Root
DMP_ENV_STAGING 
Staging
DMP_ENV_PRODUCTION 
Production
Example 
declarations
  res: dmpresource
end-declarations
dmpinitcomp(res,"Xpress Executor")
if res.status<>DMP_OK then
  writeln('ERROR: ',res.lasterror)
end-if
Further information
1. This procedure will initialize a dmpresource to access another component in the same solution as the component executing the model.
2. You can pass an empty string if you don't want to specify any of the arguments, but you must specify at least one of id, type, name or comp.
3. If you specify a component type and a component of this type does not exist in the solution, this function will look for a component whose type contains the type string you specified (e.g. passing type Xpress Insight may return a component of type Xpress Insight 5 if one exists).
4. Where multiple components in the solution match the values you specified, the dmpresource will be initialized to access an arbitrarily selected component.
5. If you don't specify a lifecycle environment, the lifecycle of the component executing the model will be used.
6. When running in a solution with isolated lifecycles, you will only be able to access component instances from the same or lower lifecycle as the current component - e.g. a model run by a component in Staging can access resources in Staging and Design but not resources in Production.
7. You should check the status attribute of the dmpresource after calling this procedure.

Parent Topic Procedures and functions

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