Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added service tasks regarding IN Groupe connector and Binary Export for 21.04.3

Expandall

Excerpt


Expand
titleCreate ICS Calendar Filea request for the IN Groupe connector

Description

Use this task to create an .ics file and store a request for the IN Groupe connector and place it in the data process map.  

Configuration

To use this task, configure the following delegate expression in your service task: 

Code Block
${createIcsFileParametrizedTaskcreateINGroupeRequestParameterizedTask}

 The following parameters can be configured in Identity Manager Admin: 

ParameterMandatoryDefault Example valueDescription
subjectCoreObjectListFieldName

The subject of the event.location

Image Removed

The location of the event.startTime

Image Removed

The start time of the event.endTime

Image Removed

The end time of the event.
targetField-ics_calendarSpecified where the .ics file shall be stored in the data map.
allDayEvent-falseIf set to "true" the event will be shown as an allDay event.
content

Image Removed

Defines the content of the event.

See following example as a reference:

Image Removed

Expand
titleCreate PDF

Description

Use this task to create a pdf and store it in the datamap. The pdf will be generated from a Jasper Reports template.

Card_CoreObjectDescriptorListName of the variable in the process map, which contains a list of CoreObjectDescriptors, that should be used to create the request.
OutputFieldName

Image Added

OutputName of the variable in the process map, where the request xml should be output to.
ConfigurationFilePath

Image Added

C:\export_mapping.propertiesAbsolute file path of the configuration file, that should be used to create the request.

statusAfterExport

-

orderedStatus that a card can take when the exporting was successfully done. 
statusOnError

-

errorInProductionStatus that a card can take when the exporting was not successfully done. 

Configuration file 

The configuration file is needed for Identity Manager to know which tag of the IN Groupe request schema should be mapped with the corresponding value from the core object. Format the configuration file as a .properties file. 

To set the value of a tag, you specify the type name of the parent tag and the tag you want to modify, for example:

Code Block
titleExample: Set a value of a tag
BatchRequestType_globalSchema = DEMANDES_2.1.XSD

The value can also be a juel expression which is available in the process map. Expressions that are always available:

  • ${CurrentDate} that resolves to the current date in "yyyyddMMhhmm" format, and
  • ${NumberOfIteration} which is a number that starts at 1 and is increased each time a core object is processed.

To set the "reference" attribute that is needed for, for example, "DataType", configure as follows: 

Code Block
titleExample: Set reference attribute
CardType_DataType|Numero_carte = 123456789

The part after the "|" symbol represents the reference value.


Expand
titleImport and process IN Groupe reports

Description

Use this task to read all IN Groupe report files from a folder and update any cards found inside.

Configuration

To use this task, configure the following delegate expression in your service task: 

Code Block
${importINGroupeReportsParameterizedTask}

 The following parameters can be configured in Identity Manager Admin: 

ParameterMandatoryExample valueDescription
InputFolder

Image Added

C:\InputThe folder which contains all the XML files.
ImportedFolder

Image Added

C:\ImportedThe folder which stores already imported XML files.
ProblemFolder

Image Added

C:\ProblemThe folder which contains XML files that could not be imported.

ConfigurationFilePath

Image Added

C:\import_mapping.propertiesThe absolute path to the mapping file.
UniqueFieldName

Image Added

Card_CardNumberThe name of the field by which each card can be identified.
StatusMappingFieldName

Image Added

StatusMapping

The name of the field that references a map, containing all the available mappings between a request status and a card status.

Note: The card status values must be present in the state graph, and the transitions from one state to another must be valid.

Configuration file 

The configuration file is needed for Identity Manager to know, which field of the IN Groupe report schema should be mapped with the corresponding value from the core object. The configuration file has to be formatted as a .properties file. 

To set the value of a tag, you specify the type name of the parent tag and the tag you want to modify (EntRecType_unRef in the example below). And, on the right side of the equals we have the datapool and the field where the value needs to be written (Card_UniqueReference in the example below).

Code Block
titleExample: Set a value of a tag
EntRecType_unRef = Card_UniqueReference

In the import mapping you also have constructs referring to complex objects from a list.  To set the "reference" attribute that is needed for, for example, "InfoType", configure as follows: 

Code Block
titleExample: Set reference attribute
InfoType|Serial_Number_CT = Card_CardNumber

The left part of the "|" symbol shows the "InfoType" tag, which is a list containing some complex objects. The right part of the "|" symbol identifies which complex objects you will take the value from, for example "Serial_Number_CT". The value will then be added to the "CardNumber" field of the Card datapool.


Expand
titleCreate ICS Calendar File

Description

Use this task to create an .ics file and store it in the data map.  

Configuration

To use this task, configure the following delegate expression in your service task: 

Code Block
${createIcsFileParametrizedTask}

The following parameters can be configured in Identity Manager Admin: 

ParameterMandatory

Default value

Description
subject

Image Added


The subject of the event.
location

Image Added


The location of the event.
startTime

Image Added


The start time of the event.
endTime

Image Added


The end time of the event.
targetField-ics_calendarSpecified where the .ics file shall be stored in the data map.
allDayEvent-falseIf set to "true" the event will be shown as an allDay event.
content

Image Added


Defines the content of the event.

See following example as a reference:

Image Added


Expand
titleCreate PDF

Description

Use this task to create a pdf and store it in the datamap. The pdf will be generated from a Jasper Reports template.

Configuration

To use this task, configure the following delegate expression in your service task:

Code Block
${generatePdfParametrizedTask}

 The following parameters can be configured in Identity Manager Admin: 

ParameterMandatoryDefault valueDescription
reportName

Image Added


The name of the Jasper Report. Must be available in Identity Manager Admin.

It can also be a JUEL Expression (for example, ${myDatapool_myReportNameField}. In this way, the template names from the process map are used dynamically.

fieldName

Image Added


The datamap field to which the pdf will be stored (as a byte[]).



Expand
titleCreate QR Code

Description 

Use this task to take a valid URL from the datamap and generate a QR code from it. 

Configuration

To use this task, configure the following delegate expression in your service task:

Code Block
${generatePdfParametrizedTaskgenerateQRCodeTask}

 The following parameters can be configured in Identity Manager Admin: 

Default valueThe datamap field to which the pdf will be stored (as a byte[])
ParameterMandatorySample ValueDescription
reportName

Image Removed

The name of the Jasper Report. Must be available in Identity Manager Admin.

It can also be a JUEL Expression (for example, ${myDatapool_myReportNameField}. In this way, the template names from the process map are used dynamically.

fieldName

Image Removed

QRCodeLinkField

Image Added

Person_HomepageDescribes the data map field in which the link is stored to create a QR code from.

QRCodeOutputField

Image Added

outputThe name of the output field to which the QR code ("jpg", byte[]) will be stored.



Expand
titleCreate QR CodeBinary Export

Description

 

Use this task to take export a valid URL binary file from the datamap and generate a QR code from it. into a file location on the hard drive (Server side).

Configuration

To use this task, configure the following delegate expression in your service task: 

Code Block
languagexml
${generateQRCodeTaskexportBinaryParametrizedTask}

 The following parameters can be configured in Identity Manager Admin: 

The name of the output field to which the QR code ("jpg", byte[]) will be stored
ParameterMandatorySample ValueDescription

QRCodeLinkField

Image Removed

Person_HomepageDescribes the data map field in which the link is stored to create a QR code from.

QRCodeOutputField

Image Removed

outputValueDescription
exportFilePath

Image Added

Example value:

  • C:/TEMP
Defines the folder into which the binary file shall be exported.
exportFileName

Image Added

Example value:

  • ${Person_FirstName}_${Person_LastName}.txt
Defines the name of the exported binary. 
exportDataMapTargetField

Image Added

Example value:

  • Person_Signature
Defines the datamap field from which the action should export the binary file.



Expand
titleImage Export

Description

Use this task to export an image from the datamap into a file location on the hard drive (Server side)The file extension will be automatically set depending on the image format.

Configuration

To use this task, configure the following delegate expression in your service task: 

Code Block
languagexml
${exportImageJavaDelegate}

The following parameters can be configured in Identity Manager Admin: 

ParameterMandatoryValueDescription
exportFilePath

Example value:

  • C:/TEMP
Defines the folder into which the image shall be exported.
exportFileBaseName

Example value:

  • ${Person_FirstName}_${Person_LastName}
Defines the base of the exported image. The export will append a time stamp so that it will result in, for example: John_Doe_2019-11-20_10-52-19.jpg
exportDataMapTargetField

Example value:

  • Person_Photo
Defines the datamap field from which the action should export the image.



Expand
titleImage Resize

Description

Use this task to define a ParametrizedAction which is capable of downsizing pictures inside of a Process.

Configuration

To use this task, configure the following delegate expression in your service task:

Code Block
languagexml
${resizeImageJavaDelegate}

The following parameters can be configured in Identity Manager Admin:

ParameterMandatoryDefault valueDescription
dataPoolSourceField


The datapool field in which the source image is stored.
dataPoolTargetField


The datapool field in which the target image shall be stored.
imageWidthInPx


The desired image width of the target image in px.
imageHeightInPx


The desired image height of the target image in px.
maxBinarySizeInKB-

Defines the maximum size the output file shall be. When the resize doesn't lead to the desired size, the action will perform a quality shrink (defined by spring parameter "qualityStep") as long as the size matches the size given by this parameter.

keepRatio

true

Boolean flag which indicates weather the aspect ratio of the image should be kept or not.

  • If set to true and the picture is in landscape format the dimensions are: (width = imageWithInPx | height = smaller than imageHeightInPx)
  • If set to true and the picture is in portrait format the dimensions are: (width = smaller than imageWidthInPx | height = imageHeightInPx)
qualityDescreaseStep-0.05Indicates the quality decrease step when trying to minimize the quality to reach the desired maxBinarySizeInKB.


This is a flowchart of the task:


Expand
titleImport CSV File

Description

Use this task to import all rows from a CSV file as core objects.

The following must apply:

  • The file must exist in the data map as byte array.
    • To achieve this, upload a CSV file in a prior user task.
    • As form field, use either a data pool field with data type "Binary Data" or a "Variable Binary Field". The "Binary Data Definition" should be "CSV" in both cases.

Whenever there is a problem with the import, no objects will be imported at all. An exception will be thrown with a message identifying the row or even the cell that caused the problem. This message will be logged, too.

Configuration

To use this task, configure the following delegate expression in your service task:

Code Block
languagexml
${importIdentitiesFromCSVTask}

The following parameters can be configured in Identity Manager Admin:

ParameterMandatoryDefault valueDescription
csvField


The field which contains the CSV file as byte array. You can use a Binary Field or a Variable Binary Field.
targetCoreTemplateName


The core template name which should be used for the new core objects. This should be based on a DAO based Datapool.

commaSeparatedListOfUniqueIdentifiers


Comma separated list of the fields which identify one unique core object.
maxNumberOfEntriesInCSV

This can be used to limit the number of core objects. If it's set and there are more entries in the CSV, an Exception will be thrown.

createdCoreObjectDescriptorListVarName

When used, the variable with the configured name will contain a list of CoreObjectDescriptors after the execution. The list describes the core objects that had been newly created by the action. Thus it's possible to perform subsequent operations on those core objects later in the process.
updatedCoreObjectDescriptorListVarName

Same as for createdCoreObjectDescriptorListVarName except that the list will contain the modified core objects.

When you configure the same name as for createdCoreObjectDescriptorListVarName the resulting list will contain descriptors for both types of core objects: newly created as well as modified.

mapping

Specifying a mapping provides manifold possibilities to configure the content of the CSV file. Without a mapping the following restrictions apply:

  • The CSV file must contain a header line.
  • The column headers must be literally equal to the datapool field names of the datapool of the target core template.
  • The delimiter must be a comma.

  • The format for dates must be dd-mm-yyyy.

  • The format for time values must be hh:mm:ss.
  • The format for datetime values must be dd-mm-yyyy-hh-mm-ss.

Also consider this:

  • When providing a mapping, its source data pool describes the CSV file while it's target data pool must be the datapool of the target core template.
  • The source data pool must have a data source of type "CSV File".
  • At the data source of the source data pool you can configure, whether the CSV file contains a header row or not.
  • At the data source of the source data pool you can configure the delimiter character used in the CSV file.
  • You may leave the data source's file name empty.
  • The data pool fields of the source data pool must match the columns of the CSV file in the correct order. All fields must be of type "Text". The field names can be chosen arbitrary.
  • The field mappings of the mapping define which columns of the CSV file are imported. You may omit fields of the source data pool. All fields of the target data pool that are contained in the commaSeparatedListOfUniqueIdentifiers must be mapped.
  • If the CSV file contains columns that are mapped to data fields of the target data pool of type date, time or datetime, you must configure the format with the field mapping.
  • See here for information about creating a new or editing an existing data pool.
  • See here for information about creating a new or editing an existing mapping.
errorMessageField
ErrorMessageIf this field is provided and an error occurs, a message containing the cause is not only logged but additionally put into the variable with the specified name.



Expand
titleValidate Uploaded Photos


Note

If you need to use this service task, please contact Nexus.

Description

Use this task to validate the uploaded photos. This task is compatible with FaceVACS-SDK 9.4.0.

Follow these steps:

  1. Install FaceVACS-SDK 9.4.0 on server.
  2. Import the valid license to sdk, see FaceVACS documentation.
  3. Copy the frsdkjava-9.4.0.jar in %TOMCATE_DIR%/lib. Normally the jar file is located in %FVSDK_9_4_0_DIR%/lib/x86_64/msc_14.1-sse4_crtdll/.
  4. The native library jfrsdkjni-9.4.0.dll has to be setup in TOMCAT. For example, set the CATALINA_OPTS in catalina.bat:
    • SET CATALINA_OPTS=-Djava.library.path="C:\FVSDK_9_4_0\lib\x86_64\msc_14.1-sse4_crtdll;C:/FVSDK_9_4_0/lib/x86_64/share"

Configuration

To use this task, configure the following delegate expression in your service task:

Code Block
languagexml
${cognitecFaceVACSValidationParametrizedTask}

The FRSDK configuration file have to be configured in the faceVACSObjectsCreater bean (needed at runtime). This file can be located in "%INSTALLDIR%/etc/frsdk.cfg".

Code Block
titleExample
<bean id="cognitecFaceVACSValidationParametrizedAction" class="de.vps.act.action.photo.validation.CognitecFaceVACSValidationParametrizedAction">
    <property name="faceVACSChecker">
        <bean class="de.vps.act.action.photo.validation.FaceVACSChecker">
            <property name="faceVACSObjectsCreator" ref="faceVACSObjectsCreator" />
        </bean>
    </property>
</bean>
 
<bean id="faceVACSObjectsCreator" class="de.vps.act.action.photo.validation.FaceVACSObjectsCreator">
    <constructor-arg value="C:/FVSDK_9_4_0/etc/frsdk.cfg" />
</bean>

The following parameters can be configured in Identity Manager Admin:

ParameterMandatoryDefault valueDescription
outputFieldName


On which variable the result of checking will be available in data map.
photoFieldName


Photo field name in data map.
checkColor-falseReturns true if the portrait characteristics are based on color and false if they are based on Gray scale (intensity) image.
checkNaturalSkinColour-falseNatural colours in face region. Returns true if the face region has natural colors, otherwise false.
checkFrontal-falseThe face is considered frontal if the rotation of the head is less than +/-5 degrees from frontal for yaw and pitch and if roll angle of head is less then +/-8 degrees.
checkEyesOpen-falseReturns true if both eyes of the person are open.
checkEyesGazeFrontal-falseReturns true if the person’s eyes are looking frontal to the camera.
checkEyesNotRed-falseReturns true if both eyes pupils are not detected as red.
checkNoTintedGlasses-falseAccording to ISO 19794-5:2005 section 7.2.11 and best recommendations glasses should not be tinted.
checkSharp-falseReturns true if the face area (from chin to crown and from left to right ear) fits the focus and depth in field characteristics(see ISO 19794-5:2005 section 7.3.3).
checkMouthClosed-falseReturns true if mouth is closed according to ISO 19794-5:2005 section 7.2.3 and appendix A 2.2.1




...