Comando DIALOG
Informações do conceito
Cria uma caixa de diálogo personalizada que solicita interativamente um ou mais valores de entrada de script dos usuários. Cada valor de entrada é armazenado em uma variável nomeada.
Nota
Não é seguro usar o comando DIALOG para inserir senhas. Em vez disso, use Comando PASSWORD.
O comando DIALOG não é suportado em scripts executados no Robôs.
Você pode criar uma caixa de diálogo interativa básica com o Comando ACCEPT.
Dica
A maneira mais fácil de criar caixas de diálogo personalizadas é com o Construtor de diálogos. Para obter mais informações, consulte Criar caixas de diálogo personalizadas.
Sintaxe
DIALOG (DIALOG TITLE texto_título WIDTH pixels HEIGHT pixels) (BUTTONSET TITLE "&OK;&Cancelar" AT pos_x pos_y <WIDTH pixels> <HEIGHT pixels> DEFAULT num_item <HORZ>) <[sintaxe_rótulo]|[sintaxe_caixa_texto]|[sintaxe_caixa_seleção]|[sintaxe_botão_opção]|[sintaxe_lista_suspensa]|[sintaxe_lista_itens_projeto]> <...n>
sintaxe_rótulo ::=
(TEXT TITLE texto_título AT pos_x pos_y <WIDTH pixels> <HEIGHT pixels> <CENTER|RIGHT>)
sintaxe_caixa_texto ::=
(EDIT TO nome_var AT pos_x pos_y <WIDTH pixels> <HEIGHT pixels> <DEFAULT cadeia>)
sintaxe_caixa_seleção ::=
(CHECKBOX TITLE texto_título TO nome_var AT pos_x pos_y <WIDTH pixels> <HEIGHT pixels> <CHECKED>)
sintaxe_botão_opção ::=
(RADIOBUTTON TITLE lista_valores TO nome_var AT pos_x pos_y <WIDTH pixels> <HEIGHT pixels> <DEFAULT num_item> <HORZ>)
sintaxe_lista_suspensa ::=
(DROPDOWN TITLE lista_valores TO nome_var AT pos_x pos_y <WIDTH pixels> <HEIGHT pixels> <DEFAULT num_item>)
project_item_list_syntax ::=
(ITEM TITLE categoria_item_projeto TO nome_var AT pos_x pos_y <WIDTH pixels> <HEIGHT pixels> <DEFAULT cadeia>)
Parâmetros
Parâmetros gerais
| Nome | Descrição |
|---|---|
| DIALOG TITLE texto_título |
Cria a caixa de diálogo principal e o título da caixa de diálogo. texto_título deve ser especificado como uma cadeia entre aspas. |
| BUTTONSET TITLE "&OK;&Cancelar" |
Os rótulos para os botões OK e Cancelar na caixa de diálogo. Normalmente, você não deve editar os valores de texto dos rótulos. Se você editar os valores, certifique-se de que o valor positivo venha antes do negativo. Por exemplo: "&Sim;&Não" |
| WIDTH pixels |
A largura do controle individual ou a largura da caixa de diálogo, se especificada para o controle DIALOG. O valor é especificado em pixels. Se nenhum valor for especificado para um controle, a largura será calculada com base no maior valor contido pelo controle. |
| HEIGHT pixels |
A altura do controle individual ou a altura da caixa de diálogo, se especificada para o controle DIALOG. O valor é especificado em pixels. |
| AT pos_x pos_y |
O local do canto superior esquerdo do controle na caixa de diálogo personalizada:
|
| DEFAULT num_item |
O valor numérico que corresponde ao valor de BUTTONSET que você deseja selecionar como padrão. Por exemplo, se os valores de BUTTONSET forem "&OK;&Cancelar", especifique DEFAULT 1 para selecionar OK por padrão. |
| HORZ opcional |
Exibe horizontalmente os valores para o controle BUTTONSET. Os valores são exibidos verticalmente por padrão. |
Nota
Para a maioria dos tipos de controle, o comando DIALOG cria uma variável para armazenar a entrada do usuário. Não use caracteres que não sejam em inglês, como é, em nomes de variáveis que serão usadas na substituição de variáveis. Nomes variáveis que contenham caracteres não ingleses causarão falhas na substituição de variáveis.
Por padrão, algumas variáveis de DIALOG são criadas como variáveis de caractere. Se usar uma variável de caracteres para armazenar valores numéricos ou datahora, você deverá converter a variável para o tipo de dados necessário no processamento subsequente em um script. Para obter mais informações, consulte Tipo de dados de entrada.
Parâmetros de rótulo
| Nome | Descrição |
|---|---|
| TEXT | Cria um rótulo de texto para identificar, notificar ou instruir. |
| TITLE texto_título |
O rótulo de controle. texto_título deve ser especificado como uma cadeia entre aspas. |
| CENTER | RIGHT opcional |
O alinhamento do texto no controle. Se você omitir CENTER ou RIGHT, será usado por padrão o alinhamento à esquerda. |
Parâmetros da caixa de texto
| Nome | Descrição |
|---|---|
|
EDIT |
Cria uma caixa de texto para entradas do usuário. |
| TO nome_var |
O nome da variável de caracteres que armazena o valor de entrada especificado pelo usuário. Se a variável já existir, o controle especificado será atribuído. Se a variável não existir, será criada e o valor especificado será atribuído. |
| DEFAULT cadeia opcional |
A cadeia de texto padrão a ser exibida no controle. cadeia deve ser especificada como uma cadeia entre aspas. |
Parâmetros da caixa de seleção
| Nome | Descrição |
|---|---|
|
CHECKBOX |
Cria uma caixa de seleção para apresentar uma opção para o usuário. |
| TITLE texto_título |
O rótulo de controle. texto_título deve ser especificado como uma cadeia entre aspas. |
| TO nome_var |
O nome da variável lógica que armazena o valor verdadeiro ou falso especificado pelo usuário. Se a variável já existir, o controle especificado será atribuído. Se a variável não existir, será criada e o valor especificado será atribuído. |
|
CHECKED opcional |
Define o controle como marcado por padrão. |
Parâmetros do botão de opção
| Nome | Descrição |
|---|---|
|
RADIOBUTTON |
Cria botões de opção para apresentar opções mutuamente exclusivas ao usuário. |
| TITLE lista_valores |
A lista de valores exibida para o controle. Os valores devem ser especificados como uma cadeia entre aspas. Separa cada valor com um ponto e vírgula (;). |
| TO nome_var |
O nome da variável numérica que armazena a posição numérica do valor do botão de opção selecionado pelo usuário. Se a variável já existir, o controle especificado será atribuído. Se a variável não existir, será criada e o valor especificado será atribuído. |
| DEFAULT num_item opcional |
O valor numérico que corresponde ao item da lista que você deseja selecionar como padrão. Por exemplo, se a lista_valores for "Vermelho;Verde;Azul", especifique DEFAULT 2 para selecionar Verde como padrão quando a lista suspensa for exibida. |
| HORZ opcional |
Exibe horizontalmente os valores para o controle. Os valores são exibidos verticalmente por padrão. |
Parâmetros da lista suspensa
| Nome | Descrição |
|---|---|
|
DROPDOWN |
Cria uma lista suspensa para apresentar uma lista de opções ao usuário. |
| TITLE lista_valores |
A lista de valores exibida para o controle. Os valores devem ser especificados como uma cadeia entre aspas. Separa cada valor com um ponto e vírgula (;). |
| TO nome_var |
O nome da variável de caracteres que armazena o valor da lista suspensa selecionado pelo usuário. Se a variável já existir, o controle especificado será atribuído. Se a variável não existir, será criada e o valor especificado será atribuído. |
| DEFAULT num_item opcional |
O valor numérico que corresponde ao item da lista que você deseja selecionar como padrão. Por exemplo, se a lista_valores for "Vermelho;Verde;Azul", especifique DEFAULT 2 para selecionar Verde como padrão quando a lista suspensa for exibida. |
Parâmetros da lista de itens do projeto
| Nome | Descrição |
|---|---|
|
ITEM |
Cria uma lista de itens de projeto para apresentar uma lista de itens de projeto do Analytics, como campos, ao usuário. |
| TITLE categoria_item_projeto |
A categoria do item do projeto a incluir no controle. Você pode especificar uma ou mais categorias. O usuário pode selecionar um único valor na lista de itens de projeto. Coloque categoria_item_projeto entre aspas, sem espaço ou pontuação entre os tipos de item. Para ver os códigos usados para especificar as categorias, consulte Códigos para categorias de item de projeto. Nota Não misture categorias diferentes no mesmo controle ITEM, a menos que tenha uma razão específica para fazê-lo. Por exemplo, não misture tabelas e campos. A lista de itens do projeto resultante ficará confusa para o usuário. |
| TO nome_var |
O nome da variável de caracteres que armazena o nome do item do projeto selecionado pelo usuário. Se a variável já existir, o controle especificado será atribuído. Se a variável não existir, será criada e o valor especificado será atribuído. |
| DEFAULT cadeia opcional |
O nome exato do item do projeto que você deseja selecionar como padrão. cadeia deve ser especificada como uma cadeia entre aspas. |
Exemplos
Como solicitar a tabela e o script ao usuário
Em um script, você precisa solicitar que o usuário selecione a tabela e o script do Analytics a serem usados na execução de uma análise.
Especifique que a tabela Metaphor_Inventário_2012 do projeto do ACL_Demo.acl é selecionada como padrão como a tabela do Analytics, mas o usuário pode selecionar qualquer tabela no projeto.
O script a ser executado também deve ser selecionado da lista de scripts no projeto do Analytics:
DIALOG (DIALOG TITLE "Análise de Inventário" WIDTH 500 HEIGHT 200) (BUTTONSET TITLE "&OK;&Cancelar" AT 370 12 DEFAULT 1 ) (TEXT TITLE "Selecione os itens do projeto do Analytics para analisar." AT 50 16 ) (TEXT TITLE "Tabela:" AT 50 50 ) (ITEM TITLE "f" TO "v_tabela" AT 50 70 DEFAULT "Metaphor_Inventário_2012" ) (TEXT TITLE "Script:" AT 230 50 ) (ITEM TITLE "b" TO "v_script" AT 230 70 )
Mais exemplos
Para ver mais exemplos de DIALOG, consulte Exemplo de script: filtra registros por data e agrupa os registros filtrados por mês.
Observações
Para obter mais informações sobre o funcionamento desse comando, consulte Criar caixas de diálogo personalizadas.
Para obter informações detalhadas sobre variáveis, consulte Trabalhando com variáveis no ACLScript.
Interatividade
Use DIALOG para criar um script interativo. Quando o comando DIALOG é processado, o script é pausado e uma caixa de diálogo é exibida solicitando informações do usuário que o Analytics usa posteriormente no processamento.
É possível criar caixas de diálogo separadas que solicitam um item de cada vez ou criar uma que solicita vários itens.
Comparação entre ACCEPT e DIALOG
O comando ACCEPT permite criar uma caixa de diálogo interativa básica, que pode ter um ou mais dos seguintes tipos de controles:
- caixa de texto
- lista de Itens do projeto
Para uma interatividade básica, ACCEPT pode ser suficiente. Para obter mais informações, consulte Comando ACCEPT.
Códigos para categorias de item de projeto
Use os seguintes códigos para especificar a categoria do item do projeto a ser exibido em uma lista de itens de projeto.
Categorias de projeto
|
Código |
Categoria |
|---|---|
|
f |
Tabelas |
|
bi |
Scripts |
|
i |
Índices |
|
r |
Exibições e relatórios |
|
w |
Áreas de trabalho |
Categorias de campo
|
Código |
Categoria |
|---|---|
|
C |
Campos de caractere |
|
N |
Campos numéricos |
|
D |
Campos de datahora |
|
L |
Campos lógicos |
Categorias de variável
|
Código |
Categoria |
|---|---|
|
c |
Variáveis de caractere |
|
n |
Variáveis numéricas |
|
d |
Variáveis de datahora |
|
l |
Variáveis lógicas |
Tipo de dados de entrada
Alguns controles do comando DIALOG armazenam as entradas do usuário em variáveis de caractere. Se você precisar de entradas numéricas ou datahora, poderá usar as funções VALUE( ) ou CTOD( ) para converter o conteúdo da variável de caracteres em um valor numérico ou datahora:
SET FILTER TO BETWEEN(%v_campo_data%; CTOD(%v_data_inicial%); CTOD(%v_data_final%))
No exemplo, as datas inicial e final desse filtro são armazenadas como valores de caractere. Elas devem ser convertidas em valores de dada para serem usadas com um campo de data que usa um tipo de dados Datetime.
Delimitar o nome da variável com símbolos de porcentagem (%) substitui o valor do caractere contido pela variável pelo nome da variável. A função CTOD( ) converte em seguida o valor do caractere em um valor de data.
Posição do comando DIALOG
É recomendável colocar todos os comandos DIALOG no início de um script, se possível. Se você solicitar todas as entradas no início, o script poderá ser executado sem interferências assim que o usuário digitar as informações necessárias.
Nota
Você não pode usar o comando DIALOG dentro do comando GROUP.
