Ferramenta para exportar, documentar e gerar updates de atualizao de dicionrios.

A ferramenta ExporDic tem com objetivo agilizar o processo de documentao das customizaes
de dicionrios e atualizao das mesmas em dicionrios e bases de nossos clientes.
Basicamente o ExporDic l os dicionrios de um ambiente procurando pelas opes selecionadas,
separa esses registros de dicionrios em novas tabelas (CTREE ou DBF), pode gerar um documento
do MS-Word sobre eles e tambm um fonte de update em AdvPL para a atualizao dos dicionrios
e base.
Para utilizao temos basicamente 2 passos:
Gerao das atualizaes
Aplicao do update em base


Gerao das atualizaes

A ferramenta pode ser includa em algum menu do sistema Microsiga Protheus ou pode ser
chamada diretamente da tela de splash do SmartClient, desta forma:




Tela Principal



Onde:

Seleo de
Tabelas
Marca/Desmarca manualmente quais as tabelas que sero analisadas
para gerao das customizaes do dicionrio. Ex SA1
Obs.: Clicando no cabealho da primeira coluna so marcados ou
desmarcados todos.
Tabelas
Marcadas
Nesta janela so mostradas quais as tabelas que esto marcadas
para analise
Seleo do
Diretrio de
Destino
o diretrio onde sero gravados os dicionrios customizados
gerados e/ou o programa fonte de update e DER.
Sufixo
o sufixo que ser colocado nos dicionrios gerados. Por exemplo,
se o sufixo dor FST os dicionrios gerados sero: sixfst.dbf,
sx2fst.dbf, sx3fst.dbf, etc.
Seleo de
Dicionrios
Define quais os dicionrios que sero ou no gerados e/ou
documentados.
Obs.: Clicando no cabealho da primeira coluna so marcados ou
desmarcados todos. Clicando no cabealho da coluna Dicionrios,
so marcados SX2, SX3, SIX, SX7, SXA, SXB, SX9 e se houver XXA
Marcao
usando
mascaras
Pode-se marcar/desmarcar vrias tabelas de uma vez utilizando-se
mscaras, por exemplo, se quisermos marcar todas as tabelas SA?,
basta digitar SA? e teclar Marcar e todas as tabelas SA? sero
marcadas. O mesmo vale para Desmarcar. A opo Lista
permite a marcao atravs de uma lista de tabelas.
Pesquisa tabela Executa a pesquisa de uma tabela na janela de seleo de tabelas
Gerar
Dicionrios
Seleciona se sero gerados ou no arquivos com os dicionrios da
tabelas selecionadas.
Gerar D.ER.
Seleciona se ser gerado ou no o diagrama de entidade
relacionamento com as customizaes dos dicionrios das tabelas
selecionada
Gerar Update
Seleciona se ser gerado ou no o fonte de update com as
customizaes dos dicionrios das tabelas selecionadas.
Obs. Aps sua gerao o ideal que se faa a reviso do fonte e
pode-se alter-lo conforme a necessidade do projeto tirando-se ou
acrescentando-se itens.
Gerar
Documentao
Seleciona se ser gerada ou no a documentao dos dicionrios das
tabelas selecionadas.
Help de Campos
Seleciona se ser ou no adicionado ao fonte de update gerado, os
helps dos campos. preciso que a opo Gerar Update esteja
selecionada.
Fonte Update Nome com o qual ser gerado o fonte de update
Visualizar
Pode-se visualizar o fonte de update gerado atravs deste boto, ele
acionar o programa associado no sistema operacional para editar
arquivos (se houver). Como feita uma cpia do fonte para a
maquina local para se efetuar a visualizao, as alteraes feitas
no tero efeito.
E-mail
Pode-se enviar o fonte de update gerado atravs deste do Outlook,
como um anexo. Ao acionar o boto ser aberta a tela de envio de
e-mail do Outlook j com o fonte como anexo, essa funcionalidade
s funciona com o Outlook, no funciona com o Outlook Express.
Driver de
gerao
Seleciona se os dicionrios gerados sero em DBF ou CTREE
Gerar Gera as opes selecionadas


Seleo de Campos



Onde:

Seleo de
campos
Lista dos campos selecionados
Selecione os campos das tabelas a serem considerados. Ter efeito para
SX3 e SX7.
Digite 1 campo por linha ou separados por ESPAO ou por PONTO-E-
VRGULA
Considerar
apenas os
campos da
seleo
Se a opo CONSIDERAR APENAS OS CAMPOS DA SELEO estiver
marcada, apenas os campos da lista sero gerados e as para tabelas
selecionadas que no tenham campos na lista no ser gerado nenhum
campo.
Se a opo no estiver marcada, para as tabelas sem campos na lista
sero gerados todos os campos e para as que tenham campos na lista,
apenas os campos informados sero gerados.
Tabelas
para
importar
campos
Digite a tabela(s) para importar a lista de campos. Pode-se selecionar
uma ou mais tabelas.
Ex. SA1 ou SA1;SA2;SA3


1 Tela de opes



Onde:

Para tabelas
do Padro
Normalmente gerado somente o que foi customizado de cada
dicionrio. Desmarcando estas opes sero geradas todas as
informaes dos dicionrios, por exemplo, suponhamos que a tabela
marcada a SA1, da forma normal no SX3 gerado s constar os
campos customizados, se desmarcamos a opo correspondente ao SX3
nesta janela, todos os campos do SA1 sero exportados, inclusive para
o update. Isso pode ser til se quisermos gerar uma atualizao de
estrutura de uma tabela.
Obs.: Clicando no cabealho da primeira coluna so marcados ou
desmarcados todos.
Tabelas do
SX5 para
gerao
Informe quais as tabelas do SX5 sero utilizadas para a gerao e/ou
documentao
Parmetros
para
gerao
Informe quais os parmetros do sistema (SX6) sero utilizadas para a
gerao e/ou documentao
Grupo de
perguntas
SX1 para
exportao
Informe quais os grupos de perguntas (SX1) sero utilizadas para a
gerao e/ou documentao


2 Tela de opes



Onde:


Diagrama de Entidade e Relacionamento
Nome Nome para o arquivo de D.E.R. gerado
Visualizar Visualiza o arquivo de D.E.R. gerado
Seleo dolayout doD.E.R.
Seleciona o layout:
Diagrama: Lista na forma de um diagrama visual
Documento Word: Lista em um documento do MS-
Word
Qtd.Colunas
Se o layout for Diagrama, define quantas colunas ele
ter
Todos oscampos
Se marcado lista todos os campos da tabela, se no
sero listados as apenas os campos de relacionamento
Listar ocontradomnio
Se o layout for Documento Word, lista ou no
contradomnio

Opes gerais de gerao
Campos com ValidUser
Se esta opo for selecionada os campos, mesmo que
do padro, com um validuser preenchido tambm sero
gerados
Campos reservados
Se esta opo for selecionada, os campos reservados
como xxx_USERLGA, xxx_USERLGI, xxx_MSEXP, etc.
tambm sero gerados
SXB relacionados aos
campos
Quando se exporta uma tabela, pode-se ou no exportar
as consultas padro relacionadas seus campos

Opes para gerao do update
Update para TMS
Gera o fonte de update apenas com os arrays de dados,
esta uma opo utilizada geralmente pelo mdulo TMS
Update sem comentrios Gera ou no os comentrios no fonte de update
Update com pergunta de
sobrescrever
No update gerada ser feita uma pergunta quando o
dado j existir no dicionrio. Apenas para SX3, SX6, SXB
Update SX3 s para novos
No update no far atualizao de campos que j
existam, apenas criar os campos novos.
Update SX6 s para novos
No update no far atualizao de parmetros que j
existam, apenas criar os parmetros novos.
Update SX7 s para novos
No update no far atualizao de gatilhos que j
existam, apenas criar os gatilhos novos.
Gerar update com CH Gera ou no o update com um include de traduo CH
Default para update SX3
com .T.
O update para o dicionrio de campos SX3, tem um
tratamento para quando o campo existe no dicionrio
destino e para quando no existe. Quando no existe
so preenchidos todos os dados do SX3, quando existe
apenas os dados que esto com .T. no update so
atulizados.
Este parmetro para definir se o default a ser gerado
no update .T. ou .F.
Gerar update com
X3_VLDUSER
Define se gera ou no a atualizao do dado
X3_VLDUSER quando o campo j existe no dicionrio
destino.
Gerar update com
X3_OBRIGAT
Define se gera ou no a atualizao do dado
X3_OBRIGAT quando o campo j existe no dicionrio
destino.
Gerar update com
X3_WHEN
Define se gera ou no a atualizao do dado X3_WHEN
quando o campo j existe no dicionrio destino.

Documentao
Seleo do modelo Word
de Dodumentao
Diretrio onde se encontra o arquivo de modelo do MS-
Word para documentao
Seleo do layout de
documentao
A documentao ser gerada pelo modelo do MS-Word,
no modelo do uso dos processos CMMi, SAS70 ou do
Boletim Tcnico , esta opo serve para escolher qual
layout utilizar.


Exemplo de documentao gerada




Exemplo de D.E.R. gerado




Aplicao do update em base

No processo anterior o ExporDic gerou os arquivos com as customizaes e/ou novas tabelas
criadas e alteradas que podem, conforme o caso serem appendadas diretamente nos dicionrios
do cliente, e gerou tambm um fonte em AdvPL para update.
A atualizao da base com este update pode ser feita de duas formas: compilando-se o fonte no
ambiente que se deseja ou compilando-se o fonte numa base local gerando-se apenas o patch
deste fonte para aplicao em outro ambiente.
Em ambos os casos as telas da aplicao sero as apresentadas a seguir, o update deve ser
executado diretamente da tela de splash do remote:



apresentada uma tela inicial sobre o update.



A seguir apresentada uma tela para a seleo de quais empresas sero aplicadas o update.



Onde:

Todos Marca / Desmarca todas as empresas
Empresa
Marcar /
Desmarcar
Faz a marcao ou desmarcao por mscaras conforme a seleo.
Inverter
Inverte marcados e desmarcados

Aps a confirmao ser aplicado o update nas empresas selecionadas.



Aps a execuo do update apresentado um tela com as incluses e alteraes do update.




Tratamento diferenciado para o update do Dicionrio de Campos (SX3)

A partir da verso 4.19.8k do ExporDic, na atualizao do Dicionrio de Campos (SX3) o vetor que
contm os dados serem atualizados, ser um vetor bi-dimensional, onde:
O primeiro elemento o dado a ser atualizado propriamente dito
O segundo elemento um booleno (.T. / .F.) que determina se aquele dado ser atualizado
quando existir o campo ou no.
No momento da atualizao do Dicionrio de Campos (SX3), o update verifica se aquele campo j
existe, no existindo o campo, ele criado e todos os dados so gravados, existindo o campo,
apenas os dados que esto com o segundo elemento do vetor com .T. sero atualizados.
Com isso pode-se gerar um update mais preciso e seguro onde apenas dados pontuais sero
atualizados quando o campo j existir.
Se a opo "Update SX3 apenas para novos registros" estiver selecionada, o update gerado
na forma normal com o vetor de apenas uma dimenso, pois sempre sero gravados todos os
dados, j que o campo no existe.
A opo "Default para update SX3 como .T." define se, por default, o contedo do segundo
elemeto ser .T. ou .F., para que depois se faa os ajustes manuais para cada dado, se necessrio.


Importante:
O fonte de update gerado deve ser revisado e pode ser alterado conforme a necessidade do
projeto tirando-se ou acrescentando-se itens.
O update para o dicionrio de campos SX3, tem um tratamento para quando o campo
existe no dicionrio destino e para quando no existe. Quando no existe so preenchidos
todos os dados do SX3, quando existe apenas os dados que esto com .T. no update so
atulizados.
O update no faz excluses de nenhum tipo.


Leia mais: http://www.ernaniforastieri.com/products/expordic/