GenericImportFTPBatch batch

In order to avoid importing manually each import file, Akuiteo allows you to import automatically these files by using the GenericImportFTPBatch batch.

Setting up the batch

The parameters in the following table correspond only to the parameters specific to the GenericImportFTPBatch batch.

Reference

To view the parameters common among batches, refer to Setting up the common parameters.

Code	Description	Type	Required
`AUTRE_SEPARATEUR`	Other separator for the import file to process. Note This parameter is to be specified when the Autre option is selected in the `SEPARATEUR` parameter.	String Ex: /	No
`BATCH_NUM_AUTO`	Allows you to manage the automatic numbering of the created objects. When the parameter is on True, the automatic numbering of the Akuiteo objects is taken into account. When the parameter is on False, the numbering of the file is kept. Note This parameter matches the Automatic numbering section in the manual import screen (Management > Imports).	Boolean	No
`CHEMIN_OK`	Name of the sub-folder in which the report file (errors and success) generated by the batch must be stored.	String Ex: Processed_files	No
`DEBUT_NOM_DU_FICHIER`	Allows you to specify the first characters of the file to import.	String Ex: Supplier_sites	No
`FORMAT_FICHIER_SORTIE`	Allows you to select the format of the output file. The following values are available: Fichier global so the file contains all imported information and errors. Fichier d'erreur uniquement so the file only contains errors that occurred during the import.	List of values Ex: Fichier global	Yes
`FTP_CHEMIN`	Path to access the FTP or SFTP directory on the server where the files are to be imported by the batch.	String Ex: supp_sites	Yes
`FTP_CHEMIN_ARCH`	Path to access the FTP server's directory where the files will be moved.	String	No
`FTP_CHEMIN_FILE_ERROR`	Name of the sub-folder in which the report file (errors and success) generated by the batch must be stored.	String	No
`FTP_MODE`	Method to connect to the FTP or SFTP server. If SFTP is specified, the `SFTP_SSH_KEYSTORE` and `SFTP_SSH_KEYSTORE_PASSWORD` parameters are required. Important Only the FTP or SFTP connection methods can be used.	String Ex:FTP or SFTP	No
`FTP_PASSWORD`	Password to connect to the FTP or SFTP server. This password must be linked to the `FTP_USER` specified.	String Ex: aHFG45*F	No
`FTP_PORT`	FTP or SFTP server port.	Number Ex: 21	Yes
`FTP_SERVEUR`	FTP or SFTP server to which invoices will be dropped by the batch.	String Ex: ftp.akuiteo.fr	Yes
`FTP_USER`	Login to connect to the FTP or SFTP server.	String Ex: TECH	No
`GESTION_ERREUR`	Allows you to define the way file errors are managed during the import. The following values are available: Annulation du traitement à la moindre erreur so the processing is stopped and fails when one error occurs. Le traitement continue quel que soit le nombre d'erreurs so the processing keeps going even if errors occur. Le traitement s'arrête au bout de N erreurs so the processing stops after a certain number of errors, defined in the `NB_ERREURS` parameter. Note This parameter matches the Error management section in the manual import screen (Management > Imports).	List of values Ex: Annulation du traitement à la moindre erreur	Yes
`HORODATAGE_FICHIER_SORTIE`	If the parameter is True, the output file name will be timestamped. If the parameter is on False, the file name will be kept.	Boolean	No
`MODE_IMPORT`	Select from the drop-down list the import template. The following values are available: Création et modification allows you to create and modify management objects. Création seulement allows you to only create management objects. Modification allows you to only modify management objects.	List of values Ex: Creation et modification	Yes
`MODELE_IMPORT`	Select the import template from the list.	List of values Ex: Supplier sites	Yes
`NB_ERREURS`	Specify the number of errors after which the batch must stops. This parameter is to be specified when the `GESTION_ERREUR` parameter is specified with the value Le traitement s'arrête au bout de N erreurs.	Number e.g. 1	No
`REPERTOIRE`	Path to the directory where import files are stored.	String Ex: Files_to_be_processed	Yes
`SEPARATEUR`	Allows you to separate the columns of the import file to process. The values available are: Tabulation Point-virgule Virgule Espace Other	List of values Ex: Tabulation	Yes
`SFTP_SSH_KEYSTORE`	Important This parameter is required if SFTP is specified for `FTP_MODE`. Path to access the Keystore file that is protected by a password and that contains keys and certificates.	String Ex: keystore	No
`SFTP_SSH_KEYSTORE_PASSWORD`	Important This parameter is required if SFTP is specified for `FTP_MODE`. Password to access the Keystore file.	String Ex: aHFG45*F	No