Criação de uma atividade SFTP

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 16 min. de leitura

    • Crie uma atividade que execute comandos SFTP básicos em um servidor remoto.

    Antes de Iniciar

    Funções necessárias: activity_creator ou workflow_admin

    Por Que e Quando Desempenhar Esta Tarefa

    Você pode criar uma atividade personalizada que gerencie arquivos e diretórios em um host de destino ou copie um arquivo de um servidor SFTP para outro. O conteúdo do arquivo é transmitido por meio de um MID Server, o que evita a necessidade de armazenar os dados no disco rígido da máquina host do MID Server.
    Nota:
    Esta atividade requer as credenciais de um usuário que pode executar comandos SFTP no host de origem. A atividade Copiar arquivo, fornecida no pacote de atividades, requer credenciais separadas para acessar o host de destino.

    Procedimento

    1. Crie uma atividade personalizada.
      Esta ação cria uma atividade personalizada usando um modelo.
    2. Depois de configurar as propriedades gerais e criar variáveis de entrada, configure o Comando de Execução SFTP.
      OpçãoDescrição
      Comando Tipo de atividade a ser criada. As opções são:
      • Copiar arquivo
      • Criar diretório
      • Obter lista de arquivos
      • Remover arquivo ou diretório
      • Renomear arquivo ou diretório
      • Definir atributos de arquivo
      Nota:
      Os campos exibidos no formulário dependem do comando selecionado.
      Host de origem Nome ou endereço IP do servidor contendo os arquivos de destino da atividade.
      Porta de origem Número da porta a ser usada na comunicação com o servidor de origem. O número padrão da porta é 22.
      Caminho do arquivo de origem Caminho completo para um arquivo (/temp/test_data_file.txt) ou diretório (/temp/test_dir) em um host de origem, dependendo do comando selecionado. Campo disponível nos seguintes comandos:
      • Copiar arquivo
      • Remover arquivo ou diretório
      • Definir atributos de arquivo
      Diretório de origem Caminho para o diretório onde os arquivos de origem são localizados. Campo disponível nos seguintes comandos:
      • Criar diretório
      • Obter lista de arquivos
      Arquivos de origem Nomes de arquivos de origem específicos a serem incluídos na transferência de arquivos. Separe os nomes de arquivosa com ponto e vírgula. Este campo oferece suporte a uma lista separada por ponto e vírgula de padrões de curinga. Por exemplo: *.txt; a?cd.pdf. Se este campo estiver em branco, todos os arquivos serão incluídos. Campo disponível nos seguintes comandos: Obter lista de arquivos
      Nota:
      Para obter informações sobre como os valores neste campo afetam as opções em outros campos, acompanhe a explicação lógica a seguir.
      É um diretório Se marcado, especifica que o caminho do arquivo é um diretório. Campo disponível nos seguintes comandos: Remover arquivo ou diretório
      Marcador de credencial para origem Marcador de credencial específico que esta atividade deve usar para executar comandos SFTP no host de origem.
      Marcador de credencial para destino Marcador de credencial específico que esta atividade deve usar para executar comandos SFTP no host de destino. Campo disponível nos seguintes comandos: Copiar arquivo
      Arquivos excluídos Nomes de arquivos de origem específicos a serem excluídos da transferência de arquivos. A atividade atua em todos os outros arquivos encontrados no diretório ou nas subpastas de origem. Separe os nomes de arquivos com vírgula. Este campo oferece suporte a uma lista separada por vírgula de padrões de curinga. Por exemplo: *.txt; a?cd.pdf. Campo disponível nos seguintes comandos: Obter lista de arquivos
      Nota:
      Para obter informações sobre como os valores neste campo afetam as opções em outros campos, acompanhe a explicação lógica a seguir.
      Incluir subpastas Se marcada, inclui os arquivos das subpastas no diretório de origem. Campo disponível nos seguintes comandos: Obter lista de arquivos
      Nota:
      Para obter informações sobre como a sua seleção afeta outros campos no formulário, acompanhe a explicação lógica a seguir.
      Host de destino Nome ou endereço IP do servidor para o qual os arquivos estão sendo transferidos. Campo disponível nos seguintes comandos: Copiar arquivo
      Porta de destino Número da porta a ser usada na comunicação com o host de destino. O número padrão da porta é 22. Campo disponível nos seguintes comandos: Copiar arquivo
      Caminho de arquivo de destino Caminho completo para um arquivo em um host de destino. Campo disponível nos seguintes comandos:
      • Copiar arquivo
      • Renomear arquivo ou diretório
      Sufixo do arquivo temporário Se existir um arquivo em um host de destino, este comando permitirá que um sufixo temporário seja usado para um nome de arquivo. Se este arquivo contiver um valor, a atividade primeiro copiará o arquivo de origem para um arquivo temporário no host de destino usando targetFilePath + tempFileSuffix como o nome. Ao concluir, a atividade renomeia o arquivo para o nome real do arquivo de destino. Se o campo não estiver preenchido, a atividade copiará o arquivo de origem diretamente para o arquivo de destino e o substituirá, caso exista. Campo disponível nos seguintes comandos: Copiar arquivo
      UID Atributo de ID de usuário a ser aplicado a um arquivo ou diretório. Os valores de UID e GID devem ser definidos juntos como um par ou eles serão ignorados. Os números de UID e GID são valores internos retornados pela atividade Obter lista de arquivos. Tipicamente, você usará primeiro a atividade Obter lista de arquivos para retornar uma lista de arquivos e seus atributos. Depois você poderá mover um arquivo de um host de origem a um host de destino e definir os atributos do arquivo de origem no arquivo de destino. Este fluxo é demonstrado em Fluxo de trabalho de Transferência de arquivos SFTP. Campo disponível nos seguintes comandos: Definir atributos de arquivo
      GID Atributo de ID de grupo a ser aplicado a um arquivo ou diretório. Os valores de UID e GID devem ser definidos juntos como um par ou eles serão ignorados. Os números de UID e GID são valores internos retornados pela atividade Obter lista de arquivos. Tipicamente, você usará primeiro a atividade Obter lista de arquivos para retornar uma lista de arquivos e seus atributos. Depois você poderá mover um arquivo de um host de origem a um host de destino e definir os atributos do arquivo de origem no arquivo de destino. Este fluxo é demonstrado em Fluxo de trabalho de Transferência de arquivos SFTP. Campo disponível nos seguintes comandos: Definir atributos de arquivo
      Permissões Permissões de arquivo ou diretório a serem definidas para o usuário e grupo especificados. Este valor deve ser expresso como inteiro, por exemplo 16877, o que define estas permissões: rwxr-xr-x. Os números de permissão são valores internos retornados pela atividade Obter lista de arquivos. Tipicamente, você usará primeiro a atividade Obter lista de arquivos para retornar uma lista de arquivos e seus atributos. Depois você poderá mover um arquivo de um host de origem a um host de destino e definir os atributos do arquivo de origem no arquivo de destino. Este fluxo é demonstrado em Fluxo de trabalho de Transferência de arquivos SFTP. Campo disponível nos seguintes comandos: Definir atributos de arquivo
      Carimbo de data/hora de acesso Substitui o carimbo de data/hora de quando o arquivo ou diretório foi acessado pela última vez. Os carimbos de data/hora de acesso e modificação devem ser configurados juntos como um par. Campo disponível nos seguintes comandos: Definir atributos de arquivo
      Carimbo de data/hora da modificação Substitui o carimbo de data/hora de quando o arquivo ou diretório foi modificado pela última vez. Os carimbos de data/hora de acesso e modificação devem ser configurados juntos como um par. Campo disponível nos seguintes comandos: Definir atributos de arquivo
      Tamanho em bytes Tamanho de um arquivo, expressado em bytes. Campo disponível nos seguintes comandos: Definir atributos de arquivo
      Requer recursos do MID Server MID Server com os recursos do MID Server apropriados para conexão com os servidores de origem e destino.
      O sistema usa esta lógica para determinar quais arquivos serão movidos do host de origem:
      • Se o campo Arquivos de origem estiver vazio, o sistema selecionará todos os arquivos no diretório de origem. Caso contrário, ele selecionará somente os arquivos cujos nomes correspondam a um dos padrões de nome de arquivo fornecidos no campo.
      • Se o campo Arquivos excluídos estiver vazio, o sistema não excluirá nada. Caso contrário, ele excluirá somente os arquivos cujos nomes correspondam a um dos padrões de nome de arquivo fornecidos no campo.
      • A regra de exclusão tem uma preferência maior do que a regra de inclusão. Se um nome de arquivo corresponder a um dos padrões de nome de arquivo no campo Arquivos excluídos, ele não será incluído na seleção, independentemente da regra de inclusão.
      • Quando a caixa de seleção Incluir subpastas estiver desmarcada, o sistema vai considerar apenas o diretório de origem para arquivos a incluir ou excluir. Caso contrário, ele procurará no diretório de origem e em qualquer uma de suas subpastas os arquivos a serem incluídos ou excluídos.
      Nota:
      Você pode mapear valores de parâmetro em uma carga de teste para variáveis na guia Saídas automaticamente. Consulte variáveis de saída do mapeamento automático.

    O que Fazer Depois

    Parâmetros de execução do modelo SFTP

    Você usa parâmetros de execução para criar o script do processo de entrada no formulário de pré-processamento.

    Para obter descrições dos campos de comando, consulte Configuração do comando de execução do SFTP.
    Nota:
    É necessário usar o prefixo executionParam. com todas as variáveis nesta tabela.
    Tabela 1. Parâmetros de execução do SFTP
    Nome Variável Tipo Uso
    Comando comando Cadeia de caracteres Identifica a função desta atividade. Os comandos possíveis são:
    • Copiar arquivo
    • Criar diretório
    • Obter lista de arquivos
    • Remover arquivo ou diretório
    • Renomear arquivo ou diretório
    • Definir atributos de arquivo
    Origem origem Cadeia de caracteres Identifica o host de origem.
    Porta de origem source_port Inteiro Identifica a porta usada para se comunicar com o host de origem.
    Diretório de origem source_directory Cadeia de caracteres Caminho para o diretório dos arquivos de origem a serem movidos.
    Arquivos de origem source_files Cadeia de caracteres Nomes dos arquivos na origem a serem movidos.
    Arquivos excluídos excluded_files Cadeia de caracteres Lista os arquivos excluídos da operação.
    Caminho do arquivo de origem source_file_path Cadeia de caracteres Caminho para os arquivos de origem a serem movidos.
    Host de destino target_host Cadeia de caracteres Identifica o host de destino.
    Porta de destino target_port Inteiro Identifica a porta usada para se comunicar com o host de destino.
    Diretório de meta target_directory Cadeia de caracteres Caminho completo para o diretório de destino no host de destino.
    Caminho de arquivo de destino target_file_path Cadeia de caracteres Caminho completo para um arquivo ou diretório no host de origem ou no host de destino. Por exemplo, este valor é usado na atividade de Renomear Arquivo ou Diretório no pacote de atividades.
    Postfix de arquivo temporário temp_file_postfix Cadeia de caracteres

    Extensão de nome de arquivo temporário usada pela atividade Copiar arquivo ao mover um arquivo. Se este campo contiver uma extensão, o arquivo de origem será copiado para um arquivo temporário usando target file name + temp_file_postfix, antes de ser renomeado para o arquivo de destino real. Se este campo estiver em branco, o arquivo de origem será copiado diretamente para o arquivo de destino.
    É um diretório is_directory Booliano Indica se o caminho do arquivo fornecido é um diretório.
    Incluir subpastas include_subfolders Booliano Indica se o sistema pesquisa nas subpastas do diretório de origem os arquivos a serem incluídos e excluídos.
    UID de atributo de arquivo file_attribute_uid Inteiro ID do usuário associado a um arquivo ou diretório.
    GID de atributo de arquivo file_attribute_gid Inteiro ID do grupo associado a um arquivo ou diretório.
    Permissões de atributo de arquivo file_attribute_permissions Inteiro Permissões de arquivo ou diretório para o usuário e grupo especificados.
    Atributo de arquivo atime file_attribute_atime Inteiro Carimbo de data/hora de acesso dos atributos do arquivo.
    Atributo de arquivo mtime file_attribute_mtime Inteiro Carimbo de data/hora de modificação dos atributos do arquivo.
    Atributo de arquivo tamanho file_attribute_size Inteiro Tamanho do arquivo, em bytes.
    Marcador de credencial de origem source_credential_tag Cadeia de caracteres Aliases de credencial para atividades de Orquestração usado para executar o comando no host de origem.
    Marcador de credencial de destino target_credential_tag Cadeia de caracteres Marcador de credencial usado para executar o comando no host de destino.
    MidCapabilities midCapabilities Cadeia de caracteres (separados por vírgulas) Lista de recursos MID Server exigidos.

    Análise de carga e parâmetros de pós-processamento do SFTP

    Use esses parâmetros para criar um script de pós-processamento, análise de carga e marcação.

    Tabela 2. Parâmetros de pós-processamento do SFTP
    Nome Variável Tipo Uso
    Saída saída Cadeia de caracteres Contém dados de saída retornados pela consulta.
    EccSysId eccSysId Cadeia de caracteres Contém o ID de referência associado à mensagem de entrada da Fila do ECC.
    ErrorMessages errorMessages Cadeia de caracteres Contém as mensagens de erro retornadas de uma consulta. Se nenhuma mensagem de erro for retornada, este valor será nulo.
    Marcadores marcadores Hashmap de valores de marcador a serem retornados do comando do SSH. Contém os marcadores usados para extrair a saída usando os comandos do SSH. A saída do marcador é delimitada por sinais de porcentagem dupla, como em %%tagname%%...%%. Configure o comando usando o seguinte formato:
    %%tagname1%%
output1 line 1
output1 line 2
…
%%

%%tagname2%%
output2 line 1
output2 line 2
…
%%
    Os marcadores retornados são objetos de hashmap JavaScript em que cada chave é prefixada com tag anexada ao tagname.
    {"__text__": "", 
"tagtagname1":"output1 line1\noutput1 line2\n", 
"tagtagname2":"output2 line1\noutput2 line2\n"}

    Configuração do comando de execução do SFTP

    Use as variáveis de entrada que você criou para configurar o comando que a Orquestração executa no endpoint do SFTP.

    Antes de Iniciar

    Crie as variáveis de entrada necessárias no formulário Entradas antes de avançar para a fase Comando de Execução.

    Funções necessárias: activity_creator, administrador

    Nota:
    Você pode testar a conexão JDBC entre o MID Server e o destino sem ter que executar a atividade em um contexto de fluxo de trabalho. Para obter detalhes, consulte saídas do modelo de teste.

    Procedimento

    1. Arraste as variáveis da lista de entradas e solte-as nos campos de comando.
      O sistema formata a variável na sintaxe apropriada para o comando.
      Figura 1. Comando de execução do SFTP
      Neste exemplo, o comando Criar diretório é exibido no campo Comando.
    2. Preencha os campos exibidos na tabela.
      Tabela 3. Campos de comando SFTP
      Campo Descrição Comando
      Comando Tipo de atividade a ser criada. As opções são:
      • Copiar arquivo
      • Criar diretório
      • Obter lista de arquivos
      • Remover arquivo ou diretório
      • Renomear arquivo ou diretório
      • Definir atributos de arquivo
      Nota:
      Os campos exibidos no formulário dependem do comando selecionado.
      		 Todos
      Host de origem Nome ou endereço IP do servidor contendo os arquivos de destino da atividade. Todos
      Porta de origem Número da porta a ser usada na comunicação com o servidor de origem. O número padrão da porta é 22. Todos
      Caminho do arquivo de origem Caminho completo para um arquivo em um servidor de origem.
      • Copiar arquivo
      • Remover arquivo ou diretório
      • Definir atributos de arquivo
      Diretório de origem Caminho para o diretório onde os arquivos de origem são localizados.
      • Criar diretório
      • Obter lista de arquivos
      Arquivos de origem Nomes de arquivos de origem específicos a serem incluídos na ação de gerenciamento. Separe os nomes de arquivos nesta lista com ponto e vírgula. Este campo permite o uso de curingas. Se este campo estiver em branco, todos os arquivos serão incluídos. Para obter informações sobre como os valores neste campo afetam as opções em outros campos, acompanhe a seção abaixo da tabela. Obter lista de arquivos
      É um diretório Caixa de seleção que determina de o caminho de arquivo especificado é um diretório. Remover arquivo ou diretório
      Marcador de credencial para origem Aliases de credencial específicos das atividades da Orquestração nesta atividade devem ser usados para executar comandos SFTP no host de origem. Todos
      Marcador de credencial para destino Marcador de credencial específico que esta atividade deve usar para executar comandos SFTP no host de destino. Copiar arquivo
      Arquivos excluídos Nomes de arquivos de origem específicos a serem excluídos da ação de gerenciamento. A atividade atua em todos os outros arquivos encontrados no diretório ou nas subpastas de origem. Separe os nomes de arquivos nesta lista com ponto e vírgula. Este campo oferece suporte ao uso de curingas. Para obter informações sobre como os valores neste campo afetam as opções em outros campos, acompanhe a seção abaixo da tabela. Obter lista de arquivos
      Incluir subpastas Caixa de seleção para gerenciar arquivos de subpastas no diretório de origem. Para obter informações sobre como a sua seleção afeta outros campos no formulário, acompanhe a seção abaixo da tabela. Obter lista de arquivos
      Host de destino Nome ou endereço IP do servidor para o qual os arquivos estão sendo transferidos. Copiar arquivo
      Porta de destino Número da porta a ser usada na comunicação com o host de destino. O número padrão da porta é 22. Copiar arquivo
      Caminho de arquivo de destino Caminho completo para um arquivo em um host de destino.
      • Copiar arquivo
      • Renomear arquivo ou diretório
      Sufixo do arquivo temporário Sufixo temporário a ser usado para um nome de arquivo se o arquivo já existir em um host de destino. Se este arquivo contiver um valor, a atividade excluirá o arquivo de destino duplicado, se existir, e copiará o arquivo de origem para um arquivo temporário usando targetFilePath + tempFileSuffix como o nome. Ao concluir, a atividade renomeia o arquivo para o nome real do arquivo de destino. Se o campo não estiver preenchido, a atividade copiará o arquivo de origem diretamente para o arquivo de destino e o substituirá, caso já exista. Copiar arquivo
      UID Atributo de ID de usuário a ser aplicado a um arquivo ou diretório. Os valores de UID e GID devem ser definidos juntos como um par ou eles serão ignorados. Definir atributos de arquivo
      GID Atributo de ID de grupo a ser aplicado a um arquivo ou diretório. Os valores de UID e GID devem ser definidos juntos como um par ou eles serão ignorados. Definir atributos de arquivo
      Permissões Permissões de arquivo ou diretório a serem definidas para o usuário e grupo especificados. Este valor deve ser expresso como um número inteiro, como 16877, que define estas permissões: rwxr-xr-x. Os números de permissão são valores internos retornados pela atividade Obter lista de arquivos. Tipicamente, você usará primeiro a atividade Obter lista de arquivos para retornar uma lista de arquivos e seus atributos. Depois você poderá mover um arquivo de um host de origem a um host de destino e definir os atributos do arquivo de origem no arquivo de destino. Isso é demonstrado em Fluxo de trabalho de Transferência de arquivos SFTP. Definir atributos de arquivo
      Carimbo de data/hora de acesso Substitui o carimbo de data/hora de quando o arquivo ou diretório foi acessado pela última vez. Os carimbos de data/hora de acesso e modificação devem ser configurados juntos como um par. Definir atributos de arquivo
      Carimbo de data/hora da modificação Substitui o carimbo de data/hora de quando o arquivo ou diretório foi modificado pela última vez. Os carimbos de data/hora de acesso e modificação devem ser configurados juntos como um par. Definir atributos de arquivo
      Tamanho em bytes Tamanho de um arquivo, expressado em bytes. Definir atributos de arquivo
      Requer recursos do MID Server MID Server com os recursos do MID Server apropriados para conexão com os servidores de origem e destino. Por padrão, o sistema seleciona um MID Server SSH. Todos
      O sistema usa esta lógica para determinar quais arquivos serão movidos do host de origem:
      • Se o campo Arquivos de origem estiver vazio, o sistema selecionará todos os arquivos no diretório de origem. Caso contrário, ele selecionará somente os arquivos cujos nomes correspondam a um dos padrões de nome de arquivo fornecidos no campo.
      • Se o campo Arquivos excluídos estiver vazio, o sistema não excluirá nada. Caso contrário, ele excluirá somente os arquivos cujos nomes correspondam a um dos padrões de nome de arquivo fornecidos no campo.
      • A regra de exclusão tem uma preferência maior do que a regra de inclusão. Se um nome de arquivo corresponder a um dos padrões de nome de arquivo no campo Arquivos excluídos, ele não será incluído na seleção, independentemente da regra de inclusão.
      • Quando a caixa de seleção Incluir subpastas estiver desmarcada, o sistema vai considerar apenas o diretório de origem para arquivos a incluir ou excluir. Caso contrário, ele procurará no diretório de origem e em qualquer uma de suas subpastas os arquivos a serem incluídos ou excluídos.
    3. Clique em Salvar.
    4. Clique em Continuar para avançar para a fase Saídas.