Comando EXPORT

Informações do conceito

Exportar dados

Exportação de exceções para o aplicativo Resultados no HighBond

Exportar dados para o aplicativo Robôs no HighBond

Exporta dados do Analytics para o formato de arquivo especificado ou para o aplicativo Resultados ou Robôs no HighBond.

Nota

É preciso ter o Microsoft Access Database Engine de 32 bits instalado para que o comando EXPORT funcione com arquivos antigos do Excel (*.xls) e arquivos do Microsoft Access (*.mdb). Para obter mais informações, consulte Excluir o Microsoft Access Database Engine (opcional).

Sintaxe

EXPORT {<FIELDS> nome_campo <AS nome_exportação> <...n>|<FIELDS> ALL <EXCLUDE nome_campo <...n>>} <UNICODE> tipo_exportação <SCHEMA> <PASSWORD número> TO {nome_arquivo|id_aclgrc|url_api_highbond} <OVERWRITE> <IF teste> <WHILE teste> <{FIRST intervalo|NEXT intervalo}> <APPEND> <KEEPTITLE> <SEPARATOR caractere> <QUALIFIER caractere> <WORKSHEET nome_planilha> <DISPLAYNAME>

Parâmetros

Nome Descrição
FIELDS nome_campo AS nome_ <...nome_de_exportação> | FIELDS ALL

Os arquivos a exportar.

  • FIELDS nome_campo exporta o campo ou os campos especificados

    Separe os nomes dos campos com espaços. Os campos são exportados na ordem em que são listados.

    Opcionalmente, você pode incluir um nome diferente para o campo no arquivo de exportação usando AS nome_de_exportação. Coloque nome_de_exportação entre aspas.

    Se você está exportando para o Resultados do HighBond (ACLGRC), é possível combinar AS com o parâmetro DISPLAYNAME. Para obter mais informações, consulte Como DISPLAYNAME interage com AS na exportação para o Resultados do HighBond.

  • FIELDS ALL exporte todos os campos da tabela

    Os campos são exportados na ordem em que aparecem no layout da tabela.
EXCLUDE nome_campo

opcional

Válido apenas ao exportar usando FIELDS ALL.

O campo ou os campos a serem excluídos do comando. O EXCLUDE permite ajustar o FIELDS ALL excluindo os campos especificados.

O EXCLUDE deve estar logo após do FIELDS ALL. Por exemplo:

FIELDS ALL EXCLUDE campo_1 campo_2

UNICODE

opcional

Disponível apenas na edição Unicode do Analytics. Aplica-se somente a arquivos de texto, arquivos de texto delimitado, arquivos XML e saída da área de transferência do Windows. (ASCII, DELIMITED, XML, CLIPBOARD)

Exporta dados do Analytics com codificação de caracteres Unicode UTF-16 LE aplicada.

  • Especifique UNICODE se os dados exportados contêm caracteres não compatíveis com ASCII estendido (ANSI)
  • Não especifique UNICODE se todos os caracteres nos dados exportados são compatíveis com ASCII estendido (ANSI)

    Os dados exportados são codificados como ASCII estendido (ANSI).

    Nota

    Todos os caracteres não compatíveis são omitidos do arquivo exportado.

Para obter mais informações, consulte Produtos Unicode da Diligent.
tipo_de_exportação

O formato do arquivo de saída ou do destino.

Especifique uma das seguintes opções:

  • ACCESS – arquivo de banco de dados do Microsoft Access (*.mdb)

    Por padrão, os dados são exportados como Unicode.

  • ACLGRC – Resultados do HighBond
  • ASCII – texto simples ASCII (*.txt)
  • CLIPBOARD – área de transferência do Windows
  • DBASE – arquivo compatível com dBASE (*.dbf)
  • DELIMITED – arquivo de texto delimitado (*.del) ou arquivo de valores separados por vírgula (*.csv)
  • EXCEL – arquivo Microsoft Excel (*.xls) compatível com o Microsoft Excel 1997 a 2003
  • HBDATA – valores compactados separados por vírgula (*.csv.gz) para um robô do HighBond ou de fluxo de trabalho no aplicativo Robôs do HighBond
  • JSON – arquivo JSON (*.json)
  • LOTUS – arquivo Lotus 123
  • WDPF6 – arquivo Wordperfect 6
  • WORD – arquivo MS Word (*.doc)
  • WP – arquivo do Wordperfect
  • XLS21 – arquivo do Microsoft Excel versão 2.1 (*.xls)
  • XLSX – arquivo do Microsoft Excel(*.xlsx)

    Por padrão, os dados são exportados como Unicode.

  • XML – arquivo XML (*.xml)

SCHEMA

opcional

Aplica-se apenas à saída em arquivos XML. (XML)

Inclua o esquema do XML no arquivo XML exportado. O esquema do XML contém metadados que descrevem a estrutura do arquivo XML, incluindo o tipo de dados dos campos.

Você pode validar o arquivo em relação ao esquema após a exportação do arquivo.

PASSWORD num

opcional

Aplica-se somente a aplicativos do HighBonds. (ACLGRC, HBDATA)

A definição de senha a ser usada.

PASSWORD num não é usado para solicitar ou especificar uma senha real. A definição de senha faz referência a uma senha previamente fornecida ou definida com o comando PASSWORD, o comando SET PASSWORD ou a tag de análise PASSWORD.

num é o número da definição de senha. Por exemplo, se as duas senhas foram previamente fornecidas ou definidas em um script, ou no agendamento de um script de análise, PASSWORD 2 especifica o uso da senha nº 2.

Para obter mais informações sobre o fornecimento ou a definição de senhas, consulte:

PASSWORD num deve ser colocado imediatamente antes de TO ou no fim da cadeia da sintaxe do comando.

O valor de senha obrigatório é um token de acesso do HighBond. Para obter mais informações, consulte Criação de uma definição de senha e especificação do valor da senha.

PASSWORD número pode ou não ser obrigatória, dependendo do ambiente em que o script é executado.

Ambiente onde o script é executado PASSWORD número é obrigatória
Analytics

(ativação on-line)

PASSWORD número não é obrigatória.

O token de acesso do HighBond do usuário atual, armazenado no registro do Windows, é usado automaticamente.
Analytics

(ativação off-line)

PASSWORD número é obrigatória.
Robôs
TO nome_arquivo

Para exportações para um arquivo, o nome do arquivo.

Se necessário, você pode incluir um caminho de arquivo absoluto ou relativo, mas a pasta do Windows já deverá existir. É preciso especificar o valor de nome_arquivo como uma cadeia entre aspas.

Nota

Para exportar para um arquivo de valores separados por vírgula (*.csv), você deve especificar a extensão de arquivo .csv como parte de nome_arquivo. Por exemplo: vendors.csv

TO id_aclgcr

Para exportações para o aplicativo Resultados do HighBond, o destino no Resultados. (ACLGRC)

O valor de id_aclgrc deve incluir o número de ID do teste de controle do Resultados e, se você está exportando para um data center localizado fora da América do Norte (EUA), o código do data center. O valor de id_aclgrc deve estar entre aspas.

O número de ID do teste de controle e o código do data center devem ser separados por um símbolo de arroba (@). Por exemplo, TO "99@eu".

Se você não sabe qual é o número de ID do teste de controle, use a interface do usuário do Analytics para iniciar uma exportação para o Resultados. Cancele a exportação após identificar o número de ID do teste de controle. Para obter mais informações, consulte Exportação de exceções para o aplicativo Resultados no HighBond.

O código do data center especifica para qual servidor regional do HighBond você está exportando dados:

  • af – África (África do Sul)
  • ap – Ásia-Pacífico (Singapura)
  • au – Ásia-Pacífico (Austrália)
  • ca – América do Norte (Canadá)
  • eu – Europa (Alemanha)
  • jp – Ásia-Pacífico (Tóquio)
  • sa – América do Sul (Brasil)
  • us – América do Norte (EUA)

Você somente pode usar os códigos de data center autorizados para a instância do HighBond na sua organização. O data center da América do Norte (EUA) é o padrão. Portanto, a especificação de @us é opcional.

TO url_api_highbond

Para exportações para o aplicativo Robôs do HighBond, o destino no Robôs. (HBDATA)

Nota

Não é possível exportar para um robô ACL. Você deve exportar para um robô HighBond ou de fluxo de trabalho.

O valor url_api_highbond é o URL da solicitação de API do HighBond para o robô de destino. O exemplo abaixo exporta um arquivo *.csv.gz para esse destino:

  • o robô com ID número 52053

  • no HighBond org com ID número 1000236

  • no data center da América do Norte (EUA) do HighBond

TO "https://apis-us.highbond.com/v1/orgs/1000236/robots/52053/working_files?env=development"

Use o parâmetro da cadeia de consulta env para especificar se o arquivo é exportado para o modo de desenvolvimento ou produção no robô:

Modo de desenvolvimento

(padrão)

  • ?env=development

ou

  • nenhuma cadeia de consulta especificada
Modo de produção

  • ?env=production

OVERWRITE

opcional

Aplica-se somente a aplicativos do HighBonds. (ACLGRC, HBDATA)

  • OVERWRITE especificado Todos os dados existentes no teste de controle de destino (tabela) ou robô serão sobrescritos pelos dados exportados. Você deve ter uma função de Gerente Profissional na coleção de destino para sobrescrever dados.

  • OVERWRITE omitido Os dados exportados serão anexados aos dados existentes no teste de controle de destino (tabela). Para obter mais informações, consulte Exportar para o Resultados do HighBond.

    Anexar não é suportado para arquivos *.csv.gz no Robôs.

Todas as interpretações relacionadas ao teste de controle de destino (tabela) são atualizadas dinamicamente para refletir os dados importados, sobrescritos ou anexados.
IF teste

opcional

Uma expressão condicional que deve ser verdadeira para processar cada registro. O comando é executado apenas nos registros que atendem à condição.

Nota

O parâmetro IF é avaliado apenas em relação aos registros restantes em uma tabela depois da aplicação dos parâmetros de escopo (WHILE, FIRST, NEXT).
WHILE teste

opcional

Uma expressão condicional que deve ser verdadeira para processar cada registro. O comando é executado até que a condição seja avaliada como falsa ou o fim da tabela seja alcançado.

Nota

Se você usar WHILE juntamente com FIRST ou NEXT, o processamento de registros será interrompido assim que um limite for alcançado.
FIRST intervalo | NEXT intervalo

opcional

O número de registros a ser processado:

  • FIRST iniciar o processamento a partir do primeiro registro até alcançar o número de registros especificado
  • NEXT iniciar o processamento a partir do registro selecionado no momento até alcançar o número de registros especificado

Use intervalo para especificar o número de registros a serem processados.

Se você omitir FIRST e NEXT, todos os registros serão processados por padrão.

APPEND

opcional

Aplica-se somente a arquivos de texto e arquivos de texto delimitado. (ASCII, DELIMITED)

Anexa a saída do comando ao final de um arquivo existente, em vez de sobrescrevê-lo.

Nota

Você deve garantir que a estrutura da saída do comando e o arquivo existente são idênticos:

  • os mesmos campos
  • a mesma ordem de campos
  • os campos correspondentes têm o mesmo comprimento
  • os campos correspondentes têm o mesmo tipo de dados

O Analytics anexa a saída a um arquivo existente, seja qual for sua estrutura. Se a estrutura da saída e do arquivo existente não corresponderem, o resultado poderá ser dados misturados, ausentes ou incorretos.

KEEPTITLE

opcional

Aplica-se somente a arquivos de texto, arquivos de texto delimitado e arquivos de valores separados por vírgula. (ASCII, DELIMITED)

Inclua os nomes dos campos do Analytics nos dados exportados. Se omitido, nenhum nome de campo aparecerá no arquivo de saída.

SEPARATOR caractere

opcional

Aplica-se somente a arquivos de texto delimitado e arquivos de valores separados por vírgula. (DELIMITED)

O caractere a ser usado como separador entre campos. É preciso especificar o caractere como uma cadeia entre aspas.

Por padrão, o Analytics usa um ponto e vírgula. Não especifique nenhum caractere diferente de vírgula se você está exportando para um arquivo de valores separados por vírgula.

QUALIFIER caractere

opcional

Aplica-se somente a arquivos de texto delimitado e arquivos de valores separados por vírgula. (DELIMITED)

O caractere qualificador de texto. Os valores dos campos são colocados entre caracteres qualificadores para identificação. É preciso especificar o caractere como uma cadeia entre aspas.

Por padrão o, Analytics usa aspas duplas.

WORKSHEET nome_planilha

opcional

Aplica-se somente a arquivos *.xlsx do Microsoft Excel. (XLSX)

O nome da planilha Excel criada em um arquivo Excel novo ou existente. Especifique até 31 caracteres.

Por padrão, o Analytics usa o nome da tabela do Analytics que você está exportando como o nome da planilha. Nomes com mais de 31 caracteres ficam truncados.

O nome_planilha pode conter apenas caracteres alfanuméricos ou o caractere sublinhado ( _ ). O nome não pode conter caracteres especiais, espaços ou começar com um número. O valor pode ser opcionalmente colocado entre aspas.

Para obter detalhes sobre a sobrescrita de pastas de trabalho e planilhas do Excel na exportação, consulte O parâmetro WORKSHEET e a sobrescrita.

DISPLAYNAME

opcional

Aplica-se somente ao Resultados do HighBond. (ACLGRC)

Exporta nomes de campos como nomes de campos e nomes de exibição como nomes de exibição para que os nomes de exibição apareçam em cabeçalhos de colunas no Resultados sem afetar o nome de campo real.

DISPLAYNAME pode ser combinado com AS. Para obter mais informações, consulte Como DISPLAYNAME interage com AS na exportação para o Resultados do HighBond.

Exemplos

Exemplos do Excel

Exemplos de arquivos delimitados

Exemplo de arquivo de valores separados por vírgula (CSV)

Exemplo do aplicativo Resultados

Exemplos do aplicativo Robôs

Exemplos do Excel

Exportar dados para um arquivo .xlsx do Excel

Exporte campos específicos da tabela Fornecedor para um arquivo *.xlsx do Excel:

OPEN Fornecedor
EXPORT FIELDS Num_Fornecedor Nome_Fornecedor Cidade_Fornecedor XLSX TO "ExportaçãoFornecedor"

Exportar dados para um arquivo .xlsx do Excel e especificar um nome de planilha

Exporte campos específicos da tabela Fornecedor para uma planilha denominada Fornecedores_EUA em um arquivo *.xlsx do Excel:

OPEN Fornecedor
EXPORT FIELDS Num_Fornecedor Nome_Fornecedor Cidade_Fornecedor XLSX TO "ExportaçãoFornecedor" WORKSHEET Fornecedores_EUA

Exemplos de arquivos delimitados

Exportar todos os campos para um arquivo delimitado

Exporte todos os campos específicos da tabela Fornecedor para um arquivo delimitado:

OPEN Fornecedor
EXPORT FIELDS ALL DELIMITED TO "ExportaçãoFornecedor"

Exportar um subconjunto dos campos para um arquivo delimitado

Você tem duas opções ao exportar um subconjunto dos campos de uma tabela para um arquivo externo:

  • especificar os campos individuais a serem exportados
  • especificar FIELDS ALL e especificar os campos a serem excluídos da exportação

Dica

Use o método menos trabalhoso.

Os exemplos abaixo se referem à tabela Fornecedor, que tem oito campos:

  • número do fornecedor
  • nome do fornecedor
  • rua do Fornecedor
  • cidade do fornecedor
  • estado do fornecedor
  • CEP do fornecedor
  • data de última atividade
  • data de revisão

Especificar os campos a exportar

Exporte dois campos da tabela Fornecedor para um arquivo delimitado:

OPEN Fornecedor
EXPORT FIELDS Num_Fornecedor Nome_Fornecedor DELIMITED TO "Fornecedores" KEEPTITLE SEPARATOR "|" QUALIFIER '"'

Especificar FIELDS ALL e especificar os campos a serem excluídos

Você exporta todos os campos, exceto os campos de data de última atividade e data de revisão, da tabela Fornecedor para um arquivo delimitado:

OPEN Fornecedor
EXPORT FIELDS ALL EXCLUDE Última_Atividade_Fornecedor Data_Revisão_Fornecedor DELIMITED TO "Endereços_Fornecedor" KEEPTITLE SEPARATOR "|" QUALIFIER '"'

Exportar dados para vários arquivos delimitados usando GROUP

Exporte campos específicos da tabela Fornecedor para dois arquivos delimitados:

  • um arquivo para nomes de fornecedor iniciando por "A" a "M"
  • um arquivo para nomes de fornecedor iniciando por "N" a "Z"

Use o comando GROUP para testar o nome do fornecedor de cada registro com uma condição IF:

GROUP
  EXPORT FIELDS EXPORT FIELDS Fornecedor_No Nome_Fornecedor DELIMITED TO "AaM" IF BETWEEN(UPPER(VENDOR_NAME), "A", "M")
  EXPORT FIELDS Fornecedor_No Nome_Fornecedor DELIMITED TO "NaZ" IF BETWEEN(UPPER(VENDOR_NAME), "N", "Z")
END

Exemplo de arquivo de valores separados por vírgula (CSV)

Exporte todos os campos para um arquivo de valores separados por vírgula

Exporte todos os campos da tabela Fornecedor para um arquivo de valores separados por vírgula:

OPEN Fornecedor
EXPORT FIELDS ALL DELIMITED TO "ExportaçãoFornecedor.csv"

Exemplo do aplicativo Resultados

Exporte dados para o aplicativo Resultados do HighBond

Especificar os campos a exportar

Exporte campos específicos da tabela Exceções_AR para o Resultados do HighBond. Sobrescreva dados existentes no teste de controle (tabela) de destino:

OPEN Exceções_CR
EXPORT FIELDS Sem Data de Vencimento Ref Tipo de Valor ACLGRC TO "10926@us" OVERWRITE

Criar uma definição de senha para executar o comando no Robôs

Crie uma definição de senha de duas partes com uma tag de análise PASSWORD e um parâmetro PASSWORD correspondente no comando EXPORT.

A tag de análise //PASSWORD 1 cria um parâmetro de entrada de senha na tarefa do robô. O parâmetro PASSWORD 1 correspondente no comando EXPORT faz referência ao valor de senha armazenado e criptografado na tarefa. A senha obrigatória é um token válido de acesso do HighBond. Para obter mais informações, consulte Criação de uma definição de senha e especificação do valor da senha.

COMMENT
//ANALYTIC Exportar dados para o Resultados
//PASSWORD 1 Token de acesso do HighBond:
//RESULT LOG
END

OPEN Exceções_CR
EXPORT FIELDS Sem Data de Vencimento Ref Tipo de Valor ACLGRC PASSWORD 1 TO "10926@us" OVERWRITE

Exemplos do aplicativo Robôs

Exporte dados para o aplicativo Robôs do HighBond

Nota

Não é possível exportar para um robô ACL. Você deve exportar para um robô HighBond ou de fluxo de trabalho.

Para saber mais sobre como acessar os dados após exportá-los para o Robôs, veja o método load_working_file().

Especificar os campos a exportar

Exporte campos específicos da tabela Trans_Maio para um arquivo CSV compactado (*.csv) no Robôs do HighBond. Se um arquivo com o mesmo nome já existir no robô 52053, no Modo de desenvolvimento, ele será sobrescrito:

OPEN Trans_Maio
EXPORT FIELDS CARDNUM AS 'CARDNUM' CODES AS 'CODES' DATE AS 'DATE' CUSTNO AS 'CUSTNO' DESCRIPTION AS 'DESCRIPTION' AMOUNT AS 'AMOUNT' HBDATA TO "https://apis-us.highbond.com/v1/orgs/1000236/robots/52053/working_files?env=development" OVERWRITE

Criar uma definição de senha para executar o comando no Robôs

Crie uma definição de senha de duas partes com uma tag de análise PASSWORD e um parâmetro PASSWORD correspondente no comando EXPORT.

A tag de análise //PASSWORD 1 cria um parâmetro de entrada de senha na tarefa do robô. O parâmetro PASSWORD 1 correspondente no comando EXPORT faz referência ao valor de senha armazenado e criptografado na tarefa. A senha obrigatória é um token válido de acesso do HighBond. Para obter mais informações, consulte Criação de uma definição de senha e especificação do valor da senha.

COMMENT
//ANALYTIC Exportar dados do Analytics para o Robôs
//PASSWORD 1 Token de acesso do HighBond:
//RESULT LOG
END

OPEN Trans_Maio
EXPORT FIELDS CARDNUM AS 'CARDNUM' CODES AS 'CODES' DATE AS 'DATE' CUSTNO AS 'CUSTNO' DESCRIPTION AS 'DESCRIPTION' AMOUNT AS 'AMOUNT' HBDATA PASSWORD 1 TO "https://apis-us.highbond.com/v1/orgs/1000236/robots/52053/working_files?env=development" OVERWRITE

Exportar todos os campos

Exporte todos os campos da tabela Trans_Maio para um arquivo CSV compactado (*.csv.gz) no Robôs do HighBond:

OPEN Trans_Maio
EXPORT FIELDS ALL HBDATA PASSWORD 3 TO "https://apis-us.highbond.com/v1/orgs/1000236/robots/52053/working_files?env=development" OVERWRITE

Especificar FIELDS ALL e especificar os campos a serem excluídos

Exporte todos os campos, exceto os campos de data de última atividade e data de revisão, da tabela Fornecedor para um arquivo CSV compactado (*.csv.gz) no Robôs do HighBond:

OPEN Fornecedor
EXPORT FIELDS ALL EXCLUDE Vendor_Last_Active Vendor_Review_Date HBDATA PASSWORD 3 TO "https://apis-us.highbond.com/v1/orgs/1000236/robots/52053/working_files?env=development" OVERWRITE

Observações

Uso do EXPORT com o comando GROUP

Para maioria dos formatos de exportação, é possível exportar dados em vários arquivos simultaneamente usando o comando GROUP.

Apenas um arquivo pode ser criado por vez, quando você está exportando dados para o Microsoft Excel e Microsoft Access.

Exportando para o Excel

Os limites a seguir se aplicam à exportação de dados para um arquivo do Excel.

Limite Detalhes
Número de registros
  • Excel 2007 e posterior (*.xlsx) máximo de 1.048.576 registros por 16.384 campos (tamanho máximo da planilha aceito pelo Excel)
  • Excel 97 e 2003 máximo de 65.536 registros

As tabelas do Analytics que ultrapassarem estes limites serão exportadas com sucesso, mas os registros em excesso serão ignorados e não serão exportados.
Comprimento dos campos
  • nenhum limite específico de comprimento dos campos
  • os comprimentos dos campos combinados não podem exceder o limite geral de comprimento de registros de 32 KB

    (32.765 caracteres no Analytics não Unicode e 16.382 caracteres no Analytics Unicode)

  • para o Excel 2.1, no máximo 247 caracteres
Comprimento dos nomes de campo
  • máximo de 64 caracteres
  • para o Excel 2.1, no máximo 248 caracteres
Tamanho dos nomes de planilha
  • máximo de 31 caracteres

Se você usar o nome de uma tabela do Analytics como nome da planilha, o nome ficará truncado na exportação para o Excel caso tenha mais de 31 caracteres.

O parâmetro WORKSHEET e a sobrescrita

O resultado de usar ou não o parâmetro WORKSHEET na exportação de uma tabela do Analytics para um arquivo Excel está explicado a seguir:

Correspondência

Descrição

 Parâmetro WORKSHEET usado Parâmetro WORKSHEET não usado
Nenhum arquivo Excel com nome correspondente
  • TO o valor de nome_arquivo não corresponde a nenhum nome de arquivo Excel existente
 Um novo arquivo Excel é criado, com uma planilha com o nome especificado Um novo arquivo Excel é criado, com uma planilha que usa o nome da tabela do Analytics exportada

Nome de arquivo Excel correspondente

Nenhum nome de planilha correspondente
  • TO o valor de nome_arquivo e um nome de arquivo Excel existente são idênticos
  • WORKSHEET nome_planilha não corresponde a um nome de planilha no arquivo Excel
 Uma planilha com o nome especificado é adicionada ao arquivo Excel existente O arquivo Excel existente é sobre escrito por um novo arquivo Excel, com uma planilha que usa o nome da tabela do Analytics exportada
Nome de arquivo Excel e nome de planilha correspondente
  • TO o valor de nome_arquivo e um nome de arquivo Excel existente são idênticos
  • WORKSHEET nome_planilha corresponde a um nome de planilha no arquivo Excel

Se a planilha existente foi criada originalmente pelo Analytics, será sobrescrita por uma planilha com o nome especificado.

Se a planilha existente foi criada originalmente no Excel, será exibida uma mensagem de erro e operação exportação será cancelada.

 O arquivo Excel existente é sobre escrito por um novo arquivo Excel, com uma planilha que usa o nome da tabela do Analytics exportada

Exportar para o Resultados do HighBond

A tabela abaixo contém informações adicionais sobre a exportação para um teste de controle no aplicativo Resultados.

Item

Detalhes

Permissões obrigatórias

A capacidade de exportar resultados para um teste de controle no aplicativo Resultados exige uma atribuição de função específica do HighBond ou privilégios administrativos:

  • Usuários com a função Usuário Profissional ou Gerente Profissional para uma coleção do Resultados podem exportar os resultados para qualquer teste de controle na coleção.

    Nota

    Somente os usuários com a função Gerente Profissional podem exportar e sobrescrever dados em um teste de controle.

  • Os Administradores de Sistema do HighBond e os administradores do Resultados recebem automaticamente a função Gerente Profissional em todas as coleções das organizações do HighBond que administram.

Para obter mais informações, consulte Permissões do aplicativo Resultados.

Limites de exportação

Os limites a seguir se aplicam à exportação para um teste de controle:

  • Máximo de 100.000 registros por exportação
  • Máximo de 100.000 registros por teste de controle
  • Máximo de 500 campos por registro
  • Máximo de 256 caracteres por campo

Você pode exportar várias vezes para o mesmo teste de controle desde que não exceda os limites gerais.

Anexação de campos

(OVERWRITE não especificado)

Independentemente da sua ordem em uma tabela do Analytics, os campos exportados são anexados aos campos existentes em um teste de controle se tiverem nomes de campos físicos correspondentes.

No Analytics, o nome do campo físico é o nome no layout da tabela. Campos exportados que não corresponderem ao nome de nenhum campo existente serão acrescentados como colunas adicionais na tabela no Resultados.

Os nomes de exibição de campos no Analytics e no Resultados não serão considerados. No entanto, se você usar o parâmetro opcional AS nome_de_exportação, o valor de nome_de_exportação será usado como o nome do campo físico se você não usar DISPLAYNAME.

Na anexação de dados a campos de questionários, o nome de exibição da coluna no Resultados permanece o nome especificado na configuração do questionário.

A anexação funciona de forma diferente se o teste de controle de destino tem um campo de chave primária especificado. Para obter mais informações, consulte Exportação de exceções para o aplicativo Resultados no HighBond.

Nota

Se você estiver executando um processo de ida e volta de dados entre o Resultados e o Analytics, e os dados estiverem desalinhados no Resultados, é provável que existam nomes de campos divergentes.

Para obter mais informações, consulte Considerações sobre nomes de campos para importação e exportação de dados do Resultados.

Requisito de senha

Consulte Criação de uma definição de senha e especificação do valor da senha.

Como DISPLAYNAME interage com AS na exportação para o Resultados do HighBond

A matriz abaixo mostra como o parâmetro DISPLAYNAME interage com AS na exportação de nomes de campos do Analytics para o Resultados.

  Sem AS Com AS
Sem DISPLAYNAME O nome do campo e o nome de exibição no Resultados são o nome do campo do Analytics. O nome do campo e o nome de exibição no Resultados são o nome de exibição do parâmetro AS.
Com DISPLAYNAME O nome do campo no Resultados é o nome do campo do Analytics. O nome de exibição no Resultados é o nome de exibição do Analytics. O nome do campo no Resultados é o nome do campo do Analytics. O nome de exibição no Resultados é o nome de exibição do parâmetro AS.

Permissões necessárias para exportar para robôs HighBond

A habilidade de carregar um arquivo CSV compactado (*.csv.gz) no aplicativo Robôs requer uma atribuição de função de robô específica ou privilégios administrativos:

  • Usuários com função de Editor ou Proprietário para um robô podem carregar um arquivo CSV compactado no robô. Usuários com função de Revisor não conseguem fazer carregamentos.

  • Administradores do Robôs são automaticamente colaboradores para cada robô, com a função de Proprietário.

  • Um Administrador de Sistema do HighBond com uma assinatura Profissional é automaticamente um Administrador do Robôs e Administrador do Resultados.

Para obter mais informações, consulte Permissões do aplicativo Robôs.

Criação de uma definição de senha e especificação do valor da senha

Quando você executa um script no Robôs que exporta dados para o aplicativo Resultados ou carrega um arquivo CSV compactado (*.csv.gz) no aplicativo Robôs, é preciso incluir uma definição de senha com o comando EXPORT. A mesma exigência se aplica a scripts executados no Analytics se você usou a ativação off-line.

Independentemente do método usado para criar a definição de senha, o valor de senha obrigatório é um token de acesso do HighBond, que você pode gerar no Launchpad. Para obter mais informações, consulte Adquira um token de acesso do HighBond.

Métodos para definição de senha

Método Descrição

Tag de análise PASSWORD

(para scripts executados no Robôs)

Se você usar a tag de análise PASSWORD para criar a definição de senha numerada para conexão ao HighBond, nenhum valor de senha será especificado no script. Quando você cria uma tarefa para ser executada no script no Robôs, um campo de entrada no Designer de tarefa permite que você ou outro usuário especifique a senha real.

Para obter mais informações, consulte Tag de análise PASSWORD.

Comando PASSWORD

(para scripts executados no Analytics com ativação off-line)

Se você usar o comando PASSWORD para criar a definição de senha numerada para se conectar ao HighBond, nenhum valor de senha será especificado no script. Um prompt de senha será exibido quando o script tentar se conectar.

Para obter mais informações, consulte Comando PASSWORD.

Comando SET PASSWORD

(para scripts executados no Analytics com ativação off-line)

Se você usar o comando PASSWORD para criar a definição da senha numerada para conexão com o HighBond, um valor de senha será especificado no script, portanto, nenhum prompt de senha será exibido. Essa abordagem é apropriada para scripts criados para execução não assistida, mas ela expõe a senha real em texto não criptografado no script, o que pode não ser adequado para a sua situação.

Para obter mais informações, consulte Comando SET PASSWORD.

Adquira um token de acesso do HighBond

Cuidado

O token de acesso gerado corresponde à conta usada para fazer login no HighBond. Como um autor de scripts, pode não ser apropriado especificar seu próprio token de acesso em um script se ele for usado por outras pessoas.

Proteja os tokens de acesso como qualquer senha de conta.

Use um token existente, a menos que você tenha um motivo para criar um novo. Se o token existente não funcionar, crie um novo. O uso de um token existente reduz o número de tokens que você precisa gerenciar.

  1. Execute uma das seguintes ações:

    • No menu principal do Analytics, selecione Ferramentas > Token de Acesso do HighBond.

    • No Editor de script, clique com o botão direito e selecione Inserir > Token do HighBond.

    A página Gerenciar Tokens da API abre no navegador. Pode ser necessário primeiro fazer o login no HighBond.

    O acesso à página Gerenciar Tokens da API por meio do Analytics é um recurso de conveniência. Você também pode fazer login no HighBond e acessar a página por meio do seu perfil de usuário sem usar o Analytics.

  2. Execute uma das seguintes ações:

    • Usar um token existente

      1. Na coluna Token, clique no token parcialmente mascarado que deseja usar.

      2. Digite a senha da conta do HighBond e clique em Confirmar.

        O token não mascarado é exibido.

      3. Clique em Copiar para copiar o token.

        Dica

        Não feche a caixa de diálogo que contém o token até colar corretamente o token.

    • Criar um novo token

      1. Clique em Adicionar token > Analytics.

      2. No painel lateral Novo token do Analytics, especifique estas informações:

        Campo ou opção Descrição
        Descrição

        Insira uma descrição que forneça informações úteis, como:

        • O propósito do token
        • Onde o token é usado – por exemplo, o nome e a localização do script do Analytics, ou o nome e a localização da tarefa do robô
        Expiração do token
        • Habilitada o token expira após um número de dias especificado
        • Desabilitada o token nunca expira

        Nota

        Sua organização pode ter uma política de segurança que exige a expiração de tokens após um determinado período. É recomendado criar tokens com expiração. O HighBond enviará uma notificação automática por e-mail antes da data de expiração.
        Expiração em Especifique o número de dias até a expiração do token (1 a 365).
        Senha Insira a senha da sua conta do HighBond.

      3. Clique em Gerar token.

      4. Clique em Copiar para copiar o token.

        Dica

        Não feche o painel lateral que contém o token até colar corretamente o token.

  3. Dependendo do método de definição de senha que você está usando, faça uma das seguintes opções:

    • Tag de análise PASSWORD No Designer de Tarefa em um robô ACL, cole o token copiado em um campo de parâmetro de senha.

    • Comando PASSWORD No Analytics, cole o token copiado em um prompt de senha exibido durante a execução de scripts.

    • Comando SET PASSWORD No Analytics, cole o token no ponto apropriado na sintaxe do comando SET PASSWORD em um script.

  4. No Launchpad, feche a caixa de diálogo ou o painel lateral que contém o token.

    Se tiver criado um novo token, uma versão parcialmente mascarada do token é adicionada ao início da lista de tokens.

    Para obter mais informações, consulte Criando e gerenciando tokens de acesso do HighBond.