ANVEDI Integration

L’codeunit ANVEDI Integration contient tous les appels API publics au module EDI, que vous pourriez vouloir appeler à partir de votre code personnalisé. Toutes les fonctions de cette codeunit sont censées être utilisées si vous souhaitez lancer directement une action EDI par code.

Concepts généraux

Dans cette section, nous aborderons d’abord les concepts de base, que vous devez comprendre pour pouvoir lire les exemples de code.

Transactions des utilisateurs

Anvaigo EDI Connect dispose d’un concept appelé « transactions utilisateur », qui peut couvrir plusieurs transactions de base de données et collecter plusieurs erreurs. La plupart des actions d’Anvaigo EDI Connect nécessitent une transaction utilisateur ouverte pour être exécutées. Vous pouvez lancer une transaction utilisateur en appelant

// Start a new user transaction with the description given by TextDescription
ANVEDIIntegration.BEGIN_USER_TRANSACTION(TextDescription);

// Your EDI code

// End the user transaction and show an error list, if there were any
ANVEDIIntegration.END_USER_TRANSACTION(TRUE, FALSE);

L’appel à END_USER_TRANSACTION permet soit d’afficher les erreurs, soit d’interrompre la transaction de base de données en cours, soit d’obtenir une valeur de retour indiquant s’il y a eu une erreur. Nous y reviendrons en détail plus tard.

BEGIN_USER_TRANSACTION

Démarre une nouvelle transaction d’utilisateur. Veuillez noter que vous n’intégrez les appels dans le module EDI qu’aux points où un COMMIT peut avoir lieu. Dans de nombreux cas, le module validera toutes les modifications apportées à la base de données avant d’exécuter la logique EDI. Vous pouvez également envisager de marquer les données et d’utiliser une tâche d’arrière-plan pour exécuter la logique EDI.

Le texte donné est affiché à l’utilisateur si une boîte de dialogue d’attente est ouverte, car le processus prend du temps.

BEGIN_USER_TRANSACTION(Text : Text[1024])

Vous devez toujours terminer un appel à BEGIN_USER_TRANSACTION par un appel à END_USER_TRANSACTION.

SHOWDIALOGS

Cette fonction peut être utilisée pour masquer toutes les boîtes de dialogue EDI.

SHOWDIALOGS(ShowDialogs : Boolean)

Ce paramètre indique si les boîtes de dialogue sont affichées ou non. L’appel à cette fonction doit se faire à l’intérieur d’une transaction utilisateur. Normalement, cette fonction est appelée directement après BEGIN_USER_TRANSACTION.

ISPROCESSING

Cette fonction indique si vous vous trouvez dans une exécution mapping. Vous pouvez vérifier cette valeur lors de la validation des déclencheurs, par exemple, pour obtenir un comportement différent lors du traitement des processus EDI. Vous pouvez également utiliser cette valeur pour afficher les boîtes de dialogue de saisie uniquement lorsque vous ne traitez pas d’EDI.

END_USER_TRANSACTION

Cette fonction met fin à la transaction d’un utilisateur.

END_USER_TRANSACTION(ShowErrorList : Boolean; BreakOnError : Boolean) Success : Boolean

Travailler avec des transactions commerciales

RUN_BUSINESSTRANSACTION_JOB

Exécute le travail de collecte de données d’un type de transaction spécifié. Elle doit être appelée à l’intérieur d’une transaction utilisateur.

RUN_BUSINESSTRANSACTION_JOB(BusinessTransactionTypeCode : Code[20])

// Start a new user transaction with the description given by TextDescription
ANVEDIIntegration.BEGIN_USER_TRANSACTION(TextDescription);

// Collects the data of the Business Transaction Type "INVOICE_OUT" and processes the mappings
ANVEDIIntegration.RUN_BUSINESSTRANSACTION_JOB('INVOICE_OUT');

// End the user transaction and show an error list, if there were any
ANVEDIIntegration.END_USER_TRANSACTION(TRUE, FALSE);

START_BT_WITH_REC

Commence une nouvelle transaction commerciale pour le code et l’identifiant d’enregistrement donnés.

START_BT_WITH_REC(BusinessTransactionTypeCode : Code[20];RecID : RecordID)

RUN_BT_BATCH_JOB

Exécute le travail de collecte par lots portant le nom spécifié. Elle doit être appelée à l’intérieur d’une transaction utilisateur.

RUN_BT_BATCH_JOB(BatchCode : Code[20])

Si vous voulez la combiner avec RUN_BUSINESSTRANSACTION_JOB, vous devez encapsuler les deux fonctions dans des blocs BEGIN..END_USER_TRANSACTION séparés et ajouter ce qui suit entre les deux :

COMMIT;
SELECTLATESTVERSION();

Actions

Parfois, vous souhaitez créer un bouton sur une page pour lancer un processus EDI, ou vous voulez l’intégrer, par exemple, dans le processus de validation. Dans ce cas, vous pouvez exécuter presque toutes les actions du module à partir du code. N’oubliez pas que les processus EDI doivent généralement être automatisés et fonctionner en arrière-plan. Par conséquent, avant d’ajouter des actions dans le code, envisagez la possibilité d’un travail en arrière-plan comme alternative.

Exécuter un EDI Mapping

Pour exécuter un EDI Mapping, nous devons lancer une transaction utilisateur. Ensuite, nous pourrions vouloir transmettre des données au mapping. Nous pouvons ensuite exécuter le mapping et vérifier le résultat à la fin de la transaction de l’utilisateur. Vous trouverez la description détaillée des commandes après l’exemple de code.

// Start a new user transaction with the description given by TextDescription
ANVEDIIntegration.BEGIN_USER_TRANSACTION(TextDescription);

// Reset any existing table views
ANVEDIIntegration.RESET_TABLEVIEWS();

// Copy sales invoice header from Rec to a local variable
SalesInvoiceHeader := Rec;
// Filter the local variable to the current record
SalesInvoiceHeader.SETRECFILTER;
// Store the filter to the record under the name INVOICE
ANVEDIIntegration.SET_TABLEVIEW('INVOICE', SalesInvoiceHeader.GETVIEW(FALSE));

// Run the mapping EXAMPLE, NAV, INVOICE. You can access the invoice header, by adding the table and setting the filter to a named table view and enter INVOICE as the name. In general, you can pass as many filters as you need to the mapping.
ANVEDIIntegration.RUN('EXAMPLE', 'NAV', 'INVOICE', FALSE, TRUE, '');

// End the user transaction and show an error list, if there were any
ANVEDIIntegration.END_USER_TRANSACTION(TRUE, FALSE);

RESET_TABLEVIEWS

Réinitialise toutes les vues de tables stockées existantes. Doit être appelé à l’intérieur d’une transaction utilisateur.

RESET_TABLEVIEWS()

SET_TABLEVIEW

Enregistre une vue de table sous un nom spécifié. Doit être appelé à l’intérieur d’une transaction utilisateur.

SET_TABLEVIEW(FilterName : Code[30];FilterText : Text[1024])

GET_TABLEVIEW

Récupère un filtre stocké. Doit être appelé à l’intérieur d’une transaction utilisateur.

GET_TABLEVIEW(FilterName : Code[30]) : Text[1024]

RUN

Exécuter un ou plusieurs mappings EDI. Doit être appelé à l’intérieur d’une transaction utilisateur.

RUN(ProjectFilter : Text[250];FormatFilter : Text[250];CodeFilter : Text[250];MultipleAllowed : Boolean;ProcessFollowing : Boolean;ProcessingQueueView : Text[250])

Autres actions

RECEIVE_ALL

Fonction obsolète. Vous devez éviter d’appeler la fonction générale et appeler l’une des fonctions plus spécifiques ci-dessous.

Il reçoit tous les canaux de communication. Cette fonction doit être appelée à l’intérieur d’une transaction utilisateur.

RECEIVE_ALL(ProcessFollowing : Boolean;ProcessingQueueView : Text[250])

RECEIVE_FOLDER

Reçoit les données du ou des dossiers de transmission spécifiés. Cette fonction doit être appelée à l’intérieur d’une transaction utilisateur.

RECEIVE_FOLDER(TransmissionFolderCodeFilter : Text[250];ProcessFollowing : Boolean;ProcessingQueueView : Text[250])

RECEIVE_COMMUNICATIONCHANNEL

Reçoit des données du canal de communication spécifié. Cette fonction doit être appelée à l’intérieur d’une transaction utilisateur.

RECEIVE_COMMUNICATIONCHANNEL(CommunicationChannelCodeFilter : Text[250];ProcessFollowing : Boolean;ProcessingQueueView : Text[250])

SEND_ALL

Fonction obsolète. Vous devez éviter d’appeler la fonction générale et appeler l’une des fonctions plus spécifiques ci-dessous.

Envoie tous les canaux de communication. Cette fonction doit être appelée à l’intérieur d’une transaction utilisateur.

SEND_ALL(ProcessFollowing : Boolean;ProcessingQueueView : Text[250])

SEND_FOLDER

Envoie les transmissions en cours du dossier de transmission spécifié. Cette fonction doit être appelée à l’intérieur d’une transaction utilisateur.

SEND_FOLDER(TransmissionFolderCodeFilter : Text[250];ProcessFollowing : Boolean;ProcessingQueueView : Text[250])

SEND_COMMUNICATIONCHANNEL

Envoie des transmissions ouvertes du canal de communication spécifié. Cette fonction doit être appelée à l’intérieur d’une transaction utilisateur.

SEND_COMMUNICATIONCHANNEL(CommunicationChannelCodeFilter : Text[250];ProcessFollowing : Boolean;ProcessingQueueView : Text[250])

PROCESS

PROCESS(ProcessFollowing : Boolean;ProcessingQueueView : Text[250];UserTransactionFilter : Boolean)

Définition du destinataire / de l’expéditeur

SET_COMMUNICATION_CHANNEL

Définit le canal de communication pour l’appel mapping suivant à l’intérieur de la transaction utilisateur.

SET_COMMUNICATION_CHANNEL(ChannelCode : Code[20])

SET_RECEIVER_PARTNER

Définit le partenaire récepteur pour l’appel mapping suivant à l’intérieur de la transaction utilisateur.

SET_RECEIVER_PARTNER(ReceiverPartner : Code[20])

SET_RECEIVER_IDENTIFICATION

Définit l’identification du récepteur pour l’appel mapping suivant à l’intérieur de la transaction utilisateur.

SET_RECEIVER_IDENTIFICATION(Identification : Text[64])

SET_SENDER_PARTNER

Définit le partenaire émetteur pour l’appel mapping suivant à l’intérieur de la transaction utilisateur.

SET_SENDER_PARTNER(PartnerCode : Code[20])

SET_SENDER_IDENTIFICATION

Définit l’identification de l’expéditeur pour l’appel mapping suivant à l’intérieur de la transaction utilisateur.

SET_SENDER_IDENTIFICATION(Identification : Text[64])

Journalisation et gestion des erreurs

Les fonctions suivantes ne peuvent être appelées que lorsqu’un mapping est en cours d’exécution. Ces fonctions sont destinées à être utilisées pour des traitements d’erreurs personnalisés à partir du code.

LogError

Enregistre un message d’erreur.

LogError(ErrorMessage : Text[1024])

LogWarning

Consigne un avertissement.

LogWarning(WarningMessage : Text[1024])

LogInformation

Enregistre les informations.

LogInformation(InformationMessage : Text[1024])

LogDocumentError

Enregistre une erreur appartenant à un document EDI. Il existe une fonction plus universelle appelée LogRecIDErrorWithCode.

LogDocumentError(ErrorMessage : Text[1024];EDIDocument : Record "EDI Document")

LogDocumentWarning

Enregistre un avertissement concernant un document EDI. Il existe une fonction plus universelle appelée LogRecIDWarningWithCode.

LogDocumentWarning(WarningMessage : Text[1024];EDIDocument : Record "EDI Document")

LogDocumentInformation

Enregistre une information appartenant à un document EDI. Il existe une fonction plus universelle appelée LogRecIDInformationWithCode.

LogDocumentInformation(InformationMessage : Text[1024];EDIDocument : Record "EDI Document")

LogDocumentLineError

Enregistre une erreur appartenant à une ligne de document EDI. Il existe une fonction plus générale appelée LogRecIDErrorWithCode.

LogDocumentLineError(ErrorMessage : Text[1024];EDIDocumentLine : Record "EDI Document Line")

LogDocumentLineWarning

Enregistre un avertissement appartenant à une ligne de document EDI. Il existe une fonction plus générale appelée LogRecIDWarningWithCode.

LogDocumentLineWarning(WarningMessage : Text[1024];EDIDocumentLine : Record "EDI Document Line")

LogDocumentLineInformation

Enregistre une information appartenant à une ligne de document EDI. Il existe une fonction plus générale appelée LogRecIDInformationWithCode.

LogDocumentLineInformation(InformationMessage : Text[1024];EDIDocumentLine : Record "EDI Document Line")

LogErrorWithCode

Enregistre une erreur avec un code d’erreur supplémentaire.

LogErrorWithCode(ContinueExecution : Boolean;ErrorMessage : Text[1024];Code : Code[20])

LogWarningWithCode

Enregistre un avertissement avec un code d’erreur supplémentaire.

LogWarningWithCode(WarningMessage : Text[1024];Code : Code[20])

LogInformationWithCode

Enregistre une information avec un code d’erreur supplémentaire.

LogInformationWithCode(InformationMessage : Text[1024];Code : Code[20])

LogRecIDErrorWithCode

Enregistre un message d’erreur qui devrait appartenir à un enregistrement spécifique.

LogRecIDErrorWithCode(ContinueExecution : Boolean;ErrorMessage : Text[1024];RecID : RecordID;Code : Code[20];IsUserAcceptable : Boolean)

LogRecIDWarningWithCode

Enregistre un avertissement qui devrait appartenir à un enregistrement.

LogRecIDWarningWithCode(WarningMessage : Text[1024];RecID : RecordID;Code : Code[20])

LogRecIDInformationWithCode

Enregistre une information qui devrait appartenir à un enregistrement.

LogRecIDInformationWithCode(InformationMessage : Text[1024];RecID : RecordID;Code : Code[20])