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 | PROTHEUS | Módulo | Gestão Jurídica (SIGAJURI) |
Segmento Executor | Jurídico | ||
Projeto | M_JUR_JUR002 | IRM | PCREQ-9336 |
Requisito | PCREQ-9337 | Subtarefa |
|
País | ( x ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. | ||
Outros |
Objetivo
Este requisito tem como objetivo disponibilizar visões gerencias relacionadas ao módulo Gestão Jurídica (SIGAJURI) na plataforma Totvs Analytics (GoodData). Serão disponibilizadas informações referentes a pedidos judiciais, contingências e escritórios credenciados. Para a análise dos dados serão incluídos também nas informações a localidade dos assuntos jurídicos e a classificação dos assuntos.
Definição da Regra de Negócio
Baseado no perfil do nosso cliente, modelamos as principais informações para que gráficos e outros recursos visuais sejam criados para disponibilizar informações gerenciais diretamente da instalação padrão do módulo SIGAJURI.
Para que a integração com o Totvs Analytics aconteça com sucesso, é preciso criar os seguintes artefatos:
- Criação do fonte de modelagem (BIXModJur.prw) que define toda a estrutura que foi criada de dimensões e fatos. (Este fonte deve ser salvo no TFS, pasta BI-Extractor->Areas->Jurídico).
- Criação de um fonte para cada fato definido na modelagem, seguindo o padrão de nomenclatura (BIX<Fato>.prw). (Este fonte deve ser salvo no TFS, pasta BI-Extractor->Areas->Jurídico->fato),
- Criação de um fonte para cada dimensão definida na modelagel, seguindo o padrão de nomenclatura (BIX<Dimensão>.prw. (Este fonte deve ser salvo no TFS, pasta BI Extractor->dimensao).
- A equipe TOTVS BA irá sincronizar as informações com a interface do Totvs Analytics e a partir deste ponto, deveremos criar os gráficos e outros materiais visuais conforme detalhado mais abaixo e exposto no Protótipo 1..
Foram modeladas as seguintes dimensões e fatos relacionados abaixo:
Dimensões
Comarca
Dimensão que vai armazenar a descrição da comarca para ser utilizada na representação dos dados no GoodDate.
Prognóstico
Dimensão que vai armazenar a descrição do prognóstico, o tipo (Provável, Possível ou Remoto) e a porcentagem informada para realizar cálculos caso necessário nas visões do GoodData.
Credenciado
Dimensão que vai armazenar a razão social do escritório credenciado que atua nos assuntos jurídicos.
Motivo Encerramento
Dimensão que vai armazenar a descrição do motivo do encerramento que está vinculado aos assuntos jurídicos.
Pedidos Jurídico
Dimensão que vai armazenar o tipo e a descrição dos tipos de pedidos que são associados aos assuntos jurídicos.
Assunto Jurídico
Dimensão que vai armazenar a descrição dos tipos de assuntos jurídicos que caracterizam os processos judiciais, procurações, itens de consultivo e demais assuntos controlados pelo módulo de Gestão Jurídica.
Área Jurídica
Dimensão que vai armazenar a descrição das áreas jurídicas que são associadas aos assuntos jurídicos cadastrados no módulo de Gestão Jurídica.
Fatos
Processos em andamento
Este fato vai armazenar a quantidade de processos abertos no mês atual, por tipo de assunto jurídico, área, comarca e credenciado. Este fato terá seus dados congelados a cada virada de mês.
Analise processos x pedidos
Este fato vai armazenar a quantidade de processos em aberto no mês atual por pedidos, tipo de assunto jurídico, comarca e credenciado. Este fato terá seus dados congelados a cada virada de mês.
Provisão consolidada
Este fato vai armazenar a moeda e o valor de provisão dos assuntos jurídicos em aberto do mês atual por tipo assunto jurídico, comarca, prognóstico e credenciado. Este fato terá seus dados congelados a cada virada de mês.
Processos Abertos e Encerrados
Este fato vai armazenar a quantidade de processos abertos e encerrados no mês atual por tipo de assunto jurídico, comarca e credenciado. Este fato terá seus dados congelados a cada virada de mês.
Benefício Econômico Jurídico
Este fato vai armazenar o valor de provisão, valor final do caso e valor envolvido dos assuntos jurídicos dos processos encerrados no mês atual, por tipo de assunto jurídico, comarca e credenciado.
Extratores
Os dados extraídos do ERP Microsiga Protheus através da função extratora BIExtractor, são transformados em informações e na sequência, armazenados em uma instância de banco de dados denominada Fluig Smart Data. Após este processo, os dados serão tratados por camadas subsequentes envolvendo as ferramentas IBM Cognos e GoodData.
Fatos
Cada tabela fato definida possui função própria de extração, padronizadas com o prefixo BIX. O nome completo da função é determinado com base no significado de negócio das informações para facilitar a compreensão e o desenvolvimento das mesmas. Além dos campos identificados para cada tabela fato, também são gerados valores para os campos:
Campo | Valor | Local |
LINPRO | Fixo “P “ – Protheus | Stage e DW |
ISTCIA | Fixo “01” – Sem conceito de instâncias | Stage e DW |
FILIAL | Filial da tabela tratada | Stage e DW |
INSTAL | Código de instalação multitenancy | DW |
Estes campos são utilizados para garantir características próprias para as informações de cada linha de produto TOTVS (Microsiga Protheus, Datasul, RM e Logix), além de serem utilizados para a composição da chave única de negócio e critérios de limpeza do banco de dados Data Warehouse.
Algumas tabelas fatos possuem a data de extração (DTEXTR). Esta data é preenchida automaticamente pelo mecanismo de extração, não sendo explicitada a atribuição na função extratora das fatos. Os campos de lookup para as dimensões Empresa (EMPRES), Estabelecimento (ESTABL) e Unidade de Negócio (UNDNEG), quando necessários na tabela fato, também são preenchidos automaticamente pelo mecanismo de extração.
As tabelas fatos realizam integridade referencial das informações das dimensões. Para cada atribuição de chave estrangeira de dimensão, deve-se executar a verificação da existência da chave na tabela origem das informações das dimensões. Caso não haja a correspondência de chave será atribuída à chave correspondente ao registro padrão existente em toda dimensão, identificado como “INDEFINIDO” . Este processo gera um log de execução dentro do diretório raiz de instalação do ERP Microsiga Protheus, estrutura definida para a área. Cada informação registrada nestes arquivos deve ser validada e, de acordo com a necessidade, corrigida para posterior nova extração para correção. O descritivo “INDEFINIDO” também é utilizado quando não há correspondência na linha de produto Microsiga Protheus, de um conceito importante para as demais linhas de produto envolvidas no TOTVS BA ou TOTVS Smart Analytics. Estes conceitos são identificados como “Ausente” na seção especificação física deste documento. Para maiores detalhes sobre os conceitos, consulte a documentação de dimensões ou glossário de indicadores disponibilizados ao final da especificação física de cada tabela fato.
A cada extração efetuada, as tabelas fatos da Fluig Smart Data envolvida são completamente limpas e todos os dados extraídos novamente. Quando há o sincronismo da Fluig Smart Data com o DW, os dados do DW são excluídos somente do período indicado para a extração das informações contidas no Stage Área. Este controle é realizado utilizando-se parâmetros de extração contidos nas tabelas HYR, HYQ, HYP, HYS e HYT. Exceções a esta regra são descritas nas funcionalidades de cada tabela fato.
As chaves estrangeiras que referenciam as dimensões nas tabelas fatos do banco de dados Fluig Smart Data são compostas pela linha de produto, instância, empresa e a chave única da tabela origem, separadas por pipes, coincidindo com as chaves de negócios (Business Key) geradas em cada umas das dimensões.
O relacionamento entre as áreas, fatos e dimensões, bem como principal fluxo de origem, é definido na função BIXModelagem, acionada internamente pela função BIExtractor. Este relacionamento deve ser atualizado na criação de novas funções extratoras.
A execução do extrator da área de Jurídico é realizada através da função BIExtractor, podendo ser utilizado o perfil de extração de usuário, disponibilizada para agendamento via Schedule do ERP Microsiga Protheus.
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
BIXModJur.prw | Criação | - | Fonte modelagem |
BIXProcAndamento.prw | Criação | - | Fonte fato |
BIXProcXPedido.prw | Criação | - | Fonte fato |
BIXProvisaoConsolidada.prw | Criação | - | Fonte fato |
BIXProcAbertxEncerra.prw | Criação | - | Fonte fato |
BIXBeneficioEcon.prw | Criação | - | Fonte fato |
BIXComarca.prw | Criação | - | Fonte dimensão |
BIXPrognostico.prw | Criação | - | Fonte dimensão |
BIXCorrespondente.prw | Criação | - | Fonte dimensão |
BIXMotivEncerramento.prw | Criação | - | Fonte dimensão |
BIXPedidosJuridico.prw | Criação | - | Fonte dimensão |
BIXAssuntoJuridico.prw | Criação | - | Fonte dimensão |
BIXAreasJuridico | Criação | - | Fonte dimensão |
Especificação Física.
Legenda | |
Fase 9 | Novo itens para atender o segmento Jurídico |
HYP - Processos em Andamento
Fato relacionado ao assunto jurídico, quantidade de processos que estão em andamento.
Descrição | Tabela Física | Fase |
Empresa | HJ4 | 1 |
Estabelecimento | HKK | 1 |
Unidade Negocio | HJ1 | 1 |
Assunto Jurídico | HYO | 9 |
Área Jurídica | HYJ | 9 |
Comarca | HYH | 9 |
Fornecedor (Credenciado) | HKJ | 1 |
Indicadores: Processos em Andamento | ||
Fluxo Principal de Origem: Cadastro de Assuntos Jurídicos | ||
Lookup de Dimensões | Origem | Fase |
Empresa – (HYP_EMPRES) | FWGrpCompany() +FWCompany() | 9 |
Estabelecimento – (HYP_ESTABL) | FWFilial() | 9 |
Assunto Jurídico – (HYP_ASSUNT) | NYB_COD | 9 |
Área Jurídica – (HYP_AREAJU) | NRB_COD | 9 |
Comarca – (HYP_COMARC) | NQ6_COD | 9 |
Credenciado - (HYP_CREDEN) | A2_COD+A2_LOJA, para registros onde o campo A2_MJURIDI = '1' | 9 |
Indicadores | Origem | Fase |
Data de Extração – (HYP_DTEXTR) | Data da extração | 9 |
Quantidade de Processos – (HYP_QTDPRO) | Quantidade de processos em andamento | 9 |
HYQ - Processos Abertos e Encerrados
Fato relacionado ao assunto jurídico, quantidade de processos abertos e encerrados no mês atual.
Descrição | Tabela Física | Fase |
Empresa | HJ4 | 1 |
Estabelecimento | HKK | 1 |
Unidade Negocio | HJ1 | 1 |
Assunto Jurídico | HYO | 9 |
Área Jurídica | HYJ | 9 |
Comarca | HYH | 9 |
Fornecedor (Credenciado) | HKJ | 1 |
Cliente | HJ7 | 1 |
Motivo de Encerramento | HYK | 9 |
Indicadores: Processos Abertos e Encerrados | ||
Fluxo Principal de Origem: Cadastro de Assuntos Jurídicos | ||
Lookup de Dimensões | Origem | Fase |
Empresa – (HYQ_EMPRES) | FWGrpCompany() +FWCompany() | 9 |
Estabelecimento – (HYQ_ESTABL) | FWFilial() | 9 |
Assunto Jurídico – (HYQ_ASSUNT) | NYB_COD | 9 |
Área Jurídica – (HYQ_AREAJU) | NRB_COD | 9 |
Comarca – (HYQ_COMARC) | NQ6_COD | 9 |
Credenciado - (HYQ_CREDEN) | A2_COD+A2_LOJA, para registros onde o campo A2_MJURIDI = '1' | 9 |
Cliente - (HYQ_CLIENT) | A1_COD+A1_LOJA | 9 |
Motivo de Encerramento - (HYQ_MOTIVO) | NQI_COD | 9 |
Indicadores | Origem | Fase |
Data de Extração – (HYQ_DTEXTR) | Data da extração | 9 |
Quantidade Abertos – (HYQ_QTDABE) | Quantidade de processos em aberto | 9 |
Quantidade Encerrados – (HYQ_QTDENC) | Quantidade de processos encerrados | 9 |
HYR - Benefício Econômico Jurídico
Fato relacionado ao assunto jurídico, valor de provisão, valor final do caso e valor envolvido dos assuntos jurídicos dos processos encerrados no mês atual.
Descrição | Tabela Física | Fase |
Empresa | HJ4 | 1 |
Estabelecimento | HKK | 1 |
Unidade Negocio | HJ1 | 1 |
Assunto Jurídico | HYO | 9 |
Comarca | HYH | 9 |
Fornecedor (Credenciado) | HKJ | 1 |
Moeda | HJ6 | 1 |
Indicadores: Benefício Econômico Jurídico | ||
Fluxo Principal de Origem: Cadastro de Assuntos Jurídicos | ||
Lookup de Dimensões | Origem | Fase |
Empresa – (HYR_EMPRES) | FWGrpCompany() +FWCompany() | 9 |
Estabelecimento – (HYR_ESTABL) | FWFilial() | 9 |
Assunto Jurídico – (HYR_ASSUNT) | NYB_COD | 9 |
Comarca – (HYR_COMARC) | NQ6_COD | 9 |
Credenciado - (HYR_CREDEN) | A2_COD+A2_LOJA, para registros onde o campo A2_MJURIDI = '1' | 9 |
Moeda - (HYR_MOEDA) | Atribuída por meio da função BIXPdrMoeda([MoedaOrigem]), considerando parâmetro do Wizard. | 9 |
Indicadores | Origem | Fase |
Data de Extração – (HYR_DTEXTR) | Data da extração | 9 |
Moeda – (HYR_MOEDA) | Moeda dos valores do assunto | 9 |
Valor Provisão – (HYR_VLPROV) | Valor de provisão | 9 |
Valor final do caso – (HYR_VLFINC) | Valor final do caso | 9 |
Valor envolvido – (HYR_VLENVO) | Valor envolvido | 9 |
HYS - Análise Processos x Pedidos
Fato relacionado ao assunto jurídico, quantidade de processos em aberto no mês atual agrupados por pedidos.
Descrição | Tabela Física | Fase |
Empresa | HJ4 | 1 |
Estabelecimento | HKK | 1 |
Unidade Negocio | HJ1 | 1 |
Assunto Jurídico | HYO | 9 |
Comarca | HYH | 9 |
Fornecedor (Credenciado) | HKJ | 1 |
Área Jurídica | HYJ | 9 |
Pedido Jurídico | HYL | 9 |
Indicadores: Análise Processo x Pedidos | ||
Fluxo Principal de Origem: Cadastro de Assuntos Jurídicos | ||
Lookup de Dimensões | Origem | Fase |
Empresa – (HYS_EMPRES) | FWGrpCompany() +FWCompany() | 9 |
Estabelecimento – (HYS_ESTABL) | FWFilial() | 9 |
Assunto Jurídico – (HYS_ASSUNT) | NYB_COD | 9 |
Comarca – (HYS_COMARC) | NQ6_COD | 9 |
Credenciado - (HYS_CREDEN) | A2_COD+A2_LOJA, para registros onde o campo A2_MJURIDI = '1' | 9 |
Área Jurídica – (HYS_AREAJU) | NRB_COD | 9 |
Pedidos Jurídicos - (HYS_PEDJUR) | NSP_COD | 9 |
Indicadores | Origem | Fase |
Data de Extração – (HYS_DTEXTR) | Data da extração | 9 |
Quantidade de Processos x Pedidos – (HYS_QTDPPE) | Quantidade de processos agrupados por pedidos | 9 |
HYT - Provisão Consolidada
Fato relacionado ao assunto jurídico, valor de provisão dos assuntos jurídicos em aberto do mês atual..
Descrição | Tabela Física | Fase |
Empresa | HJ4 | 1 |
Estabelecimento | HKK | 1 |
Unidade Negocio | HJ1 | 1 |
Assunto Jurídico | HYO | 9 |
Comarca | HYH | 9 |
Fornecedor (Credenciado) | HKJ | 1 |
Prognóstico | HYI | 9 |
Moeda | HJ6 | 1 |
Indicadores: Provisão Consolidada | ||
Fluxo Principal de Origem: Cadastro de Assuntos Jurídicos | ||
Lookup de Dimensões | Origem | Fase |
Empresa – (HYT_EMPRES) | FWGrpCompany() +FWCompany() | 9 |
Estabelecimento – (HYT_ESTABL) | FWFilial() | 9 |
Assunto Jurídico – (HYT_ASSUNT) | NYB_COD | 9 |
Comarca – (HYT_COMARC) | NQ6_COD | 9 |
Credenciado - (HYT_CREDEN) | A2_COD+A2_LOJA, para registros onde o campo A2_MJURIDI = '1' | 9 |
Prognóstico – (HYT_PROGNO) | NQ7_COD | 9 |
Moeda - (HYT_MOEDA) | Atribuída por meio da função BIXPdrMoeda([MoedaOrigem]), considerando parâmetro do Wizard. | 9 |
Indicadores | Origem | Fase |
Data de Extração – (HYS_DTEXTR) | Data da extração | 9 |
Valor Provisão – (HYT_VLPROV) | Valor de provisão consolidada | 9 |
Dimensões
Cada tabela de dimensão definida possui função própria de extração, padronizadas com o prefixo BIX. O nome completo da função é determinado com base no significado de negócio das informações para facilitar a compreensão e o desenvolvimento das mesmas. Além dos campos identificados para cada tabela de dimensão, também são gerados valores para os campos:
Campo | Valor | Local |
LINPRO | Fixo “P “ – Protheus | Stage e DW |
ISTCIA | Fixo “01” – Sem conceito de instâncias | Stage e DW |
FILIAL | Filial da tabela tratada | Stage e DW |
GRPEMP | Grupo de Empresa | Stage e DW |
CDUNEG | Código Unidade de Negócio | Stage e DW |
CDEMPR | Código da Empresa | Stage e DW |
INSTAL | Código de instalação multitenancy | DW |
BKCODE | Código da Chave de Negócio, original gerado no Stage | DW |
Estes campos são utilizados para garantir características próprias para as informações de cada linha de produto TOTVS (Microsiga Protheus, Datasul, RM e Logix) além de manter características das origens da informação.
Todas as dimensões são criadas com um registro padrão identificado pela descrição “INDEFINIDO”. Este registro é utilizado para identificar conceitos do TOTVS BA e TOTVS Smart Analytics não pertencentes ao ERP Microsiga Protheus e para identificar chaves de dimensões não encontradas durante a verificação de integridade referencial realizada pelas tabelas fatos. Esta verificação de integridade é realizada utilizando a origem das informações das tabelas e dimensões do ERP Microsiga Protheus e não os dados já inseridos no Fluig Smart Data. Este processo gera um log de execução dentro do diretório raiz de instalação do ERP Microsiga Protheus, pasta LogBI. Cada informação registrada nestes arquivos deve ser validada e, de acordo com a necessidade, corrigida para posterior nova extração para correção.
Os campos das dimensões, identificados na especificação física por Business Key é uma composição dos campos Origem, responsáveis pela caracterização única dos registros, concatenados após os campos de Linha de Produto, Instância e Código da Empresa, separados por pipes (|).
O relacionamento entre as áreas, fatos e dimensões é definido na função BIXModelagem, acionada internamente pela função BIExtractor. Este relacionamento deve ser atualizado na criação de novas funções extratoras. Os campos das dimensões com origem na tabela SX5 são declarados na função BIXKeysSX5.
A execução do extrator da área Jurídica é realizada exclusivamente através da função BIExtractor, disponibilizada para agendamento via Schedule do ERP Microsiga Protheus.
Pré-Requisito:
- Execução do Wizard de Configuração dos parâmetros essenciais ao funcionamento da Fluig Smart Data.
Nomenclatura das tabelas de dimensão:
Dimensões:
HYH - Comarca - Visualizar as informações por circunscrição judiciária
HYI - Prognóstico- Visualizar as informações por prognóstico (provável desenvolvimento futuro ou o resultado de um processo)
HYJ - Área Jurídico - Visualizar as informações por área jurídica
HYK - Motivo de Encerramento - Visualizar as informações por motivos de encerramento
HYL - Pedido Jurídico - Visualizar as informações por pedido
HYO - Assunto Jurídico - Visualizar as informações por tipo de assunto jurídico
- Tabela de Dimensão HYH – Comarca (Função BIXComarca)
Visualiza as informações por circunscrição judiciária.
Dimensão: Comarca (HYH) | |||
Fase | Campos | Atributo Destino (Stage) | Origem |
09 | Business Key | HYH_COMARC | NQ6_FILIAL+NQ6_COD |
Código | HYH_CODIGO | NQ6_COD | |
Comarca | HYH_DESC | NQ6_DESC | |
UF | HYH_UF | NQ6_UF |
- Tabela de Dimensão HYI – Prognóstico (Função BIXPrognostico)
Visualiza as informações por prognóstico (provável desenvolvimento futuro ou o resultado de um processo).
Dimensão: Prognóstico (HYI) | |||
Fase | Campos | Atributo Destino (Stage) | Origem |
09 | Business Key | HYI_PROGNO | NQ7_FILIAL+NQ7_COD |
Código | HYI_CODIGO | NQ7_COD | |
Prognóstico | HYI_DESC | NQ7_DESC | |
Porcentagem | HYI_PORCEN | NQ7_PORCEN | |
Tipo | HYI_TIPO | NQ7_TIPO |
- Tabela de Dimensão HYJ – Área Jurídica (Função BIXAreasJuridico)
Visualiza as informações por área jurídica
Dimensão: Área Jurídica (HYJ) | |||
Fase | Campos | Atributo Destino (Stage) | Origem |
09 | Business Key | HYJ_AREAJU | NRB_FILIAL+NRB_COD |
Código | HYJ_CODIGO | NRB_COD | |
Descrição | HYJ_DESC | NRB_DESC |
- Tabela de Dimensão HYK – Motivo de Encerramento (Função BIXMotivEncerramento)
Visualiza as informações por motivos de encerramento
Dimensão: Motivo de Encerramento (HYK) | |||
Fase | Campos | Atributo Destino (Stage) | Origem |
09 | Business Key | HYK_MOTIVO | NQI_FILIAL+NQI_COD |
Código | HYK_CODIGO | NQI_COD | |
Motivo | HYK_DESC | NQI_DESC |
- Tabela de Dimensão HYL – Pedido Jurídico (Função BIXPedidosJuridico)
Visualiza as informações por pedido.
Dimensão: Pedido Jurídico (HYL) | |||
Fase | Campos | Atributo Destino (Stage) | Origem |
09 | Business Key | HYL_PEDJUR | NSP_FILIAL+NSP_COD |
Código | HYL_CODIGO | NSP_COD | |
Pedido | HYL_DESC | NSP_DESC | |
Tipo | HYL_TIPO | NSP_TIPO |
- Tabela de Dimensão HYO – Assunto Jurídico (Função BIXAssuntoJuridico)
Visualiza as informações por tipo de assunto jurídico
Dimensão: Assunto Jurídico (HYO) | |||
Fase | Campos | Atributo Destino (Stage) | Origem |
09 | Business Key | HYO_ASSUNT | NYB_FILIAL+NYB_COD |
Código | HYO_CODIGO | NYB_COD | |
Assunto Jurídico | HYO_DESC | NYB_DESC |
Alterações de dicionário
Será necessário criar dois índices na tabela de assuntos jurídicos (NSZ) para que sejam realizadas buscas através deles:
NSZ_FILIAL + NSZ_DTINCL
NSZ_FILIAL + NSZ_DTENCE
Tabelas Utilizadas
HYH – Comarca
- HYI – Prognóstico
- HKJ – Fornecedor (Credenciado)
- HYK – Motivo Encerramento
- HYL – Pedidos Jurídico
- HYO – Assunto Jurídico
- HYJ – Áreas Jurídicas
- HJ6 - Moeda
- HJ7 - Cliente
- HYP – Processos em andamento
- HYS – Ranking Processos x Pedidos
- HYT – Provisão consolidada
- HYQ – Processos abertos e encerrados
- HYR – Benefício Econômico Jurídico
Protótipo de Tela
Protótipo 01
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|