Registro de Scripts

Os scripts registrados são associados a um arquivo de script (que consiste no script Jython ou Visual Basic) e a um aplicativo de destino. Quando o script personalizado é executado, você é solicitado a escolher um valor em uma lista com o qual deve completar os parâmetros do script.


A imagem mostra a guia Registro de Script Personalizado.

Para registrar um script:

  1. Na guia Configurar, em Scripts, selecione Registro de Script.

    A tela Registro de Script Personalizado consiste em três regiões:

    • Resumo — Lista todos os scripts personalizados.

    • Detalhes — Mostra o nome do script, o aplicativo de destino associado e o arquivo de script.

    • Parâmetros — Mostra o nome e o tipo do parâmetro, o nome de exibição, a sequência, o valor do parâmetro e qualquer definição de consulta usada para fornecer uma lista de valores para um determinado script personalizado.

  2. Acima da grade Resumo, clique em Adicionar.

  3. Na grade Detalhes, em Nome, informe o nome do script personalizado.

  4. Em Aplicativo de Destino, selecione o aplicativo de destino associado ao script personalizado.

  5. Para associar o script personalizado a um grupo de scripts personalizado, em Grupo de Scripts Personalizado, selecione o grupo.

  6. Em Arquivo de Script, selecione o arquivo de script para associar ao script personalizado.

    Para procurar um arquivo de script, clique em Selecionar e escolha um arquivo de script na tela Selecionar Arquivo de Script.

    Para fazer upload de um arquivo de script, clique em Selecionar. Em Selecionar Arquivo de Script, clique em Upload. Em seguida, clique em Procurar para navegar até o arquivo de script a ser carregado e clique em OK.

  7. Clique em Salvar.

Para definir os parâmetros do script personalizado:

  1. Na grade Resumo, selecione o nome do arquivo de script ao qual adicionar parâmetros.

  2. Na grade Parâmetros de Script, clique em Adicionar.

    Uma linha em branco é exibida, à qual os parâmetros devem ser adicionados.

  3. Em Nome do Parâmetro, insira o nome do parâmetro que referenciado no script.

    Por exemplo, digite PDVLOC, para o local do PDV, PDVPeriod para o período do PDV, PDVCAT para categoria do PDV ou PDVTARGET para a categoria de destino.

    O nome do parâmetro é definido pelo usuário. Você pode selecionar um prefixo ou sufixo para distingui-los no script personalizado.

  4. Em Tipo, selecione o tipo de parâmetro.

    Tipos disponíveis:

    • PDV — Solicita o local, o período, a categoria ou a regra do PDV. Os valores de PDV são obtidos dos usuários do PDV quando o script personalizado é executado.

    • Consulta—O tipo Consulta permite criar uma consulta que preenche uma lista de valores que um usuário pode selecionar ao executar o script personalizado.

    • Estático — Um tipo Estático indica que o parâmetro é um valor constante ou predefinido, e o valor do parâmetro é fornecido pelo usuário. Quando o script personalizado é executado, você pode fornecer outro valor para o parâmetro.

    Você pode usar qualquer nome para o parâmetro e também usar um prefixo ou sufixo com o nome para diferenciá-los no script personalizado.

    O nome do parâmetro deve corresponder exatamente ao fornecido no registro de script

  5. Em Nome de Exibição, informe o nome a ser exibido para o parâmetro na tela Executar Script.

  6. Em Valor do Parâmetro, informe o valor para o tipo de parâmetro "Estático".

    O valor do parâmetro deve ser recuperado no script personalizado usando a seguinte API:

    fdmAPI.getCustomScriptParameterValue("PARAMETER NAME"))
  7. Em Sequência, informe a ordem de exibição do parâmetro na tela Executar Script.

  8. Em Consulta, especifique a definição de consulta que fornece uma lista de valores para o parâmetro.

    Por exemplo, para mostrar uma lista de regras de dados para o usuário selecionar na tela Gerar Relatório, especifique a definição de consulta para definir essas consultas.

  9. Clique em Salvar.