Informações

title	Em atualização

Em breve todos os datasets internos do fluig Fluig estarão listados aqui. Aguarde!

...

Índice

maxLevel	3
outline	true
style	none

Objetivo

...

O objetivo deste documento é descrever a utilização de Datasets de datasets internos do fluigFluig, mostrar seus campos e respectivos detalhes, disponibilizando exemplos de utilização de cada dataset.

Dica

title	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

...

catalogItemDataset - Catálogo de Aprendizado

* fluig 1.5.1 ou superior

...

Coluna	Descritivo	Valor de Exemplo
id	ID do registro	2007
parentItemId	ID do item pai	703
code	Sigla	"bancodedados"
name	Nome	"Banco de Dados"
status	Status	AVAILABLE, OBSOLETE, CLOSING ou ARCHIVED
author	Autor	"Marcelo Rodrigo"
cost	Custo	5
workload	Carga Horária (em minutos)	91
preExam	ID do Pré Exame	93
posExam	ID do Pós Exame	77
reaction	ID da Avaliação de Reação	121
image	Imagem	"database.png"
type	Tipo do Item de Catálogo	com.totvs.elearning.core.catalog.Folder ou com.totvs.elearning.core.catalog.Link ou com.totvs.elearning.core.catalog.Track ou com.totvs.elearning.core.catalog.Training

Treinamentos associados a uma trilha

Se você deseja localizar treinamentos que estejam associados a uma trilha, você pode usar a constraint idParentTrack para a sua pesquisa.

...

Saiba mais como acessar datasets.

disciplineItemDataset - Catálogo de Disciplinas

* fluig 1.5.1 ou superior

...

Coluna	Descritivo	Valor de Exemplo
id	ID do registro	197
parentItemId	ID do item pai	53
code	Sigla	"sociologia"
name	Nome	"Sociologia Aplicada"
minimumScoreApprove	Pontuação mínima para aprovação	75
type	Tipo do Item de Catálogo	com.totvs.elearning.core.discipline.Discipline ou com.totvs.elearning.core.discipline.DisciplineCatalogItem ou com.totvs.elearning.core.discipline.LinkDiscipline ou com.totvs.elearning.core.discipline.FolderDiscipline
workload	Carga Horária (em minutos)	61
nameCoordinator	Nome do Coordenador	"Marcelo"
lastnameCoordinator	Sobrenome do Coordenador	"Rodrigo"
image	Imagem	"database.png"

enrollmentDataset - Matrículas

* fluig 1.5.1 ou superior

...

Âncora

	statusMatricula
	statusMatricula

Status das Matrículas

Um pouco mais sobre o status das matrículas:

...

Âncora

	statusFinalMatricula
	statusFinalMatricula

Status final das Matrículas

Um pouco mais sobre o status final das matrículas:

Status	Descritivo
SUCCESSFUL_POS_TEST	Estado que indica matrícula concluída com êxito no pós-teste
SUCCESSFUL_PRE_TEST	Estado que indica matrícula concluída com êxito no pré-teste, não necessitando do restante do treinamento
SUCCESSFUL_SCORM	Estado que indica matrícula concluída com êxito em conteúdo SCORM selecionado como critério de aprovação
UNSUCCESSFUL_POS_TEST	Estado que indica matrícula não obteve êxito na conclusão do pós-teste
UNSUCCESSFUL_PRE_TEST	Estado que indica matrícula não obteve êxito na conclusão do pré-teste
UNSUCCESSFUL_SCORM	Estado que indica matrícula não obteve êxito na conclusão de um conteúdo SCORM selecionado como critério de aprovação
UNSUCCESSFUL_EXPIRED	Estado que indica matrícula não obteve êxito na conclusão pois expirou
CANCELLED	Estado que indica matrícula cancelada
SUCCESSFUL	Estado que indica matrícula concluída com êxito em treinamento com uma das seguintes situações: Sem pré-teste; Sem pós-teste; Em parte de uma turma
UNSUCCESSFUL	Estado que indica matrícula não obteve êxito em treinamento com uma das seguintes situações: Sem pré-teste; Sem pós-teste; Em parte de uma turma
WITHOUT_ACCESS	Estado que indica usuário matriculado em turma ou treinamento, porém sua matrícula expirou sem registro de acesso

enrollmentRequestDataset - Requisições de Matrículas

* fluig 1.5.1 ou superior

...

Coluna	Descritivo	Valor de Exemplo
id	ID do Registro	1999
classId	ID da Turma	237
catalogItemId	ID da Trilha / Treinamento	561
enrollmentId	ID da Matrícula	739
itemType	Tipo de Matrícula	NormalClass ou Track/Training
userRequestingId	ID Usuário Requisitante	571
userApproverId	ID Usuário Aprovador	13
userfluigId	ID fluig do usuário matriculado	339
dateRequest	Data da Requisição	2015-06-11T17:05:08.011-03:00
status	Status da Requisição	STANDBY, APPROVED, REPROVED ou CANCELLED

enrollmentTopicDataset - Execuções em Tópicos

* fluig 1.5.4 ou superior

...

Coluna	Descritivo	Valor de Exemplo
topicId	ID do tópico executado	20159
topicName	Nome do tópico	"Tópico Inicial"
expired	Indica se a execução do tópico já está expirada	true
startDate	Data de inicio da execução do tópico	2015-08-14T15:09:13.819-03:00
completionDate	Data de conclusão do tópico	2015-08-16T11:21:37.001-03:00
completed	indica se está executado	true
topicScoreApprove	indica a pontuação para aprovação no tópico	70
score	Pontuação obtida no tópico	95
partialScore	indica a pontuação parcial antes da conclusão do tópico	60
topicWeight	Peso do tópico	75
status	Status da execução do tópico	NOT_VIEWED, ACTIVE, SUCCESSFUL_FINISHED ou UNSUCCESSFUL_FINISHED
enrollmentId	Identificador da matrícula	5123
userId	Identificador do usuário	37
normalClassId	Identificação da turma que o tópico pertence	4129

Tipo de status de Execução do Tópico

Status	Descritivo
NOT_VIEWED	Não visualizado
ACTIVE	Ativo
SUCCESSFUL_FINISHED	Finalizado com sucesso
UNSUCCESSFUL_FINISHED	Finalizado sem sucesso

enrollmentTopicItemDataset - Execuções em Itens de Tópicos

* fluig 1.5.4 ou superior

...

Coluna	Descritivo	Valor de Exemplo
enrollmentTopicItemId	Id da execução do item de tópico	222
topicId	Id do tópico a que o item pertence	556
topicItemId	Id do item de tópico	487
enrollmentTopicItemType	Tipo de execução de item de tópico	com.totvs.elearning.core.discipline.ActivityTopicItem com.totvs.elearning.core.discipline.ContentTopicItem com.totvs.elearning.core.discipline.DetachedTopicItem com.totvs.elearning.core.discipline.EnrollableTopicItem com.totvs.elearning.core.discipline.ExamTopicItem com.totvs.elearning.core.discipline.ForumTopicItem com.totvs.elearning.core.discipline.UrlTopicItem
name	Nome do item de tópico	"Atividade escolar"
mandatory	Indica se a execução do item de tópico é obrigatória dentro do tópico	true
weight	Peso do item de tópico	2
scoreType	Tipo de pontuação do item de tópico	AUTOMATIC MANUAL SCORM EXTERNAL NO_SCORE ACTIVITY
score	Pontuação atual na execução do item de tópico	65
displayTimestamp	Data e hora da visualização do item de tópico	2015-08-14T15:09:13.819-03:00
enrollmentId	Id da matrícula a que o item de tópico está relacionado	4747
userId	Id do usuário que está executando o item de tópico	289
normalClassId	Id da turma a que o item de tópico está relacionado	655

Tipos de Item de Tópico

Status	Descritivo
com.totvs.elearning.core.discipline.ActivityTopicItem	Item de Tópico do tipo Atividade Extraclasse
com.totvs.elearning.core.discipline.ContentTopicItem	Item de Tópico do tipo Conteúdo
com.totvs.elearning.core.discipline.DetachedTopicItem	Item de Tópico do tipo Avulso
com.totvs.elearning.core.discipline.EnrollableTopicItem	Item de Tópico do tipo Treinamento/Trilha
com.totvs.elearning.core.discipline.ExamTopicItem	Item de Tópico do tipo Avaliação
com.totvs.elearning.core.discipline.ForumTopicItem	Item de Tópico do tipo Tópico de Fórum
com.totvs.elearning.core.discipline.UrlTopicItem	Item de Tópico do tipo URL

Tipos de pontuação no Item de Tópico

Status	Descritivo
AUTOMATIC	Pontuação gerada automaticamente ao acessar Item do Tópico.
MANUAL	Pontuação informada pelo administrador.
SCORM	Pontuação utilizada para sobrescrever a do SCORM.
EXTERNAL	Pontuação enviada pelo sistema externo
NO_SCORE	Item que não vale nota no tópico.
ACTIVITY	Pontuação decorrente da entrega de atividade.

topicDataset - Tópicos

* fluig 1.5.1 ou superior

...

Âncora

	tipoInicializacaoTopico
	tipoInicializacaoTopico

Tipo de inicialização de tópicos

Um pouco mais sobre o Tipo de Iniciação de um tópico:

Status	Descritivo
NO_RULES	Inicialização sem regras, sempre liberado.
AFTER_REQUIREMENTS_RELEASE	Liberação após a conclução dos pré-requisitos.
DAYS_AFTER_REQUIREMENTS_RELEASE	Liberação após xx dias após conclusão dos pré-requisitos.
DAYS_AFTER_ENROLLMENT_RELEASE	Liberação após xx dias após a matrícula.
MANUAL_RELEASE	Liberação manual.

topicItemDataset - Itens de Tópicos

* fluig 1.5.1 ou superior

...

Coluna	Descritivo	Valor de Exemplo
id	ID do Registro	9321
type	Tipo	"URL", "Avaliação", "Conteúdo", "Treinamento" ou "Atividade Extraclasse"
topicId	ID do Tópico	175
name	Nome	"Atividade em Grupo Especial"
ordem	Ordem do Item	7
weight	Peso	1
mandatory	Obrigatório	true ou false
scoreType	Tipo do Score	AUTOMATIC, EXTERNAL, ACTIVITY ou MANUAL
status	Status	ACTIVE ou INACTIVE

assessmentDataset - Avaliações

* fluig 1.5.1 ou superior

...

Coluna	Descritivo	Valor de Exemplo
id	ID do Registro	9321
name	Nome	"Avaliação de Performance Anual"
creationDate	Data de Criação	1981-06-11T18:05:13.017-03:00
monitored	Avaliação Monitorada	true ou false
showScores	Exibe pontuação	true ou false
showApprovalStatus	Exibe status de aprovação	true ou false
showPerformanceOnQuestions	Exibe performance nas questões	true ou false
showCorrectAnswers	Exibe alternativas corretas	true ou false
showConclusionMessage	Exibe mensagem de conclusão	true ou false
solicitFeedbackEvaluation	Solicita feedback	true ou false
allowCommentsOnQuestions	Permite comentários nas questões	true ou false
anonymous	Avaliação anônima	true ou false
image	Imagem	"performance-anual.png"
currentVersionId	ID da versão atual	31139
editingVersionId	ID da versão em edição	31141
enabled	Status	ACTIVE ou INACTIVE

assessmentVersionDataset - Versões de Avaliações

* fluig 1.5.2 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var assessmentVersions = DatasetFactory.getDataset("assessmentVersionDataset", null, null, null);

disciplineClassDataset - Turmas e Turmas Modelo

* fluig 1.5.2 ou superior

...

Bloco de código

language	js
title	Exemplo - Somente Turmas
linenumbers	true

var onlyNormalClass = DatasetFactory.createConstraint("type", "com.totvs.elearning.core.discipline.NormalClass", "com.totvs.elearning.core.discipline.NormalClass", ConstraintType.MUST);
var constraints = new Array(onlyNormalClass);
var normalClasses = DatasetFactory.getDataset("catalogItemDataset", null, onlyNormalClass, null);

Âncora
partyScheduledDataset
partyScheduledDataset
partyScheduledDataset - Usuários agendados em avaliações

* fluig 1.5.2 ou superior

...

Dica

title	Agendamento externo por email

Para consultar agendamentos externos feitos por emails, utilize o Datasets internos fluigFluig

Acompanhe a seguir os detalhes:

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var usersScheduled = DatasetFactory.getDataset("partyScheduledDataset", null, null, null);

Âncora
emailScheduledDataset
emailScheduledDataset
emailScheduledDataset - Emails agendados em avaliações

* fluig 1.5.4 ou superior

...

Dica

title	Agendamento a usuários

Para consultar agendamentos feitos a usuários cadastrados, utilize o Datasets internos fluigFluig

Acompanhe a seguir os detalhes:

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var emailsScheduled = DatasetFactory.getDataset("emailScheduledDataset", null, null, null);

assessmentScheduleDataset - Agendamento de avaliações

* fluig 1.5.2 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var scheduleds = DatasetFactory.getDataset("assessmentScheduleDataset ", null, null, null);

assessmentApplicationGenericDataset - Execução de avaliações

* fluig 1.5.2 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var applications = DatasetFactory.getDataset("assessmentApplicationGenericDataset", null, null, null);

assessmentApplicationCatalogPreExamDataset - Execução de avaliações de pré-teste

* fluig 1.5.3 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var applications = DatasetFactory.getDataset("assessmentApplicationCatalogPreExamDataset", null, null, null);

Todas as versões da avaliação

Se você deseja visualizar todas as versões da avaliação, você pode usar a constraint allVersions para a sua pesquisa.

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var applications = DatasetFactory.getDataset("assessmentApplicationCatalogPosExamDataset", null, null, null);

Todas as versões da avaliação

Se você deseja visualizar todas as versões da avaliação, você pode usar a constraint allVersions para a sua pesquisa.

...

Bloco de código

language	js
linenumbers	true

var constraintOne = DatasetFactory.createConstraint("allversions", "true", "true", ConstraintType.MUST);
var constraints = new Array(constraintOne);
var datasetValues = DatasetFactory.getDataset("assessmentApplicationCatalogPosExamDataset", null, constraints, null);

assessmentApplicationCatalogReactionExamDataset - Execução de avaliações de reação

* fluig 1.5.3 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var applications = DatasetFactory.getDataset("assessmentApplicationCatalogReactionExamDataset", null, null, null);

Todas as versões da avaliação

Se você deseja visualizar todas as versões da avaliação, você pode usar a constraint allVersions para a sua pesquisa.

...

Bloco de código

language	js
linenumbers	true

var constraintOne = DatasetFactory.createConstraint("allversions", "true", "true", ConstraintType.MUST);
var constraints = new Array(constraintOne);
var datasetValues = DatasetFactory.getDataset("assessmentApplicationCatalogReactionExamDataset", null, constraints, null);

contentLogDataset - Execução de conteúdos

* fluig 1.5.3 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var contentLogs= DatasetFactory.getDataset("contentLogDataset", null, null, null);

enrollmentProgressDetailByTrackDataset - Detalhes de andamento de trilhas

* fluig 1.5.3 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var results = DatasetFactory.getDataset("enrollmentProgressDetailByTrackDataset", null, null, null);

enrollmentProgressDetailByTrainingDataset - Detalhes de andamento de treinamentos

* fluig 1.5.3 ou superior

...

Coluna	Descritivo	Valor de Exemplo
skillId	ID da Habilidade	122
skillName	Nome da Habilidade	"Matemática Financeira"
skillPoints	Pontos que o usuário possui na Habilidade	2.00
userId	ID do usuário	555
userName	Nome do Usuário	"André"
userLastName	Último nome do usuário	"Felipe"

assessmentAppQuestionDataset - Dataset de questões aplicadas em uma avaliação

* fluig 1.5.6 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var contentLogs= DatasetFactory.getDataset("assessmentAppQuestionDataset", null, null, null);

assessmentAppBlockDataset - Dataset de blocos em uma avaliação

* fluig 1.5.6 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var contentLogs= DatasetFactory.getDataset("assessmentAppBlockDataset", null, null, null);

assessmentClassApplicationDataset - Dataset de execução de avaliações por turma

* fluig 1.5.6 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var contentLogs= DatasetFactory.getDataset("assessmentClassApplicationDataset", null, null, null);

assessmentApplicationByTrack - Dataset de execução de avaliações por trilha (contendo pré, pós, reação)

* fluig 1.5.6 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var contentLogs= DatasetFactory.getDataset("assessmentApplicationByTrack", null, null, null);

assessmentApplicationByTraining - Dataset de execução de avaliações por treinamento (contendo pré teste, pós teste, avaliação de reação)

* fluig 1.5.6 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var contentLogs= DatasetFactory.getDataset("assessmentApplicationByTraining", null, null, null);

partyDataset - Dataset de entidades do LMS

* fluig 1.5.6 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var contentLogs= DatasetFactory.getDataset("partyDataset", null, null, null);

classResponsiblesDataset - Dataset de responsáveis por turmas

* fluig 1.5.6 ou superior

...

Bloco de código

language	js
title	Exemplo
linenumbers	true

var contentLogs= DatasetFactory.getDataset("classResponsiblesDataset", null, null, null);

disciplineResponsiblesDataset - Dataset de responsáveis por disciplinas

* fluig 1.5.6 ou superior

...

Nota

title	Importante!

Esta documentação sobre datasets de aprendizado é válida até a atualização 1.6.5-190212 da plataforma.

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

title	Conheça o fluig Learning!

Você não vai ficar sem recursos de LMS no seu dia a dia, pois temos uma novidade para você: a oferta fluig Learning! Elaé a evolução dos conceitos de LMS, focada no mercado corporativo, 100% na nuvem – SaaS.

Acesse learning.fluig.com e fique por dentro de tudo o que ele tem a oferecer para alavancar o aprendizado na sua empresa.

Durante o ano de 2019 serão comunicados mais detalhes sobre como clientes fluig podem aderir aos termos de transição do LMS da plataforma fluig para o fluig Learning. Para mais informações consulte o seu ESN.

Datasets do Social

...

PostDataset - Dataset dos posts publicados

* fluig 1.3.0 ou superior

...

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	"http://www.fluig.com/"
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

...

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

...

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	"http://www.fluig.com/"
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

...

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

...

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

...

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

...

*Obs: O campo followedAliad está documento conforme o retorno do dataset

Datasets de Documentos

...

documentApprovalHistory - Histórico de aprovações do documento

* fluig 1.4.11 ou superior

...

Informações

title	Analised *

Este item informa se o aprovador aceitou o item.
Exemplo: Caso seja uma aprovação do tipo 'OU' de dois colaboradores, o colaborador que aprovou o documento terá este campo como true, já o segundo que até então não visualizou o documento para aprovar, terá este item como false.

document - Lista todos os documentos e suas respectivas versões

* fluig 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

Informações

title	Fique ligado

1 - Pasta
2 - Documento normal
3 - Documento externo
4 - Formulário
5 - Registro de formulário
7 - Anexo Workflow
8 - Novo conteúdo
9 - Aplicativo
10 - Relatório

1

parentDocumentId

Número do documento pai

Informações

title	Fique ligado

O id 0 (zero) representa a pasta raíz

0

metaListRecordId

Sequencia do registro na tabela específica de meta lista

Informações

title	Fique ligado

Informação válida somente para registros de formulários

13

documentDescription

Descrição do documento

"Solicitação de compras"

cardDescription

Campo que corresponde a descrição do formulário

Informações

title	Fique ligado

Informação válida somente para formulários

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

Informações

title	Fique ligado

Informação válida somente para pastas

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 pelo fluig

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

Informações

title	Fique ligado

Informação válida somente para formulários

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

Informações

title	Fique ligado

Informação válida somente para formulários e seus respectivos registros

80

inheritSecurity

Propriedade que define se herda segurança do pai

true / false

quota

Cota atribuída para a pasta (valores em MB)

Informações

title	Fique ligado

Informação válida somente para pastas

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

Informações

title	Fique ligado

Informação válida somente para formulários e seus respectivos registros

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

Informações

title	Fique ligado

Informação válida somente para formulários e seus respectivos registros

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

Informações

title	Fique ligado

Informação válida somente para "Novos conteúdos"

true / false

onlyActiveRows

Propriedade que indica se o documento é ativo

Informações

title	Fique ligado

Informação válida somente para formulários

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 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

Informações

title	Fique ligado

Campo depreciado

checkinDate

Informações

title	Fique ligado

Campo depreciado

checkinTime

Informações

title	Fique ligado

Campo depreciado

customFields - Campos customizados dos documentos

Lista os 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

Informações

title	Fique ligado

Campo depreciado

executionServerId

Informações

title	Fique ligado

Campo depreciado

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

Informações

title	Fique ligado

Os níveis são: -1 - Sem Permissão, 0 - L (Leitura), 1 - G (Gravação), 2 - M (Modificação) ou 3 - T (Total)

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.

Informações

title	Fique ligado

Os tipos são: 1 - Colaborador, 2 - Grupo, ou all - Todos

1

securityVersion

Informações

title	Fique ligado

Campo depreciado

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

Informações

title	Fique ligado

Campo depreciado

lastViewed

Informações

title	Fique ligado

Campo depreciado

knowledgeDate

Informações

title	Fique ligado

Campo depreciado

versionDescription

Informações

title	Fique ligado

Campo depreciado

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"

Informações

title	Fique ligado

A partir da Atualização 1.5.0, para resgatar os complementos de uma tarefa, devem ser utilizados os métodos da API Pública (WorkflowRest) .

Caso exista algum projeto ou desenvolvimento anterior à esta atualização, que utilizem o campo taskObservation - integrações, por exemplo - é necessário importar o dataset ProcessTaskCustom.

Este dataset está preparado para retornar os dados do campo taskObservation da forma antiga, com a diferença que, caso haja mais de um complemento na mesma tarefa, eles serão separados utilizando o caractere \n.

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

Informações

title	Fique ligado

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

title	Fique ligado

A partir da atualização 1.6.1, esta coluna será substituída por assignEndDate e endDate.

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

Informações

title	Fique ligado

A partir da atualização 1.6.1, esta coluna será substituída por startDate e assignDate.

initialTermHour

Caso configurado no processo, mostra a hora de início a contar para conclusão da tarefa.

51661

Informações

title	Fique ligado

A partir da atualização 1.6.1, esta coluna será substituída por startDate e assignDate.

deadlineDate

Caso configurado no processo, mostra a data final para conclusão da tarefa.

2017-06-02T00:00:00-03:00

Informações

title	Fique ligado

A partir da atualização 1.6.1, esta coluna será substituída por deadline.

deadlineHour

Caso configurado no processo, mostra a hora final para conclusão da tarefa.

40533

Informações

title	Fique ligado

A partir da atualização 1.6.1, esta coluna será substituída por deadline.

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