Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Informações
titleEm atualização

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

...

Índice
maxLevel3
outlinetrue
stylenoneexclude.*ndice

 

Objetivo

...

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

 


Dica
titleDica!

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 TOTVS Fluig Plataforma 1.5.1 ou superior

O dataset de catálogo de itens de aprendizado permite consultar os itens do catálogo do tipo Treinamento, Trilha, Pasta ou Link.

ColunaDescritivoValor de Exemplo
idID do registro2007
parentItemIdID do item pai703
codeSigla"bancodedados"
nameNome"Banco de Dados"
statusStatus

AVAILABLE, OBSOLETE, CLOSING ou ARCHIVED

authorAutor"Marcelo Rodrigo"
costCusto5
workloadCarga Horária (em minutos)91
preExamID do Pré Exame93
posExamID do Pós Exame77
reactionID da Avaliação de Reação121
imageImagem"database.png"
typeTipo 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

languageIdiomaPORTUGUESE_BRAZIL

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  TOTVS Fluig Plataforma 1.5.1 ou superior

O dataset de catálogo de disciplinas permite consultar os itens do catálogo de disciplinas do tipo Disciplina, Pasta ou Link. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
idID do registro197
parentItemIdID do item pai53
codeSigla"sociologia"
nameNome"Sociologia Aplicada"
minimumScoreApprovePontuação mínima para aprovação

75

typeTipo 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

languageIdiomaSPANISH_SPAIN
workloadCarga Horária (em minutos)61
nameCoordinatorNome do Coordenador"Marcelo"
lastnameCoordinatorSobrenome do Coordenador"Rodrigo"
imageImagem"database.png"


enrollmentDataset - Matrículas

* Fluig  TOTVS Fluig Plataforma 1.5.1 ou superior

O dataset de matrículas permite consultar as matrículas realizadas no sistema realizadas na área de aprendizado do TOTVS Fluig Plataforma. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
idID do registro2003
nameUserNome do Usuário"Marcelo"
lastNameUserSobrenome do Usuário"Rodrigo"
userFluigId
userfluigIdID do
usuario
usuário no TOTVS Fluig Plataforma33
statusStatus da matrícula

ENROLLED, STARTED, FINISHED, CANCELLED ou BLOCKED

finalStatusStatus final da matrículaSUCCESSFUL_POS_TEST, SUCCESSFUL_PRE_TEST, SUCCESSFUL_SCORM,
UNSUCCESSFUL_POS_TEST, UNSUCCESSFUL_PRE_TEST, UNSUCCESSFUL_SCORM,
UNSUCCESSFUL_EXPIRED, CANCELLED, SUCCESSFUL, UNSUCCESSFUL
ou WITHOUT_ACCESS
scorePontuação97.00
enrollmentRequestIdID da requisição91
dateEnrollmentData da Matrícula2015-06-11T17:05:08.011-03:00
dateConclusionData de Conclusão2015-07-14T18:06:09.012-03:00

 


Âncora
statusMatricula
statusMatricula

Status das Matrículas

Um pouco mais sobre o status das matrículas:

StatusDescritivo
ENROLLEDEstado inicial da
matrícual
matrícula,
assignada
atribuída no momento que a requisição é aprovada e a respectiva matrícula gerada.
STARTEDEstado que inidica que o usuário iniciou o treinamento / trilha / turma
FINISHEDEstado que indica que o usuário finalizou o treinamento / trilha / turma
CANCELLEDEstado que indica o cancelamento da matrícula
BLOCKEDEstado que indica o bloqueio da matrícula

 


Âncora
statusFinalMatricula
statusFinalMatricula

Status final das Matrículas

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

StatusDescritivo
SUCCESSFUL_POS_TESTEstado que indica matrícula concluída com êxito no pós-teste
SUCCESSFUL_PRE_TESTEstado que indica matrícula concluída com êxito no pré-teste, não necessitando do restante do treinamento
SUCCESSFUL_SCORMEstado que indica matrícula concluída com êxito em conteúdo SCORM selecionado como critério de aprovação
UNSUCCESSFUL_POS_TESTEstado que indica matrícula não obteve êxito na conclusão do pós-teste
UNSUCCESSFUL_PRE_TESTEstado que indica matrícula não obteve êxito na conclusão do pré-teste
UNSUCCESSFUL_SCORMEstado que indica matrícula não obteve êxito na conclusão de um conteúdo SCORM selecionado como critério de aprovação
UNSUCCESSFUL_EXPIREDEstado que indica matrícula não obteve êxito na conclusão pois expirou
CANCELLEDEstado 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_ACCESSEstado 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  TOTVS Fluig Plataforma 1.5.1 ou superior

O dataset de requisição de matrículas permite consultar as requisições de matrículas realizadas no sistema na área de aprendizado do TOTVS Fluig Plataforma. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
idID do Registro1999
classIdID da Turma237
catalogItemIdID da Trilha / Treinamento561
enrollmentIdID da Matrícula739
itemTypeTipo de MatrículaNormalClass ou Track/Training
userRequestingIdID Usuário Requisitante571
userApproverIdID Usuário Aprovador13
userFluigId
userfluigIdID
Fluig
do usuário matriculado no TOTVS Fluig Plataforma339
dateRequestData da Requisição2015-06-11T17:05:08.011-03:00
statusStatus da RequisiçãoSTANDBY, APPROVED, REPROVED ou CANCELLED

...


enrollmentTopicDataset - Execuções em Tópicos

* Fluig  TOTVS Fluig Plataforma 1.5.1 4 ou superior

O dataset de execuções em tópicos permite consultar tópicos disponíveis no sistema de aprendizadoos tópicos executados pelo usuário matriculado. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
id
topicIdID do
Registro
tópico executado
10615
20159
name
topicNameNome do tópico"Tópico Inicial"
estimatedTimeTempo estimado para finalização (em dias)17weightPeso3scoreApprovePontuação para aprovação75.00disciplineClass_idID da Turma271startTopicTypeTipo de InicializaçãoNO_RULES, AFTER_REQUIREMENTS_RELEASE, DAYS_AFTER_REQUIREMENTS_RELEASE,
DAYS_AFTER_ENROLLMENT_RELEASE ou MANUAL_RELEASEnoFinishMinimumScorePermite finalizar sem atingir pontuação mínimatrue ou falsestatusStatusACTIVE ou INACTIVE

 

...

Tipo de inicialização de tópicos

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

StatusDescritivo
NO_RULESInicialização sem regras, sempre liberado.
AFTER_REQUIREMENTS_RELEASELiberação após a conclução dos pré-requisitos.
DAYS_AFTER_REQUIREMENTS_RELEASELiberação após xx dias após conclusão dos pré-requisitos.
DAYS_AFTER_ENROLLMENT_RELEASELiberação após xx dias após a matrícula.
MANUAL_RELEASELiberação manual.

 

 

topicItemDataset - Itens de Tópicos

* Fluig 1.5.1 ou superior

expiredIndica se a execução do tópico já está expiradatrue
startDateData de inicio da execução do tópico2015-08-14T15:09:13.819-03:00
completionDateData de conclusão do tópico

2015-08-16T11:21:37.001-03:00

completedindica se está executadotrue
topicScoreApproveindica a pontuação para aprovação no tópico70
scorePontuação obtida no tópico95
partialScoreindica a pontuação parcial antes da conclusão do tópico60
topicWeightPeso do tópico75
statusStatus da execução do tópicoNOT_VIEWED, ACTIVE, SUCCESSFUL_FINISHED ou UNSUCCESSFUL_FINISHED
enrollmentIdIdentificador da matrícula5123
userIdIdentificador do usuário37
normalClassIdIdentificação da turma que o tópico pertence4129


Tipo de status de Execução do Tópico
StatusDescritivo
NOT_VIEWEDNão visualizado
ACTIVEAtivo
SUCCESSFUL_FINISHEDFinalizado com sucesso
UNSUCCESSFUL_FINISHEDFinalizado sem sucesso


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

* TOTVS Fluig Plataforma 1.5.4 ou superior

O dataset de execuções em itens de tópico permite consultar os itens de tópico executados pelo usuário matriculadoO dataset de itens de tópicos permite consultar itens de tópicos disponíveis no sistema de aprendizado. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
id
enrollmentTopicItemId
ID do Registro9321typeTipo"URL", "Avaliação", "Conteúdo", "Treinamento" ou "Atividade Extraclasse"topicIdID do Tópico175nameNome"Atividade em Grupo Especial"ordemOrdem do Item7weightPeso1mandatoryObrigatóriotrue ou falsescoreTypeTipo do ScoreAUTOMATIC, EXTERNAL, ACTIVITY ou MANUALstatusStatusACTIVE ou INACTIVE

assessmentDataset - Avaliações

* Fluig 1.5.1 ou superior 

O dataset de avaliações permite consultar as avaliações disponíveis no sistema de aprendizado. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
idID do Registro9321
nameNome"Avaliação de Performance Anual"
creationDateData de Criação1981-06-11T18:05:13.017-03:00
monitoredAvaliação Monitoradatrue ou false
showScoresExibe pontuaçãotrue ou false
showApprovalStatusExibe status de aprovaçãotrue ou false
showPerformanceOnQuestionsExibe performance nas questõestrue ou false
showCorrectAnswersExibe alternativas corretastrue ou false
showConclusionMessageExibe mensagem de conclusãotrue ou false
solicitFeedbackEvaluationSolicita feedbacktrue ou false
allowCommentsOnQuestionsPermite comentários nas questõestrue ou false
anonymousAvaliação anônimatrue ou false
imageImagem"performance-anual.png"
currentVersionIdID da versão atual31139
editingVersionIdID da versão em edição31141
enabledStatusACTIVE ou INACTIVE
languageIdiomaPORTUGUESE_BRAZIL

 

assessmentVersionDataset - Versões de Avaliações

* Fluig 1.5.2 ou superior

Id da execução do item de tópico222
topicIdId do tópico a que o item pertence556
topicItemIdId do item de tópico487
enrollmentTopicItemTypeTipo 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

nameNome do item de tópico "Atividade escolar"
mandatoryIndica se a execução do item de tópico é obrigatória dentro do tópico true
weightPeso do item de tópico2
scoreTypeTipo de pontuação do item de tópico

AUTOMATIC
MANUAL
SCORM
EXTERNAL
NO_SCORE
ACTIVITY

scorePontuação atual na execução do item de tópico65
displayTimestampData e hora da visualização do item de tópico2015-08-14T15:09:13.819-03:00
enrollmentIdId da matrícula a que o item de tópico está relacionado4747
userIdId do usuário que está executando o item de tópico289
normalClassIdId da turma a que o item de tópico está relacionado655


Tipos de Item de Tópico
StatusDescritivo
com.totvs.elearning.core.discipline.ActivityTopicItemItem de Tópico do tipo Atividade Extraclasse
com.totvs.elearning.core.discipline.ContentTopicItemItem de Tópico do tipo Conteúdo
com.totvs.elearning.core.discipline.DetachedTopicItemItem de Tópico do tipo Avulso
com.totvs.elearning.core.discipline.EnrollableTopicItemItem de Tópico do tipo Treinamento/Trilha
com.totvs.elearning.core.discipline.ExamTopicItemItem de Tópico do tipo Avaliação
com.totvs.elearning.core.discipline.ForumTopicItemItem de Tópico do tipo Tópico de Fórum
com.totvs.elearning.core.discipline.UrlTopicItemItem de Tópico do tipo URL
Tipos de pontuação no Item de Tópico
StatusDescritivo
AUTOMATICPontuação gerada automaticamente ao acessar Item do Tópico.
MANUALPontuação informada pelo administrador.
SCORMPontuação utilizada para sobrescrever a do SCORM.
EXTERNALPontuação enviada pelo sistema externo
NO_SCOREItem que não vale nota no tópico.
ACTIVITYPontuação decorrente da entrega de atividade.


topicDataset - Tópicos

* TOTVS Fluig Plataforma 1.5.1 ou superior

O dataset de tópicos permite consultar tópicos disponíveis na área de aprendizado do TOTVS Fluig PlataformaO dataset de versões de avaliações permite consultar as versões de uma avaliação gravadas no sistema de aprendizado. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
assessmentId
idID
da Avaliação1999assessmentVersionIdID da Versão da Avaliação237requiredScoreÍndice de Aprovação
do Registro10615
nameNome"Tópico Inicial"
estimatedTimeTempo estimado para finalização (em dias)17
weightPeso3
scoreApprovePontuação para aprovação75.00
minExecutionTimeTempo mínimo de execução1maxExecutionTimeTempo máximo de execução85allowEssayQuestionPermite questões dissertativas
disciplineClass_idID da Turma271
startTopicTypeTipo de InicializaçãoNO_RULES, AFTER_REQUIREMENTS_RELEASE, DAYS_AFTER_REQUIREMENTS_RELEASE,
DAYS_AFTER_ENROLLMENT_RELEASE ou MANUAL_RELEASE
noFinishMinimumScorePermite finalizar sem atingir pontuação mínimatrue ou false
statusStatus
CURRENT, OLD, EDITING ou ANNULLED
Bloco de código
languagejs
titleExemplo
linenumberstrue
var assessmentVersions = DatasetFactory.getDataset("assessmentVersionDataset", null, null, null);

 

disciplineClassDataset - Turmas e Turmas Modelo

* Fluig 1.5.2 ou superior

ACTIVE ou INACTIVE


Âncora
tipoInicializacaoTopico
tipoInicializacaoTopico

Tipo de inicialização de tópicos

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

StatusDescritivo
NO_RULESInicialização sem regras, sempre liberado.
AFTER_REQUIREMENTS_RELEASELiberação após a conclução dos pré-requisitos.
DAYS_AFTER_REQUIREMENTS_RELEASELiberação após xx dias após conclusão dos pré-requisitos.
DAYS_AFTER_ENROLLMENT_RELEASELiberação após xx dias após a matrícula.
MANUAL_RELEASELiberação manual.



topicItemDataset - Itens de Tópicos

* TOTVS Fluig Plataforma 1.5.1 ou superior

O dataset de itens de tópicos permite consultar itens de tópicos disponíveis na área de aprendizado do TOTVS Fluig PlataformaO dataset de Turmas permite consultar Turmas e Turmas Modelo disponíveis no sistema de aprendizado. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
idID do Registro
3297
9321
typeTipo
da Turmacom.totvs.elearning.core.discipline.NormalClass ou
com.totvs.elearning.core.discipline.TemplateClass
NormalClass = Turma
TemplateClass = Turma Modelo
"URL", "Avaliação", "Conteúdo", "Treinamento" ou "Atividade Extraclasse"
topicIdID do Tópico175
nameNome"
Administração 2015"enrollmentInitialDateData inicial de matrícula2015-08-14T12:00:00-03:00enrollmentFinalDateData final de matrícula2015-08-20T21:00:00-03:00classInitialDateData inicial da turma2015-08-21T19:00:00-03:00classFinalDateData final da turma2015-08-29T22:00:00-03:00costCusto91reactionIdID avaliação de reação7513
Bloco de código
languagejs
titleExemplo - Somente Turmas
linenumberstrue
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);

 

partyScheduledDataset - Agendado em avaliações

* Fluig 1.5.2 ou superior

O dataset de agendados permite consultar as informações de quais são as Turmas, Disciplinas, Grupos ou Usuários agendados para executar avaliações. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
assessmentIdID da avaliação525
typeTipo do item agendado

com.totvs.elearning.core.party.PartyClassImpersonator
com.totvs.elearning.core.party.Group
com.totvs.elearning.core.party.PartyEveryone
com.totvs.elearning.core.party.PartyDisciplineImpersonator
com.totvs.elearning.core.party.User

PartyClassImpersonator = uma turma
Group = grupo de usuários
PartyEveryone = todos os usuários
PartyDisciplineImpersonator = disciplina
User = usuário

partyIdId do item agendado325
partyNameNome do item agendado"Dirceu Silva"
Bloco de código
languagejs
titleExemplo
linenumberstrue
var scheduleds = DatasetFactory.getDataset("partyScheduledDataset", null, null, null);

 

assessmentScheduleDataset - Agendamento de avaliações

* Fluig 1.5.2 ou superior

O dataset de agendamento permite consultar as informações referentes aos agendamentos realizados . Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
IdID do agendamento626
assessmentSheduleIdID da avaliação

619

assessmentNameNome da avaliação"Conceitos básicos"
languageIdioma da avaliação"PORTUGUESE_BRAZIL"
descriptionDescrição da avaliação"HCT"
initialDateData e hora inicial do agendamento2015-04-14T21:00:00-03:00
finalDateData e hora final do agendamento2016-01-21T21:00:00-02:00
statusStatus do agendamentoCANCELLED, SCHEDULED, DONE
Bloco de código
languagejs
titleExemplo
linenumberstrue
var scheduleds = DatasetFactory.getDataset("assessmentScheduleDataset ", null, null, null);
 

assessmentApplicationGenericDataset - Execução de avaliações

* Fluig 1.5.2 ou superior

O dataset de execução de avaliações permite consultar as informações referentes às execuções de avaliações. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
assessmentIdID da avaliação626
assessmentNameNome da avaliação

"Conceitos básicos"

userIdID do usuário28
userNameNome do usuário que executou a avaliação"Dirceu Silva"
finalScoreNota final na avaliação100.00
statusStatus da avaliação STARTED, FINISHED, PENDING, CANCELLED
aprovedSe o usuário foi aprovado na avaliaçãotrue, false
Bloco de código
languagejs
titleExemplo
linenumberstrue
var applications = DatasetFactory.getDataset("assessmentApplicationGenericDataset", null, null, null);

 

assessmentApplicationCatalogPreExamDataset  - Execução de Avaliações de Pré-Teste

* Fluig 1.5.3 ou superior

dataset de execução de avaliações de pré-teste permite consultar as informações referentes às execuções de avaliações em Pré-testes. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
enrollmentIdID da Matrícula626
learningIdID do Ítem Matriculado

450

learningTypeTipo do Ítem Matriculado (Trilha ou Treinamento)

com.totvs.elearning.core.catalog.Training ou

com.totvs.elearning.core.catalog.Track

Training = Treinamento

Track = Trilha

preExamIdID da Versão da avaliação de Pré-Teste1564
userIdID do Usuário1404
userNameNome do Usuário "Dirceu Silva"
assessmentIdID da Avaliação1323
assessmentNameNome da Avaliação"Prova - Conhecimentos Gerais I"
requiredScoreScore Mínimo70.00
requiredAllQuestionsNecessário responder todas as Questõestrue, false
startedTimeStampHora de Início2015-10-06T11:26:56.438-03:00
finishedTimeStampHora de Fim2015-10-13T13:12:23.259-03:00
finalScoreScore Final80.00
statusStatusSTARTED, FINISHED, PENDING, CANCELLED
approvedAprovadotrue, false
Bloco de código
languagejs
titleExemplo
linenumberstrue
var applications = DatasetFactory.getDataset("assessmentApplicationCatalogPreExamDataset", null, null, null);

 

assessmentApplicationCatalogPosExamDataset  - Execução de Avaliações de Pós-Teste

* Fluig 1.5.3 ou superior

dataset de execução de avaliações de pré-teste permite consultar as informações referentes às execuções de avaliações em Pós-testes. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
enrollmentIdID da Matrícula626
learningIdID do Ítem Matriculado

450

learningTypeTipo do Ítem Matriculado (Trilha ou Treinamento)

com.totvs.elearning.core.catalog.Training ou

com.totvs.elearning.core.catalog.Track

Training = Treinamento

Track = Trilha

posExamIdID da Versão da avaliação de Pós-Teste1564
userIdID do Usuário1404
userNameNome do Usuário "Dirceu Silva"
assessmentIdID da Avaliação1323
assessmentNameNome da Avaliação"Prova - Conhecimentos Gerais I"
requiredScoreScore Mínimo70.00
requiredAllQuestionsNecessário responder todas as Questõestrue, false
startedTimeStampHora de Início2015-10-06T11:26:56.438-03:00
finishedTimeStampHora de Fim2015-10-13T13:12:23.259-03:00
finalScoreScore Final80.00
statusStatusSTARTED, FINISHED, PENDING, CANCELLED
approvedAprovadotrue, false
Bloco de código
languagejs
titleExemplo
linenumberstrue
var applications = DatasetFactory.getDataset("assessmentApplicationCatalogPosExamDataset", null, null, null);

assessmentApplicationCatalogReactionExamDataset  - Execução de Avaliações de Reação

* Fluig 1.5.3 ou superior

dataset de execução de avaliações de pré-teste permite consultar as informações referentes às execuções de avaliações de Reação. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
enrollmentIdID da Matrícula626
learningIdID do Ítem Matriculado (Trilha ou Treinamento)

450

learningTypeTipo do Ítem Matriculado

com.totvs.elearning.core.catalog.Training ou

com.totvs.elearning.core.catalog.Track

Training = Treinamento

Track = Trilha

reactionIdID da Versão da avaliação de Reação1564
userIdID do Usuário1404
userNameNome do Usuário "Dirceu Silva"
assessmentIdID da Avaliação1323
assessmentNameNome da Avaliação"Prova - Conhecimentos Gerais I"
requiredScoreScore Mínimo70.00
requiredAllQuestionsNecessário responder todas as Questõestrue, false
startedTimeStampHora de Início2015-10-06T11:26:56.438-03:00
finishedTimeStampHora de Fim2015-10-13T13:12:23.259-03:00
finalScoreScore Final80.00
statusStatusSTARTED, FINISHED, PENDING, CANCELLED
approvedAprovadotrue, false
Bloco de código
languagejs
titleExemplo
linenumberstrue
var applications = DatasetFactory.getDataset("assessmentApplicationCatalogReactionExamDataset", null, null, null);

contentLogDataset  - Execução de Conteúdos

* Fluig 1.5.3 ou superior

dataset de execução de conteúdos permite consultar as informações referentes às execuções de conteúdos em Treinamentos e Trilhas. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
enrollmentIdID da Matrícula626
learningIdID do Ítem Matriculado (Trilha ou Treinamento)

450

nameNome do Conteúdo"Conhecimentos Gerais"
descriptionDescrição do Conteúdo

com.totvs.elearning.core.catalog.Training ou

com.totvs.elearning.core.catalog.Track

Training = Treinamento

Track = Trilha

keywordPalavras Chave"conteúdo geral treinamento"
displayTimeStampHora em que foi acessado 2015-10-06T11:29:14.044-03:00
userIdID do Usuário1323
userNameNome do Usuário "Dirceu Silva"
Bloco de código
languagejs
titleExemplo
linenumberstrue
var contentLogs= DatasetFactory.getDataset("contentLogDataset", null, null, null);

enrollmentProgressDetailByTrackDataset   - Detalhes de Andamento de Trilhas

* Fluig 1.5.3 ou superior

dataset de detalhes de andamento de Trilhas permite consultar as informações referentes à itens executados nas Trilhas. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
enrollmentIdID da Matrícula626
userNameNome do Usuário

"Dirceu Silva"

userIdID do Usuário458
statusStatus da matrículaENROLLED, STARTED, FINISHED, CANCELLED ou BLOCKED
finalStatusStatus final da matrícula

SUCCESSFUL_POS_TEST, SUCCESSFUL_PRE_TEST, SUCCESSFUL_SCORM,
UNSUCCESSFUL_POS_TEST, UNSUCCESSFUL_PRE_TEST, UNSUCCESSFUL_SCORM,
UNSUCCESSFUL_EXPIRED, CANCELLED, SUCCESSFUL, UNSUCCESSFUL ou WITHOUT_ACCESS

scoreHora em que foi acessado 80.00
enrollmentRequestIdID do Usuário1323
dateEnrollmentData de Matrícula 2015-10-06T11:25:14.014-03:00
dateConclusionData de Conclusão 2015-10-06T11:29:14.044-03:00
learningIdID do Item Matriculado   455
learningTypeTipo do Item Matriculado

com.totvs.elearning.core.catalog.Training ou

com.totvs.elearning.core.catalog.Track

Training = Treinamento

Track = Trilha

trackParentIdID da Trilha Pai do Treinamento554
learningNameNome do Item Matriculado"Atualidades I"
Bloco de código
languagejs
titleExemplo
linenumberstrue
var contentLogs= DatasetFactory.getDataset("enrollmentProgressDetailByTrackDataset", null, null, null);

Dataset sociais

Posts

ColunaDescritivo
Identificador do Postchave do Post

Alias do Usuario

nickname do usuário

Nome do Usuario

nome do usuário

Tipo

{Publicação, Compartilhamento}

Tipo de Compartilhamento

(documento, imagem, video)

Data e hora da postagem

momento que foi postado

Conteúdo Texto

texto do post

Conteúdo Objeto

conteúdo para imagem, video, documento, etc...

Contagem de likes

Contagem de likes/apoios

Removido?

se o post foi removido

Denunciado?

se o post foi denunciado
Alias da Comunidadenickname da comunidade

Qtde de Watches - acompanhando

Contagem de acompanhamentos

 

 

Comunidades

ColunaDescritivo

Alias da Comunidade

nickname da comunidade

Nome da Comunidade

Nome da Comunidade

Descrição da Comunidade

Descritivo da comunidade

Aceita Documento?

se a comunidade aceita docs

Aceita Fotos?

se a comunidade aceita fotos

Aceita Videos?

se a comunidade aceita videos

Aceita Artigos?

se a comunidade aceita artigos

Formularios?

se a comunidade aceita formularios

Requer Aprovação para entrar?

se é necessário que o moderador aprove uma participação no grupo

Conteúdo é privado?

se o conteúdo é restrito aos participantes

Comunidade Oculta?

se a comunidade não pode ser vista por quem não participa dela

Usa segurança de documentos?

se usa os modelos de segurança por permissões

Status

situação atual

 

 

Participantes

ColunaDescritivoExemplo de Valor

Alias da Comunidade

nickname da comunidadecod_comunidade

Alias do Participante

nickname do participantecod_usuario

Nome do Participante

nome do participanteJoão da Silva

É admin?

se o participante é administradortrue

É moderador?

se o participante é moderadortrue

 

 

Seguidos

ColunaDescritivo

Alias do Seguidor

Nickname do Seguidor

Nome do Seguidor

Nome do Seguidor

Alias do Seguido

Nickname do Seguido

Nome do Seguido

Nome do Seguido

Seguidores

ColunaDescritivo

Alias do Seguido

Nickname do Seguido

Nome do Seguido

Nome do Seguido

Alias do Seguidor

Nickname do Seguidor

Nome do Seguidor

Nome do Seguidor

 

Datasets de documentos

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

* Fluig 1.4.11 ou superior

ColunaDescritivoExemplo de Valor

movementDate

Data de aprovação/reprovação do documento2015-04-22T00:00:00-03:00

movementTime

Hora de aprovação/reprovação do documento11:04:06

observation

Observação ao aprovar/rejeitar o documento"Comentário do colaborador"

colleagueId

Id do colaborador0000288
approvalMovementPK.companyIdId da empresa0000001
approvalMovementPK.documentIdId do documento10903
signedMovimento foi assinado digitalmentefalse
approvalMovementPK.versionVersão do documento1000
analised *Se o documento passou por uma aprovação/reprovação manualtrue
sendDateData em que o documento foi enviado para aprovação2015-04-22T00:00:00-03:00
approvalMovementPK.iterationSequenceNúmero de sequência da movimentação1
closeIteractionSe é a última aprovação para que o documento seja publicadotrue
approvalMovementPK.levelIdNível de aprovação2
Informações
titleAnalised *

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.

 

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;

 

Atividade em Grupo Especial"
ordemOrdem do Item7
weightPeso1
mandatoryObrigatóriotrue ou false
scoreTypeTipo do ScoreAUTOMATIC, EXTERNAL, ACTIVITY ou MANUAL
statusStatusACTIVE ou INACTIVE


assessmentDataset - Avaliações

* TOTVS Fluig Plataforma 1.5.1 ou superior 

O dataset de avaliações permite consultar as avaliações disponíveis na área de aprendizado do TOTVS Fluig Plataforma. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
idID do Registro9321
nameNome"Avaliação de Performance Anual"
creationDateData de Criação1981-06-11T18:05:13.017-03:00
monitoredAvaliação Monitoradatrue ou false
showScoresExibe pontuaçãotrue ou false
showApprovalStatusExibe status de aprovaçãotrue ou false
showPerformanceOnQuestionsExibe performance nas questõestrue ou false
showCorrectAnswersExibe alternativas corretastrue ou false
showConclusionMessageExibe mensagem de conclusãotrue ou false
solicitFeedbackEvaluationSolicita feedbacktrue ou false
allowCommentsOnQuestionsPermite comentários nas questõestrue ou false
anonymousAvaliação anônimatrue ou false
imageImagem"performance-anual.png"
currentVersionIdID da versão atual31139
editingVersionIdID da versão em edição31141
enabledStatusACTIVE ou INACTIVE


assessmentVersionDataset - Versões de Avaliações

* TOTVS Fluig Plataforma 1.5.2 ou superior

O dataset de versões de avaliações permite consultar as versões de uma avaliação gravadas na área de aprendizado do TOTVS Fluig Plataforma. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
assessmentIdID da Avaliação1999
assessmentVersionIdID da Versão da Avaliação237
requiredScoreÍndice de Aprovação75.00
minExecutionTimeTempo mínimo de execução1
maxExecutionTimeTempo máximo de execução85
allowEssayQuestionPermite questões dissertativastrue ou false
statusStatusCURRENT, OLD, EDITING ou ANNULLED
Bloco de código
languagejs
titleExemplo
linenumberstrue
var assessmentVersions = DatasetFactory.getDataset("assessmentVersionDataset", null, null, null);


disciplineClassDataset - Turmas e Turmas Modelo

* TOTVS Fluig Plataforma 1.5.2 ou superior

O dataset de Turmas permite consultar Turmas e Turmas Modelo disponíveis na área de aprendizado do TOTVS Fluig Plataforma. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
idID do Registro3297
typeTipo da Turma

com.totvs.elearning.core.discipline.NormalClass ou
com.totvs.elearning.core.discipline.TemplateClass

NormalClass = Turma
TemplateClass = Turma Modelo

nameNome"Administração 2015"
enrollmentInitialDateData inicial de matrícula2015-08-14T12:00:00-03:00
enrollmentFinalDateData final de matrícula2015-08-20T21:00:00-03:00
classInitialDateData inicial da turma2015-08-21T19:00:00-03:00
classFinalDateData final da turma2015-08-29T22:00:00-03:00
costCusto91
reactionIdID avaliação de reação7513
Bloco de código
languagejs
titleExemplo - Somente Turmas
linenumberstrue
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

* TOTVS Fluig Plataforma 1.5.2 ou superior

O dataset de agendados permite consultar as informações de quais são as Turmas, Disciplinas, Grupos ou Usuários agendados para executar avaliações.

Dica
titleAgendamento externo por email

Para consultar agendamentos externos feitos por emails, utilize o emailScheduledDataset


Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
assessmentIdID da avaliação525
typeTipo do item agendado

com.totvs.elearning.core.party.PartyClassImpersonator
com.totvs.elearning.core.party.Group
com.totvs.elearning.core.party.PartyEveryone
com.totvs.elearning.core.party.PartyDisciplineImpersonator
com.totvs.elearning.core.party.User

PartyClassImpersonator = uma turma
Group = grupo de usuários
PartyEveryone = todos os usuários
PartyDisciplineImpersonator = disciplina
User = usuário

partyIdId do item agendado325
partyNameNome do item agendado"Dirceu Silva"
Bloco de código
languagejs
titleExemplo
linenumberstrue
var usersScheduled = DatasetFactory.getDataset("partyScheduledDataset", null, null, null);


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

* TOTVS Fluig Plataforma 1.5.4 ou superior

O dataset de agendados permite consultar as informações de emails que foram agendados para uma avaliação.

Dica
titleAgendamento a usuários

Para consultar agendamentos feitos a usuários cadastrados, utilize o partyScheduledDataset

Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
assessmentIdID da avaliação28021985
emailEmail do agendado[email protected]
tokenToken do agendado 525A5C03E4Cb97F0E42A0AE1B50EDB80
Bloco de código
languagejs
titleExemplo
linenumberstrue
var emailsScheduled = DatasetFactory.getDataset("emailScheduledDataset", null, null, null);


assessmentScheduleDataset - Agendamento de avaliações

* TOTVS Fluig Plataforma 1.5.2 ou superior

O dataset de agendamento permite consultar as informações referentes aos agendamentos realizados . Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
IdID do agendamento626
assessmentIdID da avaliação

619

assessmentNameNome da avaliação"Conceitos básicos"
descriptionDescrição da avaliação"HCT"
initialDateData e hora inicial do agendamento2015-04-14T21:00:00-03:00
finalDateData e hora final do agendamento2016-01-21T21:00:00-02:00
statusStatus do agendamentoCANCELLED, SCHEDULED, DONE



Bloco de código
languagejs
titleExemplo
linenumberstrue
var scheduleds = DatasetFactory.getDataset("assessmentScheduleDataset ", null, null, null);

assessmentApplicationGenericDataset - Execução de avaliações

* TOTVS Fluig Plataforma 1.5.2 ou superior

O dataset de execução de avaliações permite consultar as informações referentes às execuções de avaliações. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
assessmentIdID da avaliação626
assessmentNameNome da avaliação

"Conceitos básicos"

userIdID do usuário28
userNameNome do usuário que executou a avaliação"Dirceu Silva"
finalScoreNota final na avaliação100.00
statusStatus da avaliação STARTED, FINISHED, PENDING, CANCELLED
approvedSe o usuário foi aprovado na avaliaçãotrue, false
userEmailPara agendamentos de avaliação por email[email protected]
startDate   Data de início da execução da avaliação2015-10-06T11:26:56.438-03:00
finishDate  Data de final da execução da avaliação2015-10-06T12:26:56.438-03:00
requiredScore Pontuação mínima para aprovação na avaliação70.00
assessmentApplicationIdId da aplicação da avaliação978
Bloco de código
languagejs
titleExemplo
linenumberstrue
var applications = DatasetFactory.getDataset("assessmentApplicationGenericDataset", null, null, null);


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

* TOTVS Fluig Plataforma 1.5.3 ou superior

dataset de execução de avaliações de pré-teste permite consultar as informações referentes às execuções de avaliações em pré-testes. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
enrollmentIdID da matrícula626
learningIdID do ítem matriculado

450

learningTypeTipo do ítem matriculado (trilha ou treinamento)

com.totvs.elearning.core.catalog.Training ou

com.totvs.elearning.core.catalog.Track

Training = Treinamento

Track = Trilha

preExamIdID da versão da avaliação de pré-teste1564
userIdID do usuário1404
userNameNome do usuário "Dirceu Silva"
assessmentApplicationIdID da execução da avaliação1323
assessmentNameNome da avaliação"Prova - Conhecimentos Gerais I"
requiredScoreScore mínimo70.00
requiredAllQuestionsNecessário responder todas as questõestrue, false
startedTimeStampHora de início2015-10-06T11:26:56.438-03:00
finishedTimeStampHora de fim2015-10-13T13:12:23.259-03:00
finalScoreScore final80.00
statusStatusSTARTED, FINISHED, PENDING, CANCELLED
approvedAprovadotrue, false
Bloco de código
languagejs
titleExemplo
linenumberstrue
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.

Exemplo: localizando as aplicações de todas as versões da avaliação:

Bloco de código
languagejs
linenumberstrue
var constraintOne = DatasetFactory.createConstraint("allversions", "true", "true", ConstraintType.MUST);
var constraints = new Array(constraintOne);
var datasetValues = DatasetFactory.getDataset("assessmentApplicationCatalogPreExamDataset", null, constraints, null);


assessmentApplicationCatalogPosExamDataset - Execução de avaliações de pós-teste

* TOTVS Fluig Plataforma 1.5.3 ou superior

dataset de execução de avaliações de pós-teste permite consultar as informações referentes às execuções de avaliações em pós-testes. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
enrollmentIdID da matrícula626
learningIdID do ítem matriculado

450

learningTypeTipo do ítem matriculado (trilha ou treinamento)

com.totvs.elearning.core.catalog.Training ou

com.totvs.elearning.core.catalog.Track

Training = Treinamento

Track = Trilha

posExamIdID da versão da avaliação de pós-teste1564
userIdID do usuário1404
userNameNome do usuário "Dirceu Silva"
assessmentApplicationIdID da execução da avaliação1323
assessmentNameNome da avaliação"Prova - Conhecimentos Gerais I"
requiredScoreScore mínimo70.00
requiredAllQuestionsNecessário responder todas as questõestrue, false
startedTimeStampHora de início2015-10-06T11:26:56.438-03:00
finishedTimeStampHora de fim2015-10-13T13:12:23.259-03:00
finalScoreScore final80.00
statusStatusSTARTED, FINISHED, PENDING, CANCELLED
approvedAprovadotrue, false
Bloco de código
languagejs
titleExemplo
linenumberstrue
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.

Exemplo: localizando as aplicações de todas as versões da avaliação:

Bloco de código
languagejs
linenumberstrue
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

* TOTVS Fluig Plataforma 1.5.3 ou superior

dataset de execução de avaliações de reação permite consultar as informações referentes às execuções de avaliações de reação. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
enrollmentIdID da matrícula626
learningIdID do ítem matriculado (trilha ou treinamento)

450

learningTypeTipo do ítem matriculado

com.totvs.elearning.core.catalog.Training ou

com.totvs.elearning.core.catalog.Track

Training = Treinamento

Track = Trilha

reactionIdID da versão da avaliação de reação1564
userIdID do usuário1404
userNameNome do usuário "Dirceu Silva"
assessmentApplicationIdID da execução da avaliação1323
assessmentNameNome da avaliação"Prova - Conhecimentos Gerais I"
requiredScoreScore mínimo70.00
requiredAllQuestionsNecessário responder todas as questõestrue, false
startedTimeStampHora de início2015-10-06T11:26:56.438-03:00
finishedTimeStampHora de fim2015-10-13T13:12:23.259-03:00
finalScoreScore final80.00
statusStatusSTARTED, FINISHED, PENDING, CANCELLED
approvedAprovadotrue, false
Bloco de código
languagejs
titleExemplo
linenumberstrue
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.

Exemplo: localizando as aplicações de todas as versões da avaliação:

Bloco de código
languagejs
linenumberstrue
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

* TOTVS Fluig Plataforma 1.5.3 ou superior

dataset de execução de conteúdos permite consultar as informações referentes às execuções de conteúdos em treinamentos e trilhas. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
enrollmentIdID da matrícula626
learningIdID do ítem matriculado (trilha ou treinamento)

450

nameNome do conteúdo"Conhecimentos Gerais"
descriptionDescrição do conteúdo

com.totvs.elearning.core.catalog.Training ou

com.totvs.elearning.core.catalog.Track

Training = Treinamento

Track = Trilha

keywordPalavras chave"conteúdo geral treinamento"
displayTimeStampHora em que foi acessado 2015-10-06T11:29:14.044-03:00
userIdID do usuário1323
userNameNome do usuário "Dirceu Silva"
Bloco de código
languagejs
titleExemplo
linenumberstrue
var contentLogs= DatasetFactory.getDataset("contentLogDataset", null, null, null);


enrollmentProgressDetailByTrackDataset - Detalhes de andamento de trilhas

* TOTVS Fluig Plataforma 1.5.3 ou superior

dataset de detalhes de andamento de trilhas permite consultar as informações referentes à itens executados nas trilhas. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
enrollmentIdID da matrícula626
userNameNome do usuário

"Dirceu Silva"

userIdID do usuário458
statusStatus da matrículaENROLLED, STARTED, FINISHED, CANCELLED ou BLOCKED
finalStatusStatus final da matrícula

SUCCESSFUL_POS_TEST, SUCCESSFUL_PRE_TEST, SUCCESSFUL_SCORM,
UNSUCCESSFUL_POS_TEST, UNSUCCESSFUL_PRE_TEST, UNSUCCESSFUL_SCORM,
UNSUCCESSFUL_EXPIRED, CANCELLED, SUCCESSFUL, UNSUCCESSFUL ou WITHOUT_ACCESS

scoreHora em que foi acessado 80.00
enrollmentRequestIdID do usuário1323
dateEnrollmentData de matrícula 2015-10-06T11:25:14.014-03:00
dateConclusionData de conclusão 2015-10-06T11:29:14.044-03:00
learningIdID do item matriculado   455
learningTypeTipo do item matriculado

com.totvs.elearning.core.catalog.Training ou

com.totvs.elearning.core.catalog.Track

Training = Treinamento

Track = Trilha

trackParentIdID da trilha pai do treinamento554
learningNameNome do item matriculado"Atualidades I"
Bloco de código
languagejs
titleExemplo
linenumberstrue
var results = DatasetFactory.getDataset("enrollmentProgressDetailByTrackDataset", null, null, null);


enrollmentProgressDetailByTrainingDataset - Detalhes de andamento de treinamentos

* TOTVS Fluig Plataforma 1.5.3 ou superior

dataset de detalhes de andamento de treinamentos permite consultar as informações referentes à itens executados nos treinamentos. Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
enrollmentIdID da matrícula626
progressTypeTipo do item

PRE_EXAM, POS_EXAM, REACTION ou CONTENT


PRE_EXAM = Pré Teste

POS_EXAM = Pós Teste

REACTION = Avaliação de Reação

CONTENT = Conteúdo

descriptionDescrição do item"Prova - Conhecimentos Gerais I"
startedTimeStampData e hora de início do item2015-10-13T16:01:53.247-03:00
finishedTimeStampData e hora de fim do item

2015-10-13T16:02:16.197-03:00

durationTempo de duração em minutos10
statusStatusSTARTED, FINISHED, PENDING ou CANCELLED
scoreScore 40.00
Nota
titleObservação

Este dataset não suporta as funções fields e limit, por acumular informações de diversas tabelas. A ordem dos registros é fixa, sendo sempre por enrollmentId, lista todos os registros de: Pré-testes, Conteúdos, Pós-teste e Avaliação de reação.

Bloco de código
languagejs
titleExemplo
linenumberstrue
var contentLogs= DatasetFactory.getDataset("enrollmentProgressDetailByTrainingDataset", null, null, null);


historySkillDataset - Habilidades por Usuário

* TOTVS Fluig Plataforma 1.5.4 ou superior

O dataset de habilidades por usuários permite consultar as habilidades que o usuário obteve por meio de execução de trilhas/treinamentos e/ou participação em turmas.

Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
skillIdID da Habilidade122
skillNameNome da Habilidade"Matemática Financeira"
skillPointsPontos que o usuário possui na Habilidade2.00
userIdID do usuário555
userNameNome do Usuário"André"
userLastNameÚltimo nome do usuário"Felipe"


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

* TOTVS Fluig Plataforma 1.5.6 ou superior

O dataset de questões aplicadas em uma avaliação permite consultar detalhes de questões utilizadas em cada execução de uma avaliação, assim como informações sobre a execução em si.

Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
assessmentQuestionVersionIdA versão da questão utilizada na execução da avaliação1314
typeTipo de questãocom.totvs.elearning.core.assessment.ObjectiveQuestion
titleTítulo da questão"Questão objetiva 1"
topicTitleNome da pasta (tópico) em que a questão se encontraroot_topic
difficultyDificuldade da questão3
totalPointsTotal de pontos obtidos nesta questão na execução da avaliação1.00
isCanceledSe a versão utilizada na execução da avaliação estava canceladatrue, false
assessmentApplicationIdId da execução da avaliação1248
appBlockIdId da aplicação do bloco na avaliação1235
userIdExecutor da avaliação. Se vier em branco, a avaliação foi executada via e-mail (agendamento)208
Bloco de código
languagejs
titleExemplo
linenumberstrue
var contentLogs= DatasetFactory.getDataset("assessmentAppQuestionDataset", null, null, null);

assessmentAppBlockDataset - Dataset de blocos em uma avaliação

* TOTVS Fluig Plataforma 1.5.6 ou superior

O dataset de blocos em uma avaliação permite consultar detalhes dos blocos de uma avaliação em cada uma de suas execuções, assim como informações sobre as execuções em si.

Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
blockIdA versão do bloco1774
blockNameNome do bloco"bloco 1"
weightPeso3
minScoreMínimo de acertos0
totalPointsTotal de acertos3
userIdId do usuário que executou a avaliação107
appBlockIdId da aplicação do bloco na avaliaçãotrue, false
assessmentApplicationIdId da execução da avaliação1248
Bloco de código
languagejs
titleExemplo
linenumberstrue
var contentLogs= DatasetFactory.getDataset("assessmentAppBlockDataset", null, null, null);

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

* TOTVS Fluig Plataforma 1.5.6 ou superior

O dataset de execuções de avaliações por turma permite consultar detalhes destas avaliações, como informações sobre a qual item de tópico ela pertence, o status de aprovação, etc.

Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
userNameNome do usuário que executou a avaliação"Cleiton Ferreira"
assessmentNameNome da avaliação"Avaliação Final 1"
topicNameNome do tópico"Tópico 1"
startDateData de início da execução da avaliação2016-01-18T12:51:09.108Z
finishDateData de término da execução da avaliação2016-01-18T12:53:54.976Z
requiredScoreNota mínima para ser aprovado na avaliação50.00
finalScoreNota obtida na avaliação77.22
approvedSe aprovado ou nãotrue, false
statusSe a avaliação está terminada ou em andamentoSTARTED, FINISHED, PENDING, CANCELLED
classIdId da turma2651
assessmentIdId da avaliação3188
topicIdId do tópico3033
assessmentApplicationIdId da execução da avaliação1248
Bloco de código
languagejs
titleExemplo
linenumberstrue
var contentLogs= DatasetFactory.getDataset("assessmentClassApplicationDataset", null, null, null);


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

* TOTVS Fluig Plataforma 1.5.6 ou superior

O dataset de execuções de avaliações por trilha mostra detalhes da execução de avaliações por trilhas

Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
userNameNome do usuário que executou a avaliação"Alice Maia"
assessmentNameNome da avaliação"Prova Final"
assessmentTypeTipo de avaliaçãoPRE_EXAM, POS_EXAM, REACTION
startDateData de início da execução da avaliação2015-10-07T17:59:35.570-03:00
finishDateData de fim da execução da avaliação2015-10-07T17:59:59.339-03:00
requiredScoreNota mínima para ser aprovado70.00
finalScoreNota obtida na avaliação77.00
approvedAprovado ou nãotrue, false
assessmentAplicationIdId da execução da avaliação1248
learningIdId da trilha1234
learningTypeSe é trilha ou treinamento. Funciona como um campo de controle para relatórioscom.totvs.elearning.core.catalog.Track
Bloco de código
languagejs
titleExemplo
linenumberstrue
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)

* TOTVS Fluig Plataforma 1.5.6 ou superior

O dataset de execuções de avaliações por treinamento mostra detalhes da execução de avaliações por treinamentos

Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
userNameNome do usuário que executou a avaliação"Alex Navarro"
assessmentNameNome da avaliação"Prova experimental"
assessmentTypeTipo de avaliaçãoPRE_EXAM, POS_EXAM, REACTION
startDateData de início da execução da avaliação2015-10-07T17:59:35.570-03:00
finishDateData de fim da execução da avaliação2015-10-07T17:59:59.339-03:00
requiredScoreNota mínima para ser aprovado70.00
finalScoreNota obtida na avaliação77.00
approvedAprovado ou nãotrue, false
assessmentAplicationIdId da execução da avaliação1248
learningIdId da trilha1234
learningTypeSe é trilha ou treinamento. Funciona como um campo de controle para relatórioscom.totvs.elearning.core.catalog.Training
Bloco de código
languagejs
titleExemplo
linenumberstrue
var contentLogs= DatasetFactory.getDataset("assessmentApplicationByTraining", null, null, null);


partyDataset - Dataset de entidades do LMS

* TOTVS Fluig Plataforma 1.5.6 ou superior

Este dataset lista entidades LMS que são classificadas com Party.

Ele é utilizado por outros datasets para se obter o id de usuários(LMS), grupos(LMS), turmas, disciplinas, empresas ou por todos.

Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
idId LMS104
fluigIdId TOTVS Fluig Plataforma69033
nameprimeiro nome"Pedro"
lastNamesobrenome"Back"
fullNamenome completo"Pedro Back"
loginlogin do usuário"pedroback"
emaile-mail do usuário"[email protected]"
partyTypetipo da entidade LMS

com.totvs.elearning.core.party.User, (Usuário)

com.totvs.elearning.core.party.Group, (Grupo)

com.totvs.elearning.core.party.PartyClassImpersonator, (Turma)

com.totvs.elearning.core.party.PartyDisciplineImpersonator, (Disciplina)

com.totvs.elearning.core.party.PartyEveryone, (Tudo)

com.totvs.elearning.core.party.PartyTenantImpersonator (Empresa)

Bloco de código
languagejs
titleExemplo
linenumberstrue
var contentLogs= DatasetFactory.getDataset("partyDataset", null, null, null);


classResponsiblesDataset - Dataset de responsáveis por turmas

* TOTVS Fluig Plataforma 1.5.6 ou superior

Este dataset lista os responsáveis por turmas criadas no catálogo de disciplinas e turmas.

Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
classIdId da turma104
classNameNome da turma"Matemática - Matutino 01"
responsibleNameNome completo do responsável"Jorge Batista"
responsibleIdId do responsável78
responsibilityResponsabilidade"CORRECT_ACTIVITIES"
userIdId do usuário46
userfluigIdId do usuário no TOTVS Fluig Plataforma435
disciplineIdId da disciplina

216

Bloco de código
languagejs
titleExemplo
linenumberstrue
var contentLogs= DatasetFactory.getDataset("classResponsiblesDataset", null, null, null);

disciplineResponsiblesDataset - Dataset de responsáveis por disciplinas

* TOTVS Fluig Plataforma 1.5.6 ou superior

Este dataset lista os responsáveis por disciplinas criadas no catálogo de disciplinas e turmas.

Acompanhe a seguir os detalhes:

ColunaDescritivoValor de Exemplo
disciplineIdId da disciplina216
disciplineNameNome da disciplina"Matemática"
responsibleNameNome completo do responsável"Jorge Batista"
responsibleIdId do responsável78
responsibilityResponsabilidade"CORRECT_ACTIVITIES"
userIdId do usuário46
userfluigIdId do usuário no TOTVS Fluig Plataforma435
Bloco de código
languagejs
titleExemplo
linenumberstrue
var contentLogs= DatasetFactory.getDataset("disciplineResponsibleDatasetBusiness", null, null, null);



Nota
titleImportante!

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.


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

"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

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

"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

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.

ColunaDescritivoValor de Exemplo
AccessLogPK.documentIdCódigo do documento10903
AccessLogPK.accessDateData em que ocorreu o acesso2018-08-29
AccessLogPK.colleagueIdMatrícula do usuáriofernando.alves
AccessLogPK.companyIdCódigo da empresa102


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

* Atualização 1.4.11 ou superior

ColunaDescritivoExemplo de Valor

movementDate

Data de aprovação/reprovação do documento2015-04-22T00:00:00-03:00

movementTime

Hora de aprovação/reprovação do documento11:04:06

observation

Observação ao aprovar/rejeitar o documento"Comentário do colaborador"

colleagueId

Id do colaborador0000288
approvalMovementPK.companyIdId da empresa0000001
approvalMovementPK.documentIdId do documento10903
signedMovimento foi assinado digitalmentefalse
approvalMovementPK.versionVersão do documento1000
analised *Se o documento passou por uma aprovação/reprovação manualtrue
sendDateData em que o documento foi enviado para aprovação2015-04-22T00:00:00-03:00
approvalMovementPK.iterationSequenceNúmero de sequência da movimentação1
closeIteractionSe é a última aprovação para que o documento seja publicadotrue
approvalMovementPK.levelIdNível de aprovação2
Informações
titleAnalised *

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

* Atualização 1.0 ou superior

ColunaDescritivoExemplo de Valor

lastModifiedTime

Data da última modificação no documento2015-08-14T15:09:13.819-03:00

documentType

Tipo do documento

Informações
titleFique 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
titleFique ligado

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

0

metaListRecordId

Sequencia do registro na tabela específica de meta lista

Informações
titleFique ligado

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

13
documentDescriptionDescrição do documento"Solicitação de compras"
cardDescription

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

Informações
titleFique ligado

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

num_solicitacao
convertDocumentTypeTipo de conversão do documento
translatedPropriedade que indica se o documento foi traduzidotrue / false
visualizationVisualização do documento 
approved Propriedade que indica se o documento foi aprovado ou nãotrue / false
pdfRenderEnginePropriedade que indica se o documento utiliza o motor de renderização PDF Render
mimetypeDescrição do tipo de mídiatext/html
relatedFilesRelação de arquivos relacionados, incluindo o arquivo principal e anexosSolicitacao_de_Compras.html Solicitacao_de_Compras.js
expiresPropriedade que define se o documento está expiradotrue / false
approvalAndOrPropriedade que indica se há aprovadores AND e ORtrue / false
priorityPrioridade do documento0
downloadEnabledPropriedade que indica se o documento está habilitado para downloadtrue / false
statusArmazLongoPrazoStatus do armazenamento a longo prazo do documento
updateIsoPropertiesPropriedade que indica se atualiza as propriedades da ISOtrue / false
expirationDateData de expiração do documento2016-11-16T00:00:00-02:00
checkoutFolder

Propriedade que indica se o documento é a pasta Check-out

Informações
titleFique ligado

Informação válida somente para pastas

 true / false
volumeIdVolume em que o documento pertence

Default

usedQuotaInforma o quanto de espaço já foi utilizado na cota disponível (valores em MB)1.64712
atualizationIdPropriedade que indica o documento de atualização0
inheritApproversPropriedade que define se herda aprovações do paitrue / false
deletedPropriedade que indica se o documento está excluidotrue / false
privateDocumentPropriedade que indica se é um documento privado, ou seja, se está abaixo da pasta Meus Documentostrue / false
sizeInforma o tamanho do arquivo (valores em MB)0.00227165
documentTypeIdTipo do arquivo físico, se retornar branco ou nulo é porque esse tipo não é conhecido pela plataformaContratos
imutablePropriedade que define se a versão/revisão é inalteráveltrue / false
datasetName

O nome do dataset a qual o documento pertence

Informações
titleFique ligado

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

 dts_form_solicitacao_de_compras
topicIdCódigo do assunto do documento1
documentPK.documentIdNúmero do documento82
processingBatchPropriedade que indica se o documento está ainda em processamentotrue / false
externalDocumentIdPropriedade que indica se o documento possui alguma relação com um documento externo
permissionTypeTipo de permissão0
colleagueIdMatricula do usuário que criou o documento"fernando.alves"
indexedPropriedade que define se o documento já foi indexadotrue / false
phisicalFileNome do arquivo físico atrelado ao documentoSolicitação_de_Compras.html
keyWordPalavras chaves do documento"tag"
documentPropertyNumber

Código do formulário base

Informações
titleFique ligado

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

 80
inheritSecurityPropriedade que define se herda segurança do paitrue / false
quota

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

Informações
titleFique ligado

Informação válida somente para pastas

 100
additionalComments

Comentários adicionais do documento

"Comentário adicional"
crcCyclic 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
titleFique ligado

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


1000
uUIDUUID (identificador Único Global) do documento313DB013-DBE2-4ADB-BC0D-9BE76EEC1BFB
documentPK.companyIdCódigo da empresa em que o documento foi publicado1
createDateData de criação do documento2016-10-27T00:00:00-02:00
activeVersionPropriedade que define se a versão é ativatrue / false
publisherIdMatricula do usuário que publicou o documento"fernando.alves"
versionDescriptionDescrição da versão"Informações da versão"
validationStartDateData a partir da qual o documento poderá ser visualizado2016-11-16T00:00:00-02:00
metaListId

Código de qual meta lista o documento pertence

Informações
titleFique ligado

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

40
userNotifyPropriedade que define se notifica os usuários que tenham esse assunto de interessetrue / false
approvedDateData de Aprovação2016-11-16T00:00:00-02:00
privateColleagueIdSe é um documento particular retorna a matricula do usuário onde este documento está alocado"fernando.alves"
allowMultiCardsPerUserPropriedade que indica se permite muitos formulários por usuáriotrue / false
languageIdCódigo do Idioma do documento"pt_BR"
siteCode

Código do volume no qual o documento pertence

"Fluig"
notificationDaysPeriodo, em dias, para notificação de expiração do documento40
socialDocumentDocumento social
restrictionTypeTipo de restrição0
draft

Propriedade que define se o documento está em edição

Informações
titleFique ligado

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


 true / false
onlyActiveRows

Propriedade que indica se o documento é ativo

Informações
titleFique ligado

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

 true / false
pdfConversionStatusIndica o status de conversão do documento para PDF0
accessCountNúmero de acessos ao documento10
lastModifiedDateData da última modificação2016-11-16T00:00:00-02:00
iconIdCódigo do Ícone do documento67
documentPK.versionNúmero da versão do documento1000


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.

ColunaDescritivoValor de Exemplo
allocatedDocumentPK.companyIdCódigo da empresa1
allocatedDocumentPK.destinationDocumentCódigo do documento a ser alterado na pasta particular12903
allocatedDocumentPK.sourceDocumentCódigo do documento original10654
allocatedDocumentPK.sourceVersionVersão do documento original1000
checkoutDateData em que o check-out do documento foi realizado2018-08-29
activeIndica se o documento está ativotrue / false
colleagueIdMatrícula do usuário responsável pelo check-outfernando.alves
commentComentário realizado no momento do check-outVou editar porque...
checkoutTimeHora em que o check-out do documento foi realizado165723
checkoutAllowed
Informações
titleFique ligado

Campo depreciado



checkinDate
Informações
titleFique ligado

Campo depreciado



checkinTime
Informações
titleFique ligado

Campo depreciado




customFields - Campos customizados dos documentos

Lista os Plataforma ❙ Campos customizados dos documentos.

ColunaDescritivoValor de Exemplo
customFieldsPK.customFieldIdCódigo do campo customizado1
customFieldDescriptionDescrição do campo customizadoQuantidade de páginas
customFieldsPK.companyIdCódigo da empresa102
alwaysShowIndica se está habilitado para mostrar em todos os documentostrue / false


destinationArea - Área dos documentos

Lista as Áreas cadastradas para os documentos.

ColunaDescritivoValor de Exemplo
areaDescriptionDescrição da área do documentoAdministrativo
managerIdMatrícula do responsável pela áreafernando.alves
destinationAreaPK.companyIdCódigo da empresa102
destinationAreaPK.areaIdCódigo da área do documento1
userId
Informações
titleFique ligado

Campo depreciado


executionServerId
Informações
titleFique ligado

Campo depreciado



documentSecurityConfig - Segurança dos documentos

Retorna a configuração de segurança dos documentos.

ColunaDescritivoValor de Exemplo
attributionValueValor do atributo de segurança6kopfwg3gyubqq1444419140949
documentSecurityConfigPK.documentIdCódigo do documento10903
downloadEnabledIndica se está habilitado o download do documentotrue / false
showContentIndica se está habilitada a visualização do conteúdo do documentotrue / false
documentSecurityConfigPK.companyIdCódigo da empresa102
permissionIndica se o documento tem permissãotrue / false
securityLevel

Nível de permissão de acesso ao documento

Informações
titleFique 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
inheritOriginSecurityPropriedade que define se herda segurançatrue / false
documentSecurityConfigPK.sequenceSequência de prioridade do registro da segurança1
inheritSecurityPropriedade que define se herda segurançatrue / false
documentSecurityConfigPK.versionVersão do documento1000
attributionType

Define a atribuição da segurança.

Informações
titleFique ligado

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

1
securityVersion
Informações
titleFique ligado

Campo depreciado



knowledge - Conhecimento dos documentos

Retorna as visualizações dos documentos, indicando quando foi realizada a primeira e a última visualização.

ColunaDescritivoValor de Exemplo
knowledgePK.companyIdCódigo da empresa102
knowledgePK.documentIdCódigo do documento10903
knowledgePK.versionVersão do documento1000
knowledgePK.colleagueIdMatrícula do usuário que visualizou o documentofernando.alves
firstViewPrimeira visualização (tempo em formato Long)1444839211480
lastViewÚltima visualização (tempo em formato Long)1530553535848
lastViewedTime
Informações
titleFique ligado

Campo depreciado


lastViewed
Informações
titleFique ligado

Campo depreciado


knowledgeDate
Informações
titleFique ligado

Campo depreciado


versionDescription
Informações
titleFique ligado

Campo depreciado



topic - Assuntos dos documentos

Lista os assuntos dos documentos.

ColunaDescritivoValor de Exemplo
updateEmailIndica se está habilitada a notificação de atualização do assuntotrue / false
topicPK.topicIdCódigo do assunto1
removeEmailIndica se está habilitada a notificação de eliminação do assuntotrue / false
descriptionDescrição do assuntoEventos
mandatoryIndica se o assunto é obrigatóriotrue / false
topicPK.companyIdCódigo da empresa102


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

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

choosedColleagueIdCódigo da matrícula do responsável escolhido para a tarefa.adm
choosedSequenceNumero 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;

taskObservationMostra os complementos adicionados na tarefa.

"Registrado documento"

Informações
titleFique 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
titleFique 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
titleFique 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
titleFique 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
titleFique 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
titleFique 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
titleFique ligado

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

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

startDateIndica a data e hora que foi movimentado para a atividade. Transferências não modificam esta data.

2017-06-02T11:15:32-03:00

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

warningDateIndica a data e hora em que a tarefa passa a ser considerada em alerta.

2017-06-02T11:15:32-03:00


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

ColunaDescritivoValor de exemplo
notifyRequistionerFollowUpSe atividade notifica requisitante quando solicitação a abre.true false
jointSe atividade é uma atividade conjunta.true false
digitalSignatureSe atividade solicita assinatura digital para ser movimentada.true false
forecastedEffortEsforço previsto indicado no cadastro da atividade em segundos.1000
executionTypeTipo de execução da atividade caso for uma atividade de serviço.

0 - Manual (modelo antigo)

1 - Posterior à abertura

2 - Imediata à abertura

frequenceRequisitionerTimeFrequência entre as notificações de atraso para o requisitante em segundos.1000
transferAttachmentsSe a atividade transfere anexos da solicitação principal para a nova solicitação caso for uma atividade de sub processo.true false
cancelSubProcessSe 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 false
notifyManagerDelaySe notifica gestor do processo no caso da atividade estar em atraso.true false
positionXPosição vertical da atividade no desenho do processo.100
positionYPosição horizontal da atividade no desenho do processo.100
notifyAuthorityFollowUpSe atividade notifica responsável quando solicitação a abre.true false
processStatePk.sequenceIdentificador da sequência da atividade.4
stateNameNome da atividade.AtividadeTeste
joinSe atividade é um JOIN (junção de ramificações partindo de uma atividade de tipo FORK).true false
noticeExpirationAuthorityTimeTempo após prazo expirado para o responsável ser notificado em segundos.1000
subProcessIdIdentificador do sub processo atrelado a esta atividade caso esta seja uma atividade de sub processo.PROCESSO_A
formFolderPasta no GED onde se encontra formulário, depreciado, pois não há separação de formulários por atividades.
notifyAuthorityDelaySe a atividade notifica responsável caso esteja atrasada.true false
engineAllocationConfigurationConfiguração, em XML, do mecanismo de atribuição do responsável para essa atividade.

<AssignmentController>

<BaseActivity>3</BaseActivity>

<Returns>First</Returns>

</AssignmentController>

inhibitTransferSe a atividade não permite apresentar a opção de transferir para outro responsável.true false
counterSignSe atividade exige que o usuário coloque sua senha para que possa ser movimentada.true false
subProcessSe a atividade é um sub processo, depreciado, não é populado em momento algum.
noticeExpirationRequisitionerTimeTempo em segundos após prazo expirado para o requisitante ser notificado.1000
processStatePk.versionVersão do processo a qual esta atividade pertence.2
stateDescriptionDescrição da atividade.AtividadeTeste
agreementPercentagePercentual de aceitação para uma atividade conjunta ser movimentada.75
forecastedEffortTypeComo atividade deve controlar esforço previsto.

0 - Não controla

1 - Esforço Estimado / Previsto

2 - Apontamento de Horas

3 - Tempo de Conclusão

noticeExpirationManagerTimeTempo em segundos após prazo expirado para o gestor ser notificado.1000
deadlineTimePrazo da atividade em segundos.1000
initialStateSe atividade é uma atividade inicial.true false
allowanceManagerTimeTempo de tolerância até o primeiro aviso de atividade atrasada para o gestor em segundos.1000
stateTypeTipo da atividade. Utilizado pelo modelador Web.

0 - Atividade comum / simples

1 - Atividade automática / Gateways

2 - Atividade de sub processo

3 - Fork

4 - Join

engineAllocationIdIdentificador do mecanismo de atribuição utilizado para esta atividade.Executor Atividade
selectColleagueSe atividade exige ou não a seleção de usuários caso haja múltipla seleção.true false
deadlineFieldNameIdentificador do campo de formulário responsável por atribuir prazo caso este seja o formato da atividade.textbox_0
allowanceRequistionerTimeTempo de tolerância até o primeiro aviso de atividade atrasada para o requisitante em segundos.1000
processStatePK.processIdIdentificador do processo ao qual esta atividade pertence.PROCESSO_B
parentSequenceAtividade a qual esta está anexada, apenas utilizado para o evento de captura de erro em relação a atividade de serviço.3
frequenceManagerTimeTempo em segundos de frequência entre as notificações de atraso para o gestor.1000
periodIdIdentificador do expediente caso este seja diferente da solicitação como um todo para esta atividade em específico.Default
allowanceAuthorityTimeTempo de tolerância até o primeiro aviso de atividade atrasada para o responsável em segundos.1000
automaticSe a atividade é automática / gateway.true false
bpmnTypeTipo 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)

forkSe a atividade é um Gateway que inicia paralelismo, na base ver stateType.true false
notifyManagerFollowUpSe atividade notifica gestor quando solicitação a abre.true false
processStatePK.companyIdCódigo da empresa a qual processo pertence.1
frequenceAuthorityTimeFrequência entre as notificações de atraso para o responsável em segundos.1000
instructionDescrição das instruções da atividade.Texto
signalIdIdentificador do sinal que é disparado ou recebido caso a atividade seja um emissor ou receptor de sinal respectivamente.3
notifyRequisitionerDelaySe notifica requisitante do processo no caso da atividade estar em atraso.true 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

sourceProcessCódigo da solicitação que originou esta caso seja um sub processo.PROCESSO_B
totalDeadlineTempo em segundos do início da solicitação até a data do prazo.1560
notifyDelaySe a solicitação avisa em caso de atraso.true ou false
endDateProcessData de encerramento da solicitação.2017-06-02T11:15:32-03:00
activeSe a solicitação está ativa.true ou false
sourceThreadSequenceCó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
versionCódigo da versão do processo que originou esta solicitação.3
uUIDIdentificador interno único da solicitação gerado pelo sistema.CA9E4715-B7E2-4BB9-BACE-26EFCBC33299
totalRuntimeTempo em segundos considerando expediente entre a abertura e o encerramento da solicitação1100
deadlineDateData de prazo da solicitação como um todo.2017-06-02T11:15:32-03:00
warningDateProcessData de aviso da solicitação.2017-06-02T11:15:32-03:00
statusCó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

ColunaDescritivoValor de exemplo

advancedProcessPropertiesPK.propertyId

Nome do atributopastaDoDocumento
propertieValueValor do atributo

54

advancedProcessPropertiesPK.processIdCódigo do processoPROCESSO_A
advancedProcessPropertiesPK.companyIdCódigo da empresa1
advancedProcessPropertiesPK.versionVersão do processo2


businessPeriod -Cadastro de Expediente

* TOTVS Fluig Plataforma 1.5.1 ou superior

O dataset businessPeriod permite que se consulte os expedientes cadastrado no fluig

ColunaDescritivoValor de exemplo
businessPeriodPK.weekDayDia da Semana

1 - Domingo

2 - Segunda-feira

3 - Terça-feira

4 - Quarta-feira

5 - Quinta-feira

6 - Sexta-feira

7 - Sábado

businessPeriodPK.companyIdCódigo da empresa1
businessPeriodPK.sequence

Sequencial de ordem do horário no dia


Informações
titleFique ligado

Se um exediente vai das 8h00 até 12h00 e das 13h30 até 17h00, a primeira parte (das 8h às 12h) vai ser o sequencial 1 e a segunda (13h30 até 17h) sequencial 2

2

initialHour

Horário de início em segundos


Informações
titleFique ligado

Usando o exemplo anterior, 8h vai ser 28800 (8 * 60 * 60), e 13h30 será 48600 (13 * 60 * 60 + 30 *60).

28800
businessPeriodPK.periodIdCódigo do ExpedienteDefault
finalHour

Horário de final em segundos


Informações
titleFique ligado

Usando o exemplo anterior, 12h vai ser 43200 (12 * 60 * 60), e 17h será 61200 (17 * 60 * 60).

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.

ColunaDescritivoValor de exemplo
holidayDayDia do feriado7
holidayYearAno do feriado

2022

0 (caso seja um feriado recorrente, ou seja, anual)

holidayMonthMês do feriado

1 - Janeiro

2 - Fevereiro

...

globalCalendarPK.holidayCalendarIdDescrição do feriadoIndependência do Brasil
globalCalendarPK.companyIdCódigo da empresa

1

dayFormattedData do feriado

07-09-2022 (Formato dd-mm-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.

ColunaDescritivoValor de exemplo
companyIdCódigo da empresa1
holidayDayDia do feriado7
holidayYearAno do feriado

2022

0 (caso seja um feriado recorrente, ou seja, anual)

holidayMonthMês do feriado

1 - Janeiro

2 - Fevereiro

...

idCódigo do feriado atribuído pela plataforma1
holidayCalendarIdDescrição do feriadoIndependência do Brasil
dayFormattedData do feriado 

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. 

ColunaDescritivoValor de exemplo
processAttachmentPK.companyIdCódigo da empresa1
versionVersão do anexo/formulário1000
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

colleagueIdMatrícula do usuárioadm
attachedDateData do anexo2022-01-12T10:56:07-03:00
processAttachmentPK.processInstanceIdNúmero da solicitação2
originalMovementSquenceSequencial da movimentação que identifica em que momento da solicitação o anexo foi adicionado3
processAttachmentPK.attachmentSequenceSequencial de inclusão do anexo4
documentIdNúmero do documento8996
originalThreadSequenceNúmero da Thread de movimentação em que o anexo foi adicionado0


processDefinition - Cadastro de processos

* TOTVS Fluig Plataforma 1.5.1 ou superior

O dataset processDefinition permite que se consulte o cadastro de processos. 

ColunaDescritivoValor de exemplo
uniqueCardVersionVersão única de formulário

true

false

periodIdCódigo do expedienteDefault
deadlineTimePrazo de conclusão da solicitação em ms18000 (5 minutos)
warningDeadlineTimePrazo para entrar em alerta do prazo conclusão da solicitação em ms10800 (3 minutos)
processDefinitionPK.processIdCódigo do processoPROCESSO_A
baseDayDepreciado. Não é mais utilizado.0
notifyManagerComplementsNotifica gestor quando um complemento ou anexo for adicionado na solicitação

true

false

activeProcesso ativo ou inativo

true

false

notifyRequisitionerComplementsNotifica requisitante quando um complemento ou anexo for adicionado na solicitação

true

false

managerEngineAllocationIdCódigo do mecanismo de atribuição do gestor do processo

Usuário

Grupo

processDefinitionPK.companyIdCódigo da empresa1
keyWordTags do processotag1 tag2
publicProcessMostra se o processo está como público

true

false

baseMonthDepreciado. Não é mais utilizado.0
instructionInstrução de processosTexto contendo instruções do processo
processDescriptionDescrição do processoProcesso de Compras
volumeIdCódigo do volumeDefault
complementsLevelConfiguraçã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

managerEngineAllocationConfigurationConfiguração do mecanismo de atribuição do gestor do processo<AssignmentController><User>adm</User></AssignmentController>
snapshotFrequencyDepreciado. Não é mais utilizado.0
categoryIdCategoria do processoCompras
notifyAuthorityComplements

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. 

ColunaDescritivoValor de exemplo
formIdCódigo do formulário

0 - Caso não tenha formulário

192

versionDescriptionDescrição da versãoNova Versão
controlsAttachmentsSecurityIndica se a segurança de anexo está habilitada

true

false

bpmnVersionControle 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

activeVersão ativo ou inativa
processDefinitionVersionPK.processIdCódigo do processoPROCESSO_A
categoryStructureDepreciado. Não é mais utilizado.(em branco)
editionModeIndica se o processo está em edição

true

false

fullCategoryStructureDepreciado. Não é mais utilizado.(em branco)
counterSignExige confirmação de senha na movimentação de todas as atividades

true

false

inheritFormSecurityRegistros de formulário herdam segurança

true

false

processDefinitionVersionPK.companyIdCódigo da empresa1
blockedVersionDepreciado. Não é mais utilizado.

false

processDiagramSVG do diagrama<?xml version="1.0" encoding="UTF-8"?>
<svg ... />
processDefinitionVersionPK.versionVersão do processo3
updateAttachmentsVersionAtualiza 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.

ColunaDescritivoValor de exemplo
workflowColleagueRolePK.companyIdCódigo da empresa1
workflowColleagueRolePK.colleagueIdMatricula do usuárioadm
workflowColleagueRolePK.roleIdCódigo do papelComprador


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.

ColunaDescritivoValor de exemplo
roleDescriptionNome do papelCompradores da Empresa
workflowRolePK.companyIdCódigo da Empresa1
workflowRolePK.roleIdCódigo do papelComprador


Lista todos os mecanismos de atribuição cadastrados na plataforma.

ColunaDescritivoValor de Exemplo
attributionMecanismPK.attributionMecanismIdCódigo do mecanismoAssociado
nameNome do mecanismoAtribuição por Associação
descriptionDescrição do mecanismoPermite compor lógicas complexas de atribuição
attributionMecanismPK.companyIdCódigo da empresa1


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.

ColunaDescritivoValor de exemplo
metadata#idCódigo do registro de formulário 5
metadata#parent_idCódigo do formulário3
metadata#versionVersão do registro do formulário1000
metadata#card_index_idCódigo do formulário2
metadata#card_index_versionVersão do formulário1000
metadata#activeRegistro ativo

true

false

cardidCódigo do formulário2
companyIdCódigo da empresa1
detailCampo "Descrição" no formulárioTarefas adicionadas
documentidCódigo do registro de formulário 5
dueDateCampo "Prazo de conclusão" no formulário15/01/2022 (dd/mm/yyyy)
idCódigo sequencial dos registros desse formulário1
meetingCampo "Nome" no formulárioTarefas
meetingDateCampo "Data" no formulário12/01/2022 (dd/mm/yyyy)
qtativCampo oculto no formulário que indica a quantidade de atividades adicionadas1
tableidCampo usado para diferenciar tabela pai x filho nos formulário quando existeprincipal (Principal é quando não é um registro de uma tabela pai x filho)
versionVersão do registro de formulário1000


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.

ColunaDescritivoValor de exemplo
metadata#idCódigo do registro de formulário6
metadata#parent_idCódigo do formulário4
metadata#versionVersão do registro do formulário1000
metadata#card_index_idCódigo do formulário4
metadata#card_index_versionVersão do formulário1000
metadata#activeRegistro ativo

true

false

activityCampo "Ação" no formulárioAssinar documento
adHocDescriptionCampo "Descrição" no formulário pai do processo Listar TarefasTarefas adicionadas
cardidCódigo do formulário4
companyidCódigo da empresa1
deadlinePrazo de Conclusão da atividade15/01/2022 (dd/mm/yyyy)
Código da empresaID do Documento1
idCódigo sequencial dos registros desse formulário1
observationObservação incluída na conclusão da atividadeDocumento Assinado
openingData da criação da tarefa12/01/2022 16:12:17 (dd/mm/yyyy hh:MM:ss)
requestCódigo da solicitação que gerou esse registro1
requestDescriptionDescrição do processo que gerou essa atividadeListar Tarefas
requestTextAo encerrar a atividade, a concatenação do código da solicitação que gerou o registro e a descrição do processo1 - Listar Tarefas
requesterUsuário que criou a tarefaadm
tableidCampo usado para diferenciar tabela pai x filho nos formulário quando existeprincipal (Principal é quando não é um registro de uma tabela pai x filho)
taskStatusStatus da atividade atual

0 - Em andamento

1 - Concluída

2 - Rejeitada

versionVersão do registro de formulário1000


Datasets de Arquitetura

...

colleague - Usuários da plataforma

Lista todos os usuários cadastrados na plataforma

ColunaDescritivoValor de Exemplo
colleaguePK.companyIdCódigo da empresa102
colleaguePK.colleagueIdMatrícula do usuáriofernando.alves
colleagueNameNome do usuárioFernando Alves
mailE-mail do usuário[email protected]
loginLogin do usuário para acesso à plataformafernando.alves
activeIndica se o usuário está ativotrue / false
adminUserIndica se o usuário é administrador da plataformatrue / false
defaultLanguageIdioma padrão dos documentospt_BR
volumeIdVolume físico do usuárioDefault
maxPrivateSizeCota máxima de armazenamento do usuáiro0
currentProjectProjetos do usuárioVendas digitais
extensionNrNúmero do ramal do usuário
especializationAreaEspecialização do usuárioMarketing digital
groupIdCódigo do grupo de trabalho workflow ao qual o usuário está vinculado1
userTenantIdCódigo do usuário1
emailHtml
Informações
titleFique ligado

Campo depreciado



colleagueGroup - Vinculo dos Usuários aos Grupos

Lista os usuários que estão vinculados aos grupos

ColunaDescritivoValor de Exemplo
colleagueGroupPK.companyIdCódigo da empresa102
colleagueGroupPK.colleagueIdMatrícula do usuáriofernando.alves
colleagueGroupPK.groupIdCódigo do grupo1


group - Grupos de usuários

Lista todos os grupos cadastrados na plataforma.

ColunaDescritivoValor de Exemplo
groupDescriptionDescrição do grupoDesenvolvedores
groupPK.companyIdCódigo da empresa102
groupPK.groupIdCódigo do grupo1

...