Funções de Arquivo

As funções de arquivo permitem que scripts manipulem arquivos em agentes, disponíveis por meio de fontes e gravados em destinos.

ArchiveFile

Declaração

void ArchiveFile(string sourceId, string targetId[, bool deleteSource])

Sintaxe

ArchiveFile(<sourceId>, <targetId>[, <deleteSource>])

Parâmetros Obrigatórios

• sourceId: Fonte do tipo de arquivo no projeto atual
• targetId: Tipo de arquivo alvo no projeto atual

Parâmetros Opcionais

• deleteSource: Sinalizador booleano (padrão false) indicando se a fonte deve ser excluída após gravar com sucesso no destino

Descrição

Lê um arquivo de uma origem de tipo de arquivo e grava-o em um destino de tipo de arquivo. Esta função combina o ReadFile e WriteFilefunções, executa automaticamente FlushFile e fornece uma opção para excluir o arquivo de origem.

A origem do tipo de arquivo e o destino do tipo de arquivo usados nesta chamada de função devem ser definidos como origem e destino, respectivamente, no projeto atual. Veja as instruções em inserir itens do projeto.

Como apenas um arquivo é arquivado, recomenda-se que a fonte seja criada para retornar apenas um único arquivo. Se vários arquivos forem retornados, apenas o primeiro será usado.

Como owriteFilefunção, esta função não substituirá um arquivo existente no destino.

Se o ArchiveFile função falha, a operação não falha. Um script será abortado, um aviso será adicionado ao log da operação e a operação continuará.

Arquivar Versus Copiar

• Se deleteSource é true, o arquivo é arquivado (em outras palavras, movido) da origem para o destino e removido da origem.
• Se deleteSource é false, o arquivo será copiado da origem para o destino e permanecerá na origem.

Exemplos

// Retrieve list of files from a source
localFiles = FileList("<TAG>Sources/Local File Source</TAG>");

// Create a global archive filename
$archiveFilename = "archive.[date]-[time]." + localFiles[0];

// Archive (moves) a file, using [nome do arquivo] in the target filename(s) field
ArchiveFile("<TAG>Sources/Local File Source</TAG>",
    "<TAG>Targets/FTP Target</TAG>", true);

// Copies a file, using [nome do arquivo] in the target filename(s) field
ArchiveFile("<TAG>Sources/Local File Source</TAG>",
    "<TAG>Targets/FTP Target</TAG>", false);

DeleteFile

Declaração

int DeleteFile(string sourceId[, string fileFilter])

Sintaxe

DeleteFile(<sourceId>[, <fileFilter>])

Parâmetros Obrigatórios

• sourceId: Fonte do tipo de arquivo no projeto atual

Parâmetros Opcionais

• fileFilter: Filtro de arquivo ou Nome de arquivo para substituir a definição de origem

Descrição

Exclui um arquivo da origem especificada.

A fonte do tipo de arquivo usada nesta chamada de função deve ser definida como uma fonte no projeto atual. Veja as instruções em inserir itens do projeto.

Se o filtro de origem selecionar mais de um arquivo, um erro será gerado. Para excluir vários arquivos, use o DeleteFilesfuncionar em vez disso.

O método retorna um número inteiro 0 ou 1: retorna 1 se o arquivo foi excluído; 0 se o arquivo não puder ser encontrado.

O segundo parâmetro, fileFilter, é opcional e pode ser usado para substituir o filtro de arquivo usado na definição de origem. Um nome de arquivo pode ser usado. Alternativamente, uma variável global pode ser usada para substituir o filtro de arquivo na definição de origem. Variáveis globais são referenciadas como [de_name] na definição de origem.

Exemplos

// Delete the file "ExampleFile.txt" from the "File Share Source"
DeleteFile("<TAG>Sources/File Share Source</TAG>", "ExampleFile.txt");

DeleteFiles

Declaração

int DeleteFiles(string sourceId[, string fileFilter])

Sintaxe

DeleteFiles(<sourceId>[, <fileFilter>])

Parâmetros Obrigatórios

• sourceId: Fonte do tipo de arquivo no projeto atual

Parâmetros Opcionais

• fileFilter: Filtro de arquivo ou nome de arquivo para substituir a definição de origem

Descrição

Exclui um ou mais arquivos da origem especificada.

A fonte do tipo de arquivo usada nesta chamada de função deve ser definida como uma fonte no projeto atual. Veja as instruções em inserir itens do projeto.

Este método excluirá vários arquivos, se algum for encontrado, com base no filtro de arquivo da definição de origem. Um número inteiro é retornado especificando quantos arquivos foram excluídos. Retornar 0 significa que nenhum arquivo correspondente ao filtro de arquivo foi encontrado.

Se um caminho especificado na origem não puder ser encontrado, um erro será gerado. Se isso for uma possibilidade, a função deve ser envolvida em um Eval função.

Para excluir um único arquivo, use o DeleteFile funcionar em vez disso.

O segundo parâmetro, fileFilter, é opcional e pode ser usado para substituir o filtro de arquivo usado na definição de origem. Um nome de arquivo pode ser usado. Alternativamente, uma variável global pode ser usada para substituir o filtro de arquivo na definição de origem. Variáveis globais são referenciadas como [de_name] na definição de origem.

Exemplos

// Delete all text (".txt") files in the source "File Source"
DeleteFiles("<TAG>Sources/File Source</TAG>","*.txt");

DirList

Declaração

array DirList(string sourceId[, string path, string fileFilter])

Sintaxe

DirList(<sourceId>[, <path>, <fileFilter>])

Parâmetros Obrigatórios

• sourceId: Fonte do tipo de arquivo no projeto atual

Parâmetros Opcionais

• path: Caminho do arquivo para substituir a definição de origem
• fileFilter: Filtro de arquivo ou nome de arquivo para substituir a definição de origem

Descrição

Retorna uma lista de diretórios contidos em uma fonte, especificando opcionalmente um caminho e um filtro para restringir os resultados.

Este método retorna um array contendo os nomes dos diretórios.

A fonte do tipo de arquivo usada nesta chamada de função deve ser definida como uma fonte no projeto atual. Veja as instruções em inserir itens do projeto.

O parâmetro fileFilter é opcional e pode ser usado para substituir o filtro de arquivo usado na definição de origem. Um nome de arquivo pode ser usado. Alternativamente, uma variável global pode ser usada para substituir o filtro de arquivo na definição de origem. Variáveis globais são referenciadas como [de_name] na definição de origem.

Exemplos

// Returns the count of the list of all the text files (".txt")
// in the "example" folder of the source "File Share Source"
Length(DirList("<TAG>Sources/File Share Source</TAG>",
    "\\\\server\\example","*.txt"));

FileList

Declaração

array FileList(string sourceId[, string path, string fileFilter])

Sintaxe

FileList(<sourceId>[, <path>, <fileFilter>])

Parâmetros Obrigatórios

• sourceId: Fonte do tipo de arquivo no projeto atual

Parâmetros Opcionais

• path: Caminho do arquivo para substituir a definição de origem
• fileFilter: Filtro de arquivo ou nome de arquivo para substituir a definição de origem

Descrição

Retorna uma lista de nomes de arquivos contidos em uma fonte. Esta será a mesma lista de arquivos recebidos quando a conexão de uma origem de tipo de arquivo for testada, a menos que um filtro de arquivo seja especificado para substituir o filtro especificado na configuração da atividade.

A fonte do tipo de arquivo usada nesta chamada de função deve ser definida como uma fonte no projeto atual. Veja as instruções em inserir itens do projeto.

O parâmetro path é opcional e pode ser usado para substituir o caminho usado na definição de origem.

O parâmetro fileFilter é opcional e pode ser usado para substituir o filtro de arquivo usado na definição de origem. Um nome de arquivo pode ser usado. Alternativamente, uma variável global pode ser usada para substituir o filtro de arquivo na definição de origem. Variáveis globais são referenciadas como [de_name] na definição de origem.

O método retorna uma matriz contendo os nomes de arquivos que correspondem ao filtro de arquivo da fonte ou à fonte substituída.

Exemplos

// Returns the count of the list of
// all the files in the source "File Share Source"
Length(FileList("<TAG>Sources/File Share Source</TAG>"));

FlushAllFiles

Declaração

void FlushAllFiles([string targetId])

Sintaxe

FlushAllFiles([<targetId>])

Parâmetros Opcionais

• targetId: Tipo de arquivo alvo no projeto atual

Descrição

Persiste dados gravados em um buffer de arquivo com WriteFile().

O destino do tipo de arquivo usado nesta chamada de função deve ser definido como um destino no projeto atual. Veja as instruções em inserir itens do projeto.

Se FlushAllFiles são chamados com um targetId como argumento, todos os arquivos escritos usando esse alvo serão liberados (veja o FlushFile função). Se FlushAllFiles é chamado sem argumento, todos os arquivos escritos usando WriteFile para qualquer alvo serão persistidos em seus respectivos alvos.

Veja também o FlushFiles função.

Exemplos

// Write "contents1" to the file specified by the FTP target
WriteFile("<TAG>Targets/FTP Target</TAG>", contents1);

// Write "contents2" to a file "copy.txt",
// overriding that specified by the FTP target
WriteFile("<TAG>Targets/FTP Target</TAG>", contents2, "copy.txt");

// Flush both files to the target
FlushAllFiles("<TAG>Targets/FTP Target</TAG>");

FlushFile

Declaração

void FlushFile(string targetId[, string filename])

Sintaxe

FlushFile(<targetId>[, <filename>])

Parâmetros Obrigatórios

• targetId: Tipo de arquivo alvo no projeto atual

Parâmetros Opcionais

• filename: Nome do arquivo para substituir a definição de destino

Descrição

Persiste dados gravados em um buffer de arquivo com WriteFile. Quando FlushFile é chamado, o conteúdo atual do buffer é gravado no destino e o buffer local é descartado.

O destino do tipo de arquivo usado nesta chamada de função deve ser definido como um destino no projeto atual. Veja as instruções em inserir itens do projeto.

O parâmetro opcional, filename, pode ser usado para substituir o nome do arquivo usado na definição de destino se ele tiver sido substituído de forma semelhante na chamada para o WriteFile função. Liberar um arquivo que nunca foi gravado não tem efeito.

Alternativamente, uma variável global pode ser usada para substituir o nome do arquivo na definição de destino. Variáveis globais são referenciadas como [de_name] na definição de destino. Se um nome de arquivo de substituição for usado, cada buffer será liberado separadamente para cada nome exclusivo.

Veja também o FlushAllFiles função.

Exemplos

// Writing the variable "contents" to a target
WriteFile("<TAG>Targets/FTP Target</TAG>", contents);

// Flushing (actually writing) to the target
FlushFile("<TAG>Targets/FTP Target</TAG>");

// Write another file (overriding the filename in the target)
WriteFile("<TAG>Targets/FTP Target</TAG>", contents, "test.txt");

// Flushing the "test.txt" file explicitly
FlushFile("<TAG>Targets/FTP Target</TAG>", "test.txt");

ReadFile

Declaração

string ReadFile(string sourceId[, string fileFilter])

Sintaxe

ReadFile(<sourceId>[, <fileFilter>])

Parâmetros Obrigatórios

• sourceId: Fonte do tipo de arquivo no projeto atual

Parâmetros Opcionais

• fileFilter: Filtro de arquivo ou nome de arquivo para substituir a definição de origem

Descrição

Lê o conteúdo de um arquivo de uma origem.

A fonte do tipo de arquivo usada nesta chamada de função deve ser definida como uma fonte no projeto atual. Veja as instruções em inserir itens do projeto.

O método retorna o conteúdo do arquivo apontado pela fonte. Caso o filtro de origem selecione mais de um arquivo, o primeiro será utilizado. Recomenda-se especificar uma fonte que identifique exclusivamente um único arquivo.

O parâmetro fileFilter é opcional e pode ser usado para substituir o filtro de arquivo usado na definição de origem. Um nome de arquivo pode ser usado. Alternativamente, uma variável global pode ser usada para substituir o filtro de arquivo na definição de origem. Variáveis globais são referenciadas como [de_name] na definição de origem.

A partir do Harmony versão 8.20, se o ReadFile() função falha, a operação não falha. Um script será abortado, um aviso será adicionado ao log da operação e a operação continuará.

Este método pode ser usado para ler dados de uma fonte HTTP. Nesse caso, todos os Jitterbit $jitterbit.source.http.* variáveis serão preenchidas.

Exemplos

$fileContents = ReadFile("<TAG>Sources/File Share Source</TAG>")

WriteFile

Declaração

void WriteFile(string targetId, type fileContents[, string filename])

Sintaxe

WriteFile(<targetId>, <fileContents>[, <filename>])

Parâmetros Obrigatórios

• targetId: Tipo de arquivo alvo no projeto atual

Parâmetros Opcionais

• fileContents: Dados a serem gravados no arquivo
• filename: Nome do arquivo para substituir a definição de destino

Descrição

Escreve o fileContents para o destino do tipo de arquivo especificado por targetId. Se fileContents for do tipo binário, os dados binários serão gravados no arquivo. Em todos os outros casos, uma representação em string dos dados é gravada.

O destino do tipo de arquivo usado nesta chamada de função deve ser definido como um destino no projeto atual. Veja as instruções em inserir itens do projeto.

O terceiro parâmetro, filename, é opcional e pode ser usado para substituir o nome do arquivo usado no destino. Alternativamente, uma variável global pode ser usada para substituir o nome do arquivo na definição de destino. Variáveis globais são referenciadas como [de_name] na definição de destino.

Este método também pode ser usado para gravar/postar dados em um destino HTTP. Nesse caso, $jitterbit.target.http.* variáveis serão preenchidas.

A partir do Harmony versão 8.20, se o WriteFile() função falha, a operação não falha. Um script será abortado, um aviso será adicionado ao log da operação e a operação continuará.

Buffer e Liberação

O conteúdo do arquivo é armazenado em buffer localmente até que FlushFile ou FlushAllFiles é chamado no destino ou a transformação é concluída com êxito. Chamando WriteFile várias vezes sem ligar FlushFile anexará dados ao buffer atual e tudo será gravado no destino real do tipo de arquivo somente quando for liberado. Um buffer de arquivo é identificado exclusivamente pelo destino (e potencialmente pelo filename); por exemplo, o mesmo destino pode ser usado para gravar em arquivos diferentes no mesmo diretório, especificando um nome de arquivo e cada buffer de arquivo será separado.

Os arquivos não são realmente gravados no destino em uma transformação de teste, a menos que FlushFile ou FlushAllFiles é chamado. Se uma transformação for executada em uma operação ou como parte de uma operação de teste, o arquivo será gravado quando a transformação for concluída com êxito ou quando FlushFile ou FlushAllFiles é chamado no script.

Veja também o FlushAllFiles e FlushFiles funções.

Exemplos

// Write "contents" to a file in a target
WriteFile("<TAG>Targets/FTP Target</TAG>", contents);

// Use the filename "test.txt" instead of
// what is defined in the target
WriteFile("<TAG>Targets/FTP Target</TAG>", contents, "test.txt");