Documentação de jobs

Objective

After completing this lesson, you will be able to escrever comentários com descrições e anotações

Descrições e anotações

As descrições e anotações são uma forma conveniente de adicionar comentários a objetos e diagramas de área de trabalho.

Isso pode ser útil se você precisar compartilhar o design do projeto ou se só quiser ter uma ideia clara do que cada objeto está aqui e lhe dar um meio de verificar se alcançou seu objetivo.

Dependendo do que você está explicando e de onde deseja que a explicação apareça, você pode adicionar descrições ou anotações.

  • As descrições são vinculadas a um objeto específico e podem aparecer em diagramas onde o objeto é exibido, mas também na Biblioteca de objetos local.
  • Anotações são apenas notas autoadesivas independentes que só aparecem em diagramas.

Utilização de descrições com objetos

Uma descrição está associada a um determinado objeto. Você pode inseri-lo exibindo o diálogo de propriedades do objeto.

Ele será exibido na lista Biblioteca de objetos local.

Quando um objeto do repositório é importado e exportado, a descrição também é importada ou exportada.

Um designer de fluxo de dados determina quando mostrar descrições de objeto nos diagramas com base em uma configuração no nível do sistema e uma configuração no nível do objeto. Ambas as configurações precisam ser ativadas para visualizar a descrição de um determinado objeto.

Nota

A configuração no nível do sistema é exclusiva da configuração.

Requisitos para exibir descrições em diagramas

  • Uma descrição foi inserida nas propriedades do objeto
  • A descrição é ativada nas propriedades desse objeto
  • A opção global Visualizar descrições de objeto ativadas está ativada

Nota

A opção Descrições ativadas só está disponível quando há pelo menos um objeto apresentado no espaço de trabalho.

Uso de anotações em diagramas

Uma anotação é um objeto semelhante a uma nota autoadesiva no espaço de trabalho. Uma anotação está associada ao diagrama do objeto onde ele aparece.

Quando um job, fluxo de trabalho ou fluxo de dados é importado ou exportado e inclui anotações, as anotações associadas também são importadas ou exportadas.

Vou mostrar como adicionar descrições e anotações: