Comando EXPORT

Exporta dados do Analytics para o formato de arquivo especificado ou para o Resultados do HighBond.

Sintaxe

EXPORT {<FIELDS> nome_campo <AS nome_de_exportação> <...n>|<FIELDS> ALL} <UNICODE> tipo_de_exportação <SCHEMA>PASSWORD num TO {nome_arquivo|id_aclgrc} <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.

  • nome_campo exporta o campo ou os campos especificados

    Separe os nomes dos campos com espaços.

    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.

  • ALL exportar todos os campos da tabela

UNICODE

opcional

Disponível apenas na edição Unicode do Analytics. Aplica-se somente a arquivos de texto (ASCII), texto delimitado (DELIMITED) e XML, bem como à saída da área de transferência do Windows (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 Galvanize Unicode.
tipo_de_exportação

O formato do arquivo de saída ou destino usando 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
  • 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.
  • XLSX arquivo .xlsx do Microsoft Excel

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

  • XML arquivo XML (.xml)
SCHEMA

opcional

Aplica-se apenas à saída em arquivos 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

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

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 uma 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 Exportar para o Resultados do HighBond.

Nota

Dependendo do ambiente em que o script é executado, PASSWORD pode ou não ser obrigatório:

Analytics

(ativação on-line)

PASSWORD não é obrigatório.

O token de acesso do HighBond do usuário atual é usado automaticamente.

Analytics

(ativação off-line)

PASSWORD é obrigatório.
Robôs
Analytics Exchange
Janela Aplicativo de análise
TO nome_arquivo | id_aclgrc

O destino da exportação:

  • TO nome_arquivoexportar dados para um 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_aclgrc exportar dados para o Resultados do HighBond

    O valor de id_aclgrc deve incluir o número de ID do teste de controle e, se você estiver exportando para um data center localizado fora da América do Norte, 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 Resultados do HighBond.

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

    • ap – Ásia-Pacífico
    • au – Austrália
    • ca – Canadá
    • eu – Europa
    • us – América do Norte

    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 é o padrão. Portanto, a especificação de "@us" é opcional.
OVERWRITE

opcional

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

  • OVERWRITE especificado Todos os dados existentes no teste de controle de destino (tabela) 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.

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 (ASCII) e de texto delimitado (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 (ASCII) e arquivos de texto delimitado e de valores separados por vírgula (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 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 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 Microsoft Excel (.xlsx).

O nome da planilha Excel criada em um arquivo Excel novo ou existente.

Por padrão, o Analytics usa o nome da tabela do Analytics que você está exportando como o nome da planilha.

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

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

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"

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"

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 Num_fornecedor Nome_fornecedor DELIMITED TO "AaM" IF BETWEEN(UPPER(NOME_FORNECEDOR); "A"; "M")
  EXPORT FIELDS Num_fornecedor Nome_fornecedor DELIMITED TO "NaZ" IF BETWEEN(UPPER(NOME_FORNECEDOR); "N"; "Z")
END

Exportar dados para o Resultados do HighBond

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 PASSWORD 1 TO "10926@us" OVERWRITE

Observações

Nota

Para obter mais informações sobre o funcionamento desse comando, consulte a Ajuda do Analytics.

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 Excel:

Número de registros
  • Excel 2007 e posterior (*.xlsx) máximo de 1.048.576 registros
  • 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

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 módulo Resultados.

Item

Detalhes

Permissões obrigatórias

A capacidade de exportar resultados para um teste de controle no módulo 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.

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 Resultados do 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.

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

Comando PASSWORD

Se você usar o comando PASSWORD para criar o número de definição da senha para conexão ao HighBond, nenhum valor de senha será especificado. Portanto, a senha será solicitada quando o script tentar se conectar.

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

Comando SET PASSWORD

Se você usar o comando SET PASSWORD para criar o número de definição da senha para conexão ao HighBond, um valor de senha será especificado. Portanto, nenhuma senha será solicitada, o que é adequado para scripts projetados para execução sem intervenção manual.

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

Adquira um token de acesso do HighBond

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 os usuários podem gerar no Launchpad.

Cuidado

O token de acesso gerado corresponde à conta usada para fazer login no Launchpad. 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.

  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 fazer antes o login no Launchpad.

  2. Execute uma das seguintes ações:
    • Use um token existente Na coluna Token, clique no token parcialmente mascarado que você deseja usar e insira a senha da conta do HighBond. O token não mascarado é exibido.

      Dica

      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.

    • Crie um novo token Clique em Criar token > Analytics e insira a senha da sua conta do HighBond.

      Um novo token do Analytics é criado.

      Nota

      Se você é um Administrador de Sistema do Launchpad, também pode criar um token de API. Você deve usar tokens de API apenas para os fins a que se destinam: acesso programático à plataforma do HighBond.

  3. Clique em Copiar para copiar o token.

    Dica

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

  4. No Analytics, execute uma das seguintes ações:
    • cole o token na solicitação de senha
    • cole o token no ponto apropriado na sintaxe do comando SET PASSWORD em um script
  5. No Launchpad, feche a caixa de diálogo 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.

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.