Árvore de páginas

Versões comparadas

Chave

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

...

 

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


ApprovalLevelDto

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

 

ColleagueDto

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

 

Propriedade

Descrição

Tipo do objeto

companyId

ID da empresa

long

colleagueId

Matrícula do usuário

String

colleagueName

Nome do usuário

String

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
homePageDepreciadoString
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
colleaguebackgroundDepreciadoString
nominalUserDepreciadoBoolean
guestUserDepreciadoBoolean
maxPrivateSizeEspaço disponível (Meus Documentos)Float
usedSpaceEspaço utilizadoFloat

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 como suas próprias propriedades que representam os anexos propriamente ditos.

 

Propriedade

Descrição

Tipo do objeto

attachmentSequence

Código sequencial do anexo.

int

attachments

Objetos representando os anexos físicos.

Attachment[]

colleagueId

Matrí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 (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.

 

Propriedade

Descrição

Tipo do objeto

key

Valor do parâmetro "name" definido no campo do formulário

String

value

Valor a ser preenchido no campo definido na propriedade "key"

String

ProcessTaskAppointmentDto

Objeto responsável informar apontamento na atividade de uma solicitação Workflow.

 

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa.

long

processInstanceId

Código da solicitação.

int
movementSequenceSequencia da movimentação.int
colleagueIdMatricula do usuário que criou o documento.String
transferenceSequenceSequencia de transferencia da atividade (histórico de movimentações)int
appointmentSequenceSequencia de apontamento.int
appointmentDateData para o apontamento.Date
appointmentSecondsSegundos 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.

 

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa.

long

attributionMecanismId

Código do Mecanismo de atribuição

String
nameNome do Mecanismo de atribuiçãoString
controlClassClasse em que o Mecanismo de atribuição está referenciandoString
preSelectionClassSequencia de transferencia da atividade (histórico de movimentações)String
configurationClassSequencia de apontamento.String
descriptionDescrição do Mecanismo de atribuiçãoString
assignmentTypeTipo do Mecanismo de atribuição (0 = Interno; 1 = Customizado)int
attributionMecanismDescriptionDescrição do Mecanismo de atribuiçãoString

 

BusinessPeriodDto

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

 

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa.

long

periodId

Código do Expediente

String
periodInfosPeríodos do ExpedienteBusinessPeriodInfoDto[]

 

BusinessPeriodInfoDto

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

 

Propriedade

Descrição

Tipo 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íodoint
finalHourHora final do períodoint

 

ColleagueReplacementDto

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

 

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa

long

colleagueId

Código do usuário substituído

String
replacementIdCódigo do usuário substitutoString
validationStartDateData inicial da substituiçãoDate
validationFinalDateData final da substituiçãoDate
viewWorkflowTasksSubstituto dos processoBoolean
viewGEDTasksSubstituto dos documentosBoolean

 

Signal

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

 

Propriedade

Descrição

Tipo do objeto

signalPK

Chave primária do Sinal

SignalPK

description

Descrição do Sinal

String

 

SignalPK

Objeto responsável por retornar o PK do Sinal

 

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa

long

signalId

Código do Sinal

int

 

DeadLineDto

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

 

Propriedade

Descrição

Tipo do objeto

date

Data (Tipo String no formato "yyyy-MM-dd").

String

hora

Hora

int

 

ProcessDefinitionDto

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

 

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa.

long

processId

Código do processo

String
processDescription

Descrição do processo

String
activeProcesso ativo ou nãoBoolean

 

ProcessDefinitionVersionDto

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

 

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa.

long

processId

Código do processo

String
version

Versão do processo

int
versionDescription

Descrição da versão do processo

String
categoryStructure

Categoria do processo

String
fullCategoryStructure

Categoria completa do processo, incluindo seu código

String
processDescription

Descrição do processo

String
favorite

Se o processo está nos favoritos do usuário

Boolean
mobileReady

Se o processo está disponível no Mobile

Boolean
formId

Código do formulário vinculado ao processo

String
formVersion

Versão do formulário vinculado ao processo

String
initialProcessState

Descrição do processo

ProcessStateDto
relatedDatasets

Descrição do processo

String[]
counterSign

Se o processo assina digitalmente

Boolean

 

 

ProcessStateDto

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

 

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa.

long

sequence

Sequência do processo

int
stateName

Nome do estado do processo

String
stateDescription

Descrição do estado do processo

String
counterSign

Se o processo assina digitalmente

Boolean

 

AvailableUsersDto

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

 

Propriedade

Descrição

Tipo do objeto

willShowUsers

Utilizado para exibir a tela de seleção de usuários

Boolean

isCollectiveTask

Se a atividade é conjunta

Boolean
users

Informações do usuário

ColleagueDto[]

 

ProcessHistoryDto

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

 

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa

long

processInstanceId

Número da solicitação

int
movementSequence

Número da movimentação

int
active

Se o processo está ativo

Boolean
movementDate

Data de movimentação

Date
movementHour

Hora de movimentação

String
stateSequence

Sequencia da movimentação

int
subProcessId

Número do subprocesso se disponível

int
threadSequence

Indica 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 atividade paralelas existentes no processo.

int
previousMovementSequence

Número da movimentação anterior

int
conversionSequence

Sequencia quando a solicitação foi convertida

int
isReturn

Se possui fluxo de retorno

Boolean
labelActivity

Descrição da atividade

String
labelLink

Link da atividade

String
tasks

Atividades

ProcessTaskDto[]

 

ProcessTaskDto

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

 

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa

long

processInstanceId

Número da solicitação

int
movementSequence

Número da movimentação

int
transferredSequence

Número da sequência quando transferido

int
colleagueId

Matrícula do usuário da atividade

String
status

Status da atividade

Boolean
active

Se a atividade está ativa

Boolean
isComplement

Se é um complemento

Boolean
choosedSequence

Sequência escolhida

String
choosedColleagueId

Matrícula do usuário escolhido

String
taskObservation

Observação da atividade

String
taskCompletionDate

Data de conclusão da atividade

String
taskCompletionHour

Hora de conclusão da atividade

int
completeColleagueId

Usuário que completou a atividade

String
completeType

Tipo de conclusão:

0 - Gestor

1 - Substituto

2 - Substituto do gestor

int
taskSigned

Se a atividade foi assinada

Boolean
deadlineText

Texto de atraso

String
colleagueName

Nome do usuário

String
historTaskObservation

Histórico de observações na atividade

String
historCompleteColleague

Histórico de conclusões da atividade

String
statusConsult

Status da atividade para consulta

int
canCurrentUserTakeTask

Se o usuário logado pode assumir a atividade

Boolean

 

 

WorkflowTaskDto

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

 

Propriedade

Descrição

Tipo do objeto

companyId

Código da empresa.

long

taskId

Código da tarefa

int
owner

Dono da tarefa

String
description

Descrição da tarefa

String
deadline

Prazo da tarefa

int
creationDate

Data de criação da tarefa

Date
creationTime

Hora de criação da tarefa

int
taskStatus

Status da tarefa:

0 - Pendente

1 - Pendente de consenso

2 - Completada

3 - Transferida

4 - Cancelada

int
expectedConclusionDate

Data de conclusão experada

Date
actualConclusionDate

Data atual de conclusão

Date
actualConclusionTime

Hora atual de conclusão

int
processInstanceId

Número da solicitação

int
movementSequence

Número da movimentação

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 da pendência 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