Incorporação de relatórios no Jelly

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 14 min. de leitura

    • Você pode incorporar relatórios em qualquer elemento baseado em Jelly, como uma página de IU.

    Habilitar incorporação

    Para habilitar a incorporação de relatórios no Jelly, adicione o seguinte elemento ao código Jelly.

    <g:inline template="reporting_includes.xml" />

    Depois de adicionar este código, você pode incorporar um relatório existente ou gerar um relatório no código Jelly.

    Incorporação de um relatório existente

    Você pode incorporar um relatório existente chamando a função embedReportById(targetSpan, reportId).

    Por exemplo, adicione o seguinte ao bloco HTML/XML no registro da página de IU:
    <xml version="1.0" encoding="utf-8">
     <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null">
     <g:inline template="reporting_includes.xml" />
     <div id="report_stuff" />
     </j:jelly>
    E adicione o seguinte ao bloco de script do cliente no registro da página de IU. Substituir<report sys_id> com o sys_id real do relatório:
    var div = $j("#report_stuff");
embedReportById(div, <"report sys_id">);
    Como alternativa, você pode incorporar o JavaScript no código Jelly totalmente no bloco HTML/XML. Adicione o código do bloco de client script entre <script> tags:
    <xml version="1.0" encoding="utf-8">
     <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null">
     <g:inline template="reporting_includes.xml" />
     <div id="report_stuff" />     
     <script>
          var div = $j("#report_stuff");
          embedReportById(div, <"report sys_id">);
     </script>
     </j:jelly>
    Tabela 1. Parâmetros
    Parâmetro Descrição
    targetSpan O elemento jQuery no qual o gráfico será incorporado. O gráfico usa o tamanho deste elemento.
    reportId O sys_id do relatório que você deseja incorporar.

    Gerar e incorporar um relatório

    Você pode incorporar um relatório na IU chamando a função embedReportByParams(targetSpan, parms). Ao incorporar um relatório dessa forma, você pode gerar um novo relatório usando parâmetros ou especificar um sys_id de relatório para exibir esse relatório.

    Por exemplo, adicione o seguinte ao bloco HTML/XML no registro da página de IU:
    <xml version="1.0" encoding="utf-8">
     <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null">
     <g:inline template="reporting_includes.xml" />
     <div id="report_stuff" />
     </j:jelly>
    E adicione o seguinte ao bloco de script do cliente no registro da página de IU:
    var params = {sysparm_title: "Average for all ratings", sysparm_field: "category", sysparm_type: "bar", sysparm_table: "asmt_category_result", sysparm_aggregate: "AVG", sysparm_sumfield: "rating"}; 
var div = $j("#report_stuff");
embedReportByParams(div, params);
    Como alternativa, você pode incorporar o JavaScript dentro do código Jelly. Adicione o código do bloco de client script entre <script> tags:
    <xml version="1.0" encoding="utf-8">
     <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null">
     <g:inline template="reporting_includes.xml" />
     <div id="report_stuff" />
     <script>
          var params = {sysparm_title: "Average for all ratings", sysparm_field: "category", sysparm_type: "bar", sysparm_table: "asmt_category_result", sysparm_aggregate: "AVG", sysparm_sumfield: "rating"};
          var div = $j("#report_stuff");
          embedReportByParams(div, params);
     </script>
     </j:jelly>
    Tabela 2. Parâmetros
    Parâmetro Descrição
    targetSpan O elemento jQuery no qual o gráfico será incorporado.
    parâmetros Um objeto JSON que define o relatório. Os parâmetros disponíveis dependem do tipo de relatório.

    Gerando e incorporando um relatório de lista

    Ao incorporar um relatório de lista existente ou gerar um relatório de lista e incorporá-lo, você deve inserir mais uma linha de código.

    Adicione o seguinte ao bloco HTML/XML no registro da página de IU:
    <xml version="1.0" encoding="utf-8">
     <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null">
     <g:inline template="reporting_includes.xml" />
     <g:inline template="list2_js_includes.xml" />  
     <div id="report_stuff" />
     </j:jelly>
    Adicione o seguinte ao bloco de script do cliente no registro da página de IU. Substituir<report sys_id> com o sys_id real do relatório:
    var div = $j("#report_stuff");
embedReportById(div, <"report sys_id">);
    Ou incorpore o JavaScript no código Jelly totalmente no bloco HTML/XML. Adicione o código do bloco de client script entre <script> tags:
    <xml version="1.0" encoding="utf-8">
     <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null">
     <g:inline template="reporting_includes.xml" />
     <g:inline template="list2_js_includes.xml" />
     <div id="report_stuff" />     
     <script>
          var div = $j("#report_stuff");
          embedReportById(div, <"report sys_id">);
     </script>
     </j:jelly>
    Tabela 3. Parâmetros
    Parâmetro Descrição
    targetSpan O elemento jQuery no qual o gráfico será incorporado. O gráfico usa o tamanho deste elemento.
    reportId O sys_id do relatório que você deseja incorporar.

    Parâmetros de relatório integrado

    Ao incorporar um relatório em um elemento Jelly, você pode definir um relatório a qualquer momento, passando parâmetros.

    Parâmetros comuns

    Certos parâmetros são usados por vários tipos de relatório.

    Tabela 4. Parâmetros comuns
    Parâmetro Descrição Valor padrão
    jvar_report_id O sys_id de um registro de relatório. Se você passar este parâmetro, não especifique nenhum outro parâmetro. Todos os valores são obtidos do registro do relatório.
    sysparm_report_id Use este parâmetro em vez de jvar_report_id quando quiser substituir qualquer um dos outros parâmetros sysparm existentes no relatório.
    sysparm_title O título do relatório.
    sysparm_table A tabela a ser relatada. Especifique este valor ou sysparm_report_source_id, mas não ambos.
    sysparm_report_source_id O sys_id de uma origem de relatório. Especifique este valor ou sysparm_table, mas não ambos. Este valor será usado em vez de sysparm_table se você aprovar ambos.
    sysparm_type O tipo de relatório a ser criado.

    Valores possíveis: lista, linha, line_bar, área, spline, barra, horizontal_bar, pareto, hist, pizza, donut, semi_donut, velocímetro, mostrador, pivô, pivô_v2, funil, calendário, pirâmide, caixa, tendência, controle, caixa de tendências e mapa térmico.

    		 linha
    sysparm_field O campo da tabela especificada para agrupar dados. Necessário para relatórios de série temporal, coluna, barra, pizza, rosca, funil, pirâmide, caixa, tendência e caixa de tendência. Opcional para relatórios de lista.
    sysparm_query O filtro a ser aplicado aos dados antes de gerar o relatório. Especifique uma cadeia de caracteres de consulta para este valor.

    Para classificar os resultados da consulta por um campo específico, adicione ^ORDERBY <field_name> ou ^ORDERBYDES ao final da cadeia de caracteres de consulta. ORDERBY classifica a consulta em ordem crescente. ORDERBYDES classifica a consulta em ordem decrescente.
    sysparm_aggregate O tipo de agregação.

    Valores possíveis: AVG, COUNT, SUM e COUNT_DISTINCT

    		 CONTAGEM
    sysparm_sumcampo O campo para agregar dados. Este parâmetro não se aplica ao usar um tipo de agregação COUNT.
    sysparm_display_grid Um valor verdadeiro/falso que controla se o relatório exibe uma grade de dados. falso
    sysparm_mostrar_outro Um valor verdadeiro/falso que controla se o grupo Outro aparece no relatório. Este grupo aparecerá somente se o número de grupos exceder o número especificado no parâmetro sysparm_others. Este parâmetro se aplica a relatórios de barra, pizza, funil, pirâmide, pivô e mapa térmico. verdadeiro
    sysparm_outros O número máximo de grupos individuais de dados a serem exibidos. Todos os grupos de dados adicionais são combinados no grupo Outros. Este parâmetro se aplica a relatórios de barra, pizza, funil, pirâmide, pivô e mapa térmico.
    sysparm_source_type A origem do relatório incorporado. Opcional.

    Valores possíveis: table, metricbase, source, import

    		 tabela
    sysparm_set_color A configuração de cor do relatório.

    Valores possíveis: one_color, color_palette, many_colors

    		 paleta_cor
    sysparm_color_palette A paleta de cores que o relatório usa. Este parâmetro é usado quando sysparm_set_color="color_palette".

    Valor possível: o sys_id de uma paleta de cores

    		 IU14 Padrão
    sysparm_color A cor que o relatório usa. Este parâmetro é usado quando sysparm_set_color="one_color".

    Valor possível: o sys_id de uma cor
    sysparm_chart_colors O conjunto de cores do gráfico que o relatório usa. Este parâmetro é usado quando sysparm_set_color="several_colors".

    Valor possível: uma lista separada por vírgulas de códigos hexadecimais de cores
    sysparm_show_marker Um marcador é o valor representado por um ponto em uma linha ou outro elemento gráfico em um gráfico. Este parâmetro é um valor verdadeiro/falso que controla se o marcador aparece. verdadeiro
    sysparm_show_vazio Um valor verdadeiro/falso que controla se os registros com agrupamento vazio ou valores de tendência aparecem no relatório. falso
    sysparm_stack_field O campo usado para controlar o empilhamento em relatórios de barras e colunas.
    sysparm_bar_unstack Um valor verdadeiro/falso que controla se os dados empilhados são apresentados como uma única barra ou coluna, ou como várias barras. falso
    sysparm_box_field O campo numérico usado para medir os dados. Este parâmetro é necessário para relatórios de caixa e histograma.
    sysparm_trend_field O campo de data/hora usado para organizar os dados de tendências. Este parâmetro é necessário para relatórios de série temporal, tendência e caixa.
    sysparm_trend_interval O intervalo para medir os valores de tendência.

    Valores possíveis: ano, trimestre, mês, semana, dia da semana, hora e data.

    		 ano
    sysparm_compute_percent O valor a ser usado ao exibir porcentagens de relatório. Você pode exibir porcentagens com base na contagem total de registros ou pelo agregado especificado.

    Valores possíveis: agregado e contagem

    		 contagem
    sysparm_funnel_pescoço_percent Um número de 1 a 100 que define a porcentagem de um relatório de funil que é o gargalo do funil. 30
    sysparm_show_chart_data_label Um valor verdadeiro/falso que controla se os rótulos de dados aparecem no relatório. falso
    sysparm_show_zero Um valor verdadeiro/falso que controla se zeros aparecem nos relatórios dinâmicos multiníveis e de mapa térmico.
    sysparm_ct_row O campo usado para definir as linhas no mapa térmico e nos relatórios de bolha.
    sysparm_ct_column O campo usado para definir as colunas no mapa térmico e nos relatórios de bolha.
    sysparm_y_axis_category_fields O campo usado para definir as linhas em relatórios dinâmicos multiníveis. Especifique até cinco nomes de campo separados por vírgulas.
    sysparm_x_axis_category_fields O campo usado para definir as colunas em relatórios dinâmicos multiníveis. Especifique até três nomes de campo separados por vírgula.
    sysparm_list_ui_view O sys_id de uma exibição de lista a ser usada quando um usuário detalha o relatório.
    sysparm_show_marker Um valor verdadeiro/falso que controla se os marcadores aparecem em cada ponto representado graficamente em um relatório. verdadeiro
    sysparm_apply_alias Um valor verdadeiro/falso que controla se os aliases configurados aparecem em relatórios incorporados.

    Parâmetros do Catálogo de serviços

    Certos parâmetros se aplicam somente a relatórios criados em tabelas do catálogo de serviços, como a tabela Item solicitado [sc_req_item]. Esses parâmetros não estão disponíveis em relatórios do tipo lista ou calendário.
    Tabela 5. Parâmetros de relatório do Catálogo de serviços
    Parâmetro Descrição
    sysparm_sc_groupby_item_id O sys_id de um item do catálogo. Use este parâmetro com o parâmetro sysparm_sc_groupby_variable_id para agrupar um relatório do catálogo de serviços com base em um valor de variável do catálogo. Esses parâmetros substituem o parâmetro sysparm_field ao agrupar em variáveis do catálogo de serviços.
    sysparm_sc_groupby_variable_id O sys_id da variável de item do catálogo usada para determinar como os dados são agrupados no relatório. Esta variável deve pertencer ao item do catálogo especificado no parâmetro sysparm_sc_groupby_item_id .
    sysparm_sc_stackby_item_id O sys_id de um item do catálogo. Use este parâmetro com o parâmetro sysparm_sc_stackby_variable_id para empilhar um relatório do catálogo de serviços com base em um valor de variável do catálogo. Esses parâmetros substituem o parâmetrosysparm_stack_field ao agrupar em variáveis do catálogo de serviços. Somente relatórios compatíveis com empilhamento, como relatórios de barras, são compatíveis com esses parâmetros.
    sysparm_sc_stackby_variable_id O sys_id da variável de item do catálogo usada para determinar como os dados são agrupados no relatório. Esta variável deve pertencer ao item do catálogo especificado no parâmetro sysparm_sc_stackby_item_id .

    Parâmetros MetricBase

    Para usar MetricBase em um relatório incorporado, o parâmetro sysparm_source_type deve ser definido como "metricbase".

    O MetricBase também requer o parâmetro sysparm_custom_configuration, que tem a seguinte sintaxe:

    sysparm_custom_config: "{query_condition:\"\",transforms:[{transform:{transform:\"Reference\",name:\"chart-subjects\"},metric:\"mb_metricname\"}], group_by:\"\", table:\"mb_tablename\"}";
    Nesta sintaxe:
    • Uma transformação é uma cadeia de funções de transformação aninhadas. A última transformação de cada cadeia deve ser sempre a transformação de referência:
      {transform:\"Reference\",name:\"chart-subjects\"}
    • Uma métrica é um campo de métrica de uma tabela de métrica.
    • O campo agrupar por é o campo na tabela de métricas selecionada pelo qual a série temporal é agrupada.
    • tabela refere-se à tabela de métricas
    • mb_... são nomes de espaço reservado
    Todos os atributos são necessários, exceto para group-by.

    Parâmetros específicos do gráfico

    Certos parâmetros estão disponíveis somente para tipos de relatório específicos.

    Tabela 6. Parâmetros de relatório de donut
    Parâmetro Descrição Valor padrão
    sysparm_show_chart_total Um valor verdadeiro/falso que controla se a pontuação total do donut agrupado aparece no centro do relatório. falso
    sysparm_donut_width_percent Um número de 1 a 100 que controla a espessura do relatório de donut. 50
    Tabela 7. Parâmetros de mapa térmico
    Parâmetro Descrição Valor padrão
    sysparm_use_color_healthmap Um valor verdadeiro/falso que controla se o mapa térmico usa um gradiente para colorir o relatório. Quando verdadeiro, os valores sysparm_axis_max_color e sysparm_axis_min_color são usados. verdadeiro
    sysparm_axis_max_color A cor usada no gradiente do mapa térmico para indicar um valor alto. Este valor deve ser o sys_id de um registro de definição de cor [sys_report_color]. UI14 azul
    sysparm_axis_min_color A cor usada no gradiente do mapa térmico para indicar um valor baixo. Este valor deve ser o sys_id de um registro de definição de cor [sys_report_color]. branco
    Tabela 8. Parâmetros de mostrador
    Parâmetro Descrição Valor padrão
    sysparm_gauge_autoscale Um valor verdadeiro/falso que controla se o mostrador calcula automaticamente a escala mínima e máxima no relatório. Se você definir este valor como falso, deverá especificar um valor sysparm_from e sysparm_to. verdadeiro
    sysparm_de Um número que define o valor mínimo da escala do eixo.
    sysparm_to Um número que define o valor máximo da escala do eixo.
    sysparm_upper_limit Um número que define o limite superior do mostrador. Se você não especificar um valor, o mostrador não terá limite superior.
    sysparm_lower_limit Um número que define o limite inferior do mostrador. Se você não especificar um valor, o mostrador não terá limite inferior.
    sysparm_direction Um valor que controla quais valores são considerados positivos no relatório, valores mais baixos ou mais altos.

    Valores possíveis: minimizar e maximizar.

    		 minimizar

    Parâmetros de tamanho de gráfico

    Certos parâmetros controlam a largura e a altura do relatório.
    Tabela 9. Parâmetros de tamanho
    Parâmetro Descrição Valor padrão
    sysparm_chart_size O tamanho do gráfico no relatório. Os valores válidos são pequeno, médio e grande. grande
    sysparm_custom_chart_size Habilite este parâmetro para especificar valores personalizados de altura e largura do gráfico em vez de usar uma opção de tamanho do parâmetro sysparm_chart_size. falso
    sysparm_custom_chart_height A altura do gráfico no relatório, em pixels.
    sysparm_custom_chart_width A largura do gráfico no relatório, em pixels.

    Parâmetros de título do gráfico

    Certos parâmetros estão disponíveis somente para relatórios que exibem um título. Esses tipos de relatório incluem série temporal, barra, coluna, pizza, rosca, mostradores, tendência, caixa, caixa de tendência, histograma, pirâmide, mapa térmico, funil e relatórios de controle.
    Tabela 10. Parâmetros de título
    Parâmetro Descrição Valor padrão
    sysparm_report_title_size Um número que define o tamanho da fonte do título. 16
    sysparm_report_title_color A cor do texto do título. Este valor deve ser o sys_id de um registro de definição de cor [sys_report_color]. preto
    sysparm_title_horizont_alignment Onde o título é colocado horizontalmente em relação ao relatório. Este valor será usado somente se sysparm_custom_report_title_position for falso.

    Os valores possíveis são: esquerda, central e direita.

    		 centro
    sysparm_title_vertical_alignment Onde o título é colocado verticalmente em relação ao relatório. Este valor será usado somente se sysparm_custom_report_title_position for falso.

    Valores possíveis: superior, médio e inferior.

    		 superior
    sysparm_custom_report_title_position Um valor verdadeiro/falso que controla se as coordenadas x e y definem a posição do título do relatório em vez do alinhamento relativo. falso
    sysparm_report_title_x_position Um número que define a posição x do título no relatório. Este valor será usado somente se sysparm_custom_report_title_position for verdadeiro. 0
    sysparm_report_title_y_position Um número que define a posição y do título no relatório. Este valor será usado somente se sysparm_custom_report_title_position for verdadeiro. 0

    Parâmetros de borda do gráfico

    Certos parâmetros estão disponíveis somente para relatórios que exibem uma borda. Esses tipos de relatório incluem: série temporal, barra, coluna, pizza, donuts, mostradores, tendência, caixa, caixa de tendência, histograma, pirâmide, mapa térmico, funil e relatórios de controle.
    Tabela 11. Parâmetros de borda
    Parâmetro Descrição Valor padrão
    sysparm_show_report_border Um valor verdadeiro/falso que controla se o relatório exibe uma borda. falso
    sysparm_report_border_width Um número que define a largura da borda, em pixels. 1
    sysparm_report_border_radius Um número que define o tamanho do raio dos cantos da borda, em pixels. 0

    Parâmetros de legenda

    Certos parâmetros estão disponíveis somente para relatórios que exibem uma legenda. Esses tipos de relatório incluem relatórios de pizza, rosca, barras empilhadas, colunas empilhadas, séries temporais, tendências, caixas, histogramas, pirâmides, controles e mapas térmicos.
    Tabela 12. Parâmetros de legenda
    Parâmetro Descrição Valor padrão
    sysparm_show_legend Um valor verdadeiro/falso que controla se o relatório exibe uma legenda. verdadeiro
    sysparm_legend_horizont_alignment Onde a legenda é colocada horizontalmente em relação ao relatório.

    Valores possíveis: esquerda, centro e direita.

    		 centro
    sysparm_legend_vertical_alignment Onde a legenda é colocada verticalmente em relação ao relatório.

    Valores possíveis: superior, médio e inferior.

    		 parte inferior
    sysparm_show_legend_border Um valor verdadeiro/falso que controla se a legenda exibe uma borda. verdadeiro
    sysparm_legend_border_width Um número que define a largura da borda da legenda, em pixels. 1
    sysparm_legend_border_radius Um número que define o tamanho do raio dos cantos da borda da legenda, em pixels. 0

    Parâmetros do eixo X

    Certos parâmetros estão disponíveis somente para relatórios que usam um eixo X. Esses tipos de relatório incluem relatórios de barra, barra horizontal, pareto, coluna, área de linha, spline, caixa, caixa de tendências, controle e tendências.
    Tabela 13. Parâmetros do eixo X
    Parâmetro Descrição Valor padrão
    sysparm_x_axis_title O nome a ser exibido no eixo x.
    sysparm_x_axis_title_size Um número que define o tamanho da fonte do título no eixo x.
    sysparm_x_axis_title_bold Um valor verdadeiro/falso que controla se o texto do título no eixo x está em negrito. verdadeiro
    sysparm_x_axis_opposite Um valor verdadeiro/falso que controla se o eixo x aparece na parte superior do relatório. falso
    sysparm_x_axis_display_grid Um valor verdadeiro/falso que controla se as linhas de grade verticais aparecem a partir do eixo x. falso
    sysparm_x_axis_grid_dotted Um valor verdadeiro/falso que controla se as linhas de grade verticais são pontilhadas. falso
    sysparm_x_axis_label_size Um número que define o tamanho da fonte para rótulos de incremento no eixo x. 11
    sysparm_x_axis_label_bold Um valor verdadeiro/falso que controla se os rótulos de incremento do eixo x estão em negrito. falso

    Parâmetros do eixo Y

    Certos parâmetros estão disponíveis somente para relatórios que usam um eixo Y. Esses tipos de relatório incluem relatórios de barra, barra horizontal, Pareto, coluna, área de linha, spline, caixa, caixa de tendências, controle e tendências.
    Tabela 14. Parâmetros do eixo Y
    Parâmetro Descrição Valor padrão
    sysparm_y_axis_title O nome a ser exibido no eixo y. Uma descrição gerada automaticamente da agregação de relatório
    sysparm_y_axis_title_size Um número que define o tamanho da fonte do título do eixo y.
    sysparm_y_axis_title_bold Um valor verdadeiro/falso que controla se o texto do título no eixo y está em negrito. verdadeiro
    sysparm_y_axis_opposite Um valor verdadeiro/falso que controla se o eixo y aparece à esquerda do relatório. falso
    sysparm_y_axis_display_grid Um valor verdadeiro/falso que controla se as linhas de grade horizontais aparecem a partir do eixo y. verdadeiro
    sysparm_y_axis_grid_dotted Um valor verdadeiro/falso que controla se as linhas de grade horizontais são pontilhadas. falso
    sysparm_y_axis_label_size Um número que define o tamanho da fonte para rótulos de incremento no eixo y. 12
    sysparm_y_axis_label_bold Um valor verdadeiro/falso que controla se os rótulos de incremento do eixo y estão em negrito. falso
    sysparm_y_axis_from Um número que define o valor mais baixo exibido no eixo y.
    sysparm_y_axis_to Um número que define o valor mais alto exibido no eixo y.