> Source: https://docs.cyberelements.io/identity/7.0/pt/UserDocumentation/ReportsAuditsManagement/CreateModifyDeleteReport/

# Criar/modificar/eliminar um relatório

O relatório é configurado através de um ficheiro XML. Deve definir:

- A consulta à base de dados do CyberElements Identity para obter as informações desejadas,
- As propriedades de cada coluna a apresentar em formato XML: tipo de objeto, nome na base de dados SQL, nome a apresentar, índice de apresentação, etc.
- As opções de apresentação do gráfico (gráfico de barras, gráfico circular, pontos coloridos).

Clique no botão «New report» para criar e configurar um novo relatório.

Selecione um relatório e clique no botão «Modify» para modificar a sua configuração.

![New report](https://docs.cyberelements.io/identity/7.0/img/Identity/IdU_NouveauRapport.png)

## Propriedades de um relatório

| Parâmetro | Descrição | Tipos e valores possíveis |
|---|---|---|
| Name | Nome de apresentação do relatório. | Character string. Obrigatório. |
| Code | Corresponde ao ID do objeto. O seu valor deve ser único em todos os relatórios. | Character string, sem espaços nem caracteres especiais. Obrigatório |
| Category | Categoria de relatório na qual será apresentada a lista de relatórios. | Lista de categorias predefinidas. |
| Description |  | Character string. |
| XML | Etiquetas XML que descrevem a consulta SQL na base de dados Hpliance, as propriedades de cada coluna do relatório e as propriedades dos elementos gráficos. | Texto em formato XML. |
| Choice of report template | Modelo gráfico do relatório (para além da tabela de dados). | Without chart, Histogram, Stacked histogram, Pie chart ou Color ball by threshold. |
| With parameters | Permite adicionar variáveis introduzidas pelo utilizador. Terá de adicionar a etiqueta ao XML. | Caixa de verificação. |

## Escrever o XML de um relatório simples

```
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
```

**Exemplo: Lista de utilizadores sem número de telefone**

```
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
```

## Etiquetas XML que descrevem as colunas de um relatório

| Etiqueta XML | Definição | Valores possíveis |
|---|---|---|
| Name | O nome do campo tal como está definido na consulta SQL. | Character string. |
| Column_Link_Id | Utilizado para criar colunas que contêm dados clicáveis. Corresponde ao nome da coluna que contém o ID utilizado para gerir o vínculo. | Character string. *Opcional* |
| ObjectType | Tipo de objeto de destino do vínculo clicável (Identity, estrutura). | Identity = 1 => Redirecionamento para a página userDetails.aspx |
|  |  | Structure = 2 => Redirecionamento para a página structure.aspx |
|  |  | *Opcional* |
| DisplayName | Nome da coluna a apresentar na interface. | Character string. |
| Visible | Indica se a coluna é apresentada ou ocultada. | 'TRUE' ou 'FALSE' |
| DisplayIndex | Índice da coluna (ordem de apresentação). | Inteiro superior a 0 |

## Adicionar parâmetros introduzidos pelo utilizador no relatório: etiqueta

Selecione a caixa de verificação «With parameters» e adicione as seguintes etiquetas ao XML:

```
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
```

**Exemplo: Permissões a expirar em breve**

```
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
```

Etiquetas XML em <Parameter> que descrevem os parâmetros que podem ser introduzidos pelo utilizador:

| Etiqueta XML | Definição | Valores possíveis |
|---|---|---|
| Variable | Nome da variável utilizada na consulta SQL (sem o @). | Character string. |
| Data Type | O tipo de objeto CyberElements Identity correspondente ao parâmetro. Se não se tratar de um tipo de objeto básico (data, cadeia de caracteres, inteiro, etc.), o parâmetro será uma lista suspensa que contém os valores possíveis. | Structure=2; Authorization Rule=3; Application=4; Repository=5; Right=8; StructureType=11; Tree=12; AdminProfile=18; PersonType=19; String=22; Integer=23; Boolean=24; Date=25. |
| Label | Etiqueta a apresentar ao utilizador. | Character string. |
| AttributeCode | Código de atributo PSA. | Character string correspondente a um código PSA. |
| Mandatory | Indica se o utilizador é obrigado a especificar um valor. | 'TRUE' ou 'FALSE |
| DefaultValue | Para os parâmetros opcionais, é o valor predefinido introduzido caso o utilizador não indique nada. | Character string. |

## Definir os parâmetros dos gráficos

Selecione o modelo gráfico na lista suspensa e adicione as seguintes etiquetas ao XML:

```
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
```

Stacked histogram

Insira as seguintes etiquetas na etiqueta :

```
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
```

Color ball by threshold

Insira as seguintes etiquetas na etiqueta :

```
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
```

## Traduzir os nomes das colunas de um relatório

As colunas e os valores incluídos nos resultados de um relatório podem ser traduzidos em várias línguas.

Segue-se um exemplo de um relatório em que as colunas foram traduzidas:

```
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
```

**Etiqueta XML**

- Internationaldisplayname:
    - **Definição**: Etiqueta utilizada para traduzir os nomes das colunas devolvidas pelo relatório. Deve existir tantas ocorrências desta etiqueta quantas as línguas configuradas no CyberElements Identity.
    - **Atributo**: Lang=“<\language_code>” em que <\language_code> representa o código de língua definido nas definições de língua no separador General > Application Settings.
    - **Valor possível**: Character string. O nome da coluna apresentado no relatório para essa língua.
- CultureColumnName:
    - **Definição**: Definição do XML de cultura utilizado para traduzir o conteúdo da tabela gerada pelo relatório.
    - **Atributo**: Prop=“<\XML_Attribute>” em que <\XML_Attribute> representa o atributo da propriedade XML correspondente aos diferentes valores da coluna.
    - **Valor possível**: Character string. Coluna de cultura da consulta SQL.

## Apresentar um relatório em função do contexto do utilizador

Na versão 4000 do Hpliance, é possível adicionar a um relatório um parâmetro invisível que será definido em função da pessoa que executa o relatório. Os valores do relatório serão apresentados de acordo com os valores de um atributo do utilizador. Por exemplo, só verá os resultados relativos à sua organização.

Exemplo de relatório: enumerar todas as permissões atribuídas às identidades de uma determinada estrutura. Apresentar os apelidos, os nomes, as permissões e as aplicações de todas as identidades cujo atributo de estrutura «Responsibility» corresponde ao atributo de estrutura do utilizador com sessão iniciada.

```
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
```

**Etiquetas XML que descrevem os parâmetros baseados no contexto do utilizador.**

- Variable:
    - **Definição**: Nome da variável utilizada na consulta SQL (sem o @).
    - **Valor possível**: Character string.
- AttributUserConnected:
    - **Definição**: Especifica se o parâmetro é definido em função do contexto do utilizador atual ou se deve ser introduzido manualmente a partir da interface.
    - **Valor possível**:
        - True: contexto do utilizador
        - False: introdução manual
- AttributeCode:
    - **Definição**: Código de atributo PSA.
    - **Valor possível**: Character string correspondente ao código PSA.
