Configurer une destination SFTP avec des options de formatage de fichiers prédéfinies et une configuration de noms de fichiers personnalisée
Vue d’ensemble overview
Cette page décrit l’utilisation de la Destination SDK pour configurer une destination SFTP avec des paramètres prédéfinis par défaut. options de formatage de fichier et une configuration du nom de fichier.
Cette page affiche toutes les options de configuration disponibles pour les destinations SFTP. Vous pouvez modifier les configurations affichées dans les étapes ci-dessous ou supprimer certaines parties des configurations, si nécessaire.
Pour obtenir des descriptions détaillées des paramètres utilisés ci-dessous, voir options de configuration dans le SDK Destinations.
Conditions préalables prerequisites
Avant de passer aux étapes décrites ci-dessous, veuillez lire la section Prise en main de Destination SDK pour plus d’informations sur l’obtention des informations d’authentification d’Adobe I/O nécessaires et d’autres conditions préalables requises pour utiliser les API Destination SDK.
Étape 1 : créer une configuration de serveur et de fichier create-server-file-configuration
Commencez par utiliser la variable /destination-server point d’entrée créer une configuration de serveur et de fichier ;.
Format d’API
POST platform.adobe.io/data/core/activation/authoring/destination-servers
Requête
La requête suivante crée une nouvelle configuration de serveur de destination, configurée en fonction des paramètres fournis dans la payload.
La payload ci-dessous inclut une configuration SFTP générique, avec prédéfinie par défaut. Formatage des fichiers CSV paramètres de configuration que les utilisateurs peuvent définir dans l’interface utilisateur de l’Experience Platform.
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-server \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"name": "SFTP destination with predefined CSV formatting options",
"destinationServerType": "FILE_BASED_SFTP",
"fileBasedSFTPDestination": {
"hostname": {
"templatingStrategy": "NONE",
"value": "{{customerData.hostname}}"
},
"rootDirectory": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.remotePath}}"
},
"port": 22
},
"fileConfigurations": {
"compression": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.compression}}"
},
"fileType": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.fileType}}"
},
"csvOptions": {
"quote": {
"templatingStrategy": "NONE",
"value": "\""
},
"quoteAll": {
"templatingStrategy": "NONE",
"value": "false"
},
"escape": {
"templatingStrategy": "NONE",
"value": "\\"
},
"escapeQuotes": {
"templatingStrategy": "NONE",
"value": "true"
},
"header": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreLeadingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreTrailingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"nullValue": {
"templatingStrategy": "NONE",
"value": ""
},
"dateFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd"
},
"timestampFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd'T':mm:ss[.SSS][XXX]"
},
"charToEscapeQuoteEscaping": {
"templatingStrategy": "NONE",
"value": "\\"
},
"emptyValue": {
"templatingStrategy": "NONE",
"value": ""
}
}
}
}'
Une réponse réussie renvoie la nouvelle configuration du serveur de destination, y compris l’identifiant unique (instanceId) de la configuration. Conservez cette valeur, car elle est nécessaire à l’étape suivante.
Étape 2 : créer une configuration de destination create-destination-configuration
Après avoir créé la configuration du serveur de destination et du formatage des fichiers à l’étape précédente, vous pouvez désormais utiliser la variable /destinations Point de terminaison de l’API pour créer une configuration de destination.
Pour connecter la configuration du serveur dans étape 1 sur cette configuration de destination, remplacez la variable destinationServerId dans la requête API ci-dessous avec la valeur obtenue lors de la création de votre serveur de destination dans étape 1.
Format d’API
POST platform.adobe.io/data/core/activation/authoring/destinations
Requête
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destinations \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"name":"SFTP destination with predefined CSV formatting options",
"description":"SFTP destination with predefined CSV formatting options",
"status":"TEST",
"customerAuthenticationConfigurations":[
{
"authType":"SFTP_WITH_PASSWORD"
},
{
"authType":"SFTP_WITH_SSH_KEY"
}
],
"customerEncryptionConfigurations":[
],
"customerDataFields":[
{
"name":"remotePath",
"title":"Root directory",
"description":"Enter root directory",
"type":"string",
"isRequired":true,
"readOnly":false,
"hidden":false
},
{
"name":"hostname",
"title":"Hostname",
"description":"Enter hostname",
"type":"string",
"isRequired":true,
"readOnly":false,
"hidden":false
}
],
"uiAttributes":{
"documentationLink":"https://www.adobe.com/go/destinations-sftp-en",
"category":"SFTP",
"connectionType":"SFTP",
"monitoringSupported":true,
"flowRunsSupported":true,
"frequency":"Batch"
},
"destinationDelivery":[
{
"deliveryMatchers":[
{
"type":"SOURCE",
"value":[
"batch"
]
}
],
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"{{instanceID of your destination server}}"
}
],
"schemaConfig":{
"profileRequired":true,
"segmentRequired":true,
"identityRequired":true
},
"batchConfig":{
"allowMandatoryFieldSelection":true,
"allowDedupeKeyFieldSelection":true,
"defaultExportMode":"DAILY_FULL_EXPORT",
"allowedExportMode":[
"DAILY_FULL_EXPORT",
"FIRST_FULL_THEN_INCREMENTAL"
],
"allowedScheduleFrequency":[
"DAILY",
"EVERY_3_HOURS",
"EVERY_6_HOURS",
"EVERY_8_HOURS",
"EVERY_12_HOURS",
"ONCE"
],
"defaultFrequency":"DAILY",
"defaultStartTime":"00:00",
"filenameConfig":{
"allowedFilenameAppendOptions":[
"SEGMENT_NAME",
"DESTINATION_INSTANCE_ID",
"DESTINATION_INSTANCE_NAME",
"ORGANIZATION_NAME",
"SANDBOX_NAME",
"DATETIME",
"CUSTOM_TEXT"
],
"defaultFilenameAppendOptions":[
"DATETIME"
],
"defaultFilename":"%DESTINATION%_%SEGMENT_ID%"
},
"backfillHistoricalProfileData":true
}
}'
Une réponse réussie renvoie la nouvelle configuration de destination, y compris l’identifiant unique (instanceId) de la configuration. Conservez cette valeur, car elle est nécessaire si vous devez effectuer d’autres requêtes HTTP pour mettre à jour la configuration de votre destination.
Étape 3 : Vérification de l’interface utilisateur Experience Platform verify-ui
En fonction des configurations ci-dessus, le catalogue des Experience Platform affiche désormais une nouvelle carte de destination privée que vous pouvez utiliser.
Dans les images et enregistrements ci-dessous, notez comment les options de la variable workflow d’activation pour les destinations basées sur des fichiers correspondent aux options que vous avez sélectionnées dans la configuration de destination.
Lorsque vous renseignez des détails sur la destination, notez comment les champs sont apparus comme les champs de données personnalisés que vous configurez dans la configuration.
Lors de la planification des intervalles d’exportation, notez comment les champs apparaissaient sont les champs que vous configurez dans la variable batchConfig configuration.
Lors de l’affichage des options de configuration du nom de fichier, notez comment les champs affichés représentent la variable filenameConfig options que vous configurez dans la configuration.
Si vous souhaitez ajuster l’un des champs mentionnés ci-dessus, répétez l’opération. étapes 1 et two pour modifier les configurations en fonction de vos besoins.
Étape 4 : (facultative) Publier votre destination publish-destination
Après avoir configuré votre destination, utilisez la variable API de publication de destination pour envoyer votre configuration à Adobe en vue de la révision.
Étape 5 : (facultative) documenter votre destination document-destination
Si vous êtes un fournisseur de logiciels indépendant (ISV) ou un intégrateur de système (SI) créant une intégration personnalisée, utilisez le processus de documentation en libre-service pour créer une page de documentation du produit pour votre destination dans le Catalogue des destinations Experience Platform.
Étapes suivantes next-steps
En lisant cet article, vous savez maintenant comment créer une destination SFTP personnalisée à l’aide de Destination SDK. Ensuite, votre équipe peut utiliser la variable workflow d’activation pour les destinations basées sur des fichiers pour exporter des données vers la destination.