Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

São as representações físicas dos anexos que compõem um documento por completo. Suas propriedades representam as informações de um documento específico dentro do grupo que representa o documento como um todo para o GED, que por si só é composto por um anexo principal e pode conter outros anexos complementares.

PropriedadeDescriçãoTipo do objeto
fileNameNome do arquivo físico

...

String
pathNameCaminho absoluto do arquivo completo na máquina (sem o nome do arquivo em si),

...

caso o arquivo esteja no mesmo local onde está o servidor fluig

...

String
fullPatchCaminho absoluto do arquivo completo na máquina (com o nome do arquivo em si),

...

caso o arquivo esteja no mesmo local onde está o servidor fluig

...

String
fileSizeTamanho do arquivo físico em bytes

...

String
iconPathCaminho do ícone representativo do documento, caso vazio aparecerá o ícone padrão

...

String
attachSe é anexo do documento, valor true para documentos que não são os principais do documento

...

Boolean
principalSe é

...

arquivo principal, mutuamente exclusivo com a propriedade attach

...

Boolean
descriptorPropriedade que define se o documento é um descritor

...

Boolean
editingSe o anexo está em edição, o padrão é false

...

Boolean
fileSelectedArquivos selecionados, apenas para controle, não preencher

...

Attachment[]
filecontentConteúdo do arquivo em Base64, caso queira que o arquivo seja transferido por stream

...

byte
mobileSe o arquivo foi adicionado por um dispositivo mobile

...

Boolean

Objeto Attachment utilizado como parâmetro e retorno para métodos WebService.


RelatedDocumentDto

Representa os documentos relacionados com o documento.

PropriedadeDescriçãoTipo do objeto

...

DocumentIdNúmero do documentoint
versionVersão do documentoint
relatedDocumentIdNúmero do documento que está sendo relacionadoint
companyIdID da empresalong


DocumentSecurityConfigDto

Representa a segurança de um documento e suas propriedades. Na tabela abaixo constam mais informações sobre ele:

PropriedadeDescriçãoTipo do objeto
documentIdNúmero do documento
.
int
versionNúmero da versão do documento
.
int
companyIdCódigo da empresa em que o documento foi publicado
.
Int
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

usuários.

int
permission

Propriedade que define se é uma permissão

.

Obs.: Se não é uma permissão, é uma restrição

.

boolean
showContentPropriedade que define se lista o
conteúdo.
documentoboolean
securityLevel

Nível de permissão/restrição

,

onde:

-1 =

sem

Sem permissão/restrição (nega acesso);

0 = Leitura;

1 = Gravação;

2 = Modificação;

3 = Total.

int
sequenceSequência
da
de permissão/restrição
.
int
securityVersionPropriedade que define se o documento utiliza a segurança desta versão nas demais
.
boolean


ApproverDto

Representa Rpresenta os aprovadores de um documento ou pasta.

PropriedadeDescriçãoTipo do objeto
companyIdID da empresalong
colleagueIdMatrícula do usuárioString
documentIdNúmero do documentoint
versionVersão do documentoint
levelIdNível de aprovaçãoint
approverTypeTipo de

...

aprovação (0 = Colaboradores

...

/ 1 = Grupo)int


ApproverWithLevelDto

Representa os aprovadores de um documento ou pasta.

PropriedadeDescriçãoTipo do objeto
companyIdID da empresalong
colleagueIdMatrícula do usuárioString
documentIdNúmero do documentoint
versionVersão do documentoint
levelIdNível de aprovaçãoint



ApprovalLevelDto

Representa os níveis de aprovação de um documento ou pasta.

PropriedadeDescriçãoTipo do objeto
levelIdNível de aprovaçãoint
levelDescriptionDescrição do nível de aprovaçãoString
approvalModeModo de aprovação (1 = OU
,
/ 2 = E
,
/ 3 = ÚNICO
)
int


ColleagueDto

Representa as propriedades do usuário. A tabela abaixo contém mais informações sobre o objeto:

PropriedadeDescriçãoTipo do objeto
companyIdID da empresalong
colleagueIdMatrícula do usuárioString
colleagueNameNome do usuárioString
mailE-mail do usuárioString
extensionNrRamal do usuárioString
currentProjectProjeto do usuárioString
especializationAreaÁrea de especializaçãoString
loginLogin do usuárioString
passwdSenha do usuárioString
activeStatus do usuárioBoolean
homePageDepreciado
String
Sring
photoPathCaminho para foto de perfilString
area1IdDepreciadoint
area2IdDepreciadoint
area3IdDepreciadoint
area4IdDepreciadoint
area5IdDepreciadoint
emailHtmlUtiliza o e-mail em htmlBoolean
adminUserUsuário administradorBoolean
groupIdGrupo de trabalho workflowString
sessionIdSessão do usuárioString
defaultLanguageIdioma padrão de documentosString
menuConfigConfiguração de menuint
dialectIdIdioma do usuárioString
gedUserUsuário GEDBoolean
volumeIdVolume físicoString
colleaguebackground
colleaguebackgroudDepreciadoString
nominalUserDepreciadoBoolean
guestUserDepreciadoBoolean
maxPrivateSizeEspaço disponível (Meus Documentos)Float
usedSpaceEspaço
utilizado
utilzadoFloat


ProcessAttachmentDto

Objeto que representa um anexo de processo, contendo informações sobre a solicitação e sobre o documento o qual representa, bem como os documentos anexados nele próprio. Em resumo é uma representação global de um anexo, constituído por outros

subobjetos

subprojetos como suas próprias propriedades que representam os anexos propriamente ditos.

PropriedadeDescriçãoTipo do objeto
attachmentSequenceCódigo sequencial do anexo
.
int
attachmentsObjetos representando os anexos físicos
.
Attachment[]
colleagueIdMatrícula do usuário anexando o documento
.
String
colleagueNameNome do usuário anexando o documento
.
String
companyIdCódigo da empresa
.
long
crcCyclic Redundancy Check, calculado automaticamente, não informar
.
long
createDateData de criação do anexo
.
Date
createDateTimestampData da criação do anexo em milisegundos
.
long
deletedSe o arquivo fora deletado dos anexos
.
Boolean
descriptionDescrição do anexo
.
String
documentIdCódigo do documento no GED
.
int
DocumentType

Tipo de

Documento

documento (2 se é um anexo direto do GED

e

/ 7 se é um anexo de processo sem vínculo atual)

.

Utilizar o tipo 7 e publicá-lo após a movimentação caso o deseje no GED

.

String
fileNameNome do arquivo físico
.
String
newAttachSe é um anexo novo (anexado nesta movimentação)
.
Boolean
originalMovementSequenceCódigo da movimentação na qual o anexo foi inserido
.
int
permissionPermissões sobre o anexo específico (é recomendado controlar tais permissões pelas propriedades do processo
).
String
processInstanceIdCódigo da solicitação
.
int
sizeTamanho somado de todos os arquivos em anexo
.
float
versionVersão do documento
.
int

Objeto ProcessAttachmentDto utilizado como parâmetro e retorno para métodos WebService.


KeyValueDto

Objeto responsável por informar valores nos campos de formulário

.

PropriedadeDescriçãoTipo do objeto
keyValor do parâmetro "name" definido no campo do formulárioString
valueValor a ser preenchido no campo definido na propriedade "key"String
ProcessTaskAppointmentDto


ProcessTaskAppoimentDto

Objeto responsável por informar apontamento

na

da atividade de uma solicitação

Workflow.

workflow

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresa
.
long
processInstanceIdCódigo da solicitação
.
int
movementSequence
movimentSequenceSequencia da movimentação
.
int
colleagueId
Matricula
Matrícula do usuário que criou o documento
.
String
transferenceSequenceSequencia de
transferencia appointmentDate
transferência da atividade (histórico de movimentações)int
appointmentSequenceSequencia de apontamento.int
appoimentDate
Data para o apontamento
.
Date
appointmentSeconds
appoimentSecondsSegundos para o apontamento
.
int
colleagueNameNome do usuário para o apontamento
.
String


AttributionMecanismDto

Objeto responsável por retornar informações de Mecanismo de Atribuição.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresa
.
long
attributionMecanismIdCódigo do
Mecanismo
mecanismo de
atribuição
atriçãoString
nameNome do
Mecanismo
mecanismo de atribuiçãoString
controlClassClasse em que o
Mecanismo
mecanismo de atribuição está
referenciando
referenciadoString
preSelectionClassSequencia de
transferencia
transferência da atividade (histórico de movimentações)String
configurationClassSequencia de apontamento
.
String
descriptionDescrição do
Mecanismo
mecanismo de atribuiçãoString
assignmentTypeTipo do
Mecanismo
mecanismo de atribuição (0 =
Interno;
Inteiro / 1 = Personalizado)int
attributionMecanismDescriptionDescrição do
Mecanismo
mecanismo de atribuiçãoString


BusinessPeriodDto

Objeto responsável por retornar informações do expediente.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresa
.
long
periodIdCódigo do
Expediente
expedienteString
periodInfosPeríodos do
Expediente


BusinessPeriodInfoDto

Objeto responsável por retornar informações de um período de

um

expediente.

PropriedadeDescriçãoTipo do objeto
weekDay

Dia da semana:

1 - Domingo

2 - Segunda

3 - Terça

4 - Quarta

5 - Quinta

6 - Sexta

7 - Sábado

int
sequence

Código do período:

1 - Manhã

2 - Tarde

int
initialHourHora inicial do
período
perídoint
finalHour
Hora
Horal final do
período
perídoint



ColleagueReplacementDto

Objeto responsável por retornar informações de usuário substituto.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
colleagueIdCódigo do usuário substituídoString
replacementIdCódigo do usuário substitutoString
validationStartDateData inicial da substituição. Exemplo: 2017-08-18T00:00:00-03:00Date
validationFinalDateData final da substituição. Exemplo: 2017-08-25T00:00:00-03:00 Date
viewWorkflowtasksSubstituto dos processos
viewWorkflowTasksSubstituto dos processo
Boolean
viewGEDTasksSubstituto dos documentosBoolean


Signal

Objeto responsável por retornar informações do Sinal.

PropriedadeDescriçãoTipo do objeto
signalPKChave primária do SinalSignalPK
descriptionDescrição do SinalString



SignalPK

Objeto responsável por retornar o PK do Sinal.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
signalIdCódigo do
Sinal
sinalint



DeadLineDto

Objeto responsável por retornar Data e Hora de uma atividade.

PropriedadeDescriçãoTipo do objeto
dateData (Tipo String no formato "yyyy-MM-dd")
.
String
horaHoraint



ProcessDefinitionDto

Objeto responsável por retornar informações do processo

.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresa
.
long
processIdCódigo do processoString
processDescriptionDescrição do processoString
activeProcesso ativo ou nãoBoolean



ProcessDefinitionVersionDto

Objeto responsável por retornar informações da versão do processo

.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresa
.
long
processIdCódigo do processoString
versionVersão do processoint
versionDescriptionDescrição da versão do processoString
categoryStructure

Categoria do processo

String
fullCategoryStructureCategoria completa do processo, incluindo seu códigoString
processDescriptionDescrição do processoString
favoriteSe o processo está nos favoritos do usuárioBoolean
mobileReadySe o processo está disponível no MobileBoolean
formIdCódigo do formulário vinculado ao processoString
formVersionVersão do formulário vinculado ao processoString
initialProcessStateDescrição do processoProcessStateDto
relatedDatasetsDescrição do processoString[]
counterSignSe o processo assina digitalmenteBoolean


ProcessStateDto

Objeto responsável por retornar informações do estado do processo.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresa
.
long
sequenceSequência do processoint
stateNameNome do estado do processoString
stateDescriptionDescrição do estado do processoString
counterSignSe o processo assina digitalmenteBoolean


AvailableUsersDto

Objeto responsável por retornar usuários de uma atividade.

PropriedadeDescriçãoTipo do objeto
willShowUsersUtilizado para exibir a tela de seleção de usuáriosBoolean
isCollectiveTaskSe a atividade é conjuntaBoolean
users
Informações
informações do usuárioColleagueDto[]



ProcessHistoryDto

Objeto responsável por retornar informações do histórico de uma solicitação

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
processInstanceIdNúmero da solicitaçãoint
movementSequenceNúmero da movimentação
int
int
activeSe o processo está ativoBoolean
movementDateData de movimentaçãoDate
movementHourHora de movimentaçãoString
stateSequenceSequencia da movimentação
int
int
subProcessIdNúmero do subprocesso se disponível
int
int
threadSequenceIndica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade
de
da atividade paralelas existentes no processo.int
previousMovementSequenceNúmero da movimentação anteriorint
conversionSequenceSequencia quando a solicitação foi convertidaint
isReturn
isReturmSe possui fluxo de retornoBoolean
labelActivityDescrição da atividadeString
labelLinkLink da atividadeString
tasksAtividadesProcessTaskDto[]



ProcessTaskDto

Objeto responsável por retornar informações de uma atividade.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
processInstanceIdNúmero da solicitaçãoint
movementSequenceNúmero da
movimentaçãoint
sequência quando transferidoint
transferredSequenceNúmero da sequência quando transferido
int
int
colleagueIdMatrícula do usuário da atividadeString
statusStatus da atividadeBoolean
activeSe a atividade está ativaBoolean
isComplementSe é um complementoBoolean
choosedSequenceSequência escolhidaString
choosedColleagueIdMatrícula do usuário escolhidoString
taskObservationObservação da atividadeString
taskCompletionDateData de conclusão da atividadeString
taskCompletionHourHora de conclusão da atividadeint
completeColleagueIdUsuário que completou a atividadeString
completeType

Tipo de conclusão:

0 - Gestor

1 - Substituto

2 - Substituto do gestor

int
taskSignedSe a atividade foi assinadaBoolean
deadlineTextTexto de atrasoString
colleagueNameNome do usuárioString
historTaskObservationHistórico de observações na atividadeString
historCompleteColleagueHistórico de conclusões da atividadeString
statusConsultStatus da atividade para consultaint
canCurrentUserTakeTaskSe o usuário
logado
pode assumir a atividadeBoolean


WorkflowTaskDto

Objeto responsável por retornar informações da tarefa

.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresa
.
long
taskIdCódigo da tarefaint
ownerDono da tarefaString
descriptionDescrição da tarefaString
deadlinePrazo da tarefaint
creationDateData de criação da tarefaDate
creationTimeHora de criação da tarefaint
taskStatus

Status da tarefa:

0 - Pendente

1 - Pendente de consenso

2 -

Completada

completada

3 - Transferida

4 - Cancelada

int
expectedConclusionDateData de conclusão experadaDate
actualConclusionDateData atual de conclusãoDate
actualConclusionTimeHora atual de conclusãoint
processInstanceIdNúmero da solicitaçãoint
movementSequenceNúmero da movimentaçãoint


WorkflowRoleDto

Objeto responsável por retornar informações do Papel.

PropriedadeDescriçãoTipo do objeto
roleIdCódigo do
Papel
papelString
companyId
Código
código da empresalong
roleDescriptionDescrição do
Papel
papelString



TaskVODto

Objeto responsável por retornar informações da Tarefa.

PropriedadeDescriçãoTipo do objeto
taskIdCódigo da
Tarefa
tarefaString
typeTipolong
iconsetÍconeString
stateEstado da
Tarefa
tarefaString
iconPathCaminho do íconeString
descriptionDescrição da
Tarefa
tarefaString
childrenTarefas filhasTaskVODto[]



HomeRequestSummaryDto

Objeto responsável por retornar os números de pendências do usuário

PropriedadeDescriçãoTipo do objeto
numberOfWorkflowPendingRequestsQuantidade de solicitações iniciadas que estão pendentesint
numberOfWorkflowUnderDeadlineRequestsQuantidade de solicitações iniciadas que estão no prazoint
numberOfWorkflowDelayedRequestsQuantidade de solicitações iniciadas que estão atrasadasint
numberOfOpenRequestsQuantidade de solicitações abertasint
numberOfPoolGroupRequestsQuantidade de solicitações em Pool para um Grupoint
numberOfPoolRoleRequestsQuantidade de solicitações em Pool para um Papelint
numberOfDocumentApprovalPendingQuantidade de documentos pendentes de aprovaçãoint
numberOfDocumentAwaitingApprovalQuantidade de documentos aguardando aprovaçãoint
numberOfLearningTasksQuantidade
de Tarefas de Aprendizagem
de Tarefas de aprendizagemint
replacementIdMatrícula do usuário substituídoString


WorkflowProcessDto

Objeto responsável por retornar informações do

Processo

processo Workflow

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
processInstanceIdNúmero da solicitaçãoint
processIdCódigo do processoString
versionVersão do processoint
requesterIdMatrícula do usuário requisitanteString
requesterNameNome do usuário requisitanteString
activeSe o processo está ativoBoolean
attachmentSeqIdSequência de anexo da atividadeint
stateIdID do estadoint
stateDescriptionMatrícula do usuário substituídoString
processDescriptionDescrição do processoString
deadlineDatePrazo da atividadeDate
deadlineTextTexto de atraso da atividadeString
documentDescriptionDescrição do documentoString
colleagueNameNome do usuárioString
movementSequenceNúmero de movimentoint
mainAttachmentDocumentIdCódigo do documento principalint
mainAttachmentDocumentVersionVersão do documento principalint
counterSignSe o processo assina digitalmenteBoolean
movementHourHora da movimentaçãoString
startupHourHora que foi iniciadoString
mobileReadySe está disponível no
Mobile
mobileBoolean
canCancelSe o usuário pode cancelarBoolean
canTakeSe o usuário pode assumirBoolean
urlURL de acesso ao processoString
codeCódigo do processoString
relatedDatasetsDatasets relacionados ao processoString[]




WebServiceMessageArray 

Objeto responsável por retornar informações do documento.

  

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa

int

documentDescription

Descrição do documento

String

documentId

Código do documento

int

version

Versão do documento

int

webServiceMessage

Mensagem de retorno

String


CardEventDtoArray 

Objeto responsável por retornar evento de documento.

  

 

Propriedade

Descrição

Tipo do objeto

eventId

Código do evento

int

eventDescription

Descrição do evento

String

eventVersAnt

Versão anterior do evento

Boolean


CustomFieldsDto 

Objeto responsável por retornar informações do campo personalizado.

  

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa

int

customFieldDescription

Descrição do campo personalizado

String

customFieldId

Código do campo personalizado

int


DocumentCustomFieldsDto 

Objeto responsável por retornar informações do documento com campo personalizado. 

  

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa

int

customFieldDescription

Descrição do campo personalizado

String

customFieldId

Código do campo personalizado

int

  

DocumentApprovementHistoryDto 

Objeto responsável por retornar Histórico de aprovação de documentos.

  

Propriedade

Descrição

Tipo do objeto

colleagueId

Código do usuário

String

documentVersion

Versão do documento

int

iterationSequence

Sequencia de interação

int

levelId

Nivel do ID

int

movementSequence

Sequencia da movimentação

String

observation

Observação

String

signed

Documento assinado

Boolean

status

Status do documento

int

  

DocumentApprovalStatusDto 

Objeto responsável por retornar informações do Status de Aprovação do Documento. 

  

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa

int

documentId

Código do documento

int

version

Versão do documento

int

status

Status do documento

int


RelatedDocumentDto 

Objeto responsável por retornar informações do Documento relacionado. 

  

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa

int

documentId

Código do documento

int

relatedDocumentId

Código do documento relacionado

int

version

Versão do documento

int

  

WorkflowRoleDto 

Objeto responsável por retornar informações do Papel.

  

Propriedade

Descrição

Tipo do objeto

roleId

Código do Papel

String

companyId

Código da empresa

long

roleDescription

Descrição do Papel

String

  

TaskVODto 

Objeto responsável por retornar informações da Tarefa. 

  

Propriedade

Descrição

Tipo do objeto

taskId

Código da tarefa

String

type

Tipo

long

iconset

Ícone

String

state

Estado da tarefa

String

iconPath

Caminho do ícone

String

description

Descrição da tarefa

String

children

Tarefas filhas

TaskVODto[]

  

HomeRequestSummaryDto 

Objeto responsável por retornar os números de pendências do usuário.

  

Propriedade

Descrição

Tipo do objeto

numberOfWorkflowPendingRequests

Quantidade de solicitações iniciadas que estão pendentes

int

numberOfWorkflowUnderDeadlineRequests

Quantidade de solicitações iniciadas que estão no prazo

int

numberOfWorkflowDelayedRequests

Quantidade de solicitações iniciadas que estão atrasadas

int

numberOfOpenRequests

Quantidade de solicitações abertas

int

numberOfPoolGroupRequests

Quantidade de solicitações em Pool para um Grupo

int

numberOfPoolRoleRequests

Quantidade de solicitações em Pool para um Papel

int

numberOfDocumentApprovalPending

Quantidade de documentos pendentes de aprovação

int

numberOfDocumentAwaitingApproval

Quantidade de documentos aguardando aprovação

int

numberOfLearningTasks

Quantidade de tarefas de Aprendizagem

int

replacementId

Matrícula do usuário substituído

String


SearchResultDto 

Objeto responsável por retornar informações da busca do documento.

  

Propriedade

Descrição

Tipo do objeto

colleagueId

Matricula do usuário que criou o documento.

String

companyId

Código da empresa

int

crc

Crc do documento

long

documentDescription

Nome do documento

String

documentId

Código do documento

int

documentType

Tipo do documento

String

folderName

Nome da pasta

String

iconId

ID do ícone

int

inheritApprovers

Herda aprovadores

Boolean

lastModifiedDate

Última data modificada

Date

parentDocumentId

ID do documento pai

int

phisicalFile

Nome do arquivo de download

String

phisicalFileSize

Tamanho do arquivo

String

privateDocument

Documento privado

Boolean

publisherId

ID do publicador do documento

String

publisherName

Nome do publicador do documento

String

topicId

ID do assunto do documento

int

version

Versão do documento

int




ColleagueReplacementDto


cardData

...