Configurer une application Appian personnalisée pour fonctionner avec ABBYY FlexiCapture Connector for Appian

Pour permettre à une application Appian personnalisée d’interagir avec ABBYY FlexiCapture Connector for Appian, créez plusieurs entités. Cette page décrit les deux règles d’expression AFC et les deux méthodes API Web requises par le connecteur. Pour les autres entités, voir Modifier l’application ABBYYFlexiCapture.

Avant de créer ces entités, assurez-vous que le plugin ABBYYFlexiCapturePlugin.jar est installé sur le serveur Appian. Pour l’installer, copiez le plugin depuis le package de distribution du connecteur dans le dossier APPIAN_INSTALL/_admin/plugins/.

Créez les entités suivantes dans l’ordre :

Créer un type de données.
Créer une source de données.
Créer un magasin de données.
Créer un type d’enregistrement.
Créer une constante de type Data Store Entity pour lier le magasin de données au type de données.
Créer une règle AFC_GetConstantDSEByRecordTypeName qui renvoie une constante de type Data Store Entity.
Créer une règle AFC_GetDataTypeByRecordTypeName qui renvoie le nom complet du type de données.
Créer un dossier de type Knowledge Center pour stocker les fichiers traités reçus depuis ABBYY FlexiCapture.
Créer la méthode API Web UploadDocument pour ajouter un nouveau document au Knowledge Center.
Créer la méthode API Web CreateRecord pour alimenter la table de base de données.

Créer une règle AFC_GetConstantDSEByRecordTypeName

La méthode CreateRecord de API Web nécessite une règle qui renvoie une constante de type Data Store Entity. Cette règle détermine le magasin de données et le type de données dans lesquels un record est créé.

Créer une nouvelle règle d'expression

Dans Appian Designer, ouvrez l’application et cliquez sur New → Expression Rule.

Nommer et enregistrer la règle

Sélectionnez Create from scratch, renseignez les champs Name et Save In, puis cliquez sur Create & Edit.

Ajouter l'input RecordTypeName

Dans la boîte de dialogue Rule Inputs, cliquez sur l’icône + et ajoutez une variable d’entrée de type Text nommée RecordTypeName.

Coller l'expression

Dans l’éditeur de code à gauche, collez l’expression suivante :

if(ri!RecordTypeName == "New Records", /* Dans le paramètre RecordTypeName, indiquez le nom du nouveau type d’enregistrement au pluriel.  */
    cons!New_Constant, /* Après cons!, indiquez le nom de la constante du type d’enregistrement. */
    null /* S'il y a plusieurs types d’enregistrement dans l'application, remplacez "null" par la même condition "if" que ci-dessus, en indiquant le nom du deuxième type d’enregistrement et le nom de sa constante. */
)

Si l’input RecordTypeName correspond au nom d’un type d’enregistrement stocké (au pluriel), la règle renvoie la constante Data Store Entity qui relie le magasin de données au type de données.

Créer une règle AFC_GetDataTypeByRecordTypeName

La méthode CreateRecord de la API Web nécessite une règle qui renvoie le nom complet du type de données.

Créer une nouvelle règle d'expression

Dans Appian Designer, ouvrez l’application et cliquez sur New → Expression Rule.

Nommer et enregistrer la règle

Sélectionnez Create from scratch, renseignez les champs Name et Save In, puis cliquez sur Create & Edit.

Ajouter l'entrée RecordTypeName

Dans la boîte de dialogue Rule Inputs, cliquez sur l’icône + et ajoutez une variable d’entrée de type Text nommée RecordTypeName.

Coller l'expression

Dans l’éditeur de code à gauche, collez l’expression suivante :

if(ri!RecordTypeName == "New Records", /* Dans le paramètre RecordTypeName, indiquez le nom du nouveau type d’enregistrement au pluriel, le nom complet du type de données et l’espace de noms du type d’enregistrement. */
    'type!{urn:com:appian:types}NewDataType',
    null
    /* S’il existe plusieurs types d’enregistrement dans l’application, remplacez "null" par la même condition "if" que ci-dessus, en indiquant le nom du deuxième type d’enregistrement, le nom complet du type de données et l’espace de noms du type d’enregistrement. */
)

Si l’entrée RecordTypeName correspond au nom d’un type d’enregistrement stocké (au pluriel), la règle renvoie une string contenant le nom complet du type de données. Sinon, elle renvoie null. Pour trouver l’espace de noms, ouvrez le type de données dans l’application ABBYYFlexiCapture, puis cliquez sur le nom du type de données dans l’angle supérieur gauche pour ouvrir la fenêtre Data Type Properties.

Créer la méthode d’API Web UploadDocument

Créer une API Web

Dans Appian Designer, ouvrez l’application et cliquez sur New → Web API.

Nommer l’API Web

Saisissez UploadDocument dans les champs Name et Endpoint, remplacez HTTP Method par POST, puis cliquez sur Create & Edit.

Coller le code

Fermez la boîte de dialogue de sélection du modèle, puis collez le code suivant dans l’éditeur de code :

with(
    local!value: http!request.body,
    a!httpResponse(
        statusCode: 200,
        headers: {},
        body: uploaddocument(local!value)
    )
)

La méthode uploaddocument(String query) n’apparaît dans l’éditeur de code que si le fichier ABBYYFlexiCapturePlugin.jar se trouve dans le dossier APPIAN_INSTALL/_admin/plugins/. Cette méthode envoie directement à la méthode Java que vous avez créée une chaîne JSON contenant le contenu du fichier, puis renvoie une chaîne JSON avec l’ID du dossier dans lequel le document a été placé.

Créer la méthode d’API Web CreateRecord

Créer une nouvelle API Web

Dans Appian Designer, ouvrez l’application et cliquez sur New → Web API.

Nommer l’API Web

Saisissez CreateRecord dans les champs Name et Endpoint, définissez HTTP Method sur POST, puis cliquez sur Create & Edit.

Coller le code

Fermez la boîte de dialogue de sélection de modèle, puis collez le code suivant dans l’éditeur de code :

with(
    local!value: cast(
        rule!AFC_GetDataTypeByRecordTypeName(http!request.queryParameters.RecordTypeName),
        a!fromJson(http!request.body)
    ),
    a!writeToDataStoreEntity(
        dataStoreEntity: rule!AFC_GetConstantDSEByRecordTypeName(http!request.queryParameters.RecordTypeName),
        valueToStore: local!value,
        onSuccess: a!httpResponse(
            statusCode: 200,
            headers: {
                a!httpHeader(name: "Content-Type", value: "application/json")
            },
            body: a!toJson(
                fv!storedValues
            )
        ),
        onError: a!httpResponse(
            statusCode: 500,
            headers: {
                a!httpHeader(name: "Content-Type", value: "application/json")
            },
            body: a!toJson(
                {
                    error: "There was an error writing to the data store"
                }
            )
        )
    )
)

rule!AFC_GetDataTypeByRecordTypeName(http!request.queryParameters.RecordTypeName) prend en paramètre le nom du type d’enregistrement (reçu par la méthode d’API Web depuis ABBYY FlexiCapture Connector for Appian) et renvoie le nom complet du type de données.
rule!AFC_GetConstantDSEByRecordTypeName(http!request.queryParameters.RecordTypeName) renvoie la constante Data Store Entity.

Ajouter le paramètre de requête

Dans le volet de droite, cliquez sur le bouton New Query Parameter et ajoutez un paramètre nommé RecordTypeName à la chaîne de requête.
Sélectionnez l’option Set as default test value et cliquez sur Save.

UiPath

Blue Prism

Automation Anywhere

WinActor

Appian

Pega

M-Files

Laserfiche

NX Manager

Configurer une application Appian personnalisée pour fonctionner avec ABBYY FlexiCapture Connector for Appian

Créer une règle AFC_GetConstantDSEByRecordTypeName

Créer une règle AFC_GetDataTypeByRecordTypeName

Créer la méthode d’API Web UploadDocument

Créer la méthode d’API Web CreateRecord

​Créer une règle AFC_GetConstantDSEByRecordTypeName

​Créer une règle AFC_GetDataTypeByRecordTypeName

​Créer la méthode d’API Web UploadDocument

​Créer la méthode d’API Web CreateRecord

Créer une règle AFC_GetConstantDSEByRecordTypeName

Créer une règle AFC_GetDataTypeByRecordTypeName

Créer la méthode d’API Web UploadDocument

Créer la méthode d’API Web CreateRecord