Histórico da Página

01. VISÃO GERAL

Para simplificar o processo de configuração e do TOTVS Connector Client, tanto para uma nova instalação, quanto para atualização de versão do produto e schemas, foram implementadas duas novas APIs, conforme descritas a seguir.

02. API Auto Configure

A API de Configuração automática pode ser utilizada para realizar a configuração da aplicação, após uma nova instalação, e até mesmo para configurar novos schemas. O processo consiste desde o sincronismo dos Schemas, criação do ProductConnection, vinculo do ProductConnection com um conjunto de SchemaDefinition, limpeza de registros antigos e deleção de triggers do TCC. Para mais informações consulte o manual do usuário.

...

Content-Type: application/json
Authorization: Basic *********************Basic YWRtaW46OVpuTXA1UFBoPjs1dixYcg==

Body:

Exemplo do corpo da requisição, que pode ser utilizada para primeira configuração ou incluir novas integrações.

Bloco de código

title	Body

{
  "productConnection": {
    "dataBaseType": "ORACLE12C",
    "productName": "PIMSCS",
    "url": "jdbc:oracle:thin:@10@127.1720.2120.511:1521:AMAZONASORCL",    
    "username": "DCS_ALBERUSERNAME",
    "password": "DCS_ALBERPASSWORD"
  },
  "integrations": [
    "meus-abastecimentos"
  ],
  "forceSyncSchema": false,
  "clearOldEvents": true,
  "clearOthersProductConnectionSchema": false
}

ou

Exemplo de corpo da requisição simplificada que pode ser utilizada quando há a necessidade de habilitar novas integrações e já há um ProductConnection previamente configurado.

Bloco de código

title	Body

{
  "productConnection": {
    "id": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51"
  },
  "integrations": [
    "minha-borracharia"
  ]
}

Os atributos informados no JSON são:

productConnection: Dados de Conexão com a base do Produto.
- id (Opcional): ID do ProductConnection, caso já exista pré-configurado. Opcional. Pode ser enviado no modelo de requisição simplificada, utilizada quando há a necessidade de habilitar novas integrações e já há um ProductConnection previamente configurado, não sendo necessário enviar os demais dados do ProductConnection.
- dataBaseType: Tipo de Banco de dados utilizado. Os valores possíveis são: POSTGRESQL, MSSQLSERVER, ORACLE11G, ORACLE12C ou MYSQL
- productName: Nome do Produto a ser integrado.
  - TOTVS Agro Bioenergia: PIMSCS
  - TOTVS Agro Multicultivo: PIMSMC
  - TOTVS Pesagem: TA-PESAGEM
- url: JDBC Url para conexão com a base de dados do Produto. (Ex: jdbc:oracle:thin:@127.0.0.1:1521:ORCL)
- username: Usuário para conexão com a base de dados do Produto.
- password: Senha para conexão com a base de dados do Produto.
integrations: Lista de Catálogos de Schemas que serão configurados (agro-data-client, dado-meteorologico, fito-saas, meus-abastecimentos e minha-borracharia), vinculando sempre a ultima versão dos Schemas Definition, menor ou igual a versão do produto.
- agro-data-client: Schemas AnoAgricola, Cargo, CentroCusto, Componente, DisponibilidadeEquipamento, DisponibilidadeFuncionario, Cultivar, Cultura, Equipamento, Equipe, Funcionario, GrupoComponente, GrupoInsumo, GrupoOperacao, Instancia, Insumo, LocalProducao1, LocalProducao2, LocalProducao3, LocalProducaoFisico, Operacao, OrdemServicoCampo, PeriodoSafra, UnidadeMedida.
- dado-meteorologico: ElementoClimatico, PostoMetereologico.
- fito-saas: ParametroLocal, Instancia, Cultura, Cultivar, AnoAgricola, PeriodoSafra, LocalProducao1, LocalProducao2, LocalProducao3, LocalProducao3Fisico, Variavel, Armadilha, Inspecao, Insumo, UnidadeMedida, GrupoInsumo, InspecaoResultadoCalculado, e Espacamento.
- meus-abastecimentos: FechamentoPontoAbastecimento, Material, ApontamentoAbastecimento, UnidadeMedida, Instancia, Funcionario, PontoManutencao, GrupoOperativo, ModeloEquipamento, Marca, BombaAbastecimento, CategoriaOperacional, DisponibilidadeEquipamento, DisponibilidadeFuncionario, ParametroUnidadeAdministrativa, UniAdministrativaTrocaRecurso, Parametro, Equipamento, GrupoOperacao, Operacao, Horimetros, HorarioFechPontoAbast, ConsumoMedio, TipoLubrificante, SistemaVeicular, SubsistemaVeicular, ClasseManutencao, SubsistemaVeicularTipoLubrificante, PlanoLubrificacao, Panorama, UsuarioMobilidade, DMModulo, UsuarioMobilidadeModulo, ApontamentoLubrificacaoTemp.
- minha-borracharia: Admissibilidade, AdmissibilidadeMed, AfastamentoFerias, Autoridades, AvaliacaoPneusDesmontados, CategoriaOperacional, ClassePriorizacao, DisponibilidadeEquipamento, Empresa, EnvioConsertoReformaPneus, Equipamento, EquipamentoPneu, EquipeManutencao, EstruturaPneu, Funcionario, FuncionarioUsuarioManfro, Grupo, GrupoOperacao, GrupoOperativo, HistoricoPneu, Instancia, LocalPneu, Marca, MedidaPneu, ModeloEquipamento, ModeloLocal, ModeloPneu, MotivoCondenacaoPneu, MotivoManutencaoPneu, OcupacaoPneu, Parametro, Pneu, PneuEmpresa, PontoManutencao, PrestadorServico, UnidadeMedida, Usuario, UsuarioInstancia, ImagemAvaliacao, ComponenteManutencao, OperacaoManutencao, OrdemServicoOficina, SistemaVeicular, SubsistemaVeicular, Box, MotivoEntrada, ClasseManutencao, TipoPecaServico, Material, InstrucaoTrabalho.
forceSyncSchema (Opcional): Realiza a sincronização dos Schemas com TOTOVS Connector Server. Opcional. Valor padrão: false
clearOldEvents (Opcional): Realiza a limpeza de eventos antigos (TCC_EVENT). Opcional. Valor padrão: true
clearOthersProductConnectionSchema (Opcional): Remove configurações existentes de ProductConnection com SchemaDefinition, configurando apenas os Schemas do catalogo enviado. Opcional. Valor padrão: false

Respostas:
200 (OK): Configuração realizada com sucesso.

Retorna ProductConnection e os Schemas vinculados.

Bloco de código

title	Response

{
    "productConnection": {
        "id": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
        "productName": "PIMSCS",
        "productVersion": "12.1.2412",
        "url": "jdbc:oracle:thin:@10@127.1720.2120.511:1521:AMAZONASORCL",
        "username": "USERNAME",
        "dataBaseType": "ORACLE12C",
        "enabled": true
    },
    "schemas": [
        {
            "id": "4038eb61-a927-4b02-9470-c6a7b90ac5f2",
            "idProductConnection": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
            "idSchemaDefinition": "583587b7-a6d3-4383-830c-b37fd84f20ae",
            "versionSchemaDefinition": "12.1.2406.0001",
            "nameSchemaDefinition": "Equipamento",
            "enableStandalone": true,
            "enablePublishRemote": false
        },
        {
            "id": "8730f13f-50ac-4bd9-8576-bb6635a981d6",
            "idProductConnection": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
            "idSchemaDefinition": "22fa732b-c07d-4bb7-b409-f300b1840aca",
            "versionSchemaDefinition": "12.1.27",
            "nameSchemaDefinition": "CategoriaOperacional",
            "enableStandalone": true,
            "enablePublishRemote": false
        },
        {
            "id": "b75499b4-96a0-412b-bd40-c34ed8b221ba",
            "idProductConnection": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
            "idSchemaDefinition": "0946d8b3-a0f3-49d7-bd97-a74af21eda7f",
            "versionSchemaDefinition": "12.1.27",
            "nameSchemaDefinition": "DisponibilidadeEquipamento",
            "enableStandalone": true,
            "enablePublishRemote": false
        },
		...
    ]
}

400 (Bad Request): Falha ao validar as regras de negócio.
401 (Unauthorized): Falha de autenticação.
403 (Forbidden): Falha de autorização.
500 (Internal Server Error): Erro inesperado no sistema.

03. API Update All

API destinada para realizar a atualização de todos os ProductConnections, incluindo a versão, com base na TCC_PRODUCT_METADATA, configurados e também a atualização dos Schemas Definition, vinculando sempre a ultima versão, menor ou igual a versão do produto.

Descrição: Atualiza todos os ProductConnections e SchemaDefinition da aplicação.
URL: /api/v1/autoconfig/updateAllupdateAllupdateAll
Método: POST
Headers:

Content-Type: application/json
Authorization: Basic *********************Basic YWRtaW46OVpuTXA1UFBoPjs1dixYcg==

Body: Não possui Body

Respostas:
200 (OK): Atualização realizada com sucesso.

Retorna Lista de ProductConnection e Schemas vinculados.

Bloco de código

title	Response

[
    {
        "productConnection": {
            "id": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
            "productName": "PIMSCS",
            "productVersion": "12.1.2412",
            "url": "jdbc:oracle:thin:@127.0.0.1:1521:ORCL",
            "username": "USERNAME",
            "dataBaseType": "ORACLE12C",
            "enabled": true
        },
        "schemas": [
            {
                "id": "a618f297-234e-4580-b418-352967715cd5",
                "idProductConnection": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
                "idSchemaDefinition": "583587b7-a6d3-4383-830c-b37fd84f20ae",
                "versionSchemaDefinition": "12.1.2406.0001",
                "nameSchemaDefinition": "Equipamento",
                "enableStandalone": true,
                "enablePublishRemote": false
            },
            {
                "id": "21999128-3e95-4572-a6c2-8a5df18b958c",
                "idProductConnection": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
                "idSchemaDefinition": "0946d8b3-a0f3-49d7-bd97-a74af21eda7f",
                "versionSchemaDefinition": "12.1.27",
                "nameSchemaDefinition": "DisponibilidadeEquipamento",
                "enableStandalone": true,
                "enablePublishRemote": false
            },
			...
		]
	},
	...
]

400 (Bad Request): Falha ao validar as regras de negócio.
401 (Unauthorized): Falha de autenticação.
403 (Forbidden): Falha de autorização.
500 (Internal Server Error): Erro inesperado no sistema.

Páginas filhas

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

01. VISÃO GERAL

02. API Auto Configure

03. API Update All