É uma estrutura da Organização (Organization) que independe da Operação (Operation) e se caracteriza pela materialização de Documento (Document)s para essa organização.
Um Documento da Organização é criado quando uma Instância de Campo (FieldInstance) do tipo “Pasta de Documentos” é criada em uma operação em um dos seguintes momentos:
- através da criação da operação
- quando um predecessor na DAG de Campo (FieldDag) é concluído para a operação.
Estrutura de Dados
| Tipo | Nome do elemento | Restrições | Observações |
|---|---|---|---|
| string | ID | único | |
| string | path | 512 chars | É o caminho (pastas e subpastas) deste documento. Global para a organização. |
| string | name | 128 chars | É o nome desse documento da organização. Pode ser diferente do nome definido em Documento (Document). |
| string | description | 8192 chars | |
| string | typeOfUniqueIdentifier | 128 chars | É um grupo de chaves únicas definida pelo usuário do PM - Process Manager. Mais informações em Funcionalidades - Identificador único de Documento (uniqueIdentifier) |
| string | uniqueIdentifier | 128 chars | É o valor que deve ser úncio na organização para cada ‘typeOfUniqueIdentifier’. Mais infos em Funcionalidades - Identificador único de Documento (uniqueIdentifier) |
| bool | hasIssueDate | Se é esperado que esse item possua uma data de emissão | |
| date | issueDate | ||
| bool | hasDueDate | Se é esperado que esse item possua uma data de vencimento | |
| date | dueDate | ||
| bool | hasHistory | Caso esse item vá possuir histórico (ainda não usamos esse campo!) | |
| - | history | - | NÃO IMPLEMENTADO |
| bool | requiredDueDate | Se a data de vencimento é obrigatória | |
| enum | status | NEW, VALID, INVALID | É o status do documento da organização. Documentos não preenchidos sempre iniciam como ‘NEW’. Mais infos em Funcionalidades - Documento da Organização |
| string | invalidReasons | 8192 chars | Caso existam motivos para a invalidez do documento da organização, eles serão descritos nesse campo |
Restrições
| Nome | Descrição | Chave única |
|---|---|---|
| nome, caminho, organização | Único nome e caminho para cada org | name-path-organizationId |
Vínculos
| Entidade Vinculada | Essa Entidade | Vinculada |
|---|---|---|
| Documento (Document) | N | 1(nullable) |
| Organização (Organization) | 1 | 1 |
| Documento da Organização na Instância de Campo (OrganizationDocumentOnFieldInstance) | M | N |
Observações
Documento (Document) pode ser ‘null’, ou seja, é possível que Documentos da Organização não estejam ligados à documentos descritos no PM - Process Manager.
Exemplos:
- Documentos facultativos
- Documentos desconhecidos previamente