Histórico da Página
...
| Dica | ||
|---|---|---|
| ||
A partir da atualização Lake 1.7.0-200714 os datasets internos passam a ter controle de permissionamento pelo Painel de controle. Saiba mais na documentação de Recursos de permissão em APIs e Webservices para mais detalhes. |
Datasets de Aprendizado
...
| Nota | ||
|---|---|---|
| ||
A partir da atualização 1.6.5-190219, o LMS não faz mais parte da plataforma para novas instalações. Mas, não se preocupe: se você adquiriu a plataforma com o LMS incluso, entre em contato com o Suporte Fluig para que você consiga utiliza-lo normalmente – mesmo após a atualização 1.6.5-190219. Se você não lembra se o LMS está incluso ou não no seu pacote, consulte sua proposta comercial ou entre em contato com o seu ESN. Dica | | |
|
Datasets do Social
PostDataset - Dataset dos posts publicados
* fluig 1.3.0 ou superior
Este dataset pode ser utilizado para fornecer os posts publicados pelos usuários. Acompanhe a seguir os detalhes dos campos disponíveis:
...
Coluna
...
Descritivo
...
Exemplo de Valor
...
postId
...
Id do post
...
3
...
creationDate
...
Data em que o post foi criado
...
2015-08-05 10:49:05.0
...
lastUpdateDate
...
Data da última atualização do post
...
2015-08-05 10:49:05.0
...
numberComments
...
Número de comentários do post
...
2
...
numberDenouncemets
...
Número de denúncias do post
...
1
...
numberLikes
...
Número de apoios do post
...
2
...
numberShares
...
Número de compartilhamentos do post
...
2
...
numberWatchers
...
Número de pessoas que acompanham o post
...
2
...
isRemoved
...
Indicador se o post foi removido
...
1 - true / 0 - false
...
url
...
URL do post
...
"/post/rh/153"
...
mentions
...
Número de menções do post
...
3
...
link
...
Link contido no post
...
...
text
...
Texto do post
...
"Bem vindos!"
...
customData
...
Dados customizados do post
...
{}
...
type
...
Tipo do post
...
Publicação / Compartilhamento
...
socialId
...
Id Social de quem realizou o post
...
3
...
author
...
Login do autor do post
...
"john"
...
authorName
...
Nome do autor do post
...
"John Steel"
...
linkedObjectId
...
Id do objeto ligado ao post
...
127
...
linkedObjectClass
...
Classe do objeto ligado ao post
...
"com.totvs.technology.social.document.33"
...
linkedObjectDescription
...
Descrição do objeto ligado ao post
...
"Dunas.jpg"
PostObjectDataset - Dataset dos posts e seus respectivos objetos
* fluig 1.6.2 ou superior
Este dataset pode ser utilizado para fornecer os posts publicados pelos usuários e informações dos seus respectivos objetos. Acompanhe a seguir os detalhes dos campos disponíveis:
...
Coluna
...
Descritivo
...
Exemplo de Valor
...
postId
...
Id do post
...
3
...
id
...
Id do objeto
...
1
...
url
...
Url de acesso ao objeto
...
/ecmnavigation?app_ecm_navigation_doc=6&app_ecm_navigation_docVersion=1000
...
description
...
Descrição do objeto
...
imagem.jpg
...
customData
...
Dados customizados do objeto
...
{}
...
creationDate
...
Data em que o objeto foi criado
...
2015-08-05 10:49:05.0
...
lastUpdateDate
...
Data da última atualização do objeto
...
2015-08-05 10:49:05.0
...
numberComments
...
Número de comentários do objeto
...
2
...
numberDenouncemets
...
Número de denúncias do objeto
...
1
...
numberLikes
...
Número de apoios do objeto
...
2
...
numberShares
...
Número de compartilhamentos do objeto
...
2
...
numberWatchers
...
Número de pessoas que acompanham o objeto
...
2
...
text
...
Texto do objeto
...
Novo artigo
...
authorAlias
...
Alias do autor do objeto
...
john
...
authorName
...
Nome do autor do objeto
...
John Steel
...
* fluig 1.3.0 ou superior
Este dataset pode ser utilizado para fornecer os comentários realizados pelos usuários. Acompanhe a seguir os detalhes dos campos disponíveis:
...
Coluna
...
Descritivo
...
Exemplo de Valor
...
commentId
...
Id do post
...
3
...
creationDate
...
Data em que o comentário foi criado
...
2015-08-05 10:49:05.0
...
lastUpdateDate
...
Data da última atualização do comentário
...
2015-08-05 10:49:05.0
...
numberDenouncemets
...
Número de denúncias do comentário
...
1
...
numberLikes
...
Número de apoios do comentário
...
2
...
isRemoved
...
Indicador se o comentário foi removido
...
1 - true / 0 - false
...
url
...
URL do conteúdo onde foi realizado o comentário
...
"/ecmnavigation?app_ecm_navigation_doc=182&app_ecm_navigation_docVersion=1000"
...
commentText
...
Texto do comentário
...
"Boa inciativa!"
...
hasMentions
...
Indicador se existe menção no comentário
...
1 - true / 0 - false
...
link
...
Link contido no comentário
...
...
postId
...
Id Social onde o comentário foi realizado. Nos casos de post será o id do post, para os casos de documentos, vira o id social do documento
...
3
...
socialId
...
Id Social de quem realizou o post
...
4
...
author
...
Login do autor do comentário
...
"john"
...
authorName
...
Nome do autor do comentário
...
"John Steel"
...
* fluig 1.3.0 ou superior
Este dataset pode ser utilizado para recuperar as comunidades. Acompanhe a seguir os detalhes dos campos disponíveis:
...
Coluna
...
Descritivo
...
Exemplo de Valor
...
alias
...
Alias da comunidade
...
"RH"
...
creationDate
...
Data em que o comentário foi criado
...
2015-08-05 10:49:05.0
...
lastUpdateDate
...
Data da última atualização do comentário
...
2015-08-05 10:49:05.0
...
name
...
Nome da comunidade
...
"RH - Plantão"
...
description
...
Descrição da comunidade
...
"O canal direto de informações entre a empresa e os funcionários."
...
isApprovalRequired
...
Indicador se a comunidade precisa de aprovação para participar
...
True / False
...
isPrivateContent
...
Indicador se a comunidade tem conteúdo privado
...
True / False
...
isHidden
...
Indicador se a comunidade é oculta
...
True / False
...
isActive
...
Indicador se a comunidade está ativa
...
True / False
...
articleFolder
...
Id da pasta de artigos da comunidade
...
12
...
formFolder
...
Id da pasta de formúlarios da comunidade
...
45
...
photoFolder
...
Id da pasta de imagens da comunidade
...
32
...
documentFolder
...
Id da pasta de documentos da comunidade
...
10
...
videoFolder
...
9
ParticipantDataset - Dataset dos participantes das comunidades
* fluig 1.3.0 ou superior
Este dataset pode ser utilizado para fornecer os usuários que participam das comunidades. Acompanhe a seguir os detalhes dos campos disponíveis:
...
Coluna
...
Descritivo
...
Exemplo de Valor
...
communityAlias
...
Alias da comunidade
...
"RH"
...
participantAlias
...
Alias do participante da comunidade
...
"john"
...
panticipantName
...
Nome do participante da comunidade
...
"John Steel"
...
isAdministrator
...
Indicador se o participante é administrador da comunidade
...
1 - true
...
isModerator
...
Indicador se o participante é moderador da comunidade
...
1 - true
FollowerDataset - Dataset dos usuários que estão seguindo
* fluig 1.3.0 ou superior
Este dataset pode ser utilizado para fornecer os usuários que seguem outros usuários. Acompanhe a seguir os detalhes dos campos disponíveis:
...
Coluna
...
Descritivo
...
Exemplo de Valor
...
followerAlias
...
Alias do seguidor
...
"john"
...
followedAlias
...
Alias do seguido
...
"ana"
...
followerName
...
Nome do seguidor
...
"John Steel"
...
followedName
...
Nome do seguido
...
"Anna Smyth"
FollowedDataset - Dataset dos usuários que são seguidos
* fluig 1.3.0 ou superior
Este dataset pode ser utilizado para fornecer os usuários que são seguidos por outros usuários. Acompanhe a seguir os detalhes dos campos disponíveis:
...
Coluna
...
Descritivo
...
Exemplo de Valor
...
followerAlias
...
Alias do seguidor
...
"john"
...
followedAliad*
...
Alias do seguido
...
"ana"
...
followerName
...
Nome do seguidor
...
"John Steel"
...
followedName
...
Nome do seguido
...
"Anna Smyth"
*Obs: O campo followedAliad está documento conforme o retorno do dataset
Datasets de Documentos
documentApprovalHistory - Histórico de aprovações do documento
* Atualização 1.4.11 ou superior
...
movementDate
...
movementTime
...
observation
...
colleagueId
...
| Informações | ||
|---|---|---|
| ||
Este item informa se o aprovador aceitou o item. |
document - Lista todos os documentos e suas respectivas versões
* Atualização 1.0 ou superior
...
lastModifiedTime
...
documentType
...
Tipo do documento
| Informações | ||
|---|---|---|
| ||
|
...
parentDocumentId
...
Número do documento pai
| Informações | ||
|---|---|---|
| ||
O id 0 (zero) representa a pasta raíz |
...
metaListRecordId
...
Sequencia do registro na tabela específica de meta lista
| Informações | ||
|---|---|---|
| ||
Informação válida somente para registros de formulários |
...
Campo que corresponde a descrição do formulário
| Informações | ||
|---|---|---|
| ||
Informação válida somente para formulários |
...
Propriedade que indica se o documento é a pasta Check-out
| Informações | ||
|---|---|---|
| ||
Informação válida somente para pastas |
...
Default
...
O nome do dataset a qual o documento pertence
| Informações | ||
|---|---|---|
| ||
Informação válida somente para formulários |
...
Datasets do Social
...
PostDataset - Dataset dos posts publicados
* fluig 1.3.0 ou superior
Este dataset pode ser utilizado para fornecer os posts publicados pelos usuários. Acompanhe a seguir os detalhes dos campos disponíveis:
Coluna | Descritivo | Exemplo de Valor |
|---|---|---|
postId | Id do post | 3 |
creationDate | Data em que o post foi criado | 2015-08-05 10:49:05.0 |
lastUpdateDate | Data da última atualização do post | 2015-08-05 10:49:05.0 |
numberComments | Número de comentários do post | 2 |
numberDenouncemets | Número de denúncias do post | 1 |
numberLikes | Número de apoios do post | 2 |
numberShares | Número de compartilhamentos do post | 2 |
numberWatchers | Número de pessoas que acompanham o post | 2 |
isRemoved | Indicador se o post foi removido | 1 - true / 0 - false |
url | URL do post | "/post/rh/153" |
mentions | Número de menções do post | 3 |
link | Link contido no post | |
text | Texto do post | "Bem vindos!" |
customData | Dados customizados do post | {} |
type | Tipo do post | Publicação / Compartilhamento |
socialId | Id Social de quem realizou o post | 3 |
author | Login do autor do post | "john" |
authorName | Nome do autor do post | "John Steel" |
linkedObjectId | Id do objeto ligado ao post | 127 |
linkedObjectClass | Classe do objeto ligado ao post | "com.totvs.technology.social.document.33" |
linkedObjectDescription | Descrição do objeto ligado ao post | "Dunas.jpg" |
PostObjectDataset - Dataset dos posts e seus respectivos objetos
* fluig 1.6.2 ou superior
Este dataset pode ser utilizado para fornecer os posts publicados pelos usuários e informações dos seus respectivos objetos. Acompanhe a seguir os detalhes dos campos disponíveis:
Coluna | Descritivo | Exemplo de Valor |
|---|---|---|
postId | Id do post | 3 |
id | Id do objeto | 1 |
url | Url de acesso ao objeto | /ecmnavigation?app_ecm_navigation_doc=6&app_ecm_navigation_docVersion=1000 |
description | Descrição do objeto | imagem.jpg |
customData | Dados customizados do objeto | {} |
creationDate | Data em que o objeto foi criado | 2015-08-05 10:49:05.0 |
lastUpdateDate | Data da última atualização do objeto | 2015-08-05 10:49:05.0 |
numberComments | Número de comentários do objeto | 2 |
numberDenouncemets | Número de denúncias do objeto | 1 |
numberLikes | Número de apoios do objeto | 2 |
numberShares | Número de compartilhamentos do objeto | 2 |
numberWatchers | Número de pessoas que acompanham o objeto | 2 |
text | Texto do objeto | Novo artigo |
authorAlias | Alias do autor do objeto | john |
authorName | Nome do autor do objeto | John Steel |
CommentDataset - Dataset dos comentários realizados
* fluig 1.3.0 ou superior
Este dataset pode ser utilizado para fornecer os comentários realizados pelos usuários. Acompanhe a seguir os detalhes dos campos disponíveis:
Coluna | Descritivo | Exemplo de Valor |
|---|---|---|
commentId | Id do post | 3 |
creationDate | Data em que o comentário foi criado | 2015-08-05 10:49:05.0 |
lastUpdateDate | Data da última atualização do comentário | 2015-08-05 10:49:05.0 |
numberDenouncemets | Número de denúncias do comentário | 1 |
numberLikes | Número de apoios do comentário | 2 |
isRemoved | Indicador se o comentário foi removido | 1 - true / 0 - false |
url | URL do conteúdo onde foi realizado o comentário | "/ecmnavigation?app_ecm_navigation_doc=182&app_ecm_navigation_docVersion=1000" |
commentText | Texto do comentário | "Boa inciativa!" |
hasMentions | Indicador se existe menção no comentário | 1 - true / 0 - false |
link | Link contido no comentário | |
postId | Id Social onde o comentário foi realizado. Nos casos de post será o id do post, para os casos de documentos, vira o id social do documento | 3 |
socialId | Id Social de quem realizou o post | 4 |
author | Login do autor do comentário | "john" |
authorName | Nome do autor do comentário | "John Steel" |
CommunityDataset - Dataset das comunidades
* fluig 1.3.0 ou superior
Este dataset pode ser utilizado para recuperar as comunidades. Acompanhe a seguir os detalhes dos campos disponíveis:
Coluna | Descritivo | Exemplo de Valor |
|---|---|---|
alias | Alias da comunidade | "RH" |
creationDate | Data em que o comentário foi criado | 2015-08-05 10:49:05.0 |
lastUpdateDate | Data da última atualização do comentário | 2015-08-05 10:49:05.0 |
name | Nome da comunidade | "RH - Plantão" |
description | Descrição da comunidade | "O canal direto de informações entre a empresa e os funcionários." |
isApprovalRequired | Indicador se a comunidade precisa de aprovação para participar | True / False |
isPrivateContent | Indicador se a comunidade tem conteúdo privado | True / False |
isHidden | Indicador se a comunidade é oculta | True / False |
isActive | Indicador se a comunidade está ativa | True / False |
articleFolder | Id da pasta de artigos da comunidade | 12 |
formFolder | Id da pasta de formúlarios da comunidade | 45 |
photoFolder | Id da pasta de imagens da comunidade | 32 |
documentFolder | Id da pasta de documentos da comunidade | 10 |
videoFolder | Id da pasta de videos da comunidade | 9 |
ParticipantDataset - Dataset dos participantes das comunidades
* fluig 1.3.0 ou superior
Este dataset pode ser utilizado para fornecer os usuários que participam das comunidades. Acompanhe a seguir os detalhes dos campos disponíveis:
Coluna | Descritivo | Exemplo de Valor |
|---|---|---|
communityAlias | Alias da comunidade | "RH" |
participantAlias | Alias do participante da comunidade | "john" |
panticipantName | Nome do participante da comunidade | "John Steel" |
isAdministrator | Indicador se o participante é administrador da comunidade | 1 - true |
isModerator | Indicador se o participante é moderador da comunidade | 1 - true |
FollowerDataset - Dataset dos usuários que estão seguindo
* fluig 1.3.0 ou superior
Este dataset pode ser utilizado para fornecer os usuários que seguem outros usuários. Acompanhe a seguir os detalhes dos campos disponíveis:
Coluna | Descritivo | Exemplo de Valor |
|---|---|---|
followerAlias | Alias do seguidor | "john" |
followedAlias | Alias do seguido | "ana" |
followerName | Nome do seguidor | "John Steel" |
followedName | Nome do seguido | "Anna Smyth" |
FollowedDataset - Dataset dos usuários que são seguidos
* fluig 1.3.0 ou superior
Este dataset pode ser utilizado para fornecer os usuários que são seguidos por outros usuários. Acompanhe a seguir os detalhes dos campos disponíveis:
Coluna | Descritivo | Exemplo de Valor |
|---|---|---|
followerAlias | Alias do seguidor | "john" |
followedAliad* | Alias do seguido | "ana" |
followerName | Nome do seguidor | "John Steel" |
followedName | Nome do seguido | "Anna Smyth" |
*Obs: O campo followedAliad está documento conforme o retorno do dataset
Datasets de Documentos
...
AccessLog - Log de acesso aos documentos
Lista o log de acessos aos documentos registrados pela plataforma.
| Coluna | Descritivo | Valor de Exemplo |
|---|---|---|
| AccessLogPK.documentId | Código do documento | 10903 |
| AccessLogPK.accessDate | Data em que ocorreu o acesso | 2018-08-29 |
| AccessLogPK.colleagueId | Matrícula do usuário | fernando.alves |
| AccessLogPK.companyId | Código da empresa | 102 |
documentApprovalHistory - Histórico de aprovações do documento
* Atualização 1.4.11 ou superior
| Coluna | Descritivo | Exemplo de Valor |
|---|---|---|
movementDate | Data de aprovação/reprovação do documento | 2015-04-22T00:00:00-03:00 |
movementTime | Hora de aprovação/reprovação do documento | 11:04:06 |
observation | Observação ao aprovar/rejeitar o documento | "Comentário do colaborador" |
colleagueId | Id do colaborador | 0000288 |
| approvalMovementPK.companyId | Id da empresa | 0000001 |
| approvalMovementPK.documentId | Id do documento | 10903 |
| signed | Movimento foi assinado digitalmente | false |
| approvalMovementPK.version | Versão do documento | 1000 |
| analised * | Se o documento passou por uma aprovação/reprovação manual | true |
| sendDate | Data em que o documento foi enviado para aprovação | 2015-04-22T00:00:00-03:00 |
| approvalMovementPK.iterationSequence | Número de sequência da movimentação | 1 |
| closeIteraction | Se é a última aprovação para que o documento seja publicado | true |
| approvalMovementPK.levelId | Nível de aprovação | 2 |
| Informações | ||
|---|---|---|
| ||
Este item informa se o aprovador aceitou o item. |
document - Lista todos os documentos e suas respectivas versões
* Atualização 1.0 ou superior
| Coluna | Descritivo | Exemplo de Valor | |||||
|---|---|---|---|---|---|---|---|
lastModifiedTime | Data da última modificação no documento | 2015-08-14T15:09:13.819-03:00 | |||||
documentType | Tipo do documento
| 1 | |||||
parentDocumentId | Número do documento pai
| 0 | |||||
metaListRecordId | Sequencia do registro na tabela específica de meta lista
| 13 | |||||
| documentDescription | Descrição do documento | "Solicitação de compras" | |||||
| cardDescription | Campo que corresponde a descrição do formulário
| num_solicitacao | |||||
| convertDocumentType | Tipo de conversão do documento | ||||||
| translated | Propriedade que indica se o documento foi traduzido | true / false | |||||
| visualization | Visualização do documento | ||||||
| approved | Propriedade que indica se o documento foi aprovado ou não | true / false | |||||
| pdfRenderEngine | Propriedade que indica se o documento utiliza o motor de renderização PDF Render | ||||||
| mimetype | Descrição do tipo de mídia | text/html | |||||
| relatedFiles | Relação de arquivos relacionados, incluindo o arquivo principal e anexos | Solicitacao_de_Compras.html Solicitacao_de_Compras.js | |||||
| expires | Propriedade que define se o documento está expirado | true / false | |||||
| approvalAndOr | Propriedade que indica se há aprovadores AND e OR | true / false | |||||
| priority | Prioridade do documento | 0 | |||||
| downloadEnabled | Propriedade que indica se o documento está habilitado para download | true / false | |||||
| statusArmazLongoPrazo | Status do armazenamento a longo prazo do documento | ||||||
| updateIsoProperties | Propriedade que indica se atualiza as propriedades da ISO | true / false | |||||
| expirationDate | Data de expiração do documento | 2016-11-16T00:00:00-02:00 | |||||
| checkoutFolder | Propriedade que indica se o documento é a pasta Check-out
| true / false | |||||
| volumeId | Volume em que o documento pertence | Default | |||||
| usedQuota | Informa o quanto de espaço já foi utilizado na cota disponível (valores em MB) | 1.64712 | |||||
| atualizationId | Propriedade que indica o documento de atualização | 0 | |||||
| inheritApprovers | Propriedade que define se herda aprovações do pai | true / false | |||||
| deleted | Propriedade que indica se o documento está excluido | true / false | |||||
| privateDocument | Propriedade que indica se é um documento privado, ou seja, se está abaixo da pasta Meus Documentos | true / false | |||||
| size | Informa o tamanho do arquivo (valores em MB) | 0.00227165 | |||||
| documentTypeId | Tipo do arquivo físico, se retornar branco ou nulo é porque esse tipo não é conhecido pela plataforma | Contratos | |||||
| imutable | Propriedade que define se a versão/revisão é inalterável | true / false | |||||
| datasetName | O nome do dataset a qual o documento pertence
| dts_form_solicitacao_de_compras | |||||
| topicId | Código do assunto do documento | 1 | |||||
| documentPK.documentId | Número do documento | 82 | |||||
| processingBatch | Propriedade que indica se o documento está ainda em processamento | true / false | |||||
| externalDocumentId | Propriedade que indica se o documento possui alguma relação com um documento externo | ||||||
| permissionType | Tipo de permissão | 0 | |||||
| colleagueId | Matricula do usuário que criou o documento | "fernando.alves" | |||||
| indexed | Propriedade que define se o documento já foi indexado | true / false | |||||
| phisicalFile | Nome do arquivo físico atrelado ao documento | Solicitação_de_Compras.html | |||||
| keyWord | Palavras chaves do documento | "tag" | |||||
| documentPropertyNumber | Código do formulário base
| 80 | |||||
| inheritSecurity | Propriedade que define se herda segurança do pai | true / false | |||||
| quota | Cota atribuída para a pasta (valores em MB)
| 100 | |||||
| additionalComments | Comentários adicionais do documento | "Comentário adicional" | |||||
| crc | Cyclic Redundancy Check (identificação do conteúdo do documento) | 1749708947 | |||||
| documentPropertyVersion | Versão do formulário em que o registro de formulário foi criado
| 1000 | |||||
| uUID | UUID (identificador Único Global) do documento | 313DB013-DBE2-4ADB-BC0D-9BE76EEC1BFB | |||||
| documentPK.companyId | Código da empresa em que o documento foi publicado | 1 | |||||
| createDate | Data de criação do documento | 2016-10-27T00:00:00-02:00 | |||||
| activeVersion | Propriedade que define se a versão é ativa | true / false | |||||
| publisherId | Matricula do usuário que publicou o documento | "fernando.alves" | |||||
| versionDescription | Descrição da versão | "Informações da versão" | |||||
| validationStartDate | Data a partir da qual o documento poderá ser visualizado | 2016-11-16T00:00:00-02:00 | |||||
| metaListId | Código de qual meta lista o documento pertence
| 40 | |||||
| userNotify | Propriedade que define se notifica os usuários que tenham esse assunto de interesse | true / false | |||||
| approvedDate | Data de Aprovação | 2016-11-16T00:00:00-02:00 | |||||
| privateColleagueId | Se é um documento particular retorna a matricula do usuário onde este documento está alocado | "fernando.alves" | |||||
| allowMultiCardsPerUser | Propriedade que indica se permite muitos formulários por usuário | true / false | |||||
| languageId | Código do Idioma do documento | "pt_BR" | |||||
| siteCode | Código do volume no qual o documento pertence | "Fluig" | |||||
| notificationDays | Periodo, em dias, para notificação de expiração do documento | 40 | |||||
| socialDocument | Documento social | ||||||
| restrictionType | Tipo de restrição | 0 | |||||
| draft | Propriedade que define se o documento está em edição
| true / false | |||||
| onlyActiveRows | Propriedade que indica se o documento é ativo
| true / false | |||||
| pdfConversionStatus | Indica o status de conversão do documento para PDF | 0 | |||||
| accessCount | Número de acessos ao documento | 10 | |||||
| lastModifiedDate | Data da última modificação | 2016-11-16T00:00:00-02:00 | |||||
| iconId | Código do Ícone do documento | 67 | |||||
| documentPK.version | Número da versão do documento | 1000 |
allocatedDocument - Documentos em check-out
Lista os documentos que estão em check-out. Para saber mais sobre o check-out, consulte nossa documentação de usuário Plataforma ❙ Efetuar check-out do documento.
| Coluna | Descritivo | Valor de Exemplo | |||||
|---|---|---|---|---|---|---|---|
| allocatedDocumentPK.companyId | Código da empresa | 1 | |||||
| allocatedDocumentPK.destinationDocument | Código do documento a ser alterado na pasta particular | 12903 | |||||
| allocatedDocumentPK.sourceDocument | Código do documento original | 10654 | |||||
| allocatedDocumentPK.sourceVersion | Versão do documento original | 1000 | |||||
| checkoutDate | Data em que o check-out do documento foi realizado | 2018-08-29 | |||||
| active | Indica se o documento está ativo | true / false | |||||
| colleagueId | Matrícula do usuário responsável pelo check-out | fernando.alves | |||||
| comment | Comentário realizado no momento do check-out | Vou editar porque... | |||||
| checkoutTime | Hora em que o check-out do documento foi realizado | 165723 | |||||
| checkoutAllowed |
| ||||||
| checkinDate |
| ||||||
| checkinTime |
|
customFields - Campos customizados dos documentos
Lista os Plataforma ❙ Campos customizados dos documentos.
| Coluna | Descritivo | Valor de Exemplo |
|---|---|---|
| customFieldsPK.customFieldId | Código do campo customizado | 1 |
| customFieldDescription | Descrição do campo customizado | Quantidade de páginas |
| customFieldsPK.companyId | Código da empresa | 102 |
| alwaysShow | Indica se está habilitado para mostrar em todos os documentos | true / false |
destinationArea - Área dos documentos
Lista as Áreas cadastradas para os documentos.
| Coluna | Descritivo | Valor de Exemplo | |||||
|---|---|---|---|---|---|---|---|
| areaDescription | Descrição da área do documento | Administrativo | |||||
| managerId | Matrícula do responsável pela área | fernando.alves | |||||
| destinationAreaPK.companyId | Código da empresa | 102 | |||||
| destinationAreaPK.areaId | Código da área do documento | 1 | |||||
| userId |
| ||||||
| executionServerId |
|
documentSecurityConfig - Segurança dos documentos
Retorna a configuração de segurança dos documentos.
| Coluna | Descritivo | Valor de Exemplo | |||||
|---|---|---|---|---|---|---|---|
| attributionValue | Valor do atributo de segurança | 6kopfwg3gyubqq1444419140949 | |||||
| documentSecurityConfigPK.documentId | Código do documento | 10903 | |||||
| downloadEnabled | Indica se está habilitado o download do documento | true / false | |||||
| showContent | Indica se está habilitada a visualização do conteúdo do documento | true / false | |||||
| documentSecurityConfigPK.companyId | Código da empresa | 102 | |||||
| permission | Indica se o documento tem permissão | true / false | |||||
| securityLevel | Nível de permissão de acesso ao documento
| 3 | |||||
| inheritOriginSecurity | Propriedade que define se herda segurança | true / false | |||||
| documentSecurityConfigPK.sequence | Sequência de prioridade do registro da segurança | 1 | |||||
| inheritSecurity | Propriedade que define se herda segurança | true / false | |||||
| documentSecurityConfigPK.version | Versão do documento | 1000 | |||||
| attributionType | Define a atribuição da segurança.
| 1 | |||||
| securityVersion |
|
knowledge - Conhecimento dos documentos
Retorna as visualizações dos documentos, indicando quando foi realizada a primeira e a última visualização.
| Coluna | Descritivo | Valor de Exemplo | |||||
|---|---|---|---|---|---|---|---|
| knowledgePK.companyId | Código da empresa | 102 | |||||
| knowledgePK.documentId | Código do documento | 10903 | |||||
| knowledgePK.version | Versão do documento | 1000 | |||||
| knowledgePK.colleagueId | Matrícula do usuário que visualizou o documento | fernando.alves | |||||
| firstView | Primeira visualização (tempo em formato Long) | 1444839211480 | |||||
| lastView | Última visualização (tempo em formato Long) | 1530553535848 | |||||
| lastViewedTime |
| ||||||
| lastViewed |
| ||||||
| knowledgeDate |
| ||||||
| versionDescription |
|
topic - Assuntos dos documentos
Lista os assuntos dos documentos.
| Coluna | Descritivo | Valor de Exemplo |
|---|---|---|
| updateEmail | Indica se está habilitada a notificação de atualização do assunto | true / false |
| topicPK.topicId | Código do assunto | 1 |
| removeEmail | Indica se está habilitada a notificação de eliminação do assunto | true / false |
| description | Descrição do assunto | Eventos |
| mandatory | Indica se o assunto é obrigatório | true / false |
| topicPK.companyId | Código da empresa | 102 |
Datasets de Processos
...
processHistory - Histórico de solicitações workflow
* fluig 1.0 ou superior
O dataset de histórico de processos permite consultar os dados de uma solicitação em andamento, finalizada ou cancelada de processos cadastrados. Acompanhe a seguir os detalhes:
Coluna | Descritivo | Valor de Exemplo |
|---|---|---|
companyId | Código da empresa. | 102 |
processInstanceId | Número da solicitação. | 24254 |
movementSequence | Corresponde a quantidade de movimentações da solicitação workflow corrente. | 2 |
active | Status da atividade. Qual atividade está ativa no momento. | 0 ou false; 1 ou true; |
movementDate | Data que foi feita a movimentação da atividade. | 2015-08-22 |
movementHour | Hora exata em que a atividade foi movimentada. | 11:41:23 |
stateSequence | Código da atividade que foi movimentada. | 4 |
subProcessId | Código do subprocesso. | 0 |
threadSequence | Número da Thread de movimentação. Irá variar quando ocorrer alguns paralelismos na solicitação workflow. Ex.: processos com Fork/Join. | int |
previousMovementSequence | Qual fluxo foi movimentado no passo anterior. | 5 |
conversionSequence | Informa se a solicitação workflow foi convertida. Se o valor for igual a “0” (zero), esta solicitação nunca foi convertida até o presente momento. | int |
automaticLink | Define se o fluxo para a atividade é automático ou se necessita ser movimentado pelo usuário. | 0 ou false; 1 ou true; |
returnLink | Permite retornar para a atividade de origem do fluxo. | 0 ou false; 1 ou true; |
processTask - Tarefas das solicitações de processos workflow
* fluig 1.0 ou superior
O dataset de tarefas das solicitações de processos permite consultar dados das tarefas de uma solicitação. Acompanhe a seguir os detalhes:
Coluna | Descritivo | Valor de Exemplo | |||||
|---|---|---|---|---|---|---|---|
processTask.companyId | Código da empresa. | 102 | |||||
processTask.processInstanceId | Número da solicitação. | 24254 | |||||
processTask.movementSequence | Corresponde a quantidade de movimentações da solicitação workflow corrente. | 2 | |||||
| choosedColleagueId | Código da matrícula do responsável escolhido para a tarefa. | adm | |||||
| choosedSequence | Numero da atividade. | Número interno exemplo 6 | |||||
status | Status da atividade. Estado em que ela se encontra. | 0 - Não completada; 1 - Em consenso 2 - Completa 3 - Transferida 4 - Cancelada | |||||
active | Informa se a tarefa está ativa ou não. | 0 ou false; 1 ou true; | |||||
| taskObservation | Mostra os complementos adicionados na tarefa. | "Registrado documento"
| |||||
noticeExpirationRequisitionerDate | Caso esteja marcada a opção de notificar expiração da tarefa para o requisitante, registra a data de notificação. | 2015-08-22 | |||||
noticeExpirationRequisitionerHour | Caso esteja marcada a opção de notificar expiração da tarefa para o requisitante, registra a hora de notificação. | em milisegundos | |||||
noticeExpirationAuthorityDate | Caso esteja marcada a opção de notificar expiração da tarefa para o responsável, registra a data de notificação. | 2015-08-22 | |||||
noticeExpirationAuthorityHour | Caso esteja marcada a opção de notificar expiração da tarefa para o responsável, registra a hora de notificação. | Em milisegundos | |||||
noticeExpirationManagerDate | Caso esteja marcada a opção de notificar expiração da tarefa para o gestor, registra a data de notificação. | 2015-08-22 | |||||
noticeExpirationManagerHour | Caso esteja marcada a opção de notificar expiração da tarefa para o gestor, registra a data de notificação. | Em milisegundos | |||||
taskCompletionDate | Mostra a data de conclusão de uma tarefa. | 2017-06-02T00:00:00-03:00
| |||||
taskCompletionHour | Mostra a hora de conclusão de uma tarefa. | 40533
| |||||
| initialTermDate | Caso configurado no processo, mostra a data de início a contar para conclusão da tarefa. | 2017-06-01T00:00:00-03:00
| |||||
| initialTermHour | Caso configurado no processo, mostra a hora de início a contar para conclusão da tarefa. | 51661
| |||||
| deadlineDate | Caso configurado no processo, mostra a data final para conclusão da tarefa. | 2017-06-02T00:00:00-03:00
| |||||
deadlineHour | Caso configurado no processo, mostra a hora final para conclusão da tarefa. | 40533
| |||||
| closureStatus | Marca o status da tarefa, se está em aberto (0) ou se foi finalizada no prazo (1), dentro do tempo de aviso de expiração (2) ou após expirada (3) | int de 0 a 3. Em aberto - 0; Finalizada no prazo - 1; Aviso de expiração - 2; Expirada - 3. | |||||
| startDate | Indica a data e hora que foi movimentado para a atividade. Transferências não modificam esta data. | 2017-06-02T11:15:32-03:00 | |||||
| assignDate | Indica a data e hora que foi criada a tarefa. Ao transferir uma atividade, a hora da transferência é associada aqui. | 2017-06-02T11:15:32-03:00 | |||||
assignEndDate | Indica data e hora que a tarefa foi concluída ou transferida pelo responsável. | 2017-06-02T11:15:32-03:00 1 - Uma tarefa que foi transferida e depois concluída, o assignEndDate vai marcar a data da transferência e a endDate vai marcar a data da conclusão. 2 - Em uma tarefa em consenso, quando um responsável tomou sua decisão vai gravar no assignEndDate, quando o consenso foi atingido, vai gravar na endDate. 3 - Em uma tarefa simples, onde apenas um usuário movimentou, os dois campos terão o mesmo valor. | |||||
endDate | Indica data e hora que a atividade foi concluída em todas as situações, não somente pelo responsável. Exemplo, consenso, múltiplas transferências. | 2017-06-02T11:15:33-03:00 1 - Uma tarefa que foi transferida e depois concluída, o assignEndDate vai marcar a data da transferência e a endDate vai marcar a data da conclusão. 2 - Em uma tarefa em consenso, quando um responsável tomou sua decisão vai gravar no assignEndDate, quando o consenso foi atingido, vai gravar na endDate. 3 - Em uma tarefa simples, onde apenas um usuário movimentou, os dois campos terão o mesmo valor. | |||||
| warningDate | Indica a data e hora em que a tarefa passa a ser considerada em alerta. | 2017-06-02T11:15:32-03:00 | |||||
| deadline | Indica a data e hora de expiração da atividade. | 2017-06-02T11:15:32-03:00 | |||||
| completeColleagueId |
processState - Atividades do processo
* fluig 1.5.1 ou superior
O dataset de atividades do processo permite identificar as configurações de uma atividade. Acompanhe a seguir os detalhes:
| Coluna | Descritivo | Valor de exemplo |
|---|---|---|
| notifyRequistionerFollowUp | Se atividade notifica requisitante quando solicitação a abre. | true e false |
| joint | Se atividade é uma atividade conjunta. | true e false |
| digitalSignature | Se atividade solicita assinatura digital para ser movimentada. | true e false |
| forecastedEffort | Esforço previsto indicado no cadastro da atividade em segundos. | 1000 |
| executionType | Tipo de execução da atividade caso for uma atividade de serviço. | 0 - Manual (modelo antigo) 1 - Posterior à abertura 2 - Imediata à abertura |
| frequenceRequisitionerTime | Frequência entre as notificações de atraso para o requisitante em segundos. | 1000 |
| transferAttachments | Se a atividade transfere anexos da solicitação principal para a nova solicitação caso for uma atividade de sub processo. | true e false |
| cancelSubProcess | Se permite cancelar solicitação pai com uma sub solicitação aberta caso a atividade marcada seja de sub processo que originou aquela solicitação. | true e false |
| notifyManagerDelay | Se notifica gestor do processo no caso da atividade estar em atraso. | true e false |
| positionX | Posição vertical da atividade no desenho do processo. | 100 |
| positionY | Posição horizontal da atividade no desenho do processo. | 100 |
| notifyAuthorityFollowUp | Se atividade notifica responsável quando solicitação a abre. | true e false |
| processStatePk.sequence | Identificador da sequência da atividade. | 4 |
| stateName | Nome da atividade. | AtividadeTeste |
| join | Se atividade é um JOIN (junção de ramificações partindo de uma atividade de tipo FORK). | true e false |
| noticeExpirationAuthorityTime | Tempo após prazo expirado para o responsável ser notificado em segundos. | 1000 |
| subProcessId | Identificador do sub processo atrelado a esta atividade caso esta seja uma atividade de sub processo. | PROCESSO_A |
| formFolder | Pasta no GED onde se encontra formulário, depreciado, pois não há separação de formulários por atividades. | |
| notifyAuthorityDelay | Se a atividade notifica responsável caso esteja atrasada. | true e false |
| engineAllocationConfiguration | Configuração, em XML, do mecanismo de atribuição do responsável para essa atividade. | <AssignmentController> <BaseActivity>3</BaseActivity> <Returns>First</Returns> </AssignmentController> |
| inhibitTransfer | Se a atividade não permite apresentar a opção de transferir para outro responsável. | true e false |
| counterSign | Se atividade exige que o usuário coloque sua senha para que possa ser movimentada. | true e false |
| subProcess | Se a atividade é um sub processo, depreciado, não é populado em momento algum. | |
| noticeExpirationRequisitionerTime | Tempo em segundos após prazo expirado para o requisitante ser notificado. | 1000 |
| processStatePk.version | Versão do processo a qual esta atividade pertence. | 2 |
| stateDescription | Descrição da atividade. | AtividadeTeste |
| agreementPercentage | Percentual de aceitação para uma atividade conjunta ser movimentada. | 75 |
| forecastedEffortType | Como atividade deve controlar esforço previsto. | 0 - Não controla 1 - Esforço Estimado / Previsto 2 - Apontamento de Horas 3 - Tempo de Conclusão |
| noticeExpirationManagerTime | Tempo em segundos após prazo expirado para o gestor ser notificado. | 1000 |
| deadlineTime | Prazo da atividade em segundos. | 1000 |
| initialState | Se atividade é uma atividade inicial. | true e false |
| allowanceManagerTime | Tempo de tolerância até o primeiro aviso de atividade atrasada para o gestor em segundos. | 1000 |
| stateType | Tipo da atividade. Utilizado pelo modelador Web. | 0 - Atividade comum / simples 1 - Atividade automática / Gateways 2 - Atividade de sub processo 3 - Fork 4 - Join |
| engineAllocationId | Identificador do mecanismo de atribuição utilizado para esta atividade. | Executor Atividade |
| selectColleague | Se atividade exige ou não a seleção de usuários caso haja múltipla seleção. | true e false |
| deadlineFieldName | Identificador do campo de formulário responsável por atribuir prazo caso este seja o formato da atividade. | textbox_0 |
| allowanceRequistionerTime | Tempo de tolerância até o primeiro aviso de atividade atrasada para o requisitante em segundos. | 1000 |
| processStatePK.processId | Identificador do processo ao qual esta atividade pertence. | PROCESSO_B |
| parentSequence | Atividade a qual esta está anexada, apenas utilizado para o evento de captura de erro em relação a atividade de serviço. | 3 |
| frequenceManagerTime | Tempo em segundos de frequência entre as notificações de atraso para o gestor. | 1000 |
| periodId | Identificador do expediente caso este seja diferente da solicitação como um todo para esta atividade em específico. | Default |
| allowanceAuthorityTime | Tempo de tolerância até o primeiro aviso de atividade atrasada para o responsável em segundos. | 1000 |
| automatic | Se a atividade é automática / gateway. | true e false |
| bpmnType | Tipo BPMN da atividade, utilizado pelo Studio ao processar desenhos de processo. | 10 - Início normal 11 - Início por mensagem (não utilizado) 12 - Início por timer 13 - Início por timer condicional 14 - Início por sinal 15 - Início por múltiplo paralelo (não utilizado) 16 - Início por evento múltiplo (não utilizado) 30 - Evento intermediário normal 31 - Evento intermediário por mensagem (não utilizado) 32 - Evento intermediário por timer 33 - Evento intermediário de escala (não utilizado) 34 - Evento intermediário de compensação (não utilizado) 35 - Evento intermediário de timer condicional 36 - Evento intermediário de ligação 37 - Evento intermediário de sinal 38 - Evento intermediário múltiplo paralelo (não utilizado) 39 - Evento intermediário de evento múltiplo (não utilizado) 40 - Evento intermediário de recepção de mensagem (não utilizado) 41 - Evento intermediário de recepção de sinal 42 - Evento intermediário de recepção de ligação 43 - Evento intermediário de erro 60 - Evento de finalização normal 61 - Evento de finalização por mensagem (não utilizado) 62 - Evento de finalização de escala (não utilizado) 63 - Evento de finalização por erro 64 - Evento de finalização de sinal 65 - Evento de finalização por cancelamento 66 - Evento de finalização múltiplo (não utilizado) 67 - Evento de finalização de compensação (não utilizado) 68 - Evento de finalização imediata 80 - Atividade simples 81 - Atividade de usuário 82 - Atividade de serviço 83 - Atividade de recepção 84 - Atividade de e-mail 85 - Atividade manual 86 - Atividade de regra de negócio 87 - Atividade de script 100 - Sub processo 101 - Ad Hoc 120 - Automática exclusiva 121 - Automática inclusiva 122 - Evento Gateway (não utilizado) 123 - Evento Gateway Exclusivo (não utilizado) 124 - Evento Gateway Paralelo (não utilizado) 125 - Gateway Complexo (não utilizado) 126 - Fork 127 - Join 140 - Sem laço (não utilizado) 141 - Laço padrão (não utilizado) 142 - Laço paralelo (não utilizado) |
| fork | Se a atividade é um Gateway que inicia paralelismo, na base ver stateType. | true e false |
| notifyManagerFollowUp | Se atividade notifica gestor quando solicitação a abre. | true e false |
| processStatePK.companyId | Código da empresa a qual processo pertence. | 1 |
| frequenceAuthorityTime | Frequência entre as notificações de atraso para o responsável em segundos. | 1000 |
| instruction | Descrição das instruções da atividade. | Texto |
| signalId | Identificador do sinal que é disparado ou recebido caso a atividade seja um emissor ou receptor de sinal respectivamente. | 3 |
| notifyRequisitionerDelay | Se notifica requisitante do processo no caso da atividade estar em atraso. | true e false |
workflowProcess - Solicitações de processos
* fluig 1.5.1 ou superior
O dataset de solicitações de processos permite buscar dados sobre solicitações em andamento ou fechadas. Acompanhe a seguir os detalhes:
Coluna | Descritivo | Valor de Exemplo |
|---|---|---|
workflowProcessPK.processInstanceId | Código da solicitação. | 102 |
attachmentSeqId | Código sequencial do anexo onde está localizado o registro de formulário do processo. | 1 |
cardIndexDocumentId | Código do documento que representa o formulário com o qual o processo está relacionado. | 15 |
startDateProcessFromHistory | Data da primeira movimentação segundo o primeiro registro em HISTOR_PROCES, variável transiente, descontinuada e não populada, utilizar startDateProcess. | |
expired | Indica se a última atividade aberta da solicitação está atrasada. Variável transiente, descontinuada e não populada. Tratamentos de SLA devem ser feitos via api /process-management/api/v2. | |
workflowProcessPK.companyId | Código da empresa. | 1 |
closureStatus | Código de finalização do processo dependendo do SLA da solicitação como um todo (não por atividade). | 0 - Aberta 1 - No Prazo 2 - Em Aviso 3 - Em Atraso |
processId | Código do processo. | PROCESSO_A |
startDateProcess | Data de início da solicitação. | 2017-06-02T11:15:32-03:00 |
cardDocumentId | Código do documento que representa o registro de formulário vinculado a solicitação. | 550 |
periodId | Código do expediente do processo no momento em que a solicitação foi aberta. | Default |
totalWarning | Tempo em segundos total entre início da data de aviso e fim do prazo da solicitação. | 1280 |
requesterId | Código da matrícula do usuário que abriu a solicitação. | user |
| sourceProcess | Código da solicitação que originou esta caso seja um sub processo. | PROCESSO_B |
| totalDeadline | Tempo em segundos do início da solicitação até a data do prazo. | 1560 |
| notifyDelay | Se a solicitação avisa em caso de atraso. | true ou false |
| endDateProcess | Data de encerramento da solicitação. | 2017-06-02T11:15:32-03:00 |
| active | Se a solicitação está ativa. | true ou false |
| sourceThreadSequence | Código da ramificação onde está a atividade de sub processo que originou essa solicitação caso ela seja proveniente de uma outra solicitação. | 0 |
| version | Código da versão do processo que originou esta solicitação. | 3 |
| uUID | Identificador interno único da solicitação gerado pelo sistema. | CA9E4715-B7E2-4BB9-BACE-26EFCBC33299 |
| totalRuntime | Tempo em segundos considerando expediente entre a abertura e o encerramento da solicitação | 1100 |
| deadlineDate | Data de prazo da solicitação como um todo |
...
Código do formulário base
| Informações | ||
|---|---|---|
| ||
Informação válida somente para formulários e seus respectivos registros |
...
Cota atribuída para a pasta (valores em MB)
| Informações | ||
|---|---|---|
| ||
Informação válida somente para pastas |
...
Comentários adicionais do documento
...
Versão do formulário em que o registro de formulário foi criado
| Informações | ||
|---|---|---|
| ||
Informação válida somente para formulários e seus respectivos registros |
...
Código de qual meta lista o documento pertence
| Informações | ||
|---|---|---|
| ||
Informação válida somente para formulários e seus respectivos registros |
...
Código do volume no qual o documento pertence
...
Propriedade que define se o documento está em edição
| Informações | ||
|---|---|---|
| ||
Informação válida somente para "Novos conteúdos" |
...
Propriedade que indica se o documento é ativo
| Informações | ||
|---|---|---|
| ||
Informação válida somente para formulários |
...
allocatedDocument - Documentos em check-out
Lista os documentos que estão em check-out. Para saber mais sobre o check-out, consulte nossa documentação de usuário Efetuar check-out do documento.
...
| Informações | ||
|---|---|---|
| ||
Campo depreciado |
...
| Informações | ||
|---|---|---|
| ||
Campo depreciado |
...
| Informações | ||
|---|---|---|
| ||
Campo depreciado |
customFields - Campos customizados dos documentos
Lista os Campos Customizados dos documentos.
...
destinationArea - Área dos documentos
Lista as Áreas cadastradas para os documentos.
...
| Informações | ||
|---|---|---|
| ||
Campo depreciado |
...
| Informações | ||
|---|---|---|
| ||
Campo depreciado |
documentSecurityConfig - Segurança dos documentos
Retorna a configuração de segurança dos documentos.
...
Nível de permissão de acesso ao documento
| Informações | ||
|---|---|---|
| ||
Os níveis são: -1 - Sem Permissão, 0 - L (Leitura), 1 - G (Gravação), 2 - M (Modificação) ou 3 - T (Total) |
...
Define a atribuição da segurança.
| Informações | ||
|---|---|---|
| ||
Os tipos são: 1 - Colaborador, 2 - Grupo, ou all - Todos |
...
| Informações | ||
|---|---|---|
| ||
Campo depreciado |
knowledge - Conhecimento dos documentos
Retorna as visualizações dos documentos, indicando quando foi realizada a primeira e a última visualização.
...
| Informações | ||
|---|---|---|
| ||
Campo depreciado |
...
| Informações | ||
|---|---|---|
| ||
Campo depreciado |
...
| Informações | ||
|---|---|---|
| ||
Campo depreciado |
...
| Informações | ||
|---|---|---|
| ||
Campo depreciado |
topic - Assuntos dos documentos
Lista os assuntos dos documentos.
...
Datasets de Processos
processHistory - Histórico de solicitações workflow
* fluig 1.0 ou superior
O dataset de histórico de processos permite consultar os dados de uma solicitação em andamento, finalizada ou cancelada de processos cadastrados. Acompanhe a seguir os detalhes:
...
Coluna
...
Descritivo
...
Valor de Exemplo
...
companyId
...
Código da empresa.
...
102
...
processInstanceId
...
Número da solicitação.
...
24254
...
movementSequence
...
Corresponde a quantidade de movimentações da solicitação workflow corrente.
...
2
...
active
...
Status da atividade. Qual atividade está ativa no momento.
...
0 ou false;
1 ou true;
...
movementDate
...
Data que foi feita a movimentação da atividade.
...
2015-08-22
...
movementHour
...
Hora exata em que a atividade foi movimentada.
...
11:41:23
...
stateSequence
...
Código da atividade que foi movimentada.
...
4
...
subProcessId
...
Código do subprocesso.
...
0
...
threadSequence
...
Número da Thread de movimentação. Irá variar quando ocorrer alguns paralelismos na solicitação workflow. Ex.: processos com Fork/Join.
...
int
...
previousMovementSequence
...
Qual fluxo foi movimentado no passo anterior.
...
5
...
conversionSequence
...
Informa se a solicitação workflow foi convertida. Se o valor for igual a “0” (zero), esta solicitação nunca foi convertida até o presente momento.
...
int
...
automaticLink
...
Define se o fluxo para a atividade é automático ou se necessita ser movimentado pelo usuário.
...
0 ou false;
1 ou true;
...
returnLink
...
Permite retornar para a atividade de origem do fluxo.
...
0 ou false;
1 ou true;
processTask - Tarefas das solicitações de processos workflow
* fluig 1.0 ou superior
O dataset de tarefas das solicitações de processos permite consultar dados das tarefas de uma solicitação. Acompanhe a seguir os detalhes:
Coluna | Descritivo | Valor de Exemplo | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
processTask.companyId | Código da empresa. | 102 | ||||||||
processTask.processInstanceId | Número da solicitação. | 24254 | ||||||||
processTask.movementSequence | Corresponde a quantidade de movimentações da solicitação workflow corrente. | 2 | ||||||||
| choosedColleagueId | Código da matrícula do responsável escolhido para a tarefa. | adm | ||||||||
| choosedSequence | Numero da atividade. | Número interno exemplo 6 | ||||||||
status | Status da atividade. Estado em que ela se encontra. | 0 - Não completada; 1 - Em consenso 2 - Completa 3 - Transferida 4 - Cancelada | ||||||||
active | Informa se a tarefa está ativa ou não. | 0 ou false; 1 ou true; | ||||||||
| taskObservation | Mostra os complementos adicionados na tarefa. | "Registrado documento"
| ||||||||
noticeExpirationRequisitionerDate | Caso esteja marcada a opção de notificar expiração da tarefa para o requisitante, registra a data de notificação. | 2015-08-22 | ||||||||
noticeExpirationRequisitionerHour | Caso esteja marcada a opção de notificar expiração da tarefa para o requisitante, registra a hora de notificação. | em milisegundos | ||||||||
noticeExpirationAuthorityDate | Caso esteja marcada a opção de notificar expiração da tarefa para o responsável, registra a data de notificação. | 2015-08-22 | ||||||||
noticeExpirationAuthorityHour | Caso esteja marcada a opção de notificar expiração da tarefa para o responsável, registra a hora de notificação. | Em milisegundos | ||||||||
noticeExpirationManagerDate | Caso esteja marcada a opção de notificar expiração da tarefa para o gestor, registra a data de notificação. | 2015-08-22 | ||||||||
noticeExpirationManagerHour | Caso esteja marcada a opção de notificar expiração da tarefa para o gestor, registra a data de notificação. | Em milisegundos | taskCompletionDate | Mostra a data de conclusão de uma tarefa. |
| Informações | ||
|---|---|---|
| ||
A partir da atualização 1.6.1, esta coluna será substituída por assignEndDate e endDate. |
taskCompletionHour
Mostra a hora de conclusão de uma tarefa.
40533
| Informações | ||
|---|---|---|
| ||
A partir da atualização 1.6.1, esta coluna será substituída por assignEndDate e endDate. |
2017-06-01T00:00:00-03:00
| Informações | ||
|---|---|---|
| ||
A partir da atualização 1.6.1, esta coluna será substituída por startDate e assignDate. |
51661
| Informações | ||
|---|---|---|
| ||
A partir da atualização 1.6.1, esta coluna será substituída por startDate e assignDate. |
2017-06-02T00:00:00-03:00
| Informações | ||
|---|---|---|
| ||
A partir da atualização 1.6.1, esta coluna será substituída por deadline. |
deadlineHour
40533
| Informações | ||
|---|---|---|
| ||
A partir da atualização 1.6.1, esta coluna será substituída por deadline. |
int de 0 a 3.
Em aberto - 0;
Finalizada no prazo - 1;
Aviso de expiração - 2;
Expirada - 3.
assignEndDate
2017-06-02T11:15:32-03:00
1 - Uma tarefa que foi transferida e depois concluída, o assignEndDate vai marcar a data da transferência e a endDate vai marcar a data da conclusão.
2 - Em uma tarefa em consenso, quando um responsável tomou sua decisão vai gravar no assignEndDate, quando o consenso foi atingido, vai gravar na endDate.
3 - Em uma tarefa simples, onde apenas um usuário movimentou, os dois campos terão o mesmo valor.
endDate
2017-06-02T11:15:33-03:00
1 - Uma tarefa que foi transferida e depois concluída, o assignEndDate vai marcar a data da transferência e a endDate vai marcar a data da conclusão.
2 - Em uma tarefa em consenso, quando um responsável tomou sua decisão vai gravar no assignEndDate, quando o consenso foi atingido, vai gravar na endDate.
3 - Em uma tarefa simples, onde apenas um usuário movimentou, os dois campos terão o mesmo valor.
2017-06-02T11:15:32-03:00
2017-06-02T11:15:32-03:00
advancedProcessProperties - inserir significado
*Inserir versão fluig
*Inserir resumo do que faz este dataset
...
advancedProcessPropertiesPK.propertyId
...
| status | Código do status da solicitação. | 0 - Aberto 1 - Cancelado 2 - Finalizado |
advancedProcessProperties - Propriedades Avançadas
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset advancedProcessProperties permite que se consulte as propriedades avançadas dos processos
| Coluna | Descritivo | Valor de exemplo |
|---|---|---|
advancedProcessPropertiesPK.propertyId | Nome do atributo | pastaDoDocumento |
| propertieValue | Valor do atributo | 54 |
| advancedProcessPropertiesPK.processId | Código do processo | PROCESSO_A |
| advancedProcessPropertiesPK.companyId | Código da empresa | 1 |
| advancedProcessPropertiesPK.version | Versão do processo | 2 |
businessPeriod -Cadastro de Expediente
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset businessPeriod permite que se consulte os expedientes cadastrado no fluig
| Coluna | Descritivo | Valor de exemplo | |||||
|---|---|---|---|---|---|---|---|
| businessPeriodPK.weekDay | Dia da Semana | 1 - Domingo 2 - Segunda-feira 3 - Terça-feira 4 - Quarta-feira 5 - Quinta-feira 6 - Sexta-feira 7 - Sábado | |||||
| businessPeriodPK.companyId | Código da empresa | 1 | |||||
| businessPeriodPK.sequence | Sequencial de ordem do horário no dia
| 2 | |||||
| initialHour | Horário de início em segundos
| 28800 | |||||
| businessPeriodPK.periodId | Código do Expediente | Default | |||||
| finalHour | Horário de final em segundos
| 43200 |
globalCalendar - Cadastro de feriados
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset globalCalendar permite que se consulte os feriados cadastrados no fluig. Este dataset está depreciado a partir da 1.6.2 e não deve mais ser utilizado. Utilize o dataset holiday.
...
businessPeriod - inserir significado
*Inserir versão fluig
*Inserir resumo do que faz este dataset
...
globalCalendar - inserir significado
*Inserir versão fluig
*Inserir resumo do que faz este dataset
| Coluna | Descritivo | Valor de exemplo | |
|---|---|---|---|
| holidayDay | Dia do feriado | 7 | |
| holidayYear | Ano do feriado | 2022 0 (caso seja um feriado recorrente, ou seja, anual) | |
| holidayMonth | Mês do feriado | 1 - Janeiro 2 - Fevereiro ... | |
| globalCalendarPK.holidayCalendarId | Descrição do feriado | Independência do Brasil | |
| globalCalendarPK.companyId | Código da empresa | 1 | |
| dayFormatted | Data do feriado | 02/10/1907-09-2022 (Formato dd-mm- | aa)aaaa) No caso de feriado recorrente, virá o ano conforme o que foi cadastrado, não 0. |
holiday -
...
Cadastro de feriados
* TOTVS Fluig Plataforma 1.6.2 ou superior
O dataset holiday permite que se consulte os feriados cadastrados no fluig.
*Inserir versão fluig
*Inserir resumo do que faz este dataset
| Coluna | Descritivo | Valor de exemplo |
|---|---|---|
| companyId | Código da empresa | 1 |
| holidayDay | Dia do feriado | 7 |
| holidayYear | Ano do feriado | 2022 0 (caso seja um feriado recorrente, ou seja, anual) |
| holidayMonth | Mês do feriado | 1 - Janeiro 2 - Fevereiro ... |
| id | código Código do feriado atribuído pela plataforma | 1 |
| HolidayCalendarIdholidayCalendarId | Descrição do feriado | Independência do Brasil |
| dayFormatted | Data do feriado |
processAttachment - inserir significado
*Inserir versão fluig
07-09-2022 (Formato dd-mm-aaaa) No caso de feriado recorrente, virá o ano conforme o que foi cadastrado, não 0. |
processAttachment - Cadastro de anexos em solicitações
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset processAttachment permite que se consulte os anexos de processos incluindo formulários da solicitação. *Inserir resumo do que faz este dataset
| Coluna | Descritivo | Valor de exemplo |
|---|---|---|
| processAttachmentPK.companyId | Código da empresa | 1 |
| version | Versão do anexo |
| /formulário | 1000 | |
| fieldValue1...fieldValue15 | Campos auxiliares para filtro na central de tarefas. Estes campos persistem os dados do formulário conforme definido nos campos de filtro na configuração do processo | 2022-01-18 Opção 1 123 Nome |
| colleagueId | Matrícula do |
| usuário | adm | |
| attachedDate | Data do anexo | 2022-01-12T10:56:07-03:00 |
| processAttachmentPK.processInstanceId | Número da solicitação | 2 |
| originalMovementSquence | Sequencial da movimentação que identifica em que momento da solicitação o anexo foi adicionado | 3 |
| processAttachmentPK.attachmentSequence | Sequencial de inclusão do anexo | 4 |
| documentId | Número do documento | 8996 |
| originalThreadSequence |
| Número da Thread de movimentação em que o anexo foi adicionado | 0 |
processDefinition -
...
Cadastro de processos
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset processDefinition permite que se consulte o cadastro de processos.
*Inserir versão fluig
*Inserir resumo do que faz este dataset
| Coluna | Descritivo | Valor de exemplo | ||
|---|---|---|---|---|
| uniqueCardVersion | Versão única de formulário - | true /false | ||
| periodId | Código do expediente | Default | ||
| deadlineTime | Prazo de conclusão da solicitação em ms | 18000 (5 minutos) | ||
| warningDeadlineTime | Prazo para entrar em alerta do prazo conclusão da solicitação em ms | 10800 (3 minutos) | ||
| processDefinitionPK.processId | Código do processo | PROCESSO_A | ||
| baseDay | Depreciado. Não é mais utilizado. | 0 | ||
| notifyManagerComplements | Notifica gestor quando um complemento ou anexo for adicionado na solicitação | true false | ||
| active | Processo ativo ou inativo | true false | ||
| notifyRequisitionerComplements | Notifica requisitante quando um complemento ou anexo for adicionado na solicitação | true false | notifyRequisitionerComplements | Notifica requisitante |
| managerEngineAllocationId | Mecanismo Código do mecanismo de atribuição do gestor do processo | Usuário Grupo | ||
| processDefinitionPK.companyId | Código da empresa | 1 | ||
| keyWord | Tags do processo | tag1 tag2 | ||
| publicProcess | Mostra se o processo está como público | true false | ||
| baseMonth | Depreciado. Não é mais utilizado. | 0 | ||
| instruction | Instrução de processos | Texto contendo instruções do processo | ||
| processDescription | Descrição do processo | Processo de Compras | ||
| volumeId | Código do volume | Default | ||
| complementsLevel | Configuração dos usuários que podem anexar e adicionar observações na solicitação quando não está sob sua responsabilidade | 0 - Não configurado 1 - Solicitante, responsável(eis) por atividade e gestor 2 - Todos os participantes do processo e gestor 3 - Todos os usuários | ||
| managerEngineAllocationConfiguration | Configuração do mecanismo de atribuição do gestor do processo | <AssignmentController><User>adm</User></AssignmentController> | ||
| snapshotFrequency | Depreciado. Não é mais utilizado. | 0 | ||
| managerEngineAllocationConfiguration | snapshotFrequency | categoryId | Categoria do processo | Compras |
| notifyAuthorityComplementsNotifica responsável | Notifica responsável quando um complemento ou anexo for adicionado na solicitação | true false |
processDefinitionVersion -
...
Cadastro de versões de processos
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset processDefinitionVersion permite que se consulte as versões dos processos.
*Inserir versão fluig
*Inserir resumo do que faz este dataset
| Coluna | Descritivo | Valor de exemplo | ||||
|---|---|---|---|---|---|---|
| formId | Código do formulário | 0 - Caso não tenha formulário 192 | ||||
| versionDescription | Descrição da versão | Nova Versão | ||||
| controlsAttachmentsSecurity | Indica se a segurança de anexo está habilitadasegurança de anexo está habilitada | true false | ||||
| bpmnVersion | Controle indicativo se utiliza componentes não suportados na versão web | (em branco) - Caso seja criado pela web 1 - Caso seja criado pelo studio mas é suportado via web 2 - Caso seja criado pelo studio e não é suportado via web | ||||
| active | Versão ativo ou inativa | bpmnVersion | active | |||
| processDefinitionVersionPK.processId | Código do processo | PROCESSO_A | ||||
| categoryStructure | Depreciado. Não é mais utilizado. | (em branco) | ||||
| editionMode | Indica se o processo está em edição | true false | ||||
| fullCategoryStructure | Depreciado. Não é mais utilizado. | (em branco) | ||||
| counterSign | inheritFormSecurity | processDefinitionVersionPK.companyId | blockedVersion | processDiagram | processDefinitionVersionPK.version | updateAttachmentsVersion |
processState - inserir significado
*Inserir versão fluig
| Exige confirmação de senha na movimentação de todas as atividades | true false | |
| inheritFormSecurity | Registros de formulário herdam segurança | true false |
| processDefinitionVersionPK.companyId | Código da empresa | 1 |
| blockedVersion | Depreciado. Não é mais utilizado. | false |
| processDiagram | SVG do diagrama | <?xml version="1.0" encoding="UTF-8"?> <svg ... /> |
| processDefinitionVersionPK.version | Versão do processo | 3 |
| updateAttachmentsVersion | Atualiza anexos | true false |
workflowColleagueRole - Listagem de usuários por papéis
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset workflowColleagueRole permite que se consulte os usuários presentes em cada papel cadastrado.*Inserir resumo do que faz este dataset
| Coluna | Descritivo | Valor de exemplo | notifyRequistionerFollowUp | joint | digitalSignature | forecastedEffort | executionType | frequenceRequisitionerTime | transferAttachments | cancelSubProcess | notifyManagerDelay | positionX | positionY | notifyAuthorityFollowUp | processStatePk.sequence | stateName | join | noticeExpirationAuthorityTime | subProcessId | Código do subprocesso | formFolder | notifyAuthorityDelay | engineAllocationConfiguration | inhibitTransfer | counterSign | subProcess | noticeExpirationRequisitionerTime | processStatePk.version | stateDescription | agreementPercentage | forecastedEffortType | noticeExpirationManagerTime | deadlineTime | initialState | allowanceManagerTime | stateType | engineAllocationId | selectColleague | deadlineFieldName | allowanceRequistionerTime | processStatePK.processId | parentSequence | FrequenceManagerTime | periodId | allowanceAuthorityTime | automatic | bpmnType | fork | notifyManagerFollowUp | processStatePK.companyId | frequenceAuthorityTime | instruction | signalId | notifyRequisitionerDelay |
|---|
workflowColleagueRole - inserir significado
*Inserir versão fluig
| workflowColleagueRolePK.companyId | Código da empresa | 1 |
| workflowColleagueRolePK.colleagueId | Matricula do usuário | adm |
| workflowColleagueRolePK.roleId | Código do papel | Comprador |
workflowRole - Cadastro de papéis
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset workflowRole permite que se consulte os papéis cadastrados no fluig.
| Coluna | Descritivo | Valor de exemplo |
|---|---|---|
| roleDescription | Nome do papel | Compradores da Empresa |
| workflowRolePK.companyId | Código da Empresa | 1 |
| workflowRolePK.roleId | Código do papel | Comprador |
attributionMecanism - Mecanismos de Atribuição
Lista todos os mecanismos de atribuição cadastrados na plataforma.
| Coluna | Descritivo | Valor de Exemplo |
|---|---|---|
| attributionMecanismPK.attributionMecanismId | Código do mecanismo | Associado |
| name | Nome do mecanismo | Atribuição por Associação |
| description | Descrição do mecanismo | Permite compor lógicas complexas de atribuição |
| attributionMecanismPK.companyId | Código da empresa | 1 |
FLUIGADHOC - Dados de solicitações Adhoc/Listar Tarefas
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset FLUIGADHOC permite que se consulte os dados do formulário FLUIGADHOC que é utilizado pelo processo Listar Tarefas, padrão do fluig.*Inserir resumo do que faz este dataset
| Coluna | Descritivo | Valor de exemplo |
|---|
| metadata#id | Código |
workflowProcess - inserir significado
*Inserir versão fluig
*Inserir resumo do que faz este dataset
| do registro de formulário | 5 | |
| metadata#parent_id | Código do formulário | 3 |
| metadata#version | Versão do registro do formulário | 1000 |
| metadata#card_index_id | Código do formulário | 2 |
| metadata#card_index_version | Versão do formulário | 1000 |
| metadata#active | Registro ativo | true false |
| cardid | Código do formulário | 2 |
| companyId | Código da empresa |
| 1 |
workflowRole - inserir significado
*Inserir versão fluig
*Inserir resumo do que faz este dataset
...
| detail | Campo "Descrição" no formulário | Tarefas adicionadas |
| documentid | Código do registro de formulário | 5 |
| dueDate | Campo "Prazo de conclusão" no formulário | 15/01/2022 (dd/mm/yyyy) |
| id | Código sequencial dos registros desse formulário | 1 |
| meeting | Campo "Nome" no formulário | Tarefas |
| meetingDate | Campo "Data" no formulário | 12/01/2022 (dd/mm/yyyy) |
| qtativ | Campo oculto no formulário que indica a quantidade de atividades adicionadas | 1 |
| tableid | Campo usado para diferenciar tabela pai x filho nos formulário quando existe | principal (Principal é quando não é um registro de uma tabela pai x filho) |
| version | Versão do registro de formulário | 1000 |
FLUIGADHOCPROCESS - Dados das atividades em solicitações Adhoc/Listar Tarefas
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset FLUIGADHOCPROCES permite que se consulte os dados das atividades criadas a partir de um processo listar tarefas ou adhoc.
FLUIGADHOC - inserir significado
*Inserir versão fluig
*Inserir resumo do que faz este dataset
| Coluna | Descritivo | Valor de exemplo | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| metadata#id | Código do registro de formulário | 6 | |||||||||||
| metadata#parent_id | Código do formulário | 4 | |||||||||||
| metadata#version | Versão do registro do formulário | 1000 | |||||||||||
| metadata#card_index_id | Código do formulário | 4 | |||||||||||
| metadata#card_index_version | metadata#activeVersão do formulário | cardid1000 | companyId | Código da empresa | detail | documentid | dueDate | id | meeting | meetingDate | qtativ | tableid | version |
FLUIGADHOCPROCESS - inserir significado
*Inserir versão fluig
*Inserir resumo do que faz este dataset
| metadata#active | Registro ativo | true false | ||||||||||
| activity | Campo "Ação" no formulário | Assinar documento | ||||||||||
| adHocDescription | Campo "Descrição" no formulário pai do processo Listar Tarefas | Tarefas adicionadas | ||||||||||
| cardid | Código do formulário | 4 | ||||||||||
| companyid | Código da empresa | 1 | ||||||||||
| Coluna | Descritivo | Valor de exemplo | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| metadata#id | metadata#parent_id | metadata#version | metadata#card_index_id | metadata#card_index_version | metadata#active | activity | adHocDescription | cardid | companyid | deadline | Prazo de Conclusão da atividade | 15/01/2022 (dd/mm/yyyy) |
| Código da empresadocumentid | ID do Documento | 1 | ||||||||||
| id | Código sequencial dos registros desse formulário | 1 | ||||||||||
| observation | Observação incluída na conclusão da atividade | Documento Assinado | ||||||||||
| opening | Data da criação da tarefa | 12/01/2022 16:12:17 (dd/mm/yyyy hh:MM:ss) | ||||||||||
| request | Código da solicitação que gerou esse registro | 1 | ||||||||||
| requestDescription | requestText | requester | tableid | taskStatus | version |
Datasets de Arquitetura
AccessLog - Log de acesso aos documentos
Lista o log de acessos registrados pela plataforma.
...
| Descrição do processo que gerou essa atividade | Listar Tarefas | |
| requestText | Ao encerrar a atividade, a concatenação do código da solicitação que gerou o registro e a descrição do processo | 1 - Listar Tarefas |
| requester | Usuário que criou a tarefa | adm |
| tableid | Campo usado para diferenciar tabela pai x filho nos formulário quando existe | principal (Principal é quando não é um registro de uma tabela pai x filho) |
| taskStatus | Status da atividade atual | 0 - Em andamento 1 - Concluída 2 - Rejeitada |
| version | Versão do registro de formulário | 1000 |
Datasets de Arquitetura
...
...
colleague - Usuários da plataforma
...
Lista todos os grupos cadastrados na plataforma.
| Coluna | Descritivo | Valor de Exemplo |
|---|---|---|
| groupDescription | Descrição do grupo | Desenvolvedores |
| groupPK.companyId | Código da empresa | 102 |
| groupPK.groupId | Código do grupo | 1 |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas