Relações de documentação
A função de gestão das relações de documentaçãopermite associar, a um dado documento, das relações versus os elementos do dicionário Estes elementos são utilizados, em completando as informações encontradas no dicionário, para gerar automaticamente dos parágrafos e seu conteúdo, nomeadamente nas secções pré-requeridas e as secções anexas finais.
Relações segundo os tipos de documentação
A lista das relações existentes e a maneira donde elas são utilizadas segundo o tipo de documentação, é dado no seguinte. Encontramos nestes quadros uma coluna Compl.
Esta coluna define, quando ela está a Sim, que as relações descritas pelo código vêm em complemento das relações encontradas no dicionário. Assim, quando se gera uma documentação funcional, as janelas, as tabelas, objectos que lhe estão associadas são analizadas para reencontrar os códigos associados, mas é possível que um código de actividade não directamente religado à função influi sobre o seu funcionamento. Acrescentar-se-á então este código actividade via uma relação.
Quando a coluna Compl está a Não, nenhuma outra informação do dicionário não permite de definir a relação em questão. É então obrigatório de preencher este tipo de relação se se pretende que esta informação figura na documentação gerada. Falta notar que em certos casos (tabelas diversas, menus locais), poder-se-á reencontrar as relações deste tipo, mas de maneira pouco fiável (não nos interessa neste caso que tabelas diversas e os menus locais cuja parametrização é um pré-requisito da função).
Funções
As documentações das funções (códigos AFC) podem ser enriquecidos pelas relações do quadro seguinte.
Ligação | Significado | Utilização no momento da geração de documentação | Compl |
ACV | Códigos de actividade | Lista dos códigos actividades afectadas nos pré-requisitos. | Sim |
ADP | Parâmetro | Parâmetros afectados nos pré-requisitos. | Não |
ANM | Contadores | Lista dos contadores associados à função nos pré-requisitos. | Não |
GAU | Documentos automáticos | Lista dos documentos automáticos associados à função nos pré-requisitos. | Não |
CDE | Códigos secção | Lista dos contadores secção associados à função nos pré-requisitos. | Não |
TRS | Transacções | Lista das funções permitindo de definir as transacções para a função documentada. | Não |
ADI | Tabelas diversas | Lista das tabelas diversas nos pré-requisitos função. | Não |
AML | Menus locais | Lista dos menus locais a parametrizar nos pré-requisitos. | Não |
ARP | Listas | Estados lançados depois a função. | Sim |
ABT | Tarefa batch | Anexo das tarefas batch permitindo de lançar a função. | Sim |
ATB | Tabelas | Tabelas colocadas em marcha na função | Sim |
Observação : A pesquisa dos códigos actividades a partir das funções no dicionário é muito exaustiva, e é susceptível reenviar certos códigos actividades cuja presença não foi forçosamente desejada. Para etapa de comportamento, é suficiente criar uma relação versus o código de actividade FAL (sempre falso). Desde logo que uma relação deste tipo está inserido, apenas os outros códigos actividades presentes na lista das ligações são reenviadas.
Parâmetros
As documentrações das funções (códigos ADP) podem ser enriquecidos pelas relações do quadro seguinte.
Ligação | Significado | Utilização no momento da geração de documentação | Compl |
AFC | Função | Lista das funções afectadas na ajuda descrevendo o parâmetro. | Não |
ACV | Códigos de actividade | Lista dos códigos actividades associadas. | Sim |
AOE | Modelo de importação/exportação | Lista dos modelos de importação exportação este parâmetro. Esta relação utiliza que de maneira recíproca (para obter os parâmetros associados aos modelos na documentação em questão). | Não |
AT2 | Tabelas pré-requisitos | Lista das tabelas a preencher nos pré-requisitos. | Não |
Variável de dimensionamento
As documentações das funções (códigos ADM) podem ser enriquecidos pelas relações do quadro seguinte.
Ligação | Significado | Utilização no momento da geração de documentação | Compl |
ATB | Tabelas dimensionadas | Lista das tabelas dimensionadas pela variável. | Sim |
Modelo de importação/exportação
As documentações dos modelos de importação/exportação (códigos AOE) podem ser enriquecidos pelas relações do quadro seguinte.
Ligação | Significado | Utilização no momento da geração de documentação | Compl |
ADP | Parâmetros afectados | Lista dos parâmetros influindo o funcionamento do modelo. De referir que as relações recíprocas são também percorridos. | Não |
AT2 | Tabelas pré-requisitos | Lista das tabelas mencionadas nos pré-requisitos de utilização. | Não |
ATB | Tabelas actualizadas | Lista das tabelas actualizadas | Sim |
Listas
As documentações dos modelos de listas (códigos ARP) podem ser enriquecidos pelas relações do quadro seguinte.
Ligação | Significado | Utilização no momento da geração de documentação | Compl |
ATB | Tabelas editadas | Lista das tabelas cujo conteúdo alimenta a lista | Sim |
Eventos de workflow
As documentrações dos eventos de workflow (códigos AWA) podem ser enriquecidos pelas relações do quadro seguinte.
Ligação | Significado | Utilização no momento da geração de documentação | Compl |
ATB | Tabelas do contexto | Lista das tabelas cujo conteúdo faz parte do contexto de desencadeamento. | Sim |
Acções
As documentrações das acções (códigos ACT) podem ser enriquecidos pelas relações do quadro seguinte.
Ligação | Significado | Utilização no momento da geração de documentação | Compl |
ACT | Acções ligadas | Acções relacionadas com a precedente | Sim |
Desencadeadores estatísticos
As documentações dos desencadeadores estatísticos (códigos PS1) podem ser enriquecidas pelas relações do quadro seguinte.
Ligação | Significado | Utilização no momento da geração de documentação | Compl |
ATB | Tabelas | Tabelas colocadas em obra no contexto de desencadeamento | Sim |
Caso particular dos pontos de entrada
Os pontos de entrada se apoiam de maneira um pouco particular sobre as relações. Com efeito :
- O elemento do dicionário que está documentado e o tratamento no dicionário dos tratamentos
- cada ponto de entrada está definido por uma relação versus o tipo APE, e o código associado é o nome do ponto de entrada. As relações que se seguem (até à próxima relação APE) caracterizando este ponto de entrada. Se as características comuns existem antes da primeira ligação APE, são supostas ser válidas por defeito para todos os pontos de entrada.
- As relações ATB e AT2 são utilizadas para definir as tabelas abertas (respectivamente com um conteúdo significativo ou não significativo)
- A relação TRS permite definir se existe uma transacção em curso (valor 2) ou não (valor 1)
- A relação TRA permite definir se existe uma transacção aberta (valor 2) ou não (valor 1)
Assim, se o quadro de relações seguinte:
| TRS | 1 |
| TRA | 2 |
| ATB | TABELA1 |
| AT2 | TABELA2 |
| APE | PONTO1 |
| ATB | TABELA3 |
| APE | PONTO2 |
| TRA | 1 |
| APE | PONTO3 |
| AT2 | TABELA4 |
O tratamento dispõe de 3 pontos de entrada PONTO1, PONTO2, PONTO3 :
- O PONTO1 não tem transacção aberta, gera um rasto, a tabela TABELA1 está em linha e significativa, a tabela TABELA2 está em linha sem ser significativo (valores por defeito), a TABELA3 está em linha e é significativa
- O ponto PONTO2 os mesmos valores por defeito, excepto que não tem rasto (a tabela TABELA3 não está em linha).
- O ponto PONTO3 tem os mesmos valores por defeito (um rasto está aberto). A tabela TABELA4 está aberta sem ser significativa.