> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/pt/automatizacao/runbooks/runbook-report-settings.md). # Definições de relatório de Runbook ## Visão geral Vários runbooks do RealmJoin incluem capacidades de relatórios automatizados para entregar relatórios, notificações e alertas diretamente aos administradores. Dependendo da configuração, os relatórios podem ser: * **enviados por email** — usando a API Microsoft Graph em nome de um endereço do remetente configurado * **carregados para um Storage Account do Azure** — e disponibilizados como um link de transferência SAS com prazo limitado Dar suporte a ambos os canais de entrega é o padrão pretendido para todos os runbooks de relatórios daqui em diante. Nem todos os runbooks de relatórios ainda poderão suportar ambos os canais, mas o conjunto de runbooks suportados está em crescimento contínuo. Ambos os canais podem ser ativados de forma independente ou em combinação. Todas as definições partilhadas são configuradas uma vez no [Personalização do RealmJoin Runbook](https://portal.realmjoin.com/settings/runbooks-customizations) e aplicam-se automaticamente a todos os runbooks que usam a respetiva funcionalidade. As definições que diferem por runbook (como o nome do contentor de destino) não fazem parte desta configuração central e são definidas diretamente no respetivo runbook. As funções que consomem estas definições — [`Send-RjRbReportEmail`](/pt/dev-reference/report-functions/send-rjrbreportemail.md) e [`Publish-RjRbFilesToStorageContainer`](/pt/dev-reference/report-functions/publish-rjrbfilestostoragecontainer.md) — são fornecidas pelo **RealmJoin.RunbookHelper** módulo PowerShell. Consulte [Funções de Relatório](/pt/dev-reference/report-functions.md) para documentação detalhada de utilização. ## Entrega por email ### Pré-requisitos Recomendamos usar uma caixa de correio partilhada dedicada, como `realmjoin-report@contoso.com`. Esta caixa de correio será usada como endereço do remetente para todos os relatórios. Pode usar um endereço no-reply, uma vez que não se espera que os destinatários respondam a relatórios automatizados. ### Configuração Como descrito em detalhe na [Personalização baseada em JSON](https://docs.realmjoin.com/automation/runbooks/runbook-customization#json-based-customizing) documentação, navegue até [Personalização do RealmJoin Runbook](https://portal.realmjoin.com/settings/runbooks-customizations) no Portal RealmJoin (Definições > Personalizações de Runbook). No `Definições` bloco, adicione ou modifique a secção `RJReport` para incluir a propriedade `EmailSender` com o endereço de email do remetente pretendido: ```json { "Settings": { "RJReport": { "EmailSender": "realmjoin-report@contoso.com" } } } ``` Substitua `realmjoin-report@contoso.com` pelo endereço real da sua caixa de correio partilhada. ### Informações de contacto do Service Desk (opcional) Esta configuração central fornece apenas os valores unificados do Service Desk para todos os runbooks. Se as informações de contacto são efetivamente incluídas num email de notificação é determinado pelo próprio runbook em questão — apenas os runbooks que implementam os parâmetros correspondentes do Service Desk (por ex., `ServiceDeskDisplayName`, `ServiceDeskPortalUrl`) leem estes valores e apresentam-nos nos seus emails. Para fornecer as informações de contacto do Service Desk para estes runbooks, adicione as seguintes propriedades à `RJReport` secção: ```json { "Settings": { "RJReport": { "EmailSender": "realmjoin-report@contoso.com", "ServiceDesk_DisplayName": "IT Service Desk", "ServiceDesk_EMail": "servicedesk@domain.com", "ServiceDesk_Phone": "+49123456789", "ServiceDesk_PortalUrl": "https://servicedesk.domain.com" } } } ``` **Parâmetros:** * `ServiceDesk_DisplayName` — Nome apresentado do seu Service Desk (por ex., "IT Support", "Help Desk") * `ServiceDesk_EMail` — Endereço de email do Service Desk (apresentado como um `mailto:` link clicável) * `ServiceDesk_Phone` — Número de telefone do Service Desk em formato internacional (apresentado como um `tel:` link clicável) * `ServiceDesk_PortalUrl` — URL do portal ou website do seu Service Desk (apresentada como uma ligação clicável) Todos os parâmetros são opcionais. Se configurados, aparecerão no rodapé do email como ligações clicáveis. > **Nota:** Alguns runbooks aceitam adicionalmente uma ligação para o ticket por execução (por ex., `ServiceDeskTicketUrl`) para referenciar o ticket específico que desencadeou o pedido. Este é um parâmetro do runbook, não faz parte desta configuração central. ### Identidade visual do email (opcional) Os emails de relatório podem transportar uma identidade visual específica do Tenant: o cabeçalho e o rodapé padrão do RealmJoin podem ser substituídos pelas suas próprias imagens, a imagem do rodapé pode ligar a um destino personalizado — por exemplo, a sua intranet ou portal de IT — e as cores do modelo podem ser ajustadas ao design corporativo. Para configurar a identidade visual, adicione uma `Branding` subsecção ao `RJReport` bloco (aninhado como `StorageAccount`): ```json { "Settings": { "RJReport": { "Branding": { "HeaderImageUrl": "https://cdn.contoso.com/branding/email-header.png", "FooterImageUrl": "https://cdn.contoso.com/branding/email-footer.png", "FooterLink": "https://intranet.contoso.com", "AccentColor": "#0052cc", "TextColor": "#1a1a2e" } } } } ``` **Parâmetros:** | Definição | Obrigatório | Predefinição | Descrição | | ---------------- | ----------- | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `HeaderImageUrl` | não | gráfico de cabeçalho do RealmJoin | URL HTTPS pública de uma imagem de cabeçalho personalizada que substitui o gráfico de cabeçalho predefinido do RealmJoin | | `FooterImageUrl` | não | gráfico de rodapé do RealmJoin | URL HTTPS pública de uma imagem de rodapé personalizada que substitui o gráfico de rodapé predefinido do RealmJoin | | `FooterLink` | não | `https://www.realmjoin.com` | URL para a qual a imagem do rodapé aponta | | `AccentColor` | não | `#f8842c` (laranja do RealmJoin) | Cor de destaque do modelo de email: linhas de cabeçalho das tabelas, botões de ação, bordas de destaque das caixas de informação | | `TextColor` | não | `#011e33` (azul-marinho do RealmJoin) | Cor principal do texto do modelo de email: texto do corpo, títulos, itens de lista, código | **Requisitos da imagem:** * A imagem deve ser acessível através de uma **URL HTTPS pública** — por exemplo, um contentor do Azure Blob Storage com acesso de leitura anónimo, uma CDN ou o website da empresa. Uma URL que contenha um SAS Token também funciona e mantém o contentor privado. * Formatos suportados: **PNG, JPEG ou GIF**. O formato é detetado pela assinatura do ficheiro, e não pela extensão do ficheiro. * As imagens são renderizadas a **750 px de largura**. As dimensões recomendadas são **750×200 px** (correspondendo às faixas predefinidas) ou **1500×400 px** para ecrãs de alta densidade de píxeis. * Máximo **200 KB** por imagem; **100 KB ou menos** é recomendado. As imagens de identidade visual partilham o limite total de tamanho do email de \~4 MB com os anexos do relatório (para comparação, os gráficos predefinidos do RealmJoin têm 52 KB e 15 KB). **Requisitos de cor:** * Os valores têm de ser cores hexadecimais de 6 dígitos, incluindo o prefixo `#` — por exemplo `#0052cc`. As formas abreviadas (`#05c`) e os nomes de cores (`vermelho`) não são suportados. * Tanto os emails como os respetivos anexos são lidos em **e** modo escuro: escolha uma cor de texto que permaneça legível num cartão de conteúdo branco e uma cor de destaque com contraste suficiente em relação ao texto branco dos botões. * As cores de estado (verde/vermelho/âmbar para estados de sucesso, erro e aviso) e os cinzentos neutros não são deliberadamente configuráveis — têm um significado que não deve mudar por Tenant. As imagens são transferidas e validadas pelo runbook em cada execução. Se uma definição for deixada vazia, são usados o gráfico, a cor e a ligação do rodapé predefinidos do RealmJoin. Se uma transferência falhar, uma imagem for inválida ou uma cor não for um valor hex válido, é registado um aviso e é usado o predefinido correspondente em alternativa — uma configuração de identidade visual incorreta nunca impede o envio de um email de relatório. Todas as definições são opcionais e aplicam-se a todos os runbooks que enviam emails de relatório. > **Nota:** As definições de cor requerem **RealmJoin.RunbookHelper 0.8.9** ou posterior na Automation Account. Com versões mais antigas do módulo, as definições de imagem continuam a aplicar-se e as cores são ignoradas. ## Entrega para Storage Account Os runbooks de relatórios que suportam este canal de entrega podem carregar a respetiva saída para um contentor do Azure Blob Storage. Após um carregamento bem-sucedido, o runbook devolve uma ligação SAS com prazo limitado que pode ser usada para transferir o ficheiro diretamente. Este canal pode ser usado de forma independente ou em complemento da entrega por email. ### Pré-requisitos É necessário um Azure Storage Account existente. A identidade gerida da Automation Account (ou o Service Principal usado pelos runbooks) precisa de, no mínimo, **Storage Blob Data Contributor** permissões no Storage Account ou no respetivo grupo de recursos. ### Configuração Navegue até [Personalização do RealmJoin Runbook](https://portal.realmjoin.com/settings/runbooks-customizations) e adicione um `StorageAccount` subsecção ao `RJReport` bloco: ```json { "Settings": { "RJReport": { "StorageAccount": { "ResourceGroup": "rg-reports", "StorageAccountName": "stcontosoreports", "LinkExpiryDays": 6 } } } } ``` **Parâmetros:** | Definição | Obrigatório | Predefinição | Descrição | | -------------------- | ----------- | ------------ | ------------------------------------------------------------- | | `ResourceGroup` | sim | — | Grupo de recursos que contém o Storage Account | | `StorageAccountName` | sim | — | Nome do Azure Storage Account | | `LinkExpiryDays` | não | `6` | Número de dias até o link de transferência SAS gerado expirar | > **Nota:** As definições específicas de um runbook individual — como o nome do contentor de destino ou um nome de blob personalizado — são configuradas diretamente nesse runbook e, intencionalmente, não fazem parte desta configuração central. O mesmo se aplica à adição de prefixo ao nome do blob: se um prefixo de carimbo de data/hora (`yyyyMMdd-HHmmss`) é acrescentado ao nome do blob para evitar sobrescritas é controlado pelo `AddBlobNamePrefix` parâmetro de [`Publish-RjRbFilesToStorageContainer`](/pt/dev-reference/report-functions/publish-rjrbfilestostoragecontainer.md) (predefinição `$false`), que cada runbook passa explicitamente. ## Exemplo combinado O seguinte excerto mostra uma configuração completa `RJReport` com todas as funcionalidades ativadas: ```json { "Settings": { "RJReport": { "EmailSender": "realmjoin-report@contoso.com", "ServiceDesk_DisplayName": "IT Service Desk", "ServiceDesk_EMail": "servicedesk@domain.com", "ServiceDesk_Phone": "+49123456789", "ServiceDesk_PortalUrl": "https://servicedesk.domain.com", "Branding": { "HeaderImageUrl": "https://cdn.contoso.com/branding/email-header.png", "FooterImageUrl": "https://cdn.contoso.com/branding/email-footer.png", "FooterLink": "https://intranet.contoso.com", "AccentColor": "#0052cc", "TextColor": "#1a1a2e" }, "StorageAccount": { "ResourceGroup": "rg-reports", "StorageAccountName": "stcontosoreports", "LinkExpiryDays": 6 } } } } ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.realmjoin.com/pt/automatizacao/runbooks/runbook-report-settings.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.