Configurar ações do fornecedor de IoT

Artigo
09/04/2024

Depois de configurar um fornecedor de IoT (Internet das Coisas), pode especificar um conjunto de ações a serem acionadas com base nos dados capturados dos dispositivos IoT da sua organização. Em conjunto com cinco ações predefinidas, pode criar ações personalizadas associadas ao seu fornecedor para automatizar vários aspetos das operações do Connected Field Service.

As seguintes ações são fornecidas com o Connected Field Service:

Solicitar dados dos dispositivos
Registar dispositivo
Leituras de dispositivos agregadas
Consultar leituras de dispositivos
Obter eventos de dispositivos

Solicitar dados dos dispositivos

A ação Obter dados do dispositivo obtém os dados mais recentes de um dispositivo ou de uma coleção de dispositivos a partir do fornecedor de IoT. Aparece no separador Histórico de Dados do Dispositivo.

Uma vez que os dados podem vir de vários dispositivos, a ação Obter dados do dispositivo requer uma EntityCollection como entrada. A tabela seguinte descreve os parâmetro da EntityCollection.

Parâmetro	Tipo	Details
msdyn_iotdeviceid	cadeia	O ID do dispositivo do GUID (msdyn_iotdevice) no Connected Field Service, convertido numa cadeia
msdyn_name	cadeia	O nome do dispositivo
@odata.type	cadeia	O tipo OData da entidade

Entrada de amostra:

{
  "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 Obter dados do dispositivo devolve os dados obtidos no formato JSON em série. A tabela seguinte descreve os parâmetro da saída PullDeviceDataResultsJSON.

Propriedade de JSON	Tipo	Details
ID	cadeia	O ID do dispositivo do GUID (msdyn_iotdevice) no Connected Field Service, convertido numa cadeia
ConnectionState	boolean	Se o dispositivo está desligado (false) ou ligado (true)
ConnectionStateUpdatedTime	datetime	O carimbo de data/hora da última atualização do estado da ligação do fornecedor de IoT
DeviceReportedProperties	cadeia	As propriedades relatadas do dispositivo formatadas como uma cadeia JSON
LastActivityTime	datetime	O carimbo de data/hora da última atividade reportada do 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"
     }
  ]
}

Registar dispositivo

A ação Registar dispositivo cria uma associação entre um dispositivo ou uma coleção de dispositivos e o fornecedor de IoT. Novos dispositivos e dispositivos ou componentes que um técnico troca podem ser registados. Depois de registar um dispositivo, este aparece no separador Histórico de Registos do registo do Dispositivo IoT.

Uma vez que vários dispositivos podem ser registados de uma vez, a ação Registar dispositivo requer uma EntityCollection como entrada. A tabela seguinte descreve os parâmetro da EntityCollection.

Parâmetro	Tipo	Details
msdyn_iotdeviceid	cadeia	O ID do dispositivo do GUID (msdyn_iotdevice) no Connected Field Service, convertido numa cadeia
msdyn_name	cadeia	O nome do dispositivo
@odata.type	cadeia	O tipo OData da entidade

Entrada de amostra:

{
  "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 Registar dispositivo devolve os resultados do registo no formato JSON em série. A tabela seguinte descreve os parâmetro da saída RegistrationResultsJSON.

Propriedade de JSON	Tipo	Details
ID	cadeia	O ID do dispositivo do GUID (msdyn_iotdevice) no Connected Field Service, convertido numa cadeia
RegistrationStatus	OptionSetValue	O estado do registo do fornecedor de IoT de volta ao Connected Field Service Valores e etiquetas: - 192350000: Desconhecido - 192350001: Registo anulado - 192350002: Em curso - 192350003: Registado - 192350004: Erro Nota: Um OptionSet é uma lista de opções com mapeamento de valor de etiqueta, como um controlo de lista pendente.
DeviceId	cadeia	O ID do dispositivo no sistema do fornecedor de IoT
Mensagem	cadeia	Uma mensagem detalhada para o utilizador do Connected Field Service sobre o registo

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 dispositivos agregadas

A ação Leituras de dispositivos agregadas obtém dados de dispositivos agregados do fornecedor de IoT. Os dados agregados fornecem um instantâneo rápido da condição do dispositivo em mosaicos de resumo no Connected Field Service.

Captura de ecrã de um dispositivo de IoT no Field Service a mostrar leituras agregadas.

A tabela seguinte descreve os parâmetros de entrada da ação Leituras de dispositivos agregadas.

Parâmetro	Tipo	Details
deviceId	cadeia	O ID do dispositivo do GUID (msdyn_iotdevice) no Connected Field Service, convertido numa cadeia
medições	cadeia	Uma lista de medidas no formato JSON; consulte o seguinte fragmento de código para ver exemplos

Entrada de amostra:

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

A ação Leituras de dispositivos agregadas devolve as medidas no formato JSON em série. A tabela que se segue apresenta os parâmetros de saída.

Propriedade de JSON	Tipo	Details
measuresOutput	cadeia	Os valores das medidas devolvidas no formato JSON; consulte o seguinte fragmento de código para ver 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 dispositivos agregadas baseiam-se na entidade de histórico de dados do dispositivo se não estiver a utilizar a ação Leituras de dispositivos agregadas.

Consultar leituras de dispositivos

A ação Consultar leituras de dispositivos obtém dados históricos do dispositivo, tais como temperatura e humidade, do fornecedor de IoT e apresenta-os como um gráfico de série temporal.

Captura de ecrã da temperatura e humidade do dispositivo ao longo do tempo.

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

Parâmetro	Tipo	Details
From	datetime	A hora de início da leitura (medição) no formato ISO; por exemplo, "2020-04-10T13:51:55.781Z"
To	datetime	A hora de fim da leitura (medição) no formato ISO
IoTDeviceId	cadeia	O ID do dispositivo do GUID (msdyn_iotdevice) no Connected Field Service, convertido numa cadeia
Intervalo	cadeia	O tamanho do intervalo do ponto de desenho especificado no 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 é sempre 365 dias.

Entrada de amostra:

{
    "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 dispositivos devolve os dados no formato JSON em série. A tabela que se segue apresenta os parâmetros de saída.

Propriedade de JSON	Tipo	Details
AggregatedDeviceReadings	Cadeia (de carateres)	Os valores das medidas devolvidas no formato JSON; consulte o seguinte fragmento de código para ver 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 dispositivos

A ação Obter eventos de dispositivos obtém eventos do histórico de serviços do dispositivo e apresenta-os como afixações no fundo do gráfico criado pela ação Consular leituras de dispositivos. Pode incluir quaisquer entidades personalizadas, como a última vez que realizou uma atualização de ativos.

Captura de ecrã de eventos mostrados como afixações sob o gráfico de temperatura e humidade ao longo do tempo do dispositivo.

Nota

Não tem de criar uma nova ação. Registe um plug-in personalizado na ação msdyn_IoTGetDeviceEvents, como plug-ins para criar eventos.

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

Propriedade de JSON	Tipo	Details
From	datetime	A hora de início da leitura (medição) no formato ISO; por exemplo, "2020-04-10T13:51:55.781Z"
To	datetime	A hora de fim da leitura (medição) no formato ISO
IoTDeviceId	cadeia	O ID do dispositivo do GUID (msdyn_iotdevice) no Connected Field Service, convertido numa cadeia

Entrada de amostra:

{ 
    "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 dispositivos devolve os dados no formato JSON em série. A tabela que se segue apresenta os parâmetros de saída.

Propriedade de JSON	Tipo	Details
EventsName	cadeia	Curta descrição da categoria do evento; utilize-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 no formato ISO; o carimbo de data/hora do eixo x para a afixação do evento
Color	cadeia	A cor da afixação do evento, fornecida como uma cadeia de código hex
Descrição	cadeia	Uma curta descrição do evento, apresentada quando o utilizador paira o cursor sobre a afixação ou seleciona a afixação para ver detalhes
ID	cadeia	O ID do evento; pode ser um nome ou outro valor fácil para o utilizador, como o número da ordem de intervenção ou o código de confirmação da reserva
Entidade	cadeia	O nome da entidade do Dataverse relacionada com o evento; por exemplo, "msdyn_workorder"
URL	cadeia	O URL da página de detalhes do evento, como uma ligação para o formulário da ordem de intervenção Se transmitir uma entidade e GUID, o sistema gera automaticamente uma hiperligação.
GUID	cadeia	O GUID, convertido numa cadeia, do registo 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"
    }
  }
}

Partilhar via

Configurar ações do fornecedor de IoT

Solicitar dados dos dispositivos

Registar dispositivo

Leituras de dispositivos agregadas

Consultar leituras de dispositivos

Obter eventos de dispositivos

Próximos passos

Comentários

Recursos adicionais