Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article describes how to set up an AriadNext connector. The connector generates a Two-Dimensional Document (2D-DOC) (a specific French barcode format) using the AriadNext external system. The purpose is to allow inclusion of data and ensure the authenticity of the document through digital signatures. 

Info
title<SMARTIDHOME>

In this article, <SMARTIDHOME> refers to /home/nexus, but this can be different depending on the setup.


Expand
titlePrerequisites
  • The Smart ID version needs to be 22.10.x as a minimum. 

Step-by-step instruction

Note
Ensure that you have the required authorization and certificate for accessing the AriadNext SOAP service before using this connector. See "Set up AriadNext" below for more information.

...

Expand
titleGenerate a barcode

To generate a barcode: 

  1. Add a new service task called MISC: Execute REST client call to your process. 

  2. Add the following parameters. The values are arbitrary and need to be updated: 

    ParameterMandatoryValueDescription
    URL

    http://{ariad-next-connector-host}:{ariad-next-connector-port}/api/barcodeThe URL endpoint where the data will be sent (must end with /api/barcode)
    username

    Any value to bypass the validation
    password

    Any value to bypass the validation
    includeHttpResponseBodyInProcessMap

    true

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

    httpResponseBody

    The variable name used in a process afterwards to extract the image from the response body
    markPosition

    Default value:

    • NONE

    Valid values:

    • TOP, BOTTOM, LEFT, RIGHT, NONE
    The position of the 2D-DOC mark
    outputFormat

    Default value:

    • PNG

    Valid values:

    • PNG, JPG, TIFF, GIF, BMP, TEXT, FONT_DMTX, FONT_ALPHA
    The format of the output
    issueCountry

    Default value:

    • FR
    The issue country of the document

    firstnames

    ${Person_Firstname} (to send multiple first names, use the comma separator)The first name(s)
    lastname

    ${Person_Lastname} The last name
    registrationNumber

    ${Person_RegistrationNumber}The registration number of the card owner
    organization

    ${Person_Organization}The organization
    documentId

    ${Person_DocumentId}The internal unique identifier of the document


    See a response example below:

    Code Block
    languagexml
    titleExample: Response
    <?xml version="1.0" encoding="UTF-8"?>
    <data>
        <field name="image">image encoded as base 64</field>
        <field name="width">21.599999999999998</field> <!-- width in millimeters -->
        <field name="height">21.599999999999998</field> <!-- height in millimeters -->
    </data>


  3. Use the groovy script below to de-serialize the data and decode the image if applicable in another task of your process:

    def data = new de.nexus.utils.operators.XmlConverter(new StringReader(httpResponseBody)).asJaxBObject(de.nexus.data.xml.Data.class)
    def imageAsBase64 = data.toMap().get("image")
    def image = java.util.Base64.getDecoder().decode(imageAsBase64)
     
    Card_2DDOC = image



Expand
titleSet up AriadNext

The AriadNext system is configurable using the config/ariad-next.yaml file. You can configure host, security, and image polish settings in the configuration file.

Docker

  1. Open the environment file <SMARTIDHOME>/compose/smartid.env for editing. 

  2. Set the properties for the following three variables to fit your deployment:

    PRIME_CONNECTORS_VERSION=2305.0.0
    # -- AriadNext properties
    ARIAD_NEXT_CONNECTOR_PORT=7077
    ARIAD_NEXT_CONNECTOR_CERT_RESOLVER=le
    ARIAD_NEXT_CONNECTOR_PREFIX=ariad-next-connector


  3. Update the docker/compose/identitymanager/ariad-next-connector/docker-compose.yml

Tomcat (stand-alone)

  1. Adapt the config files in the WEB-INF/classes/config folder.

...