Quick BI:Configurar um canal personalizado

Criar um canal personalizado

1. Faça login no console do Quick BI.

2. Acesse a página de criação de canal personalizado a partir da página inicial do produto Quick BI, conforme ilustrado na figura abaixo.

   

3. Na caixa de diálogo Create Custom Channel, defina os parâmetros a seguir.

   

   Parâmetro	Descrição
   Name	Insira um nome para o canal personalizado.
   Push Address	Insira a URL do endpoint do canal personalizado que receberá as mensagens. O endpoint deve oferecer suporte ao método de solicitação POST.
   Request Add Key	Insira a chave de assinatura do canal personalizado para validar as assinaturas das solicitações. É possível inserir a chave manualmente ou clique em Auto-generate Key para gerá-la automaticamente. O receptor deve verifique a assinatura das mensagens recebidas.

4. Clique em Save And Test.

   Após salve o canal, ele passa a constar na lista de canais de bot.

   

Configurar um canal personalizado ao receber assinaturas

Ao crie uma assinatura, inclua o canal personalizado na configuração do método de alerta.

1. Acesse a página de gerenciamento de assinaturas a partir da página inicial do Quick BI.

   

2. Durante a criação da tarefa de assinatura, escolha Custom Channel como Receiving Method para visualize o canal personalizado em Receiving Channel.

   

   Para mais informações, consulte Criar uma tarefa de assinatura.

3. O formato da mensagem para notificações de assinatura enviadas a canais personalizados é o seguinte:

   {
       "schema":"1.0",
       "header":{
           "organizationId":"b5fb3d10xx",  # Organization ID
           "eventId":"bc679418-9e7xx",      # Unique Event ID
           "createTime":"1705398011696",
           "eventType":"SUBSCRIBE"  # Event type, subscribe; used to determine business logic
       },
       "event":{
           "createTime":"1705397830000",
           "customParams":"{\"param\":\"this is a test\"}",   # Custom parameters in the subscription. JSON format, key structure.
           "customReceiveGroups":"xxx",   # Custom receiving groups
           "customReceiveUsers":[   # Custom recipients.
               {
                   "nick":"Zhang San",     # Nickname
                   "accountId":"cQUPAaY81L", # Third-party account ID saved in Quick BI
                   "accountType":4,   # Account type.
                   "userId":"053da9"   # Quick BI userId
               }
           ],
           "worksInfo":{              # Report-related information
               "components":[        # Component information
                   {
                       "componentId":"123", 
                       "componentName":"Cross Table",
                       "componentType":4
                   }
               ],
               "worksId":"0458e831-0250-486",   # Report ID
               "worksName":"Ranking List",             # Report name
               "worksType":"PAGE",
               "workspaceName":"Li Si Resource Plan Import",    # Workspace name
               "workspaceId":"3e60ee7f-a99f-4231-913",   # Workspace ID
               "worksUrl":"https://baidu.com/xxxx"       # Report preview URL
    
           },
           "subscribeId":"73a1d0b2420",          # Subscription ID
           "taskId": "4899407788885930938",      # Subscription task ID
           "ownerId":"fec0741443204",            # Subscription task owner
           "title":"Custom Webhook Push Channel",        # Subscription task title
           "subject":"Custom",                     # Subscription task subject
           "content":{         # Subscription task text
               "head":"<p style=\";\">Custom Webhook Push Channel</p>",   
               "tail":"<p style=\";\">Custom Webhook Push Channel</p>"
           },
           "snapshot":{       
               "images":[           # Screenshot attachments
                   {
                       "name":"2467699471858258259-1.jpeg",
                       "url":"https://qbi-dev.cn-shanghai.aliyuncs.com/xxxx"
                   }
               ],
               "pdfs":[            # PDF attachments
                   {
                       "name":"2467699471858258259-1.pdf",
                       "url":"https://qbi-dev.cn-shanghai.aliyuncs.com/xxxx"
                   }
               ],
               "excels":[          # Excel attachments
                   {
                       "name":"2467699471858258259-1.xlsx",
                       "url":"https://qbi-dev.cn-shanghai.aliyuncs.com/xxxx"
                   }
               ]
           }
       }
   }

Configurar um canal personalizado ao receber alertas

Adicione o canal personalizado ao método de alerta durante o monitoramento de métricas.

1. Acesse a página de monitoramento de métricas a partir da página inicial do Quick BI, conforme mostrado na figura abaixo.

   

2. Na caixa de diálogo Monitor Alert Settings, selecione Custom Channel como método de alerta para visualize o canal personalizado em Custom Channel.

   Para mais detalhes, consulte Configurar monitoramento.

Configurar um canal personalizado na emissão de tarefas de relatório

1. Selecione Custom Channel ao configure a Report Task Issuance para envio de dados.

2. O formato da mensagem para notificações de tarefas de relatório enviadas a canais personalizados é o seguinte:

   {
    "deadlineTime": "2024-07-26 20:00:00", # Reporting deadline
    "taskUrl": "https://bi.aliyun.com/xxx", # Reporting link
    "taskTitle": "Report Task Name", # Report task name
    "sendTime": "2024-07-04 19:19:20", # Report task issuance time
    "dashboardName": "Wang Wu's Report" # Report name
   }

Configurar um canal personalizado no fluxo eletrônico de aprovação externa

Os administradores da organização podem integrar o canal personalizado aos processos de aprovação externa.

1. Crie um canal personalizado na página de gerencie de configurações, conforme ilustrado na figura abaixo.

2. Ative o canal de aprovação personalizado na página de configure de colaboração.

   

   Após ative essa opção, o canal personalizado recebe notificações de solicitação quando usuários pedem acesso a recursos do Quick BI.

3. O formato da mensagem para notificações de aprovação do Quick BI enviadas a canais personalizados é o seguinte:

   {
       "authPointsValue":3,    # Permission points.
       "resourceId":"b8b5392b-bb44-4bd8-e9642787e8d",   # The ID of the resource for which permissions are requested.
       "resourceName":"20 widgets on the first screen (8 on the mobile client's first screen)",     # The report resource name.
       "approverId":"e52b777a1dde4bfb94f91e18128bcfb0",  # The approver UID.
       "roleId":0,
       "applyReason":"123123",              # The reason for the request.
       "extInfo": [                         # Extended information. If the resource type is dataFormInsertData, this field displays the name, type, and submitted information for each control in the user-submitted form.
         {
             "data": {                     # The data entry information of the control.
               "63912418-e311-4573-84be-1f732ffd9f35": 20,   # The control ID and its submitted value.
               "f9a46753-98a1-4709-9327-949c6a03af08": "test",
               "ffe8327a-9de8-4699-a23a-097088a22d2e": "test1"
             },
             "dataId": null,               # The data record ID.
             "dataWithComponent": {        # The details of the control.
               "63912418-e311-4573-84be-1f732ffd9f35": {   # The control ID.
               "componentType": "number",  # The control type.
               "data": 20,                 # The value submitted by the user in this control.
               "label": "Age"              # The control name.
             },
               "f9a46753-98a1-4709-9327-949c6a03af08": {
               "componentType": "text",
               "data": "test",
               "label": "Remarks"
             },
               "ffe8327a-9de8-4699-a23a-097088a22d2e": {
               "componentType": "text",
               "data": "test1",
               "label": "Name"
             }
           }
         }
       ],
       "resources": [                       # Menu information. This field is available only for BI portals.    
         {
             "resourceId": "a8d78c04-df99-42c3-a0a2-dbe7350b077c",  # The menu ID.
             "resourceName": "Level-3 menu",     # The menu name.
             "resourceType": "0"            # The menu type.
         }
       ],
       "applicantName":"Mr. Zhang",                 # The requester nickname.
       "gmtCreate":1705399339000,               # The creation time.
       "approverName":"Ms. Wang",                  # The approver nickname.
       "expireDate":1708077734000,              # The permission validity period.
       "workspaceName":"Quick BI Assessment Workspace",        # The workspace name.
       "applicantId":"e9a40c524ef8471faefbd",   # The requester UID.
       "applicationId":"b31c8cf5-aa31-42f7-927a-da3cb2feefd4",  # The approval ID.
       "resourceType":"dashboard"               # The resource type.
   }

   Observação 1: O campo resources, que contém informações de menu, está disponível apenas para aprovações de portal de BI. O resourceType em resources aceita somente os seguintes tipos:

   O resourceType em resources aceita somente os seguintes tipos:

   • 0: Dashboard

   • 2: Workbook

   • 5: Data Entry

   • 6: Downloads

   • 7: Ad hoc analysis

   • 8: Data dashboard

   Observação 2: A tabela a seguir descreve os tipos de recurso. Os tipos de recurso não diferenciam maiúsculas de minúsculas.

   • dataProduct: Portal de BI

   • portal_menu: Menu de portal de BI

   • dashboard: Dashboard

   • screen: Painel de dados

   • report: Workbook

   • ANALYSIS: Análise ad hoc

   • dashboardOfflineQuery: Downloads

   • dataForm: Entrada de dados

   • cube: Conjunto de dados

   • datasource: Fonte de dados

   • dataFormInsertData: Entrada de dados para armazenamento

   Observação 3: A tabela a seguir descreve os pontos de permissão authPointsValue para cada tipo de recurso.

   Tipo de recurso	Descrição dos pontos de permissão authPointsValue
   Entrada de dados	1: Enviar dados 9: Gerenciar dados próprios 10: Gerenciar todos os dados 11: Edite
   Conjunto de dados, Fonte de dados, Preparação de dados	1: Usar 11: Edite
   Painel de dados, Workbook, Dashboard, Downloads	1: Somente visualização 2: Exportar 3: Visualize e exportar 11: Edite
   Portal de BI	Permissões do portal de BI 11: Edite Permissões de conteúdo do menu Igual ao anterior Importante Observação: Para entrada de dados, o valor correspondente a gerencie dados próprios é 3.

Apêndice: Método de recepção e verificação de assinatura por sistema externo

sign = SHA256.digest(timestamp + nonce + token)