← Back to plugin index

Vasco Token Report Strategy

Description
This task strategy plugin iterates over token records and - if certain conditions are met - executes a report renderer on the token. It is thought to produce for example letters for newly issued tokens.

The task uses a token persister plugin to go through the set of tokens for which a report should be rendered using the configured report renderer.

Type name
VascoTokenReportStrategy
Class
com.airlock.iam.servicecontainer.app.application.configuration.task.token.VascoTokenReportStrategyConfig
May be used by
License-Tags
Digipass
Properties
Manage Token Data Provider (manageTokenDataProvider)
Description
The token data provider plug-in is used to access all tokens (not only those for which a report should be created).(e.g. to retrieve a new token to be assigned)
Should be configured to return all accessible tokens.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Select New Token (selectNewToken)
Description
Controls whether a the next available token should be automatically assigned if no hardware token is assigned.
Attributes
Boolean
Optional
Default value
false
Vasco Token Service (vascoTokenService)
Description
The service layer.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Token Data Provider (tokenDataProvider)
Description
The token data provider plugin is used to read all tokens to be handled by this task. Should be configured to only return the tokens that should be handled by this task.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Report Type Short Desc (reportTypeShortDesc)
Description
Defines a short textual description of the type of the report being rendered.
The text is used in the user trail log written when a report is rendered. Please specify a text like in the examples below, so it suits the structure of the log statement it is used in.
Attributes
String
Optional
Default value
UNSPECIFIED
Example
password letter
Example
keyfile accompanying report
Example
mobile number registration letter
User Store (userStore)
Description
The user store to retrieve all user data.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Report Renderer (reportRenderer)
Description
Tells this task which generic renderer to use to render reports.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Barcode Generator (barcodeGenerator)
Description

Optional barcode generator. If this property is configured, a barcode image and the corresponding barcode content are added to the parameter map accessible by report templates. The following keys are defined:

  • BarcodeImage: placeholder for the barcode image.
  • BarcodeContent: placeholder for the barcode content.
  • BarcodeContentDisplay: placeholder for the barcode content in a human-readable format.

Tracking ID: If the "tracking ID" field is configured in the token data provider the generated barcode content is automatically stored in the token. This is useful for future reference, e.g., for tracking active shipments.

Attributes
Plugin-Link
Optional
Assignable plugins
Language Attribute Name (languageAttributeName)
Description
Tells the report task which attribute in the context data container contains the language to be used for rendering the password. If this property is configured and if the context data container of the user has a value for this attribute, it is used when calling the report renderer plug-in.
Attributes
String
Optional
Suggested values
language
Output Directory (outputDirectory)
Description
Directory in the file system to put the rendered reports in. The directory is either absolute or relative to the JVMs current directory.

This property is not required if the renderer plugin (see separate property) does not write on the outputstream (e.g. sends it somewhere else). It is required otherwise.

Note: If this property is not defined and the used renderer plugin writes on the output stream, then the result (e.g. a PDF file) is lost.

Attributes
File/Path
Optional
Working Directory (workingDirectory)
Description
A writable directory used to store partial reports.
If this property is defined, the credential reports are not directly generated into the output directory (see other property) but they are generated into this working directory and are moved to the output directory once they are done.
This helps to solve problems with processes automatically reading the rendered reports and reading partial reports during the generation process. Make sure that the working directory and the output directory reside in the same file system (if not the moving of the generated file will not be atomic).
The directory is either absolute or relative to the JVMs current directory.
Attributes
File/Path
Optional
Delete Old Reports (deleteOldReports)
Description
Deletes old rendered reports of a user from the file system when a new one is rendered. Setting this to TRUE results in at most one rendered report of this type per user.
Caution: This feature will delete all reports starting with the prefix configured by property "file-name-prefix" and the user's name. Thus you must make sure, that different report types use different filename prefixes.
Attributes
Boolean
Optional
Default value
false
File Name Prefix (fileNamePrefix)
Description
Filename prefix for rendered report files. It is important to set this to a unique value for the kind of reports generated by this task. When this task deletes old reports, it looks at this prefix (and the user id) in order to find out what files to delete. Thus, if this prefix is the same as for other reports and the reside in the same directory, other reports may be deleted.
Do not use the prefix "pwd-" or the empty prefix if password- or tokenlist reports are stored in the same directory. The latter is used as default for token lists (matrix card) and the former for password letters.
Attributes
String
Mandatory
Example
token-letter
Example
smartcardLetter
File Name Suffix (fileNameSuffix)
Description
Filename suffix for rendered report files. The indicated suffix is appended to the generated reports. This may be required if the files are processed (e.g. printed) by another process (manual or automatic).
Attributes
String
Mandatory
Suggested values
.pdf, .docx, .txt
Aggregate Report (aggregateReport)
Description
Optional property to describe an aggregate report over all generated reports in a batch. If none is configured, no aggregate report will be generated.
Attributes
Plugin-Link
Optional
Assignable plugins
Required Order Options (requiredOrderOptions)
Description
Order options that have to be set for this task to handle the order. Leave empty handle all orders with the "order new" flag set. Several options can be comma-separated, in which case ALL listed options must be set for an order to be handled.
Attributes
String-List
Optional
Excluding Order Options (excludingOrderOptions)
Description
Order options that, if set, will exclude the order from being handled by this task. Leave empty to not exclude any orders. Several options can be comma-separated, in which case ANY listed option excludes the order from being handled by this task.
Attributes
String-List
Optional
YAML Template (with default values)

type: VascoTokenReportStrategy
id: VascoTokenReportStrategy-xxxxxx
displayName: 
comment: 
properties:
  aggregateReport:
  barcodeGenerator:
  deleteOldReports: false
  excludingOrderOptions:
  fileNamePrefix:
  fileNameSuffix:
  languageAttributeName:
  manageTokenDataProvider:
  outputDirectory:
  reportRenderer:
  reportTypeShortDesc: UNSPECIFIED
  requiredOrderOptions:
  selectNewToken: false
  tokenDataProvider:
  userStore:
  vascoTokenService:
  workingDirectory: