Relatórios › Tipos de relatório › Visão geral de booklets › Criando um booklet › Criando booklets em formato RTF › Marcas de booklet e de exportação de contrato › Booklets parametrizados › Sintaxe de parâmetro de booklet
Sintaxe de parâmetro de booklet
A sintaxe no modelo de booklet é semelhante à sintaxe para passar parâmetros para relatórios de formato livre.
Observações relativas à sintaxe:
- O nome do parâmetro será retirado de uma lista predefinida, nomes em MAIÚSCULAS, sem texto livre (exceto para os parâmetros de formato livre que *são* texto livre).
- O valor do parâmetro será texto livre (usando a palavra-chave VALUE) ou um valor de contexto (usando a palavra-chave CONTEXT_VALUE ). Quando não houver um contexto do contrato, os valores de contexto não são passados.
- O valor diferencia maiúsculas de minúsculas.
- Ao passar mais de um valor para o mesmo parâmetro e o parâmetro não estiver definido como seleção múltipla, ou ao passar o mesmo parâmetro mais de uma vez, o último valor exibido no modelo será passado.
- Ao passar nenhum valor (estando ausente a palavra-chave VALUE ou <<VALUE=>>), o booklet passará "null" como o valor. Isso removerá o valor de filtro original, como se ele não estivesse no relatório favorito (semelhante a Todos).
- Passar um nome de parâmetro que não existe, não tem efeito (isso é importante para o formato livre em um grupo).
- Os valores de parâmetro serão mesclados com o filtro favorito original, onde os parâmetros do booklet têm prioridade sobre o filtro original. Portanto, se passarmos um parâmetro para um filtro que já existe no relatório, o filtro usará o parâmetro do booklet.
- A definição de seleção múltipla ou curinga, terá de ser declarada usando a palavra-chave SELECT_TYPE. Os valores podem ser: MULTI, WILDCARD ou SINGLE (o valor padrão se não estiver definido é SINGLE).
- Em caso de seleção múltipla de recursos/grupo de recursos. Por agora, o usuário poderá selecionar somente um tipo. Recursos ou grupos de recursos. O usuário terá de declarar qual foi usado no parâmetro usando a palavra-chave IS_GROUP. O valor pode ser YES ou NO (o padrão se não estiver definido é NO).
- Ao definir a seleção múltipla, o usuário tem de definir o caminho completo da entidade separado por "/"™ (consulte o exemplo de Sintaxe de parâmetro de booklet abaixo). Ao selecionar várias métricas, se o usuário tiver definido um contexto do contrato, ele poderá ignorar a definição do caminho completo e o contexto do contrato será usado para obter informações relevantes.
- Composto e o grupo Favoritos têm a mesma sintaxe que o Normal. Para os relatórios compostos, os valores de parâmetro serão passados para cada série. Para os relatórios de grupo, o valor será passado para cada integrante do grupo (relatórios de formato livre também). Se houver relatórios compostos dentro do grupo, os valores de parâmetro serão passados para cada série de cada um dos integrantes.
Exemplo de sintaxe de parâmetro de booklet
<<BEGIN_FAVORITE=Normal favorite name>>
<<BEGIN_PARAMETER>>
<<NAME=AGGREGATION>><<VALUE=Sum>>
<<END_PARAMETER>>
<<BEGIN_PARAMETER>>
<<NAME=CONTRACT>><<CONTEXT_VALUE=SLA_NAME>>
<<END_PARAMETER>>
<<BEGIN_PARAMETER>>
<<NAME=SERVICE>><<VALUE=Service 1>>
<<END_PARAMETER>>
<<BEGIN_PARAMETER>>
<<NAME=RESOURCE>><<IS_GROUP=NO>><<VALUE=Resource 1>>
<<END_PARAMETER>>
<<BEGIN_PARAMETER>>
<<NAME=metric >>
<<SELECT_TYPE=MULTI>>
<<VALUE=Contract Party/Contract/metric 1>>
<<VALUE=Contract Party/Contract/metric 2>>
<<VALUE=Contract Party/Contract/metric 3>>
<<END_PARAMETER>>
<<NAME>>
<<CHART>>
<<DATA>>
<< END_FAVORITE>>