Histórico da Página
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico |
---|
(Obrigatório)
Informações Gerais
Especificação | |||
Produto | Datasul | Módulo | EAI |
Segmento Executor | Tecnologia | ||
Projeto1 | PDR_LD_FRW001 | IRM1 | PCREQ-9836 |
Requisito1 | PCREQ-10304 | Subtarefa1 | |
País | ( ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( x ) TODOS. | ||
Outros |
Legenda Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos).
Objetivo
Neste desenvolvimento será possível a execução dos objetos de negócio expostos pelo Datasul, através do recebimento de mensagens baseadas no padrão Mensagem Única TOTVS, preparadas para portar os parâmetros de entrada necessários e os dados de retorno gerados após a execução do referido objeto.
(Obrigatório)
Definição da Regra de Negócio
Os aplicativos que fizerem o consumo de objetos de negócio através da Mensageria TOTVS deverão enviar mensagens com o formato de dados do aplicativo que, naquela integração, possuir o papel de ERP. A definição dos papeis na integração ficará a cargo do segmento que estiver demandando a mesma.
Considerando um cenário onde o Datasul atue como ERP na integração, teremos todas as mensagens trafegadas com o formato de dados do Datasul. Tomando por exemplo uma integração de cadastro de usuários entre Protheus e Datasul, o fluxo será o seguinte:
- Protheus efetua o cadastro de um usuário;
- O objeto de negócio correspondente aciona o adapter de integração;
- O adapter de integração converte o modelo de dados Protheus para o modelo de dados Datasul, baseando-se no XML Schema obtido pelo serviço getSchema;
- O adapter de integração envia a mensagem para o engine de EAI do Protheus;
- O engine de EAI Protheus envia a mensagem para o webservice de recebimento do Datasul;
- O webservice de recebimento encaminha a mensagem para o engine de EAI do Datasul;
- O engine de EAI identifica o objeto de negócio solicitado na mensagem;
- O engine de EAI extrai os dados de entrada da mensagem e aciona o objeto de negocio, passando os dados extraídos como parâmetro;
- O engine de EAI recebe os dados de retorno do objeto de negócio;
- A mensagem de retorno é gerada pelo engine de EAI com os dados de saída do objeto de negócio;
- A mensagem de retorno é enviada ao webservice de recebimento do Protheus;
- O webservice de recebimento encaminha a mensagem de retorno para o engine de EAI Protheus;
- O engine de EAI Protheus extrai os dados e encaminha para o objeto de negócio Protheus;
- O objeto de negócio Protheus recebe os dados, converte do modelo Datasul para o modelo Protheus e processa o retorno.
Pelo fluxo acima, a responsabilidade de conversão dos dados de um modelo para outro fica sob responsabilidade do papel de Vertical.
De acordo com a especificação da Mensageria TOTVS, o conteúdo da tag <BusinessContent> de uma mensagem terá o formato definido no XML Schema do objeto de negócio presente na tag <Transaction>. Nesta tag, o objeto de negócio sempre será precedido pelo nome do ERP.
No exemplo abaixo a mensagem - uma BusinessEvent - refere-se ao objeto de negócio fnbo017, um DBO, associado ao cadastro de usuários no Datasul:
Bloco de código | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?>
<TOTVSMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xmlschema/general/totvsmsg.xsd">
<MessageInformation version="1.000">
<UUID>Fnbobofn-0170-0001-0000-000000000006</UUID>
<Type>BusinessMessage</Type>
<Transaction>Datasul/fnbo.bofn017</Transaction>
<StandardVersion>1.0</StandardVersion>
<SourceApplication>SoapUI</SourceApplication>
<Product name="SoapUI" version="5.2.1"/>
<GeneratedOn>2016-03-17T18:15:00</GeneratedOn>
<DeliveryType>Sync</DeliveryType>
</MessageInformation>
<BusinessMessage>
<BusinessEvent>
<Entity>Datasul/fnbo.bofn017</Entity>
<Event>upsert</Event>
<Identification/>
</BusinessEvent>
<BusinessContent>
<RowObjectbofn017>
<RowObjectbofn017Row>
<cod_usuario>cod_usuar12</cod_usuario>
<nom_usuario>usuario_121</nom_usuario>
<cod_senha>cod_senha</cod_senha>
<cod_idiom_orig>cod_idiom_orig</cod_idiom_orig>
<ind_tip_usuar>ind_tip_usuar</ind_tip_usuar>
<num_pessoa>0</num_pessoa>
<nom_dir_spool>nom_dir_spool</nom_dir_spool>
<nom_subdir_spool>nom_subdir_spool</nom_subdir_spool>
<cod_servid_exec>cod_servid_exec</cod_servid_exec>
<cod_e_mail_local>cod_e_mail_local</cod_e_mail_local>
<dat_ult_erro_tentat_aces>2001-01-01</dat_ult_erro_tentat_aces>
<hra_ult_erro_tentat_aces>hra_ult_erro_tentat_aces</hra_ult_erro_tentat_aces>
<qtd_erro_tentat_aces>0.0</qtd_erro_tentat_aces>
<log_servid_exec_obrig>true</log_servid_exec_obrig>
<dat_inic_valid>2001-01-01</dat_inic_valid>
<dat_fim_valid>2001-01-01</dat_fim_valid>
<dat_valid_senha>2001-01-01</dat_valid_senha>
<num_dias_valid_senha>0</num_dias_valid_senha>
<log_segur_uhr_atlzdo>true</log_segur_uhr_atlzdo>
<cod_livre_1>cod_livre_1</cod_livre_1>
<cod_livre_2>cod_livre_2</cod_livre_2>
<val_livre_1>0.0</val_livre_1>
<val_livre_2>0.0</val_livre_2>
<num_livre_1>0</num_livre_1>
<num_livre_2>0</num_livre_2>
<log_livre_1>true</log_livre_1>
<log_livre_2>true</log_livre_2>
<dat_livre_1>2001-01-01</dat_livre_1>
<dat_livre_2>2001-01-01</dat_livre_2>
<des_checksum>des_checksum</des_checksum>
<num_perf_usuar>0</num_perf_usuar>
<des_cod_perf_usuar>des_cod_perf_usuar</des_cod_perf_usuar>
<log_mostra_framework>true</log_mostra_framework>
<nom_subdir_spool_rpw>nom_subdir_spool_rpw</nom_subdir_spool_rpw>
<cod_dialet>cod_dialet</cod_dialet>
<log_usuar_wap>true</log_usuar_wap>
<cod_e_mail_celular>cod_e_mail_celular</cod_e_mail_celular>
<log_usuar_atlzdo_ged>true</log_usuar_atlzdo_ged>
<log_ativ_multi_idiom>true</log_ativ_multi_idiom>
<idi_tip_login>0</idi_tip_login>
<idi_dtsul>1122</idi_dtsul>
<idi_dtsul_instan>0</idi_dtsul_instan>
<cod_senha_framework>cod_senha_framework</cod_senha_framework>
<log_trace>false</log_trace>
<num_dia_cont_modul_dtsul>0</num_dia_cont_modul_dtsul>
<ind_tip_aces_usuar>Comum</ind_tip_aces_usuar>
<log_full_determ>false</log_full_determ>
<log_solic_impres>false</log_solic_impres>
<des_login_inform>des_login_inform</des_login_inform>
</RowObjectbofn017Row>
</RowObjectbofn017>
</BusinessContent>
</BusinessMessage>
</TOTVSMessage> |
O respectivo retorno desta mensagem conterá os dados recebidos na mensagem original, com as devidas atualizações. Estes dados serão enviados na tag <XMLContent>, subordinada à tag <ReturnContent> (vide exemplo a seguir).
Bloco de código | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8" ?>
<TOTVSMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xmlschema/general/totvsmsg.xsd">
<MessageInformation version="12.1.1">
<UUID>af468991-b5c7-8d82-0d14-1a304c481181</UUID>
<Type>Response</Type>
<Transaction>datasul/fnbo.bofn017</Transaction>
<StandardVersion>1.0</StandardVersion>
<SourceApplication>jvd001651</SourceApplication>
<CompanyId/>
<Product name="Datasul" version="11.5.X"/>
<GeneratedOn>2016-04-06T16:36:46.238-03:00</GeneratedOn>
</MessageInformation>
<ResponseMessage>
<ReceivedMessage>
<SentBy>Protheus-SoapUI</SentBy>
<UUID>Fnbobofn-0170-0001-0000-000000001450</UUID>
</ReceivedMessage>
<ProcessingInformation>
<ProcessedOn>2016-04-06T16:36:46.238-03:00</ProcessedOn>
<Status>OK</Status>
</ProcessingInformation>
<ReturnContent>
<XMLContent>
<RowObjectbofn017 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RowObjectbofn017Row>
<cod_usuario>test889</cod_usuario>
<nom_usuario>Usuário de teste #306</nom_usuario>
<cod_senha>cod_senha</cod_senha>
<cod_idiom_orig>por</cod_idiom_orig>
<ind_tip_usuar>Comum</ind_tip_usuar>
<num_pessoa>0</num_pessoa>
<nom_dir_spool>nom_dir_spool</nom_dir_spool>
<nom_subdir_spool>nom_subdir_spool</nom_subdir_spool>
<cod_servid_exec>cod_servid_exec</cod_servid_exec>
<cod_e_mail_local>cod_e_mail_local</cod_e_mail_local>
<dat_ult_erro_tentat_aces>2001-01-01</dat_ult_erro_tentat_aces>
<hra_ult_erro_tentat_aces>000000</hra_ult_erro_tentat_aces>
<qtd_erro_tentat_aces>0.0</qtd_erro_tentat_aces>
<log_servid_exec_obrig>true</log_servid_exec_obrig>
<dat_inic_valid>2001-01-01</dat_inic_valid>
<dat_fim_valid>2001-01-01</dat_fim_valid>
<dat_valid_senha>2001-01-01</dat_valid_senha>
<num_dias_valid_senha>0</num_dias_valid_senha>
<log_segur_uhr_atlzdo>true</log_segur_uhr_atlzdo>
<cod_livre_1>cod_livre_1</cod_livre_1>
<cod_livre_2>cod_livre_2</cod_livre_2>
<val_livre_1>0.0</val_livre_1>
<val_livre_2>0.0</val_livre_2>
<num_livre_1>0</num_livre_1>
<num_livre_2>0</num_livre_2>
<log_livre_1>true</log_livre_1>
<log_livre_2>true</log_livre_2>
<dat_livre_1>2001-01-01</dat_livre_1>
<dat_livre_2>2001-01-01</dat_livre_2>
<des_checksum>des_checksum</des_checksum>
<num_perf_usuar>0</num_perf_usuar>
<des_cod_perf_usuar>des_cod_perf_usuar</des_cod_perf_usuar>
<log_mostra_framework>true</log_mostra_framework>
<nom_subdir_spool_rpw>nom_subdir_spool_rpw</nom_subdir_spool_rpw>
<cod_dialet>cod_dialet</cod_dialet>
<log_usuar_wap>true</log_usuar_wap>
<cod_e_mail_celular>cod_e_mail_celular</cod_e_mail_celular>
<log_usuar_atlzdo_ged>true</log_usuar_atlzdo_ged>
<log_ativ_multi_idiom>true</log_ativ_multi_idiom>
<idi_tip_login>0</idi_tip_login>
<idi_dtsul>211</idi_dtsul>
<idi_dtsul_instan>0</idi_dtsul_instan>
<cod_senha_framework>cod_senha_framework</cod_senha_framework>
<log_trace>false</log_trace>
<num_dia_cont_modul_dtsul>0</num_dia_cont_modul_dtsul>
<ind_tip_aces_usuar>Interno</ind_tip_aces_usuar>
<log_full_determ>false</log_full_determ>
<log_solic_impres>false</log_solic_impres>
<des_login_inform>des_login_inform</des_login_inform>
<r-Rowid>AAAAAAALlMg=</r-Rowid>
</RowObjectbofn017Row>
</RowObjectbofn017>
</XMLContent>
</ReturnContent>
</ResponseMessage>
</TOTVSMessage> |
Para mensagens enviadas requisitando a execução de serviços (APIs), a estrutura básica se mantem, havendo diferenças no tipo de mensagem, que será uma BusinessRequest, e na tag <BusinessContent>. Veja exemplo:
Bloco de código | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?>
<TOTVSMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xmlschema/general/totvsmsg.xsd">
<MessageInformation version="1.000">
<UUID>btapi930-za00-0001-0000-000000001357</UUID>
<Type>BusinessMessage</Type>
<Transaction>Datasul/btb.btapi930za.getProfile</Transaction>
<StandardVersion>1.0</StandardVersion>
<SourceApplication>Protheus-SoapUI</SourceApplication>
<Product name="SoapUI" version="12.1.1"/>
<GeneratedOn>2016-04-06T16:36:46</GeneratedOn>
<DeliveryType>Sync</DeliveryType>
</MessageInformation>
<BusinessMessage>
<BusinessRequest>
<Operation>Datasul/btb.btapi930za.getProfile</Operation>
</BusinessRequest>
<BusinessContent>
<btapi930za_getProfile_in>
<QP_userCode>adm</QP_userCode>
<QP_pageId>integration</QP_pageId>
<QP_dataCode>ecm</QP_dataCode>
</btapi930za_getProfile_in>
</BusinessContent>
</BusinessMessage>
</TOTVSMessage> |
A mensagem de retorno (ResponseMessage) conterá, na tag <XMLContent>, os dados gerados pela execução do objeto de negócio.
Bloco de código | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8" ?>
<TOTVSMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xmlschema/general/totvsmsg.xsd">
<MessageInformation version="1.000">
<UUID>af468991-b5c7-8d82-0d14-1a30dc76389b</UUID>
<Type>Response</Type>
<Transaction>datasul/btb.btapi930za.getprofile</Transaction>
<StandardVersion>1.0</StandardVersion>
<SourceApplication>jvd001651</SourceApplication>
<CompanyId/>
<Product name="Datasul" version="11.5.X"/>
<GeneratedOn>2016-04-06T16:36:48.417-03:00</GeneratedOn>
</MessageInformation>
<ResponseMessage>
<ReceivedMessage>
<SentBy>Protheus-SoapUI</SentBy>
<UUID>btapi930-za00-0001-0000-000000001357</UUID>
</ReceivedMessage>
<ProcessingInformation>
<ProcessedOn>2016-04-06T16:36:48.417-03:00</ProcessedOn>
<Status>OK</Status>
</ProcessingInformation>
<ReturnContent>
<XMLContent>
<btapi930za_getProfile_out>
<ttProfile xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ttProfileRow>
<pageId>integration</pageId>
<dataCode>ecm</dataCode>
<dataValue>7c93b71451fcdd0515fde8883d856d5b</dataValue>
</ttProfileRow>
</ttProfile>
<RowErrors xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</btapi930za_getProfile_out>
</XMLContent>
</ReturnContent>
</ResponseMessage>
</TOTVSMessage> |
Identificação das transações de Mensageria TOTVS
Ao receber uma mensagem, o Engine de EAI do Datasul precisa determinar se a transação é do padrão de Mensagem Única TOTVS, ou de Mensageria TOTVS. Isso é feito verificando a forma de registro da transação, conforme descrito na especificação do serviço getSchema.
Transformação de modelos de dados
A transformação de modelos de dados de outros produtos para o modelo Datasul será realizada no objeto de negócio, através de função específica.
<Regra de negócio é o que define a forma de fazer o negócio, o processo definido e/ou as regras que devem ser contempladas. Devem ser descritas restrições, validações, condições e exceções do processo. Caso necessário, incluir neste capítulo também regras de integridade que devem ser observadas no momento do desenvolvimento>.
<Na tabela abaixo informe quais são as rotinas envolvidas, o tipo de operação, a opção de menu e se necessário uma breve descrição das regras de negócio relacionadas a rotina>.
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
[ACAA040 – Parâmetros] | [Alteração] | [Atualizações -> Acadêmico-> Tesouraria] | - |
[ACAA050 – Negociação Financeira] | [Envolvida] | [Atualizações -> Acadêmico-> Tesouraria] | - |
[ACAA060 – Cadastro de Pedidos] | [Criação] | [Atualizações -> Acadêmico-> Cadastros] | - |
Exemplo de Aplicação:
- Criar o campo “% Mínimo Espécie” (AAA_PERESP) onde o usuário informará o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação.
- Criar o campo “Referência Mínima para Cálculo” (AAA_REFCAL) onde o usuário informará um dos 4 valores disponíveis para pagamento das mensalidades como a referência mínima para calcular o débito total do aluno.
- Criar o parâmetro MV_ACPARNE que definirá se as informações de “% Mínimo Espécie” e “Referência Mínima para Cálculo” serão obrigatórias.
- O parâmetro MV_ACPARNE deve ter as seguintes opções: 1=Obrigatório e 2=Opcional. Deve ser inicializado como opcional>.
Tabelas Utilizadas
- SE2 – Cadastro de Contas a Pagar
- FI9 – Controle de Emissão de DARF>.
Opcional
Protótipo de Tela
<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.
Protótipo 01
Opcional
Fluxo do Processo
<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>.
Opcional
Dicionário de Dados
Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/
Índice | Chave |
01 | <FI9_FILIAL+FI9_IDDARF+FI9_STATUS> |
02 | <FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_EMISS+FI9_IDDARF> |
03 | <FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_PREFIX+FI9_NUM+FI9_PARCEL+FI9_TIPO> |
Campo | <AAA_PERESP> |
Tipo | <N> |
Tamanho | <6> |
Valor Inicial | <Varia de acordo com o tipo informado. Por exemplo, quando o campo “tipo” for date, neste campo pode ser informado uma data>. |
Mandatório | Sim ( ) Não ( ) |
Descrição | <Referência Mínima para Cálculo> |
Título | <Ref.Calc.> |
Picture | <@E999.99> |
Help de Campo | <Informar o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação> |
(Opcional)
Grupo de Perguntas
<Informações utilizadas na linha Protheus>.
Nome: FINSRF2
X1_ORDEM | 01 |
X1_PERGUNT | Emissão De |
X1_TIPO | D |
X1_TAMANHO | 8 |
X1_GSC | G |
X1_VAR01 | MV_PAR01 |
X1_DEF01 | Comum |
X1_CNT01 | '01/01/08' |
X1_HELP | Data inicial do intervalo de emissões das guias de DARF a serem consideradas na seleção dos dados para o relatório |
(Opcional)
Consulta Padrão
<Informações utilizadas na linha Protheus>
Consulta: AMB
Descrição | Configurações de Planejamento |
Tipo | Consulta Padrão |
Tabela | “AMB” |
Índice | “Código” |
Campo | “Código”; ”Descrição” |
Retorno | AMB->AMB_CODIGO |
(Opcional)
Estrutura de Menu
<Informações utilizadas na linha Datasul>.
Procedimentos
Procedimento |
|
|
|
Descrição | (Max 40 posições) | (Max 40 posições) | (Max 40 posições) |
Módulo |
|
|
|
Programa base |
|
|
|
Nome Menu | (Max 32 posições) | (Max 32 posições) | (Max 32 posições) |
Interface | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex |
Registro padrão | Sim | Sim | Sim |
Visualiza Menu | Sim/Não | Sim/Não | Sim/Não |
Release de Liberação |
|
|
|
Programas
Programa |
|
|
|
Descrição | (Max 40 posições) | (Max 40 posições) | (Max 40 posições) |
Nome Externo |
|
|
|
Nome Menu/Programa | (Max 32 posições) | (Max 32 posições) | (Max 32 posições) |
Nome Verbalizado[1] | (Max 254 posições) | (Max 254 posições) | (Max 254 posições) |
Procedimento |
|
|
|
Template | (Verificar lista de opções no man01211) | (Verificar lista de opções no man01211) | (Verificar lista de opções no man01211) |
Tipo[2] | Consulta/Manutenção/ Relatório/Tarefas | Consulta/Manutenção/ Relatório/Tarefas | Consulta/Manutenção/ Relatório/Tarefas |
Interface | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex |
Categoria[3] |
|
|
|
Executa via RPC | Sim/Não | Sim/Não | Sim/Não |
Registro padrão | Sim | Sim | Sim |
Outro Produto | Não | Não | Não |
Visualiza Menu | Sim/Não | Sim/Não | Sim/Não |
Query on-line | Sim/Não | Sim/Não | Sim/Não |
Log Exec. | Sim/Não | Sim/Não | Sim/Não |
Rotina (EMS) |
|
|
|
Sub-Rotina (EMS) |
|
|
|
Localização dentro da Sub Rotina (EMS) |
|
|
|
Compact[4] | Sim/Não | Sim/Não | Sim/Não |
Home[5] | Sim/Não | Sim/Não | Sim/Não |
Posição do Portlet[6] | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right |
Informar os papeis com os quais o programa deve ser vinculado |
|
|
|
Cadastro de Papéis
<O cadastro de papéis é obrigatório para os projetos de desenvolvimento FLEX a partir do Datasul 10>.
<Lembrete: o nome dos papeis em inglês descrito neste ponto do documento, devem ser homologados pela equipe de tradução>.
Código Papel | (máx 3 posições) |
Descrição em Português* |
|
Descrição em Inglês* |
|
[1] Nome Verbalizado é obrigatório para desenvolvimentos no Datasul 10 em diante.
[2] Tipo é obrigatório para desenvolvimento no Datasul 10 em diante
[3] Categorias são obrigatórias para os programas FLEX.
[4] Obrigatório quando o projeto for FLEX
[5] Obrigatório quando o projeto for FLEX
[6] Obrigatório quando o projeto for FLEX
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|