Incluindo um elemento de código JavaScript

Use um elemento de código JavaScript para cada bloco de código que você está usando em um modelo.
Restrição: ícone Novo recurso O elemento de código JavaScript está disponível apenas em modelos da versão 2.

Sobre Esta Tarefa

JavaScript pode variar de argumentos simples para scripts complexos.
  • Para argumentos simples, é possível aplicar script ao conteúdo de um elemento, como um elemento de texto. Clique duas vezes no elemento de texto, selecione a guia Expressão de script e insira um script.
  • Para scripts complexos, você pode utilizar esta tarefa para aplicar o script usando o elemento de código JavaScript.
A seguir estão os benefícios de usar o elemento de código JavaScript na guia Expressão de script de um elemento:
  • É possível reutilizar scripts de outros usuários.
  • Você pode agrupar cálculos sem se preocupar com a ordem de sua execução.
  • É possível criar estruturas de dados normais e complexas, como coleções, e incluir continuamente nelas.
    Dica: A partir da liberação do Rational Publishing Engine V2.1, é possível chamar a função que é definida em um elemento de código JavaScript em outro código JavaScript ou Expressão de script, configurando uma propriedade Script da biblioteca no código de script. Para configurar a propriedade Script da biblioteca, vá para a visualização Propriedades do elemento Código JavaScript e selecione a guia Específico, ative a caixa de seleção Script da biblioteca. Para obter mais informações sobre a propriedade de script da biblioteca, consulte Propriedades do elemento de código JavaScript.

O arquivo JavaScript utils.js está incluído em seus arquivos de instalação e nos arquivos de componente Document Builder predefinidos para você usar para JavaScript simples, como incluir a data atual na saída de relatório.

Para ver uma lista do código JavaScript existente em seu modelo, clique em Modelo > Revisar JavaScript. A visualização Procurar é aberta e uma lista de elementos que usam JavaScript é exibida. Os filtros nativos não são considerados JavaScript neste contexto. Os filtros nativos não são listados nos resultados da procura.

Procedimento

  1. Salve seu modelo antes de começar a trabalhar com JavaScript.
  2. Na visualização Paleta, selecione o elemento ícone Código JavaScript Código JavaScript e o arraste para o editor de conteúdo do modelo.
  3. Dê um clique duplo no elemento de código JavaScript.
  4. Na guia Expressão de script, selecione a variável da árvore na qual aplicar o código JavaScript.
  5. Insira o código JavaScript usando uma destas opções:
    • Escreva um script manualmente nessa janela
    • Copie e cole um script de um editor externo para esta janela
    • Clique em Incluir script e selecione um arquivo de seu computador, um servidor remoto, ou a partir do componente Document Builder
  6. Opcional: Se você copiou o script a partir de XHTML, pode:
    • Selecione a opção Entrada XHTML para permitir que as tags XHTML que estão contidas no script sejam editadas.
    • Limpe a opção Entrada XHTML para remover todas as tags XHTML do script.
    Se você estiver copiando rich text ou estiver usando rich text nas condições, deverá selecionar a opção Entrada XHTML.
    Importante: XHTML inválido causa falha de geração de documento. Verifique se o seu XHTML é válido antes de salvar suas mudanças.
  7. Opcional: Se você estiver gerando o modelo na saída XHTML, poderá:
    • Selecionar a opção Saída XHTML para analisar o script e renderizá-lo como rich text.
    • Limpar a opção Saída XHTML para tratar o script como texto simples.
    Esta seleção se aplica a todos os atributos de origem de dados na expressão. Não é possível combinar texto simples e XHTML em seu script.

    Se você estiver copiando rich text ou criando rich text em uma base ad hoc, deverá selecionar a opção Saída XHTML.

  8. Depois de inserir o script, clique em Script de teste para validar o código. Se existirem erros em JavaScript, a geração de documentos não poderá ser concluída com êxito.
  9. Clique em OK para salvar suas mudanças. O bloco de código é reduzido no elemento. É possível expandir o código para visualizá-lo no editor de conteúdo do modelo.

Trabalhando no editor JavaScript

Use o editor JavaScript para trabalhar em seu script com o assistente de coloração e conteúdo da sintaxe.

Sobre Esta Tarefa

Coloração de sintaxe especifica como o código de origem JavaScript será renderizada com sua própria cor e estilo. Para mudar as preferências de cores da sintaxe padrão, no Document Studio, selecione Windows > Preferências > JavaScript > Editor > Coloração de sintaxe.

Assistente de conteúdo mostra em uma janela pop-up uma lista de alternativas válidas para concluir a linha atual de código. Para ativar o assistente de conteúdo, pressione Ctrl + Space.

Esta é uma captura de tela do editor JavaScript.

Procedimento

  1. Dê um clique duplo no elemento de código JavaScript. A janela Código de entrada para elemento de código JavaScript é aberta.
  2. Opcional: Se você estiver incluindo um novo script de outro arquivo, clique em Incluir script e selecione um arquivo de seu computador, de um servidor remoto ou do componente Document Builder. Clique em OK.

    Para arquivos selecionados de seu computador ou de um servidor remoto, uma cópia do código JavaScript de seu arquivo selecionado é aberta no editor JavaScript.

    Para arquivos selecionados do Document Builder, a janela Utilizar referência de script é aberta. Você deve escolher se incluir JavaScript como um link de referência no modelo:
    • Se você selecionar Sim, o link para o arquivo JavaScript (.js) será integrado em uma identificação <Script>. Por exemplo, o link de referência a seguir é incluído no editor JavaScript que você não deve modificar:
      <Script src= "library://api/scripts/51"></Script>
      Lembre-se: Quando você executa a geração de documentos a partir do modelo, e tem um JavaScript como um link de referência no modelo, o Document Builder deve estar ativo e conectado ao Documento Studio. Para obter detalhes, consulte o tópico Conectando-se ao componente Document Builder.
    • Se você selecionar Não, uma cópia do código JavaScript do seu arquivo selecionado será aberto no editor JavaScript.
  3. Opcional: Clique em Abrir no editor para inserir o script em um editor Eclipse JavaScript. O script é aberto em uma nova guia do editor como um arquivo temporário .js, de forma que você possa editar o JavaScript e gerenciar o script por meio das opções na visualização Esboço. Depois de editar o script, salve suas mudanças e feche a guia do editor temporário JavaScript para retornar à janela Código de entrada para elemento de código JavaScript.
  4. Clique em Script de teste para validar o código.
  5. Clique em OK para salvar as mudanças e sair da janela.