Estrutura de Integração de Canais (Controle Hospedado)

2025-05-08

Use o tipo de controle hospedado da Estrutura de Integração de Canais para integrar seu provedor de canais ao aplicativo cliente do Unified Service Desk. Você pode criar vários tipos de controle hospedado da Estrutura de Integração de Canais para hospedar canais diferentes. Para saber mais, consulte Integrar canal usando a Estrutura de Integração de Canais.

Para criar um tipo de controle hospedado da Estrutura de Integração de Canais, consulte Criar um controle hospedado da Estrutura de Integração de Canais

Ações de UII predefinidas

As ações a seguir têm suporte para esse tipo de controle hospedado.

Fechar

Essa ação é usada para fechar o controle hospedado.

Evento de Fogo

Dispara um evento definido pelo usuário desse controle hospedado.

Parâmetro	Descrição
nome	Nome do evento definido pelo usuário.

Todos os pares nome=valor subsequentes tornam-se os parâmetros para o evento. Para obter mais informações sobre como criar um evento definido pelo usuário, consulte Criar um evento definido pelo usuário.

MoverParaPainel

Essa ação é usada para mover controles hospedados entre painéis em tempo de execução.

Parâmetro	Descrição
aplicativo	Nome do controle hospedado a ser movido.
painel	Painel de destino para o controle hospedado.

Exibe uma URL do controle hospedado e executa as regras de navegação da janela nela para rotear o pop-up para o local apropriado.

Parâmetro	Descrição
URL	Roteia um pop-up desse controle hospedado usando essa URL como se fosse um pop-up solicitado do controle exibido.
moldura	O quadro do qual esse pop-up se originou.

RunScript

Essa ação injeta JavaScript no quadro principal do aplicativo.

Parâmetro	Descrição
	O parâmetro data é o JavaScript que será injetado no formulário. Nota: Os parâmetros de substituição podem ser usados no script e serão substituídos antes que o script seja executado.

Tamanho do conjunto

Essa ação define explicitamente a largura e a altura do controle hospedado. Isso é particularmente útil ao usar "auto" em seus layouts de painel.

Parâmetro	Descrição
largura	A largura do controle hospedado.
altura	A altura do controle hospedado.

SetUserCanClose

Permite que o usuário feche o controle hospedado clicando no ícone X no canto superior direito da guia de controle hospedado.

Parâmetro	Descrição
UserCanClose	Defina isso como `true` para permitir que o usuário feche o controle hospedado. Caso contrário, defina false.

RaiseCifClientEvent

Essa ação envia os dados gerados do evento do lado do cliente para o controle hospedado.

Parâmetro	Descrição
evento	Os eventos do lado do cliente de onde você deseja gerar os dados.
dados	O parâmetro data usa valores eventData. Passe os dados como uma cadeia de caracteres que foi recebida do evento usando parâmetros de substituição. `data = [[data]+]`. Os eventos do lado do cliente com suporte são os seguintes: OnClickToAct SendKbArticleEvent evento onpagenavigate (referência da API JavaScript da CIF)

UpdateCifContext

Essa ação envia os dados do cliente para o provedor de canal.

Parâmetro	Descrição
corrId	O identificador exclusivo deve ser o mesmo que o passado no evento inicial do provedor de canal para que o UpdateCifContext obtenha de volta o resultado.
ação	O parâmetro para aceitar ou rejeitar o objeto de promessa. Ele assume o valor como `accept` ou `reject`. Se você passar `accept`, a API chama a função de sucesso, que executará ainda mais o parâmetro result. se você passar `reject`, a API chama a função de erro.
resultado	Os dados que você deseja enviar do cliente para o provedor de canal.

Eventos predefinidos

Os eventos a seguir têm suporte para esse tipo de controle hospedado.

Criar Registro

O evento ocorre quando a API JavaScript do Channel Integration Framework correspondente é chamada do provedor de canal para criar uma entidade. Os dados passados na API também são passados para o aplicativo cliente do Unified Service Desk.

Parâmetro	Descrição
entidade	O nome lógico da entidade.
dados	Cadeia de caracteres que define os atributos e valores para o novo registro de entidade.
corrId	O identificador exclusivo para o evento CreateRecord gerado.

Para saber mais, consulte createRecord (Referência da API JavaScript da CIF)

Recuperar Registro

O evento ocorre quando a API JavaScript do Channel Integration Framework correspondente é chamada do provedor de canal para recuperar uma entidade. Os dados passados na API também são passados para o aplicativo cliente do Unified Service Desk.

Parâmetro	Descrição
entidade	O nome lógico da entidade do registro que você deseja recuperar.
entityId	GUID do registro de entidade que você deseja recuperar.
corrId	O identificador exclusivo para o evento RetrieveRecord gerado.
Opções	Opções de consulta do sistema OData, $select e $expand, para recuperar seus dados. Use a opção de consulta do sistema $select para limitar as propriedades retornadas, incluindo uma lista separada por vírgulas de nomes de propriedade. Esta é uma prática recomendada de desempenho importante. Se as propriedades não forem especificadas usando $select, todas as propriedades serão retornadas. Use a opção de consulta do sistema $expand para controlar quais dados de entidades relacionadas são retornados. Se você incluir apenas o nome da propriedade de navegação, receberá todas as propriedades dos registros relacionados. Você pode limitar as propriedades retornadas para registros relacionados usando a opção de consulta do sistema $select entre parênteses após o nome da propriedade de navegação. Use isso para propriedades de navegação de valor único e com valor de coleção . Você especifica as opções de consulta começando com `?`. Você também pode especificar várias opções de consulta usando `&` para separar as opções de consulta. Por exemplo: `?$select=name&$expand=primarycontactid($select=contactid,fullname)`

Para saber mais, consulte retrieveRecord (Referência da API JavaScript da CIF)

Registro de atualização

O evento ocorre quando a API JavaScript do Channel Integration Framework correspondente é chamada do provedor de canal para atualizar uma entidade. Os dados passados na API também são passados para o aplicativo cliente do Unified Service Desk.

Parâmetro	Descrição
entidade	O nome lógico da entidade do registro que você deseja atualizar.
entityId	GUID do registro de entidade que você deseja atualizar.
dados	String contendo `key: value` pares, onde `key` é a propriedade da entidade e `value` é o valor da propriedade que você deseja atualizar.
corrId	O identificador exclusivo para o evento UpdateRecord gerado.

Para saber mais, consulte updateRecord (Referência da API JavaScript da CIF)

DeleteRecord

O evento ocorre quando a API JavaScript do Channel Integration Framework correspondente é chamada do provedor de canal para excluir uma entidade. Os dados passados na API também são passados para o aplicativo cliente do Unified Service Desk.

Parâmetro	Descrição
entidade	O nome lógico da entidade do registro que você deseja excluir.
dados	Cadeia de caracteres que define os atributos e valores para o novo registro de entidade.
entityId	GUID do registro de entidade que você deseja excluir.
corrId	O identificador exclusivo para o evento DeleteRecord gerado.

Para saber mais, consulte deleteRecord (Referência da API JavaScript da CIF)

GetEntityMetadata

O evento ocorre quando a API JavaScript do Channel Integration Framework correspondente é chamada do provedor de canais para retornar os metadados da entidade especificada. Os dados passados na API também são passados para o aplicativo cliente do Unified Service Desk.

Parâmetro	Descrição
entidade	O nome lógico da entidade.
Atributos	Os atributos para os quais você deseja obter metadados.
corrId	O identificador exclusivo para o evento GetEntityMetadata gerado.

Para saber mais, consulte [getEntityMetadata (Referência da API JavaScript da CIF)](.. /channel-integration-framework/v1/develop/reference/microsoft-ciframework /getentitymetadata.md)

GetEnvironment

O evento ocorre quando a API JavaScript da Estrutura de Integração de Canais correspondente é chamada do provedor de canais para obter os detalhes atuais do aplicativo e da página da Interface Unificada. Os detalhes incluem appId, pageType e recordId (se disponível). Os dados passados na API também são passados para o aplicativo cliente do Unified Service Desk.

Não há parâmetros para este evento.

Para saber mais, consulte getEnvironment (Referência da API JavaScript da CIF)

Formulário aberto

O evento ocorre quando a API JavaScript do Channel Integration Framework correspondente é chamada do provedor de canal para abrir um formulário de entidade ou um formulário de criação rápida. Os dados passados na API também são passados para o aplicativo cliente do Unified Service Desk.

Parâmetro	Descrição
entityFormOptions	Opções de formulário de entidade para abrir o formulário.
entityFormParameters	Um objeto de dicionário que passa parâmetros extras para o formulário. Parâmetros inválidos causarão um erro. Para obter informações sobre como passar parâmetros para um formulário, consulte Definir valores de campo usando parâmetros passados para um formulário e Configurar um formulário para aceitar parâmetros querystring personalizados
corrId	O identificador exclusivo para o evento OpenForm gerado.

Para saber mais, consulte [openForm (Referência da API JavaScript da CIF)](.. /channel-integration-framework/shared /openform.md)

RenderSearchPage

O evento ocorre quando a API JavaScript do Channel Integration Framework correspondente é chamada do provedor de canal, permitindo pesquisar entre os registros de um tipo de entidade específico. Essa API abre a página de entidade da Interface Unificada com o campo de pesquisa pré-preenchido com a cadeia de caracteres de pesquisa que é passada como um parâmetro. Os dados passados na API também são passados para o aplicativo cliente do Unified Service Desk.

Parâmetro	Descrição
entidade	O nome lógico da entidade do registro que você deseja consultar.
cadeia de caracteres de pesquisa	Cadeia de caracteres para pesquisar entre os atributos dos registros da entidade.
corrId	O identificador exclusivo para o evento RenderSearchPage gerado.

Para saber mais, consulte [renderSearchPage (Referência da API JavaScript da CIF)](.. /channel-integration-framework/shared /rendersearchpage.md)

SearchAndOpenRecords

O evento ocorre quando a API JavaScript do Channel Integration Framework correspondente é chamada do provedor de canal para procurar o registro do provedor de canal durante a comunicação de entrada e abre o registro. Os dados passados na API também são passados para o aplicativo cliente do Unified Service Desk.

Parâmetro	Descrição
entidade	O nome lógico da entidade a ser pesquisado e aberto.
queryParmeters	Opções de consulta do sistema OData, $select e $expand, para recuperar seus dados. Use a opção de consulta do sistema $select para limitar as propriedades retornadas, incluindo uma lista separada por vírgulas de nomes de propriedade. Esta é uma prática recomendada de desempenho importante. Se as propriedades não forem especificadas usando $select, todas as propriedades serão retornadas. Use a opção de consulta do sistema $expand para controlar quais dados de entidades relacionadas são retornados. Se você incluir apenas o nome da propriedade de navegação, receberá todas as propriedades dos registros relacionados. Você pode limitar as propriedades retornadas para registros relacionados usando a opção de consulta do sistema $select entre parênteses após o nome da propriedade de navegação. Use isso para propriedades de navegação de valor único e com valor de coleção. Você especifica as opções de consulta começando com `?`. Você também pode especificar várias opções de consulta usando `&` para separar as opções de consulta. Por exemplo: `?$select=name&$expand=primarycontactid($select=contactid,fullname)`
searchOnly	Defina false para abrir o registro na página Interface Unificada se o registro de pesquisa for um único registro. Defina false para abrir a página de pesquisa se o resultado da pesquisa tiver vários registros e preencha automaticamente a página de pesquisa com o valor da tag mencionado quando o campo de pesquisa é usado em queryParmeters. Defina true apenas para obter resultados da pesquisa como um resultado de promessa e não abrir o registro ou a página de pesquisa.
corrId	O identificador exclusivo para o evento SearchAndOpenRecords gerado.