O fluig dispõe de alguns objetos que são utilizados no desenvolvimento sobre a plataforma. O objetivo deste guia é apresentar as propriedades específicas destes objetos nas seções abaixo.
Representa o documento e suas propriedades. A tabela abaixo contém mais informações sobre o objeto:
Propriedade | Descrição | Tipo do objeto |
documentId | Número do documento. | int |
version | Número da versão do documento. | int |
companyId | Código da empresa em que o documento foi publicado. | Int |
UUID | UUID (identificador Único Global) do documento. | String |
documentTypeId | Tipo do arquivo físico, se retornar branco ou nulo é porque esse tipo não é conhecido pelo fluig. | String |
languageId | Código do Idioma do documento. | String |
iconId | Código do Ícone do documento. | int |
topicId | Código do assunto do documento. | int |
colleagueId | Matricula do usuário que criou o documento. | String |
documentDescription | Descrição do documento. | String |
additionalComments | Comentários adicionais do documento. | String |
phisicalFile | Nome do arquivo físico atrelado ao documento. | String |
createDate | Data de criação. | java.util.Date |
approvedDate | Data de Aprovação. | java.util.Date |
lastModifiedDate | Data da última modificação. | java.util.Date |
documentType | Tipo do documento, onde: 0 = Pasta raiz 1 = Pasta 2 = Documento normal 3 = Documento externo 4 = Formulário 5 = Registro de formulário 7 = Anexo Workflow 8 = Novo Conteúdo 9 = Aplicativo 10 = Relatório portal = Site portalPage = Página de Site. | String |
expirationDate | Data de expiração. | java.util.Date |
parentDocumentId | Número da Pasta/Formulário pai. | int |
relatedFiles | String com o nome do arquivo físico principal e anexos. | String |
activeVersion | Propriedade que define se a versão é ativa. | boolean |
versionDescription | Descrição da versão. | String |
downloadEnabled | Propriedade que define se o documento permite Download | boolean |
approved | Propriedade que define se o documento está em aprovação. | boolean |
validationStartDate | Data a partir da qual o documento poderá ser visualizado. | java.util.Date |
publisherId | Matricula do usuário que publicou o documento. | String |
cardDescription | Descrição do registro de formulário, para documento do tipo 5. | String |
documentPropertyNumber | Formulário que foi usado como base para criação do registro de formulário, por isso só tem um valor quando o documento é do tipo 5 (registro de formulário). | int |
documentPropertyVersion | Versão do formulário em que o registro de formulário foi criado. | int |
privateDocument | Propriedade que define se o documento/pasta está abaixo da pasta particular. | boolean |
privateColleagueId | Se é um documento particular retorna a matricula do usuário onde este documento está alocado. | String |
indexed | Propriedade que define se o documento já foi indexado. | boolean |
priority | Prioridade do documento. | int |
userNotify | Propriedade que define se notifica os usuários que tenham esse assunto de interesse. | boolean |
expires | Propriedade que define se o documento está expirado. | boolean |
volumeId | Volume onde o documento foi publicado, se estiver em branco ele utiliza o volume do pai. | String |
inheritSecurity | Propriedade que define se herda segurança do pai. | boolean |
updateIsoProperties | Propriedade que define se atualiza as propriedades da cópia controlada. | boolean |
lastModifiedTime | Hora da última modificação em milissegundos. | String |
deleted | Propriedade que define se o documento está na lixeira. | boolean |
datasetName | Documento do dataset , se o documento é um formulário. | String |
keyWord | Palavras chaves do documento. Cada palavra é separada por vírgula. | String |
imutable | Propriedade que define se a versão/revisão é inalterável. | boolean |
draft | Propriedade que define se o documento está em edição, para documento do tipo “Novo Conteúdo”. | boolean |
internalVisualizer | Propriedade que define se utiliza visualizador interno. | boolean |
phisicalFileSize | Tamanho físico do documento principal e anexos. | float |
| versionOption | Condição de versionamento do documento: 0 = Será mantida a versão 1 = Será criado nova revisão 2 = Será criado nova versão Importante lembrar que no momento da criação de um novo documento o valor sempre será 0. | int |
Representa a segurança de um documento e suas propriedades. Na tabela abaixo constam mais informações sobre ele:
Função | Descrição da Função | Tipo do Retorno |
documentId | Número do documento. | int |
version | Número da versão do documento. | int |
companyId | Código da empresa em que o documento foi publicado. | Int |
attributionValue | Matricula de um usuário ou o código do grupo que está na segurança deste documento. É possível saber se vai retornar um usuário ou um grupo pelo tipo da segurança. Obs.: Retorna em branco quando o tipo é todos os usuários. | String |
attributionType | Tipo da segurança, onde: 1 = Usuário; 2 = Grupo; 3 = Todos os Usuários. | int |
permission | Propriedade que define se é uma permissão. Obs.: Se não é uma permissão é uma restrição. | boolean |
showContent | Propriedade que define se lista o conteúdo. | boolean |
securityLevel | Nível de permissão/restrição, onde: -1 = sem permissão/restrição (nega acesso); 0 = Leitura; 1 = Gravação; 2 = Modificação; 3 = Total. | int |
sequence | Sequência da permissão/restrição. | int |
securityVersion | Propriedade que define se o documento utiliza a segurança desta versão nas demais. | boolean |
Representa os aprovadores de um documento ou pasta.
Propriedade | Descrição | Tipo do objeto |
companyId | ID da empresa | long |
colleagueId | Matrícula do usuário | String |
documentId | Número do documento | int |
version | Versão do documento | int |
levelId | Nível de aprovação | int |
Representa os níveis de aprovação de um documento ou pasta.
Propriedade | Descrição | Tipo do objeto |
levelId | Nível de aprovação | int |
levelDescription | Descrição do nível de aprovação | String |
approvalMode | Modo de aprovação (1 = OU, 2 = E, 3 = ÚNICO) | int |