Compartilhar via


Configurar ações do provedor de IoT

Depois de configurar um provedor de IoT (Internet das Coisas), você poderá especificar um conjunto de ações a serem disparadas com base nos dados capturados dos dispositivos IoT da organização. Com cinco ações predefinidas, você pode criar ações personalizadas associadas ao provedor para automatizar vários aspectos das operações do Connected Field Service.

As seguintes ações acompanham o Connected Field Service:

Extrair dados do dispositivo

A ação Extrair dados do dispositivo busca os dados mais recentes de um dispositivo ou de uma coleção de dispositivos do provedor de IoT. Ela é exibida na guia Histórico de dados do dispositivo.

Como os dados podem vir de vários dispositivos, a ação Extrair dados do dispositivo exige EntityCollection como entrada. A tabela a seguir descreve os parâmetros de EntityCollection.

Parâmetro Type Details
msdyn_iotdeviceid cadeia A identificação do dispositivo GUID (msdyn_iotdevice) no Connected Field Service, convertida em uma cadeia de caracteres
msdyn_name cadeia O nome do dispositivo
@odata.type cadeia Tipo OData da entidade

Entrada de exemplo:

{
  "EntityCollection":[
      {
    "msdyn_iotdeviceid":"B25B5E21-326E-4C36-9296-C195286DGEC9",
    "msdyn_name":" HVAC 32443",
    "@odata.type":"Microsoft.Dynamics.CRM.msdyn_iotdevice"
      },
      {
    "msdyn_iotdeviceid":"B25B5E21-326E-4C36-9296-C195286DGEE9",
    "msdyn_name":" HVAC 92232",
    "@odata.type":"Microsoft.Dynamics.CRM.msdyn_iotdevice"
      }
  ]
}

A ação Extrair dados do dispositivo retorna os dados buscados em formato JSON serializado. A tabela a seguir descreve os parâmetros da saída PullDeviceDataResultsJSON.

Propriedade JSON Type Details
ID cadeia A identificação do dispositivo GUID (msdyn_iotdevice) no Connected Field Service, convertida em uma cadeia de caracteres
ConnectionState boolean Se o dispositivo está desconectado (falso) ou conectado (verdadeiro)
ConnectionStateUpdatedTime datetime O carimbo de data/hora da atualização mais recente do estado de conexão do provedor de IoT
DeviceReportedProperties cadeia As propriedades relatadas do dispositivo, formatadas como uma cadeia de caracteres JSON
LastActivityTime datetime O carimbo de data/hora da atividade relatada mais recentemente pelo dispositivo

Saída de exemplo:

{
  "PullDeviceDataResultsJSON":[
     {
    "Id":"B25B5E21-326E-4C36-9296-C195286DGEC9",
    "ConnectionState":true,
    "ConnectionStateUpdatedTime":"2019-08-2911:00:00",
    "DeviceReportedProperties":{
      "temperature":65.6366305680316,
      "humidity":21.3333366666
      },
    "LastActivityTime": "2019-08-2011:00:00"
    },
    {
    "Id":"B25B5E21-326E-4C36-9296-C195286DGEE9",
    "ConnectionState":true,
    "ConnectionStateUpdatedTime":"2019-08-2911:00:00",
    "DeviceReportedProperties":{
      "temperature":62.8366305680316,
      "humidity":19.5333366666
    },
    "LastActivityTime": "2019-08-2011:00:00"
     }
  ]
}

Registrar dispositivo

A ação Registrar dispositivo cria uma associação entre um dispositivo ou uma coleção de dispositivos e o provedor de IoT. Novos dispositivos e dispositivos ou componentes trocados por um técnico podem ser registrados. Depois que você registra um dispositivo, ele é exibido na guia Histórico do Registro do registro do dispositivo IoT.

Como vários dispositivos podem ser registrados ao mesmo tempo, a ação Registrar dispositivo exige EntityCollection como entrada. A tabela a seguir descreve os parâmetros de EntityCollection.

Parâmetro Type Details
msdyn_iotdeviceid cadeia A identificação do dispositivo GUID (msdyn_iotdevice) no Connected Field Service, convertida em uma cadeia de caracteres
msdyn_name cadeia O nome do dispositivo
@odata.type cadeia Tipo OData da entidade

Entrada de exemplo:

{
  "EntityCollection": [
    {
      "msdyn_iotdeviceid": "5754578D-1F9A-4720-BC21-3C3042C05B2F",
      "msdyn_name": "Coffee maker 1",
      "@odata.type": "Microsoft.Dynamics.CRM.msdyn_iotdevice"
    },
    {
      "msdyn_iotdeviceid": "5754578D-1F9A-4720-BC21-3C3042C06C5F",
      "msdyn_name": "Coffee maker 2",
      "@odata.type": "Microsoft.Dynamics.CRM.msdyn_iotdevice"
    }
  ]
}

A ação Registrar dispositivo retorna os resultados de registro em formato JSON serializado. A tabela a seguir descreve os parâmetros da saída RegistrationResultsJSON.

Propriedade JSON Type Details
ID cadeia A identificação do dispositivo GUID (msdyn_iotdevice) no Connected Field Service, convertida em uma cadeia de caracteres
RegistrationStatus OptionSetValue O status do registro do provedor de IoT retornado para Connected Field Service
Valores e rótulos:
- 192350000: desconhecido
- 192350001: não registrado
- 192350002: em andamento
- 192350003: registrado
- 192350004: erro
Observação: OptionSet é uma lista de opções com mapeamento de valores do rótulo como um controle de lista suspensa.
DeviceId cadeia A ID do dispositivo no sistema do provedor de IoT
Mensagem cadeia Uma mensagem detalhada para o usuário do Connected Field Service referente ao registro

Saída de exemplo:

{
   "RegistrationResultsJSON":[
      {
         "Id":"5754578D-1F9A-4720-BC21-3C3042C05B2F",
         "RegistrationStatus":{"Value":192350003},
         "DeviceId":"DeviceIdFromThirdPartyOrUserDefined",
         "Message":"Registration info/warning/error message"   
      },
      {
         "Id":"5754578D-1F9A-4720-BC21-3C3042C06C5F",
         "RegistrationStatus":{"Value":192350003},
         "DeviceId":"DeviceIdFromThirdPartyOrUserDefined",
         "Message":"Registration info/warning/error message"   
      }   
  ]
}

Leituras de dispositivo agregado

A ação Leituras de dispositivo agregado busca dados de dispositivo agregado no provedor de IoT. Os dados agregados oferecem um instantâneo rápido da condição do dispositivo em blocos de resumo no Connected Field Service.

Captura de tela de um dispositivo de IoT no Field Service, mostrando leituras agregadas.

A tabela a seguir descreve os parâmetros de entrada da ação Leituras de dispositivo agregado.

Parâmetro Type Details
deviceId cadeia A identificação do dispositivo GUID (msdyn_iotdevice) no Connected Field Service, convertida em uma cadeia de caracteres
medidas cadeia Uma lista de medidas em formato JSON; consulte o trecho de código a seguir para obter exemplos

Entrada de exemplo:

[
    {
        "Measure":"Humidity",
        "Aggregate":"Min",
        "TimeRangeType":"Days",
        "TimeRangeValue":7
    },
    {
        "Measure":"Temperature",
        "Aggregate":"Avg",
        "TimeRangeType":"Days",
        "TimeRangeValue":14
    }
]

A ação Leituras de dispositivo agregado retorna as medidas em formato JSON serializado. A tabela a seguir exibe os parâmetros de saída.

Propriedade JSON Type Details
measuresOutput cadeia Os valores das medidas retornadas em formato JSON; consulte o trecho de código a seguir para obter exemplos

Saída de exemplo:

[
    {
        "Name":"Humidity",
        "Aggregate":"Min",
        "Unit":"F",
        "TimeRangeValue":7,
        "TimeRangeType":"Days",
        "Position":1,
        "Value":"39.13334"
    },
    {
        "Name":"Temperature",
        "Aggregate":"Avg",
        "Unit":"F",
        "TimeRangeValue":14,
        "TimeRangeType":"Days",
        "Position":2,
        "Value":"65.13334"
    }
]

As leituras de dispositivo agregado se basearão na entidade do histórico de dados do dispositivo se você não estiver usando a ação Leituras de dispositivo agregado.

Consultar leituras de dispositivo

A ação Consultar leituras de dispositivo busca dados de dispositivo históricos, como temperatura e umidade, no provedor de IoT e os exibe como um gráfico de série temporal.

Captura de tela de temperatura e umidade do dispositivo com o passar do tempo.

A tabela a seguir descreve os parâmetros de entrada da ação Consultar leituras de dispositivo.

Parâmetro Type Details
From datetime A hora de início da leitura (medição) em formato ISO; por exemplo, "2020-04-10T13:51:55.781Z"
To datetime A hora de término da leitura (medição) em formato ISO
IoTDeviceId cadeia A identificação do dispositivo GUID (msdyn_iotdevice) no Connected Field Service, convertida em uma cadeia de caracteres
Intervalo cadeia O tamanho do intervalo do ponto de plotagem especificado em formato de duração ISO-8601; por exemplo, 1 minuto é "PT1M", 1 milissegundo é "PT0.001S"
Todos os intervalos são do mesmo tamanho. Um mês é sempre convertido em 30 dias, e um ano tem sempre 365 dias.

Entrada de exemplo:

{
    "From":"2023-04-01T18:05:37.661Z", 

    "To":"2023-05-31T18:05:37.661Z", 

    "IotDeviceId":"50fce36f-9e3e-ed11-bba3-000d3a8b1de9", 

    "Interval":"P1D"
} 

A ação Consultar leituras de dispositivo retorna os dados em formato JSON serializado. A tabela a seguir exibe os parâmetros de saída.

Propriedade JSON Type Details
AggregatedDeviceReadings String Os valores das medidas retornadas em formato JSON; consulte o trecho de código a seguir para obter exemplos

Saída de exemplo:

{
  "HVAC Unit 123": {
    "Temperature": {
      "2017-04-01T06:00:00Z": {
        "min": -29,
        "max": 62.59,
        "avg": 16.89,
        "sum": 4054.14,
        "count": 240
      },
      "2017-04-01T08:00:00Z": {
        "min": -29,
        "max": 62.59,
        "avg": 16.89,
        "sum": 4054.14,
        "count": 480
      }
    },
    "Humidity": {
      "2017-04-01T06:00:00Z": {
        "min": 10,
        "max": 48.3,
        "avg": 29.25,
        "sum": 7020.62,
        "count": 240
      },
      "2017-04-01T08:00:00Z": {
        "min": 10,
        "max": 48.3,
        "avg": 29.25,
        "sum": 7020.62,
        "count": 480
      }
    }
  }
}    

Obter eventos de dispositivo

A ação Obter eventos de dispositivo busca eventos do histórico de serviço do dispositivo e os exibe como marcações na parte inferior do gráfico criado pela ação Consultar leituras de dispositivo. Você pode incluir quaisquer entidades personalizadas, como a última vez em que executou uma atualização de ativo.

Captura de tela de eventos mostrados como marcações no gráfico de temperatura e umidade do dispositivo com o passar do tempo.

Observação

Você não precisa criar uma ação novo. Registre um plug-in personalizado na ação msdyn_IoTGetDeviceEvents, como plug-ins para criar eventos.

A tabela a seguir descreve os parâmetros de entrada da ação Obter eventos de dispositivo.

Propriedade JSON Type Details
From datetime A hora de início da leitura (medição) em formato ISO; por exemplo, "2020-04-10T13:51:55.781Z"
To datetime A hora de término da leitura (medição) em formato ISO
IoTDeviceId cadeia A identificação do dispositivo GUID (msdyn_iotdevice) no Connected Field Service, convertida em uma cadeia de caracteres

Entrada de exemplo:

{ 
    "IotDeviceId": "50fce36f-9e3e-ed11-bba3-000d3a8b1de9", 
    "From": "2023-06-12T18:57:54.864Z", 
    "To": "2023-06-12T19:57:54.864Z" 
} 

A ação Obter eventos de dispositivo retorna os dados em formato JSON serializado. A tabela a seguir exibe os parâmetros de saída.

Propriedade JSON Type Details
EventsName cadeia Descrição resumida da categoria do evento; use-a para mostrar ou ocultar todos os eventos nessa categoria
Carimbo de data/hora cadeia O carimbo de data/hora do evento formatado como uma cadeia de caracteres em formato ISO; o carimbo de data/hora do eixo x para a marcação do evento
Color cadeia A cor da marcação do evento, fornecida como uma cadeia de caracteres hexadecimal
Description cadeia Uma descrição curta do evento, exibida quando o usuário focaliza a marcação ou seleciona a marcação para exibir detalhes
ID cadeia A ID do evento; pode ser um nome ou outro valor amigável ao usuário, como o número da ordem de serviço ou o código de confirmação da reserva
Entity cadeia O nome da entidade do Dataverse relacionado ao evento; por exemplo, "msdyn_workorder"
URL cadeia A URL da página de detalhes do evento, como um link para o formulário da ordem de serviço
Se você passar uma entidade e um GUID, o sistema gerará automaticamente um hiperlink.
GUID cadeia A GUID, convertida em uma cadeia de caracteres, do registro da entidade no Dataverse

Saída de exemplo:

{
  "Service History": {
    "2019-08-07T19:14:53Z": {
      "color": "#FF6300",
      "description": "Work Order Created",
      "id": "00001",
      "entity": "msdyn_workorder",
      "url": "",
      "guid": "952a7592-8818-ea11-a811-000d3a5466d7"
    },
    "2019-08-08T19:14:53Z": {
      "color": "#ECC5AC",
      "description": "Work Order Created",
      "id": "00002",
      "entity": "msdyn_workorder",
      "url": "",
      "guid": "952a7592-8818-ea11-a811-000d3a5466d9"
    },
    "2019-09-21T09:34:53Z": {
      "color": "#ECC5AC",
      "description": "Case Created",
      "id": "000121",
      "entity": "msdyn_incident",
      "url": "",
      "guid": "952a7592-8818-ea11-a811-000d3a5466d0"
    }
  },
  "Asset History": {
    "2019-08-07T19:14:53Z": {
      "color": "#FF6400",
      "description": "Asset Model Upgraded",
      "id": "001223",
      "entity": "new_assetupgraded",
      "url": "",
      "guid": "952a7592-8818-ea11-a811-000d3a5466d7"
    }
  }
}

Próximas etapas