Como configurar uma consulta como camada

Essa seção fornece orientações sobre como configurar uma consulta como uma camada.

Consultas dos módulos Organização, Workflow e Integração e das soluções de Eventos e Despacho escritas para objetos georeferenciados, assim como consultas de outros módulos e soluções que incluem objetos com atributos do tipo Georreferência, podem ser usadas como camadas. Além disso, as colunas Latitude e Longitude e a coluna com o ID do objeto (por exemplo ID do Ativo para consultas da organização) devem estar habilitadas nos resultados de cada consulta no sistema e listadas no parâmetro RequiredValues no arquivo XML (veja a tabela a seguir). Durante a criação da consulta, no passo Filtros, é necessário filtrar a consulta pelo tipo do objeto que será utilizado na camada. Em seguida, durante a seleção de colunas, o tipo do objeto deve ser especificado na coluna Aplicável a para filtrar as propriedades padrão e os atributos customizados aplicados ao objeto. Todas as propriedades padrão do objeto devem ser selecionadas. Do contrário, nenhum dado será plotado no mapa. Observe também que você somente poderá visualizar as camadas baseadas em consultas das quais você é autor, editor ou membro da audiência.

Antes que uma consulta possa ser configurada como camada, ela deve ser cadastrada no sistema. Para maiores informações sobre como cadastrar consultas do sistema em cada módulo, veja os respectivos tópicos sobre consultas em cada módulo. Para maiores informações sobre como criar um atributo do tipo Georreferência para um objeto de sistema, veja o Capítulo 17: Administração -> Customizações -> Objetos e Atributos -> Como criar um atributo de um objeto (exceto eventos)).

Camadas de consultas são cadastradas em nós QueryLayer, conforme o exemplo abaixo.

<QueryLayer ShowRawDataInsteadOfTemplate="false">

<id>Delegacias</id>

<Name>Delegacias</Name>

<Type>Organization</Type>

<Description></Description>

<Area>Integrator</Area>

<Controller>Map</Controller>

<Action>GetMarkers</Action>

<Icon id="icone_camada_delegacias" />

<Template id="asset_template" />

<RequiredColumns>Oid:ID, assetaddress:Endereço</RequiredColumns>

<RequiredValues>Oid:ID, Latitude, Longitude</RequiredValues>

<SearchKey>Title</SearchKey>

<AutoRefresh>15</AutoRefresh>

</QueryLayer>

Na estrutura XML da camada, os seguintes elementos podem ser configurados:

Parâmetro	Obrigatório?	Descrição
QueryLayer	Sim	Utilizado para cadastrar a camada, e contém os atributos ShowRawDataInsteadOfTemplate e UseCacheServer. Valores válidos para esses atributos: "True" e "False". Se o primeiro atributo for verdadeiro, o modelo de pop-up será desconsiderado e o conteúdo será exibido em formato JSON. Se falso, as informações serão exibidas de acordo com o modelo definido. O segundo atributo não é obrigatório. Caso seja "True" os dados da camada serão obtidos do serviço Modulo Integration Service. Caso seja "False", a camada irá utilizar os dados do sistema. Observe que o modelo utilizado deve ter sido configurado anteriormente, conforme explicado no Apêndice -> Camadas para o mapa de integração -> Como configurar um modelo de pop-up para uma camada.
id	Sim	Identificador único para a camada. Esse valor deve ser igual ao GUID ou ao nome da consulta cadastrada no sistema e não pode ser igual a nenhum outro ID de camada.
Name	Sim	Define o nome a ser exibido no menu, representando a camada.
Type	Sim	Usado para indicar o módulo onde a consulta foi criada. Valores válidos: "Organization" para consultas da organização, "REST" para consultas REST, "EventsManager” para consultas de eventos agendados, "Events" para consultas do Workflow e "AssistedDispatch" para consultas de chamados. Valores válidos para consultas que possam conter objetos com atributos do tipo Georreferência: "EnterpriseRiskManagement" para consultas da solução ERM.
Description	Não	Parâmetro utilizado para auxiliar a identificação da camada apenas no XML.
Area	Sim	Área do sistema à qual a camada pertence. Valores válidos: "Integrator" para camadas de consulta e "EventsManager" para camadas de eventos agendados acessados diretamente via API.
Controller	Sim	Área do sistema à qual a camada pertence. Valores válidos: "Map" para a área "Integrator" e "MapQueries" para a área "EventsManager".
Action	Sim	Ação executada para retornar a informação. Valores válidos: "GetMarkers" (padrão) e "GetServiceUnits" (caso o parâmetro ObjectType estiver incluído com o valor "ServiceUnit") para a área "Integrator"; e "GetDailyEvents", "GetNextDayEvents", "GetMonthEvents", "GetNextSevenDaysEvents", e "GetClosedEvents" para a área "EventsManager".
Icon	Sim	Identificador do ícone configurado para a camada. Para mais detalhes sobre como configurar ícones, veja Apêndice -> Camadas para o mapa de integração -> Como configurar um ícone para uma camada.
Template	Sim	Identificador do modelo configurado para o pop-up exibido quando um objeto na camada é selecionado. Para mais detalhes sobre como configurar esse modelo, veja Apêndice -> Camadas para o mapa de integração -> Como configurar um modelo de pop-up para uma camada.
RequiredColumns	Não	Define que pelo menos uma das entradas nos resultados da consulta devem conter valores para as colunas (propriedades) listadas nesse parâmetro. Essas colunas também devem ser habilitadas nos resultados da consulta. Se essa condição não for obedecida, a camada não será exibida e, em vez disso, o sistema irá exibir uma mensagem de erro. Esse campo deve ser preenchido com o mesmo nome de cada coluna (exatamente da forma como aparece no sistema), junto ao nome que será utilizado para isso nas mensagens de erro. Esses são separados por dois pontos, com cada grupo de nomes separados por uma vírgula e um espaço. Caso o nome exibido no sistema seja o mesmo nome da variável, esse nome só precisa ser inserido uma única vez, sem a necessidade dos dois pontos. Por exemplo, nome1 no sistema:nome1 exibido, nome2 no sistema:nome2 exibido, nome3 no sistema.
RequiredValues	Não	Define que todas as entradas nos resultados das consultas devem conter valores para as colunas (propriedades) listadas nesses parâmetros. Essas colunas devem, também, estar habilitadas nos resultados da consulta. Se essa condição não for obedecida, a camada não irá ser exibida e, em vez disso, o sistema irá exibir uma mensagem de erro. Esse campo deve ser preenchido com o mesmo nome de cada coluna (exatamente da forma como aparece no sistema), junto ao nome que será utilizado para isso nas mensagens de erro. Esses são separados por dois pontos, com cada grupo de nomes separados por uma vírgula e um espaço. Caso o nome exibido no sistema seja o mesmo nome da variável, esse nome só precisa ser inserido uma única vez, sem a necessidade dos dois pontos. Por exemplo, nome1 no sistema:nome1 exibido, nome2 no sistema:nome2 exibido, nome3 no sistema. Observe que as colunas Latitude e Longitude e a coluna com o ID do objeto devem ser incluídas neste parâmetro, pois são necessárias para que objetos sejam plotados no mapa. Isso permite ao sistema exibir uma mensagem de erro caso uma consulta não possa ser exibida por causa da ausência dessas colunas.
SearchKey	Não	Indica qual propriedade do objeto incluído no escopo da consulta será utilizada para localizá-lo no sistema quando usuários procurarem por esse objeto no campo Busca da janela Camadas. Em outras palavras, isso define qual propriedade os usuários devem inserir quando procurarem por um objeto através do mecanismo de busca no mapa. Para permitir que os usuários busquem objetos por nome, utilize o valor "Title". Se o campo será utilizado para localizar pontos de interesse e unidades de serviço especificamente, utilize o valor "AssetTypeName", pois esses objetos são ativos de tipos distintos. Para mais informações sobre quais valores podem ser utilizados aqui, entre em contato com a equipe de suporte.
AutoRefresh	Não	Indica a frequência, em segundos, com a qual a camada será automaticamente atualizada para exibir os dados mais recentes disponíveis da fonte de dados.