Batch SQLBatchJob

Important

Le batch SQLBatchJob doit être utilisé uniquement sur indication de la société Akuiteo.

Le batch SQLBatchJob permet de modifier ou d'interroger la base de données d'Akuiteo, à l'aide de requêtes SQL ou de procédures stockées en base de données.

Pour pouvoir utiliser le batch SQLBatchJob, la règle de gestion BATCH_SQL_ACTIF doit être activée.

Lors de la création du batch, le modèle de batch à sélectionner dans la liste déroulante Modèle de batch est SQLBatchJob.

Lorsque le batch est lancé, une requête SQL ou une procédure stockée est exécutée :

  • Pour que le batch exécute une requête SQL, le paramètre REQUEST doit être renseignée avec une requête SQL et le paramètre IS_STORED_PROC doit être Faux.
  • Pour que le batch exécute une procédure stockée dans la base de données, le paramètre REQUEST doit être renseignée avec le nom d'une procédure stockée et le paramètre IS_STORED_PROC doit être Vrai.

La requête ou la procédure stockée peut être :

  • soit de type INSERT, UPDATE ou DELETE afin d'effectuer des modifications sur la base de données d'Akuiteo.
  • soit de type SELECT afin d'interroger la base de données et d'enregistrer le résultat obtenu dans un fichier de sortie. Dans ce cas, le paramètre GENERATE_OUTPUT doit être Vrai et les autres paramètres associés doivent être renseignés si besoin (voir Fichier de sortie).

Si besoin, des paramètres supplémentaires peuvent être renseignés dans le paramètre PARAMETERS afin de les appliquer à la requête ou à la procédure stockée.

Fichier de sortie

Lorsque la requête ou la procédure stockée est de type SELECT et que le paramètre GENERATE_OUTPUT est Vrai, le batch enregistre dans un fichier de sortie le résultat. Ce fichier est enregistré :

  • dans le répertoire du serveur local Akuiteo spécifié dans le paramètre CHEMIN du batch.
  • dans le répertoire FTP souhaité si les paramètres associés sont spécifiés (FTP_CHEMIN, FTP_MODE, FTP_PASSWORD, FTP_PORT, FTP_SERVEUR, FTP_USER, SFTP_SSH_KEYSTORE et SFTP_SSH_KEYSTORE_PASSWORD).

Les autres paramètres associés au fichier de sortie sont CARRIAGE_RETURN, ENCODING, EXTENSION, FILENAME, SEPARATOR, SHOW_HEADERS et TIMESTAMP (voir Paramétrer le batch).

Note

Le fichier de sortie généré sera vide si la requête ou la procédure stockée n'est pas de type SELECT.

Les paramètres du tableau suivant correspondent seulement aux paramètres spécifiques au batch SQLBatchJob.

Référence

Pour consulter les paramètres communs à la plupart des batchs, voir Configurer les paramètres communs.

Code Description Type Obligatoire

ALWAYS_SEND_MAIL

Permet de toujours envoyer les mails de log même si aucune erreur n'est rencontrée. Les mails de log sont envoyés à l'adresse mail renseignée dans le paramètre BATCH_MAIL.

Booléen

 Oui
CARRIAGE_RETURN

Note

Ce paramètre est utilisé uniquement si le paramètre GENERATE_OUTPUT est Vrai.

Format du caractère correspondant aux retours chariots dans le fichier de sortie :

  • Unix () pour que le caractère des retours chariot soit au format Unix.
  • Windows () pour que le caractère des retours chariot soit au format Windows.
  • Par défaut (Dépend de l'OS du serveur) pour que le caractère des retours chariot soit au format du système d'exploitation du serveur Akuiteo.

Liste de valeurs

Ex : Windows ()

 Non
CHEMIN

Note

Ce paramètre est obligatoire si le paramètre GENERATE_OUTPUT est Vrai.

Chemin d'accès au répertoire sur le serveur local Akuiteo dans lequel sera enregistré le fichier de sortie.

Chaîne

Ex : C:\akuiteo\docs\SqlResults

 Non
ENCODING

Note

Ce paramètre est utilisé uniquement si le paramètre GENERATE_OUTPUT est Vrai.

Encodage du fichier de sortie.

Si le paramètre n'est pas renseigné, l'encodage par défaut est UTF-8.

Chaîne

Ex : ISO-8859-1

 Non
EXTENSION

Note

Ce paramètre est utilisé uniquement si le paramètre GENERATE_OUTPUT est Vrai.

Extension du fichier de sortie.

Chaîne

Ex : txt

 Non
FILENAME

Note

Ce paramètre est utilisé uniquement si le paramètre GENERATE_OUTPUT est Vrai.

Nom du fichier de sortie.

Chaîne

Ex : SqlResult

 Non
FTP_CHEMIN

Note

Ce paramètre est utilisé uniquement si le paramètre GENERATE_OUTPUT est Vrai.

Chemin d'accès au répertoire sur le serveur FTP ou SFTP dans lequel le fichier de sortie sera déposé par le batch.

Chaîne

Ex : docs\SqlResults

 Non
FTP_MODE

Note

Ce paramètre est utilisé uniquement si le paramètre GENERATE_OUTPUT est Vrai.

Mode de connexion au serveur FTP ou SFTP.

Si SFTP est renseigné, les paramètres SFTP_SSH_KEYSTORE et SFTP_SSH_KEYSTORE_PASSWORD sont obligatoires.

Important

Seuls les modes de connexion FTP ou SFTP peuvent être renseignés.

Chaîne

Ex : FTP

 Non
FTP_PASSWORD

Note

Ce paramètre est utilisé uniquement si le paramètre GENERATE_OUTPUT est Vrai.

Mot de passe pour se connecter au serveur FTP ou SFTP. Ce mot de passe doit être associé au FTP_USER renseigné.

Chaîne

Ex : aHFG45*F

 Non
FTP_PORT

Note

Ce paramètre est utilisé uniquement si le paramètre GENERATE_OUTPUT est Vrai.

Port du serveur FTP ou SFTP.

Nombre

Ex : 21

 Non
FTP_SERVEUR

Note

Ce paramètre est utilisé uniquement si le paramètre GENERATE_OUTPUT est Vrai.

Adresse du serveur FTP ou SFTP vers lequel les factures seront déposées par le batch.

Chaîne

Ex : ftp.akuiteo.fr

 Non
FTP_USER

Note

Ce paramètre est utilisé uniquement si le paramètre GENERATE_OUTPUT est Vrai.

Identifiant pour se connecter au serveur FTP ou SFTP.

Chaîne

Ex : TECH

 Non
GENERATE_OUTPUT

Si le paramètre est sur Vrai, le résultat de la requête ou de la procédure stockée de type SELECT est enregistré dans un fichier de sortie. La requête ou la procédure stockée concernée doit être de type SELECT. Sinon, le fichier de sortie sera vide.

Si le paramètre est sur Faux, aucun fichier de sortie n'est enregistré.

 Booléen Oui
IS_STORED_PROC

Si le paramètre est Vrai, le batch exécutera une procédure stockée dans la base de données. La valeur à renseigner dans le paramètre REQUEST doit ainsi correspondre à une procédure stockée.

Si le paramètre est Faux, le batch exécutera une requête SQL. La valeur à renseigner dans le paramètre REQUEST doit ainsi correspondre à une requête SQL.

 Booléen Oui
IS_STORED_PROC_WITH_UPDATE

Note

Ce paramètre est utilisé uniquement si le paramètre IS_STORED_PROC est Vrai.

Le paramètre doit être Vrai si la procédure stockée est de type INSERT, UPDATE ou DELETE.

Le paramètre doit être Faux si la procédure stockée est de type SELECT.

Le batch rencontrera une erreur lors de son exécution si la mauvaise option est sélectionnée pour ce paramètre.

 Booléen Non
PARAMETERS

Valeurs des paramètres de la requête ou de la procédure stockée.

Dans la requête SQL ou la procédure stockée, des clés de paramètres peuvent être renseignées au format [nomParametre]

Dans le paramètre PARAMETERS du batch, la valeur d'un paramètre doit être renseignée au format clé=valeur

Pour renseigner plusieurs paramètres, utilisez le séparateur | (ex : clé1=valeur1|clé2=valeur2|clé3=valeur3).

Exemple

La requête SQL contient la ligne suivante qui permet de filtrer les affaires qui commencent par la valeur fournie dans le paramètre [param] :

WHERE af_code_affaire LIKE '[param]%'

Dans le paramètre PARAMETERS du batch, je renseigne param=A123.

La requête SQL retournera ainsi les affaires dont le code affaire commence par A123.

 Chaîne Non
REQUEST

Requête SQL ou procédure stockée à exécuter.

Si le paramètre IS_STORED_PROC est Faux, la valeur à renseigner doit correspondre à une requête SQL.

Exemple

INSERT

INTO

T_UTIL_WEB

(TWB_IDENT, TWB_USER, TWB_PWD, TWB_DATE, TWB_DESCRIPTION)

VALUES

(null, 'ABC', 'DEF', null, 'Description')

Si le paramètre IS_STORED_PROC est Vrai, la valeur à renseigner doit correspondre à une procédure stockée. La valeur doit être exprimée au format nomProcedureStockee(argument1,argument2) sans guillemets autour des arguments.

Exemple

La procédure stockée s'appelle procedure et les arguments à utiliser sont param1 et param2. La valeur à renseigner dans REQUEST est donc procedure(param1, param2)

Important

Ne renseignez pas de point-virgule ; à la fin de l'expression.

Requête SQL

 Oui
SEPARATOR

Note

Ce paramètre est utilisé uniquement si le paramètre GENERATE_OUTPUT est Vrai.

Séparateur des colonnes dans le fichier de sortie.

Chaîne

Ex : ;

 Non
SFTP_SSH_KEYSTORE

Important

Si le FTP_MODE est paramétré sur SFTP, ce paramètre est obligatoire.

Chemin d'accès au fichier Keystore, protégé par un mot de passe et contenant plusieurs clés et certificats.

Chaîne

Ex : keystore

 Non
SFTP_SSH_KEYSTORE_PASSWORD

Important

Si le FTP_MODE est paramétré sur SFTP, ce paramètre est obligatoire.

Mot de passe pour accéder au fichier Keystore.

Chaîne

Ex : aHFG45*F

 Non
SHOW_HEADERS

Note

Ce paramètre est utilisé uniquement si le paramètre GENERATE_OUTPUT est Vrai.

Si le paramètre est Vrai, les entêtes de colonnes sont présentes dans le fichier de sortie.

 Booléen Non
TIMESTAMP

Note

Ce paramètre est utilisé uniquement si le paramètre GENERATE_OUTPUT est Vrai.

Horodatage ajouté dans le nom du fichier de sortie, entre le FILENAME et l'EXTENSION.

Le paramètre doit être renseigné avec la syntaxe Java de l'objet SimpleDateFormat. Consultez la documentation d'Oracle pour plus d'informations.

Si le paramètre est vide, l'horodatage ne sera pas présent dans le nom du fichier de sortie.

Chaîne

Ex : yyyy.MM.dd

 Non