Configuração de servidor e arquivo para especificações do servidor de destino baseado em arquivo
Visão geral
Esta página detalha todas as opções de configuração do servidor para seus servidores de destino baseados em arquivos e mostra como configurar várias opções de configuração de arquivo para os usuários que exportam arquivos do Experience Platform para seu destino.
As especificações de configuração do servidor e do arquivo para destinos com base em arquivo podem ser configuradas no Adobe Experience Platform Destination SDK por meio do /destination-servers endpoint . Ler Operações de endpoint da API do servidor de destino para obter uma lista completa de operações que podem ser realizadas no ponto de extremidade.
As seções abaixo incluem especificações do servidor de destino específicas para cada tipo de destino de lote suportado no Destination SDK.
Especificação do servidor de destino Amazon S3 baseado em arquivo
A amostra abaixo mostra uma configuração correta do servidor de destino para um destino Amazon S3.
{
"name": "S3 destination",
"destinationServerType": "FILE_BASED_S3",
"fileBasedS3Destination": {
"bucket": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.bucket}}"
},
"path": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.path}}"
}
},
"fileConfigurations": {
// See the file formatting configuration section further below on this page
}
}
Parâmetro
Tipo
Descrição
name
String
O nome da conexão de destino.
destinationServerType
String
Defina esse valor de acordo com a plataforma de destino. Para Amazon S3, defina como FILE_BASED_S3.
fileBasedS3Destination.bucket.templatingStrategy
String
Obrigatório. Use PEBBLE_V1.
fileBasedS3Destination.bucket.value
String
O nome do Amazon S3 bucket a ser usado por este destino.
fileBasedS3Destination.path.templatingStrategy
String
Obrigatório. Use PEBBLE_V1.
fileBasedS3Destination.path.value
String
O caminho para a pasta de destino que hospedará os arquivos exportados.
Esta seção descreve as configurações de formatação de arquivo para o arquivo exportado CSV arquivos. Você pode modificar várias propriedades dos arquivos exportados para corresponder aos requisitos do sistema de recepção de arquivos no seu lado, a fim de ler e interpretar de maneira ideal os arquivos recebidos do Experience Platform.
OBSERVAÇÃO
As opções CSV só são compatíveis ao exportar arquivos CSV. O fileConfigurations não é obrigatória ao configurar um novo servidor de destino. Se você não passar nenhum valor na chamada da API para as opções CSV, os valores padrão da variável quadro de referência mais abaixo será usada.
Configurações de arquivo com as opções de CSV e templatingStrategy defina como NONE
No exemplo de configuração abaixo, todas as opções de CSV são corrigidas. As configurações de exportação definidas em cada uma das csvOptions os parâmetros são finais e os usuários não podem modificá-los.
Configurações de arquivo com as opções de CSV e templatingStrategy defina como PEBBLE_V1
No exemplo de configuração abaixo, nenhuma das opções de CSV é corrigida. O value em cada uma das csvOptions é configurado em um campo de dados do cliente correspondente por meio da variável /destinations endpoint (por exemplo customerData.quote para quote opção de formatação de arquivo) e os usuários podem usar a interface do usuário do Experience Platform para selecionar entre as várias opções configuradas no campo de dados do cliente correspondente.
"fileConfigurations": {
"compression": {
"templatingStrategy": "PEBBLE_V1",
"value": "{% if customerData contains 'compression' and customerData.compression is not empty %}{{customerData.compression}}{% else %}NONE{% endif %}"
},
"fileType": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.fileType}}"
},
"csvOptions": {
"sep": {
"templatingStrategy": "PEBBLE_V1",
"value": "{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'delimiter' %}{{customerData.csvOptions.delimiter}}{% else %},{% endif %}"
},
"quote": {
"templatingStrategy": "PEBBLE_V1",
"value": "{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'quote' %}{{customerData.csvOptions.quote}}{% else %}\"{% endif %}"
},
"escape": {
"templatingStrategy": "PEBBLE_V1",
"value": "{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'escape' %}{{customerData.csvOptions.escape}}{% else %}\\{% endif %}"
},
"nullValue": {
"templatingStrategy": "PEBBLE_V1",
"value": "{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'nullValue' %}{{customerData.csvOptions.nullValue}}{% else %}null{% endif %}"
},
"emptyValue": {
"templatingStrategy": "PEBBLE_V1",
"value": "{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'emptyValue' %}{{customerData.csvOptions.emptyValue}}{% else %}{% endif %}"
}
}
}
Referência completa e exemplos para opções de formatação de arquivo suportadas
DICA
As opções de formatação de arquivos CSV descritas abaixo também estão documentadas na variável Guia do Apache Spark para arquivos CSV. As descrições usadas abaixo são obtidas do guia do Apache Spark.
Abaixo está uma referência completa de todas as opções disponíveis de formatação de arquivo no Destination SDK, junto com exemplos de saída para cada opção.
Campo
Obrigatório / Opcional
Descrição
Valor padrão
Exemplo de saída 1
Exemplo de saída 2
templatingStrategy
Obrigatório
Para cada opção de formatação de arquivo configurada, é necessário adicionar o parâmetro templatingStrategy, que pode ter dois valores:
NONE: use esse valor se você não estiver planejando permitir que os usuários selecionem entre valores diferentes para uma configuração. Consulte essa configuração para um exemplo em que as opções de formatação de arquivo são fixas.
PEBBLE_V1: use esse valor se desejar permitir que os usuários selecionem entre valores diferentes para uma configuração. Nesse caso, você também deve configurar um campo de dados do cliente correspondente na variável /destination configuração de ponto de extremidade, para exibir as várias opções para os usuários na interface do usuário. Consulte essa configuração por exemplo, onde os usuários podem selecionar entre valores diferentes para opções de formatação de arquivo.
-
-
-
compression.value
Opcional
Codec de compactação a ser usado ao salvar dados no arquivo. Valores compatíveis: none, bzip2, gzip, lz4e snappy.
none
-
-
fileType.value
Opcional
Especifica o formato do arquivo de saída. Valores compatíveis: csv, parquete json.
csv
-
-
csvOptions.quote.value
Opcional
Somente para"fileType.value": "csv". Define um caractere único usado para escapar de valores entre aspas, onde o separador pode fazer parte do valor.
null
-
-
csvOptions.quoteAll.value
Opcional
Somente para"fileType.value": "csv". Indica se todos os valores devem ser sempre entre aspas. O padrão é apenas valores de escape contendo um caractere de aspas.
false
quoteAll:false --> male,John,"TestLastName"
quoteAll:true -->"male","John","TestLastName"
csvOptions.delimiter.value
Opcional
Somente para"fileType.value": "csv". Define um separador para cada campo e valor. Esse separador pode ter um ou mais caracteres.
,
delimiter:, —> comma-separated values"
delimiter:\t —> tab-separated values
csvOptions.escape.value
Opcional
Somente para"fileType.value": "csv". Define um caractere único usado para evitar aspas dentro de um valor já citado.
\
"escape":"\\" —> male,John,"Test,\"LastName5"
"escape":"'" —> male,John,"Test,'''"LastName5"
csvOptions.escapeQuotes.value
Opcional
Somente para"fileType.value": "csv". Indica se os valores que contêm aspas devem sempre ser entre aspas. O padrão é omitir todos os valores que contenham um caractere de aspas.
true
-
-
csvOptions.header.value
Opcional
Somente para"fileType.value": "csv". Indica se os nomes das colunas devem ser gravados como a primeira linha no arquivo exportado.
true
-
-
csvOptions.ignoreLeadingWhiteSpace.value
Opcional
Somente para"fileType.value": "csv". Indica se os espaços em branco à esquerda devem ser aparados a partir de valores.
