Miscellaneous standard service tasks in Identity Manager

${sparPersonsokTask}

ssnFieldName

-

The name of the process variable where the SSN for the searched person is stored.

personFoundFieldName

Default value:

• SPAR_PersonFound

The name of the result variable where to put info if person was found or not. 

resultsPrefix

Default value:

• SPAR

The prefix for all the result variable names.

isVisibleNamn

Default value:

• false

Boolean value. If true, the info from "namn" will be returned. See Result below for more info.

isVisiblePersondetaljer

Default value:

• false

Boolean value. If true, the info from "persondetaljer" will be returned. See Result below for more info.

isVisibleFolkbokforing

Default value:

• false

Boolean value. If true, the info from "folkbokforing" will be returned. See Result below for more info.

isVisibleUtlandsadress

Default value:

• false

Boolean value. If true, the info from "utlandsadress" will be returned. See Result below for more info.

SPAR_PersonFound

always

If the person was found or not. Boolean value.

If the SSN is invalid, instead of this result, a BMPN error will be thrown (SPAR_VALIDATION). See "BPMN errors" below.

SPAR_Namn_Aviseringsnamn

isVisibleNamn = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/namn/

SPAR_Namn_Fornamn

isVisibleNamn = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/namn/

SPAR_Namn_Tilltalsnamn

isVisibleNamn = true

Integer value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/namn/

SPAR_Namn_Mellannamn

isVisibleNamn = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/namn/

SPAR_Namn_Efternamn

isVisibleNamn = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/namn/

SPAR_Persondetaljer_Sekretessmarkering

isVisiblePersondetaljer = true

Boolean value (not "JA", "NEJ" as in the SOAP response)

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/persondetaljer/

SPAR_Persondetaljer_SekretessmarkeringSattAvSPAR

isVisiblePersondetaljer = true

Boolean value (not "JA", "NEJ"  as in the SOAP response)

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/persondetaljer/

SPAR_Persondetaljer_SkyddadFolkbokforing

isVisiblePersondetaljer = true

Boolean value (not "JA", "NEJ"  as in the SOAP response)

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/persondetaljer/

SPAR_Persondetaljer_AvregistreringsorsakKod

isVisiblePersondetaljer = true

String value.

If the person is deceased, this variable will tell by a special code.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/persondetaljer/

SPAR_Persondetaljer_Fodelsedatum

isVisiblePersondetaljer = true

XMLGregorianCalendar value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/persondetaljer/

SPAR_Persondetaljer_FodelselanKod

isVisiblePersondetaljer = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/persondetaljer/

SPAR_Persondetaljer_Fodelseforsamling

isVisiblePersondetaljer = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/persondetaljer/

SPAR_Persondetaljer_Kon

isVisiblePersondetaljer = true

String value.

see documentation at https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/persondetaljer/

SPAR_Persondetaljer_SvenskMedborgare

isVisiblePersondetaljer = true

Boolean value (not "JA", "NEJ"  as in the SOAP response)

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/persondetaljer/

SPAR_Folkbokforing_DatumFrom

isVisibleFolkbokforing = true

XMLGregorianCalendar value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/folkbokfoering/

SPAR_Folkbokforing_FolkbokfordLanKod

isVisibleFolkbokforing = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/folkbokfoering/

SPAR_Folkbokforing_FolkbokfordKommunKod

isVisibleFolkbokforing = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/folkbokfoering/

SPAR_Folkbokforing_Hemvist

isVisibleFolkbokforing = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/folkbokfoering/

SPAR_Folkbokforing_Folkbokforingsdatum

isVisibleFolkbokforing = true

XMLGregorianCalendar value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/folkbokfoering/

SPAR_Folkbokforing_DistriktKod

isVisibleFolkbokforing = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/folkbokfoering/

SPAR_Utlandsadress_Utdelningsadress1

isVisibleUtlandsadress = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/internationell-adress/

SPAR_Utlandsadress_Utdelningsadress2

isVisibleUtlandsadress = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/internationell-adress/

SPAR_Utlandsadress_Utdelningsadress3

isVisibleUtlandsadress = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/internationell-adress/

SPAR_Utlandsadress_Land

isVisibleUtlandsadress = true

String value.

For more information, see https://www.statenspersonadressregister.se/master/start/teknisk-info/xml-scheman/20211/internationell-adress/

SPAR_VALIDATION

If there is a SOAP Fault with a validation error for the request sent. This means that either the SSN or some "iden" values (see the last four environment variables in "Prerequisites" above) are in the wrong format.

SPAR_CERTIFICATE

If the connection certificate file cannot be found, opened, or is invalid.

SPAR_TRUST_STORE

If the trust store cannot be found or opened.

SPAR_COMMUNICATION

If there is any other communication issue while sending the request or there is any SOAP fault response other than validation.

SPAR_MISSING_CONFIG_VARIABLES

If any of the required environment variables (see "Prerequisites" above) is missing. The message of the error has the comma-separated list of the missing variables.

CoreObjectListFieldName

Example value:

• Card_CoreObjectDescriptorList

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

OutputFieldName

Example value:

• Output

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

ConfigurationFilePath

Example value:

• C:\export_mapping.properties

Absolute file path of the configuration file, that should be used to create the request. The configuration file needs to be encoded in UTF-8, to ensure language specific characters are displayed correctly.

statusAfterExport

-

Example value:

• ordered

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

statusOnError

-

Example value:

• errorInProduction

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

SchemaVersion

Example value:

• 04 or 05

The Schema Version the file must be created as.

InputFolder

Example value:

• C:\Input

The folder which contains all the XML files.

ImportedFolder

Example value:

• C:\Imported

The folder which stores already imported XML files.

ProblemFolder

Example value:

• C:\Problem

The folder which contains XML files that could not be imported.

ConfigurationFilePath

Example value:

• C:\import_mapping.properties

The absolute path to the mapping file.

UniqueFieldName

Example value:

• Card_CardNumber

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

StatusMappingFieldName

Example value:

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

ImportFilesRegexPattern

-

Default value:

• ((DR_)|(CR_))\w{3}\d{10}\d{14}(?:_R)\.xml

The regular expression for importing files.

DescriptorsListOfModifiedObjects

-

Default value:

• DescriptorsListOfModifiedObjects

The name of the list in the process map that contains the modified objects after task execution.
When empty, no list will be provided.

subject

The subject of the event.

location

The location of the event.

startTime

The start time of the event.

endTime

The end time of the event.

targetField

-

Example value:

• ics_calendar

Specified where the .ics file shall be stored in the data map.

allDayEvent

-

Valid values:

• true

• false (default)

If set to "true" the event will be shown as an allDay event.

content

Defines the content of the event.

fieldName

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

reportName

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.

QRCodeLinkField

Example value:

• Person_Homepage

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

QRCodeOutputField

Example value:

• output

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

exportFilePath

Example value:

• C:/TEMP

Defines the folder into which the binary file shall be exported.

exportFileName

Example value:

• ${Person_FirstName}_${Person_LastName}.txt

Defines the name of the exported binary. 

exportDataMapTargetField

Example value:

• Person_Signature

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

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.

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

Valid values:

• true (default)

• false

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

Indicates the quality decrease step when trying to minimize the quality to reach the desired maxBinarySizeInKB.

csvField

Valid values::

• Binary Field

• Variable Binary Field

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

ErrorMessage

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

outputFieldName

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

photoFieldName

Photo field name in data map.

checkColor

-

Valid values:

• true

• false

Returns true if the portrait characteristics are based on color and false if they are based on Gray scale (intensity) image.

checkNaturalSkinColour

-

Valid values:

• true

• false

Natural colours in face region. Returns true if the face region has natural colors, otherwise false.

checkFrontal

-

Valid values:

• true

• false

The 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

-

Valid values:

• true

• false

Returns true if both eyes of the person are open.

checkEyesGazeFrontal

-

Valid values:

• true

• false

Returns true if the person’s eyes are looking frontal to the camera.

checkEyesNotRed

-

Valid values:

• true

• false

Returns true if both eyes pupils are not detected as red.

checkNoTintedGlasses

-

Valid values:

• true

• false

According to ISO 19794-5:2005 section 7.2.11 and best recommendations glasses should not be tinted.

checkSharp

-

Valid values:

• true

• false

Returns 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

-

Valid values:

• true

• false

Returns true if mouth is closed according to ISO 19794-5:2005 section 7.2.3 and appendix A 2.2.1

Url

Any String or JUEL expression

The URL endpoint where the data will be sent.

username

Any String or JUEL expression

The username for the HttpBasicAuth.

password

Any String or JUEL expression

This will be a secret field containing the password for the HttpBasicAuth.

myfield01

Any String or JUEL expression

This parameter is added as shown in the example above and will be added to the request body.

myCertificate01

Any String or JUEL expression

This parameter is added as shown in the example above and will be added to the request body.

includeHttpResponseBodyInProcessMap

Valid values:

• true

• false (default)

If the value is set to true, this parameter defines if the HTTP response body should be added to the process map. 

The parameter is only added if the HTTP status is successful (200).

httpResponseBodyVariableName

Example value:

• httpResponseBody

This parameter is added if the parameter includeHttpResponseBodyInProcessMap is set to true. It defines the name of the variable to use in the process map and it must be provided as a string. 

You can use the HTTP response body afterwards in a script task using the variable name that you defined.

200

Success

300

No exception and no reaction inside code

400

Throws Htppclientexception

500

Throws BPMNError

GuidDataPoolField

Example value:

• Card_Guid

Which data pool field to store the GUID in.