Páginas filhas
  • ER_PCREQ-5584_Reestruturação_das_mensagens_de_integração

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

 Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.                                                             

  

Informações Gerais

 

Especificação

Produto

TOTVS 12

Módulo

TSA

Segmento Executor

Manufatura

Projeto

D_MAN_TSA001

IRM

PCREQ-383

Requisito

PCREQ-5584

Subtarefa

PDRMAN-4406

Release de Entrega Planejada

12.1.7

Réplica

 

País

( X ) Brasil

Objetivo

  • Catalogar as mensagens, padronizando os códigos e as mensagens resultantes, para que seja possível montar FAQs de ajuda
  • Tornar mais legível a descrição das chaves externas quando se trata de relacionamentos
  • Esta reestruturação é apenas para as mensagens de integração com o sistema externo

 

Definição da Regra de Negócio

 As mensagens devem conter um código único, ou seja, o mesmo código não poderá ser utilizado para mais de uma mensagem e uma mesma mensagem não pode conter dois código diferentes em momentos diferentes. Essa mudança facilitará a catalogação de problemas e futuras ajudas ao usuário.


Novo Catálogo de Mensagens

Abaixo as tabelas separadas por WebServices com todas as possíveis mensagens de retorno do TSA catalogadas e com os novos códigos.

WebService de Dias Não Trabalhados (DayNotWorked) Removido Sucesso
Mensagens Comuns Entre WebServices
00100Registro salvo com sucesso
00101Erro técnico
00102Registro removido com sucesso
00501Lista de dias não trabalhados recebida para processo de integração esta NULL
00103Erro técnico: Nenhum registro de {0} foi encontrado com a chave externa {1}


 

 

WebService de Cargo (PositionLevel)
CódigoMensagem
0020100502Chave externa é um campo obrigatório
0050300202Descrição é um campo obrigatório
00504Dia não trabalhado é um campo obrigatório
00505Ano não pode ser Inferior a 1800
00506Recorrente não é um campo obrigatório
0050700203Erro técnico: Existe mais de um registro com a chave externa externa
00508Localidade é um campo obrigatório
00509Turno é um campo obrigatório
00204Registro não pode ser removido pois ele tem relacionamentos.
00206Lista de 'positionLevel' recebida para processo de integração está vazia
0020700510Erro técnico: Nenhum registro foi encontrado com a chave externa00511Erro técnico: Mais de um registro foi encontrado com a chave externa
00512Dia não trabalhado não encontrado
00513Turno não encontrado
00514Localidade não encontrado
00515Erro técnico: Chaves externas invalidas


 

 

Registro não pode ser removido pois ele tem relacionamentos.
WebService de Unidade de Lotação (AllocationUnitUnit)
CodigoCódigoMensagem
00100Registro Salvo com Sucesso
00101Erro Técnico
00102Registro Removido com Sucesso
00301Chave externa da escala é um campo obrigatório
00302Chave externa da pessoa jurídica é obrigatória
00303Descrição 01101Chave externa é um campo obrigatório
0110200304Descrição Tipo de unidade é um campo obrigatório
0110300305Erro técnico: Existe mais de um registro Mais de um registro foi encontrado com a chave externa
00306Erro técnico: Chave externa de situação de afastamento invalida
00307Erro técnico: Nenhum registro foi encontrado com a chave externa externa
0110400308Lista de 'positionLevelUnits' recebida para processo de integração esta NULLestá vazia
0110500309Registro não pode ser removido pois ele tem relacionamentos.
0110600310Erro técnico: Mais de   Já existe um registro foi encontrado com a chave externa
01107Erro técnico: Nenhum registro foi encontrado com a chave externa
01108
com essa unidade e com essa situação de afastamento.
00311Registro não foi excluído pois a chave externa não foi encontrada.


 

 

WebService de Escala (Scale)
CódigoMensagem
00100Registro Salvo com Sucesso
00102Registro Removido com sucesso
00101Erro técnico
00401Erro Técnico: 00401 Lista de 'Scale' recebida para processo de integração esta NULLestá vazia
00402Descrição é um campo obrigatório
00403Chave externa é um campo obrigatório
00404Turno é um campo obrigatório
00405Sequencia de inicio é um campo obrigatório
00406Sequencia de término é um campo obrigatório
00407Tipo de dia é um campo obrigatório
00408 Erro Erro técnico: Há mais do que um registo com chave externa
00409Pelo menos um par de escala deve ser informado.
00410 Erro Erro técnico: Nenhum registro foi encontrado com a chave externa
00411Erro técnico: Mais de um registro foi encontrado com a chave externa
00412Escala nãoo não pode ser excluida excluída pois não há outra escala no turno.
00413 Registro Registro não pode ser removido pois ele tem relacionamentos.

 

 



WebService de Unidade Dias Não Trabalhados (UnitDayNotWorked)
CódigoMensagem
00100Registro Salvo com Sucesso
00101Erro técnico
00102Registro Removido com Sucesso
00501Lista de dias não trabalhados recebida para processo de integração está vazia
00502Chave externa 00301Chave externa de escala é um campo obrigatório
00302Chave externa da pessoa jurídica é obrigatória
00503Descrição é um campo obrigatório
00504Dia não trabalhado 00303Descrição é um campo obrigatório
00505Ano não pode ser Inferior a 1800
00506Recorrente não 00304Tipo de unidade é um campo obrigatório
0030500507Erro técnico: Mais Existe mais de um registro foi encontrado com a chave externa
00306Erro técnico: Chave externa de situação de afastamento invalida
externa 
00508Localidade é um campo obrigatório
00509Turno é um campo obrigatório
0051000307Erro técnico: Nenhum registro foi encontrado com a chave externa
00308Lista de 'Units' recebida para processo de integração esta NULL
00309Registro não pode ser removido pois ele tem relacionamentos.
00310Erro técnico:  Já existe um registro com essa unidade e com essa situação de afastamento.
00311Registro não foi excluido pois nenhuma chave externa não existente.
00312Unidade salvo com sucesso

 

 

WebService de Cargo (PositionLevel)CódigoMensagem00100Registro Salvo com Sucesso00101Erro técnico00102Registro Removido com sucesso00201Chave externa é um campo obrigatório00202Descrição é um campo obrigatório00203Erro técnico: Existe mais de um registro com a chave externa00204Registro não pode ser removido pois ele tem relacionamentos.00206Lista de 'positionLevel' recebida para processo de integração esta NULL00207
00512Dia não trabalhado não encontrado
00513Turno não encontrado
00514Localidade não encontrado
00515Erro técnico: Chaves externas invalidas

 

 

WebService de Usuário (User)
CódigoMensagem
00601Chave externa do usuário não foi informada ou são iguais.
00602Erro técnico: Existe mais de um registro com a chave externa
00603Já existe um usuário com a mesma chave externa.
00604Erro técnico: Nenhum registro foi encontrado com a chave externa
00605Dado em duplicidade na mesma transação
00606Data inicial é um campo obrigatório
00607Data final é um campo obrigatório
00608Data final deve ser maior que a inicial
00609Chave externa invalida
00610Chave externa de usuário é um campo obrigatório
00611Chave externa do relacionamento é um campo obrigatório
00612Registo já foi excluído 
00613Erro técnico: Mais de um registro foi encontrado com a chave externa
00614Registro não encontrado
00615Chave externa da unidade tomadora é um campo obrigatório
00616O papel informado é inválido Valores válidos: 0 - Funcionário 1 - Prestador; 2 - Autônomo
00617Papel é um campo obrigatório
00618Chave externa da unidade prestadora é um campo obrigatório para o papel prestador.
00619Chave externa da unidade prestadora só deve ser informada quando o papel for Prestador.
00620Chave externa é um campo obrigatório
00621Chave externa de pessoa física é um campo obrigatório
00622Usuário não encontrado

 

 

 Erro técnico: Nenhum registro foi encontrado com a chave externa

WebService de Localidade (Location)
CódigoMensagem
00100Registro Salvo com Sucesso
00101Erro técnico
00701Chave externa é um campo obrigatório
00702Descrição do estado é um campo obrigatório
00703Descrição da cidade é um campo obrigatório
00704Pelo menos um dos campos país,  estado ou cidade devem ser informados.
00705Descrição do país é um campo obrigatório
00706Erro técnico: Existe mais de um registro com a chave externa
00707Registro não pode ser removido pois ele tem relacionamentos
00708Erro técnico: Nenhum registro foi encontrado com a chave externa
00709Lista de 'Location' recebida para processo de integração esta NULLestá vazia
00710Erro técnico: Mais de um registro foi encontrado com a chave externa

 

 

WebService de Turno (ShiftWork)
CódigoMensagem
00100Registro Salvo com Sucesso
00101Erro técnico
00102Registro Removido com sucesso
00801Chave externa é um campo obrigatório
00802Data inicial é um campo obrigatório
00803Descrição é um campo obrigatório
00804Existem funcionários com data de início do turno antes do início da validade do turno.
00805Erro técnico: Existe mais de um registro com a chave externa
00806Erro técnico: Nenhum registro passado por parâmetro
00807Chave externa de escala é um campo obrigatório
00808Sequencia de inicio é um campo obrigatório
00809Sequencia de término é um campo obrigatório
00810Tipo de dia é um campo obrigatório
00811Pelo menos um par de escala deve ser informado
00812Erro técnico: Chave externa da escala inválida ou já em uso ou turno sem escala.
00813Escala com tipo de dia incorreto:
00814Registro não pode ser removido pois ele tem relacionamentos.
00815Erro técnico: Lista de 'ShiftWork' recebida para processo de integração esta NULLestá vazia
00816Erro técnico: Nenhum registro foi encontrado com a chave externa
00817Erro técnico: Mais de um registro foi encontrado com a chave externa

 

 

WebService de Exceções (Exception)
CódigoMensagem
00100Registro Salvo com Sucesso
00101Erro técnico
00102Registro Removido com sucesso
00901Chave externa é um campo obrigatório
00902Usuário é um campo obrigatório
00903Tipo da exceção é um campo obrigatório
00904Origem é um campo obrigatório
00905Data inicial é um campo obrigatório
00906Data final é um campo obrigatório
00907Data final deve ser maior que a inicial
00908Direção é um campo obrigatório
00909Quando enviado pares de horários do tipo Intervalo ou Lanche é obrigatório o envio de horário da Jornada.
00910Erro técnico: Mais de um registro foi encontrado com a chave externa
00911Erro técnico: Nenhum registro passado por parâmetro
00912Erro técnico: Existe mais de um registro com a chave externa
00913Pelo menos um periodo período deve ser informado
00914Erro técnico: Nenhum registro foi encontrado com a chave externa
00915Registro não pode ser removido pois ele tem relacionamentos.

 

 

WebService de Usuário (User)CódigoMensagem00100Registro Salvo com Sucesso00101Erro Técnico00102Registro Removido com Sucesso00601Chave externa do usuário não foi informada ou são iguais.00602Erro técnico: Existe mais de um registro com a chave externa00603Já existe um usuário com a mesma chave externa.00604Erro técnico: Nenhum registro foi encontrado com a chave externa00605Dado em duplicidade na mesma transação00606Data inicial é um campo obrigatório00607Data final é um campo obrigatório00608Data final deve ser maior que a inicial00609Chave externa invalida00610Chave externa de usuário é um campo obrigatório00611Chave externa do relacionamento é um campo obrigatório00612Registo já foi excluido 00613Erro técnico: Mais de um registro foi encontrado com a chave externa00614Registro não encontrado00615Chave externa da unidade tomadora é um campo obrigatório00616O papel informado é inválido Valores válidos: 0 - Funcionário 1 - Prestador; 2 - Autônomo00617Papel é um campo obrigatório00618Chave externa da unidade prestadora é um campo obrigatório para o papel prestador.00619Chave externa da unidade prestadora só deve ser informada quando o papel for Prestador.00620Chave externa é um campo obrigatório00621Chave externa de pessoa física é um campo obrigatório00622Usuário não encontrado
00916Não é permitido ter mais de um intervalo do tipo Jornada.

 

 

WebService de Situação de Afastamento (AbsenceReason)
CódigoMensagem
00100Registro Salvo com Sucesso
00101Erro Técnico
00102Registro Removido com Sucesso
01001Chave externa é um campo obrigatório
01002Tipo de situação é um campo obrigatório
01003Descrição é um campo obrigatório
01004Erro técnico: existe mais do que um registo com a chave externa
01005Erro técnico: Chave externa da unidade inválida
01006No relacionamento com o usuário "{0}" a data inicial é um campo obrigatório
01007No relacionamento com o usuário "{0}" a data final é um campo obrigatório
01008No relacionamento com o usuário "{0}" a data final deve ser maior que a inicial.
01009No relacionamento com o usuário "{0}" a data final deve ser igual ou maior que a data de hoje
01010Lista de 'ScaleAbsenceReasons' recebida para processo de integração esta NULLestá vazia
01011Registro não foi excluido pois nenhuma chave externa não existente.excluído pois nenhum registro com a chave externa foi encontrado
01012Erro técnico: Mais de um registro de situação de afastamento foi encontrado com a chave externa "{0}".
01013Erro técnico: Nenhuma situação de afastamento foi encontrada com a chave externa "{0}"
01014Erro técnico: Mais de um registro de usuário foi encontrado com a chave externa "{0}"
01015Erro técnico: Nenhum usuário foi encontrado com a chave externa "{0}".
01016Data inicial é um campo obrigatório
01017Data final é um campo obrigatório
01018Registro não pode ser removido pois ele tem relacionamentos.
00101901019Erro técnico: Nenhum registro foi encontrado com a chave externa

 

 

WebService de Pessoa Física (NaturalPersonUnidade de Lotação (AllocationUnit)
CódigoMensagem
01101Chave externa é um campo obrigatório
01102Descrição é um campo obrigatório
01103Erro técnico: Existe mais de um registro com a chave externa 
01104Lista de 'allocationUnit' recebida para processo de integração está vazia
01105Registro não pode ser removido pois ele tem relacionamentos
01106Erro técnico: Mais de um registro foi encontrado com a chave externa
01107Erro técnico: Nenhum registro foi encontrado com a chave externa
01108Registro não pode ser removido pois ele tem relacionamentos.

 

 

WebService de Pessoa Física (NaturalPerson)
CódigoMensagem
00100Registro Salvo com Sucesso
00101Erro Técnico
00102Registro Removido com Sucesso
01201Chave externa é um campo obrigatório
01202Nome é um campo obrigatório
01203Erro técnico: Existe mais de um registro com a chave externa
01204Lista de 'NaturalPerson' recebida para processo de integração esta NULLestá vazia
01205Registro não pode ser removido pois ele tem relacionamentos.
01206Erro técnico: Mais de um registro foi encontrado com a chave externa
01207Erro técnico: Nenhum registro foi encontrado com a chave externa
01208Registro não pode ser removido pois ele tem relacionamentos.
01209CEP inválido.

 

 

WebService de Centro de Custo (CostCenter)
CódigoMensagem
00100Registro Salvo com Sucesso
00101Erro Técnico
00102Registro Removido com Sucesso
01301Chave externa é um campo obrigatório
01302Descrição é um campo obrigatório
01303Erro técnico: Existe mais de um registro com a chave externa
01300Lista de 'CostCenter' recebida para processo de integração esta NULLestá vazia
01305Erro técnico: Nenhum registro foi encontrado com a chave externa
01306Erro técnico: Mais de um registro foi encontrado com a chave externa
01307Registro não pode ser removido pois ele tem relacionamentos.

 

 

WebService de Sincronização (Synchronization)

Código

Mensagem

00101Erro Técnico

01401

Chave externa não inserida

01402

Tabela é um campo obrigatório

01403

Chave externa não existe

01404

01401

Chave externa encontrada com sucesso

01405

Chave externa do usuário

01402Tabela

é um campo obrigatório

01403

01406

Chave externa

não existe

 

da associação é um campo obrigatório

01407

Data inicial é um campo obrigatório

01408

Nome da tabela é invalido

01409

Associação com o usuário encontrada com sucesso

01410

Associação com usuário não encontrada



WebService Pessoa Jurídica (LegalPerson)
CódigoMensagem
01501Chave externa é um campo obrigatório
01502CNPJ ou CEI devem ser informados
01503Deve ser informado apenas um dos campos: CNPJ ou CEI.
01504Nome de pessoa jurídica é um campo obrigatório
01505Erro técnico: Mais de um registro foi encontrado com a chave externa
01506Lista de 'legalPersons' recebida para processo de integração está vazia
01507Registro não pode ser removido pois tem relacionamentos
01509Erro técnico: Nenhum registro foi encontrado com a chave externa

 

 

WebService de Turno e empréstimo de turno (UserShiftWork)

Código

Mensagem

01602

Erro técnico: Existe mais de um registro com a chave externa

01604

Erro técnico: Nenhum registro foi encontrado com a chave externa

01605

Dado em duplicidade na mesma transação

01606

Data inicial é um campo obrigatório

01607

Data final é um campo obrigatório

01608

Data final deve ser maior que a inicial

01609

Chave externa invalida

01610

Chave externa de usuário é um campo obrigatório

01611

Chave externa do relacionamento é um campo obrigatório

01612

Registo já foi excluído 

01614

Registro não encontrado

01622

Usuário não encontrado

Novo Formato de Exibição de Chave Externa Para Relacionamento

As mensagens referentes à relacionamentos entre tabelas, como usuário e turno, deve ser formatada de forma clara e em português.

 

Regra:

Chave + Nome Da Entidade, Chave + Nome da Entidade Relacionada

 

Exemplo:

Chave do Usuário: 100;12;1, Chave do Turno: 100;1;1545 

 

 Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.