NevisIDMHistorySource
The NevisIDMHistorySource
is used to query for historic data managed by the nevisIDM software. It makes use of the nevisIDM administration web service which has to be provided in form of a NevisIDMConnectionPool
.
The NevisIDMHistorySource
can be used to query the history of units, users, profiles and credentials. The query can be refined by providing query values for certain search fields. The name of these fields are dependent on the query type.
The data objects resulting from the web service call are made available through the values
attribute. The fields of the objects can then easily be accessed using EL expressions. In addition, properties are made available through the attribute map properties
.
Configuration
Name | Type, usage constraints, defaults | Description |
---|---|---|
service | required: paraVal default: none type: NevisIDMConnectionPool | The NevisIDMConnection pool providing access to the nevisIDM administration web service. |
queryType | required: paraVal default: none type: query type string | Determines which nevisIDM entity is queried:unit : query for unitsuser : query for userprofile : query for profilescredential : query for credentials |
searchFields | optional: paraMap default: empty maptype: string/string map | Defines the values and fields to search. The names of the fields depend on the type of the query. See below for a complete list of fields to be used in a query. It can be used to restrict the search for a given client. |
dateFrom, dateTo | optional: paraVal default: none type: date | Query the history in a range of two dates. |
operation | optional: paraVal default: none type: operation type | Query only history entries of a specified operation type. insert ; update ; delete |
actorExtId | optional: paraVal default: none type: string | Query only history entries of the user specified by this ext ID. |
record | optional: paraList default: none type: list of integers | The parameter record is used to only fetch the history entries specified, e.g., by specifying 1 and 2 only the first and second records are returned. |
versionTo | optional: paraVal default: none type: integer | The version number to which the source shall retrieve historic entries. |
versionFrom | optional: paraVal default: none type: integer | The version number from which the source shall retrieve historic entries. |
numRecords | optional: paraVal default: none type: integer | The number of historic entries the source shall retrieve. |
Example
- Query the history of a profile and only select the second history entry. This is used to retrieve the state of a profile before it was deleted.
<dataSource type="NevisIDMHistorySource">
<dp:paraVal name="service" value="${inst.nevisIdm}" />
<dp:paraVal name="queryType" value="profile" />
<dp:paraMap name="searchFields">
<value name="extId" value="#{rtCfg['profile.extid']}" />
</dp:paraMap>
<dp:paraList name="record">
<value>2</value>
</dp:paraList>
</dataSource>
- Query a set of versions:
<dataSource type="NevisIDMHistorySource">
<dp:paraVal name="service" value="${inst.nevisIDM}"/>
<dp:paraVal name="queryType" value="user"/>
<dp:paraMap name="searchFields">
<value name="loginId" value="myuser" />
</dp:paraMap>
<dp:paraVal name="versionFrom" value="5" />
<dp:paraVal name="numRecords" value="3" />
</dataSource>