Armazenamento de arquivos para integração (Amazon S3)
Pré-requisitos:
Acesso ao menu Configuração >
Configuração > Sistema (CM006)
Serviço de armazenamento de arquivos
Quando a opção de ARMAZENAMENTO DE ARQUIVOS PARA INTEGRAÇÃO está ativada no
menu Configuração > Configuração > Sistema (CM006), isso indica que o sistema
foi configurado para utilizar o serviço
Amazon Simple Storage Service (Amazon S3) como
local de armazenamento para arquivos eletrônicos (objetos) associados às
funcionalidades da tabela DIINTERFACE
.
Adicionalmente, para dar suporte ao armazenamento desses arquivos no Amazon
S3, fazemos uso do
AWS Transfer Family. Este
serviço oferece suporte gerenciado para a transferência de arquivos
business-to-business (B2B) utilizando o protocolo SFTP
, permitindo a
movimentação direta de objetos para um bucket do Amazon S3 de forma
altamente segura por cliente e por ambiente contratado.
Clientes que utilizam Hosting SoftExpert e que queiram fazer uso deste recurso,
sugerimos contatar a equipe comercial da SoftExpert, com o objetivo de solicitar
detalhes do nosso serviço de SFTP
.
É importante ressaltar que o SFTP não deve ser utilizado como repositório de arquivos. Para garantir a segurança e otimizar o uso dos recursos, adotamos uma política de retenção de 15 (quinze) dias para todos os arquivos armazenados no SFTP. Após este período, os arquivos são automaticamente deletados.
Diretrizes de metadados dos objetos
Ao enviar arquivos por meio do Secure File Transfer Protocol (SFTP), é crucial observar diretrizes específicas relacionadas aos metadados dos objetos que estão sendo transferidos. Um exemplo dessas diretrizes inclui:
- Ao criar um nome para o seu objeto, é possível utilizar caracteres Unicode com codificação UTF-8.
- Os nomes das chaves de objeto diferenciam letras maiúsculas de minúsculas;
- Os nomes das chaves dos objetos podem ter até 1.024 caracteres;
- Um prefixo de objeto não pode começar com uma barra
("/")
; - Adicionar uma barra
("/")
no prefixo do objeto após o primeiro caractere ser interpretado como um diretório. Esses segmentos de diretório estão limitados a 255 caracteres.
O modelo de dados do Amazon S3 é uma estrutura plana: você cria um bucket e o bucket armazena objetos. Não há hierarquia de sub-buckets ou de subpastas. No entanto, é possível pressupor a hierarquia lógica usando prefixos e delimitadores de nome de chave como faz o console do Amazon S3. O console do Amazon S3 é compatível com o conceito de pastas.
Vamos supor que seu SFTP
(admin-created
) tenha quatro objetos com as
seguintes chaves de objeto:
Development/Projects.xls
Finance/statement1.pdf
Private/taxdocument.pdf
s3-dg.pdf
O console usa prefixos de nome de chave (Development/
, Finance/
e
Private/
) e o delimitador ("/")
para apresentar uma estrutura de pasta. A
chave s3-dg.pdf
não tem um prefixo, de modo que seu objeto aparece diretamente
no nível da raiz do bucket. Ao abrir a pasta Development/
, o objeto
Projects.xlsx
é exibido.
- Para obter detalhes da convenção de nomenclatura, consulte Criar nomes de chaves de objeto (portal AWS).
- Certifique-se de que o nome da chave do objeto também seja compatível com protocolos diferentes do S3. Especificamente, evite caracteres especiais que possam não ser suportados em outros protocolos.
Exemplos de caracteres a serem evitados
Evite caracteres a seguir em um nome de chave de objeto, devido ao tratamento especial significativo para garantir consistência em todas as aplicações.
Barra invertida
\
Chave esquerda
{
- Caracteres ASCII não imprimíveis (128-255 caracteres decimais)
Circunflexo
^
Chave direita
}
Caractere de porcentagem
%
Crase / acento grave
`
Colchete direito
]
- Aspas
Sinal de maior
>
Colchete esquerdo
[
Til
~
Sinal de menor
<
Caractere hashtag
#
Barra vertical / barra de pipe
|
Por exemplo, ao importar arquivos eletrônicos por meio da interface
DCDOC
, no campo DSFIELD03
, é
crucial evitar o uso desses caracteres. O DSFIELD03
é o campo no qual você
deve especificar o caminho do arquivo eletrônico no SFTP
, o que
consequentemente influencia o arquivo dentro do Bucket do Amazon S3.
Exemplo válido inserido no campo DSFIELD03 | Exemplo inválido inserido no campo DSFIELD03 |
---|---|
Images/Image.png | {User/Document.doc} |
Document-2023.doc | File^Name.txt |
File123.pdf | {"Special/File.xlsx"} |
User123/File.doc | Percentage%Report.pdf |
Certifique-se de evitar os caracteres listados na tabela "Exemplo Inválido" ao nomear suas chaves de objeto. Esses caracteres podem causar problemas de consistência e tratamento inadequado nos aplicativos e sistemas envolvidos. Utilize apenas caracteres alfanuméricos e símbolos permitidos para garantir a integridade e o correto funcionamento do sistema.