...

A entidade CarolStagingTable possui dois atributos similares, que representam abstrações diferentes: name e stagingTableName. A diferenciação de cada atributo será explicado a seguir.

Atributos

• O atributo stagingTableName representa exatamente o nome da StagingTable na TOTVS Carol. Por exemplo, se na TOTVS Carol contém uma StagingTable com o nome "fazenda", o atributo stagingTableName deverá ser, exatamente, "fazenda";

• O atributo name representa um "apelido" para o TOTVS Connector Server diferenciar dos nomes das StagingTable. Por exemplo, na TOTVS Carol contém uma StagingTable chamada "inspecao" e no TOTVS Connector Server, contém duas CarolStagingTable que apontam para a StagingTable "inspecao" na TOTVS Carol. Para diferenciar as duas CarolStagingTable, utiliza-se o atributo name.

• O atributo description representa uma descrição sobre a CarolStagingTable;

Mas por que pode conter duas CarolStagingTable no TOTVS Connector Server apontando para a mesma StagingTable na TOTVS Carol?

...

{
  "carolConnectorId": "b26a732f-d2fc-47c8-9e0d-545d6e3ef674",
  "stagingTableName": "fazenda",
  "description": "Exemplo de CarolStagingTable, que representa uma StagingTable na TOTVS Carol",
  "name": "apelido_para_fazenda"
}

IMPORTANTE!

Quando enviar uma mensagem para o TOTVS Connector Server, destinada à TOTVS Carol, a entidade EventDataCarolRequest deverá conter, exatamente, o valor do atributo name. Portanto, não deverá mandar o atributo stagingTableName na mensagem.

...

A entidade EventDataCarolRequest é utilizada para encapsular os dados para enviar ao TOTVS Connector Server.

Atributos

• O atributo environmentToken é o token gerado na entidade Client Environment;

• O atributo stagingTableName é exatamente o apelido (atributo name) cadastrada na entidade CarolStagingTable;

• O atributo originApp é o nome do produto que está enviando os dados (produto de origem);

• O atributo dataList é uma lista de objetos que será enviada para a StagingTable na TOTVS Carol, ou seja, os objetos são as próprias representações da StagingTable;

{
  "environmentToken": "dac9b5163b31479bd9a2151b6f2fe2bbb3d48cf110911d36c062995994598c6e",
  "stagingTableName": "atributo_name_da_entidade_CarolStagingTable",
  "originApp": "app_de_origem",
  "dataList": [
    {}
  ]
}

Como enviar?

...

{
    "header": {
        "type": "atributo_name_da_entidade_CarolStagingTable", "generatedOn": "2000-01-01T00:00:00.000000Z", "locale": "pt_BR" }, "content": {} }

Estrutura Final TOTVSMessage<EventDataCarolRequest>

...

{
    "header": {
        "type": "atributo_name_da_entidade_CarolStagingTable", 
"generatedOn": "2000-01-01T00:00:00.000000Z", 
"locale": "pt_BR" 
}, 
"content": {
        "environmentToken": "dac9b5163b31479bd9a2151b6f2fe2bbb3d48cf110911d36c062995994598c6e",
        "stagingTableName": "atributo_name_da_entidade_CarolStagingTable",
        "originApp": "app_de_origem",
        "dataList": [
           {}
        ]
    }

}

04. Observações

...