Histórico da Página

...

Dica

title	Dica!

A partir da atualização Lake 1.7.0-200714 os datasets internos passam a ter controle de permissionamento pelo Painel de controle. Saiba mais na documentação de Recursos de permissão em APIs e Webservices para mais detalhes.

Datasets de Aprendizado

...

Lista os documentos que estão em check-out. Para saber mais sobre o check-out, consulte nossa documentação de usuário Plataforma ❙ Efetuar check-out do documento.

Coluna

Descritivo

Valor de Exemplo

allocatedDocumentPK.companyId

Código da empresa

1

allocatedDocumentPK.destinationDocument

Código do documento a ser alterado na pasta particular

12903

allocatedDocumentPK.sourceDocument

Código do documento original

10654

allocatedDocumentPK.sourceVersion

Versão do documento original

1000

checkoutDate

Data em que o check-out do documento foi realizado

2018-08-29

active

Indica se o documento está ativo

true / false

colleagueId

Matrícula do usuário responsável pelo check-out

fernando.alves

comment

Comentário realizado no momento do check-out

Vou editar porque...

checkoutTime

Hora em que o check-out do documento foi realizado

165723

checkoutAllowed

Informações

title	Fique ligado

Campo depreciado

checkinDate

Informações

title	Fique ligado

Campo depreciado

checkinTime

Informações

title	Fique ligado

Campo depreciado

...

customFields - Campos customizados dos documentos

Lista os Plataforma ❙ Campos customizados dos documentos.

Coluna	Descritivo	Valor de Exemplo
customFieldsPK.customFieldId	Código do campo customizado	1
customFieldDescription	Descrição do campo customizado	Quantidade de páginas
customFieldsPK.companyId	Código da empresa	102
alwaysShow	Indica se está habilitado para mostrar em todos os documentos	true / false

...

destinationArea - Área dos documentos

Lista as Áreas cadastradas para os documentos.

...

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

Coluna

Descritivo

Valor de Exemplo

attributionValue

Valor do atributo de segurança

6kopfwg3gyubqq1444419140949

documentSecurityConfigPK.documentId

Código do documento

10903

downloadEnabled

Indica se está habilitado o download do documento

true / false

showContent

Indica se está habilitada a visualização do conteúdo do documento

true / false

documentSecurityConfigPK.companyId

Código da empresa

102

permission

Indica se o documento tem permissão

true / false

securityLevel

Nível de permissão de acesso ao documento

Informações

title	Fique ligado

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

3

inheritOriginSecurity

Propriedade que define se herda segurança

true / false

documentSecurityConfigPK.sequence

Sequência de prioridade do registro da segurança

1

inheritSecurity

Propriedade que define se herda segurança

true / false

documentSecurityConfigPK.version

Versão do documento

1000

attributionType

Define a atribuição da segurança.

Informações

title	Fique ligado

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

1

securityVersion

Informações

title	Fique ligado

Campo depreciado

...

topic - Assuntos dos documentos

Lista os assuntos dos documentos.

Coluna	Descritivo	Valor de Exemplo
updateEmail	Indica se está habilitada a notificação de atualização do assunto	true / false
topicPK.topicId	Código do assunto	1
removeEmail	Indica se está habilitada a notificação de eliminação do assunto	true / false
description	Descrição do assunto	Eventos
mandatory	Indica se o assunto é obrigatório	true / false
topicPK.companyId	Código da empresa	102

...

Coluna	Descritivo	Valor de exemplo
advancedProcessPropertiesPK.propertyId	Nome do atributo	pastaDoDocumento
propertieValue	Valor do atributo	54
advancedProcessPropertiesPK.processId	Código do processo	PROCESSO_A
advancedProcessPropertiesPK.companyId	Código da empresa	1
advancedProcessPropertiesPK.version	Código Versão do processo	2

businessPeriod -Cadastro de Expediente

...

Coluna

Descritivo

Valor de exemplo

businessPeriodPK.weekDay

Dia da Semana

1 - Domingo

2 - Segunda-feira

3 - Terça-feira

4 - Quarta-feira

5 - Quinta-feira

6 - Sexta-feira

7 - Sábado

businessPeriodPK.companyId

Código da empresa

1

businessPeriodPK.sequence

Sequencial de ordem do horário no dia

Informações

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

title	Fique ligado

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

28800

businessPeriodPK.periodId

Código do Expediente

Default

finalHour

Horário de final em segundos

Informações

title	Fique 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.

*Inserir versão fluig

*Inserir resumo do que faz este dataset

02/10/19 aa)

Coluna	Descritivo	Valor de exemplo
holidayDay	Dia do feriado	7
holidayYear	Ano do feriado	2022 0 (caso seja um feriado recorrente, ou seja, anual)
holidayMonth	Mês do feriado	1 - Janeiro 2 - Fevereiro ...
globalCalendarPK.holidayCalendarId	Descrição do feriado	Independência do Brasil
globalCalendarPK.companyId	Código da empresa	1
dayFormatted	Data do feriado	07-09-2022 (Formato dd-mm-

holiday - inserir significado

*Inserir versão fluig

aaaa)

No caso de feriado recorrente, virá o ano conforme o que foi cadastrado, não 0.

holiday - Cadastro de feriados

* TOTVS Fluig Plataforma 1.6.2 ou superior

O dataset holiday permite que se consulte os feriados cadastrados no fluig.*Inserir resumo do que faz este dataset

Coluna	Descritivo	Valor de exemplo
companyId	Código da empresa	1
holidayDay	Dia do feriado	7
holidayYear	Ano do feriado	2022 0 (caso seja um feriado recorrente, ou seja, anual)
holidayMonth	Mês do feriado	1 - Janeiro 2 - Fevereiro ...
id	código Código do feriado atribuído pela plataforma	1
HolidayCalendarIdholidayCalendarId	Descrição do feriado	Independência do Brasil
dayFormatted	Data do feriado	07-09-2022 (Formato dd-mm-aaaa)

processAttachment - inserir significado

*Inserir versão fluig

No caso de feriado recorrente, virá o ano conforme o que foi cadastrado, não 0.

processAttachment - Cadastro de anexos em solicitações

* TOTVS Fluig Plataforma 1.5.1 ou superior

O dataset processAttachment permite que se consulte os anexos de processos incluindo formulários da solicitação. *Inserir resumo do que faz este dataset

Coluna	Descritivo	Valor de exemplo
processAttachmentPK.companyId	Código da empresa	1
version	Versão do anexo

fieldValue

/formulário

1000

fieldValue1...fieldValue15

Campos auxiliares para filtro na central de tarefas.

Estes campos persistem os dados do formulário conforme definido nos campos de filtro na configuração do processo

2022-01-18

Opção 1

123

Nome

colleagueId

Matrícula do

uusário

usuário	adm
attachedDate	Data do anexo	2022-01-12T10:56:07-03:00
processAttachmentPK.processInstanceId	Número da solicitação	2
originalMovementSquence	Sequencial da movimentação que identifica em que momento da solicitação o anexo foi adicionado	3
processAttachmentPK.attachmentSequence	Sequencial de inclusão do anexo	4
documentId	Número do documento	8996
originalThreadSequence

l

Número da Thread de movimentação em que o anexo foi adicionado

0

processDefinition -

...

Cadastro de processos

* TOTVS Fluig Plataforma 1.5.1 ou superior

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

*Inserir versão fluig

*Inserir resumo do que faz este dataset

Coluna	Descritivo	Valor de exemplo
uniqueCardVersion	Versão única de formulário -	true / false
periodId	Código do expediente	Default
deadlineTime	Prazo de conclusão da solicitação em ms	18000 (5 minutos)
warningDeadlineTime	Prazo para entrar em alerta do prazo conclusão da solicitação em ms	10800 (3 minutos)
processDefinitionPK.processId	Código do processo	PROCESSO_A
baseDay	Depreciado. Não é mais utilizado.	0
notifyManagerComplements	Notifica gestor quando um complemento ou anexo for adicionado na solicitação	true false
active	Processo ativo ou inativo	true false
notifyRequisitionerComplements	Notifica requisitanterequisitante quando um complemento ou anexo for adicionado na solicitação	true false
managerEngineAllocationId	Código do mecanismo	managerEngineAllocationId	Mecanismo de atribuição do gestor do processo	Usuário Grupo
processDefinitionPK.companyId	Código da empresa	1
keyWord	Tags do processo	tag1 tag2
publicProcess	Mostra se o processo está como público	true false
baseMonth	Depreciado. Não é mais utilizado.	0
instruction	Instrução de processos	Texto contendo instruções do processo
processDescription	Descrição do processo	Processo de Compras
volumeId	Código do volume	Default
complementsLevel	managerEngineAllocationConfiguration	snapshotFrequency	categoryId	Categoria do processo	notifyAuthorityComplements	Notifica responsável

processDefinitionVersion - inserir significado

*Inserir versão fluig

*Inserir resumo do que faz este dataset

Configuração dos usuários que podem anexar e adicionar observações na solicitação quando não está sob sua responsabilidade	0 - Não configurado 1 - Solicitante, responsável(eis) por atividade e gestor 2 - Todos os participantes do processo e gestor 3 - Todos os usuários
managerEngineAllocationConfiguration	Configuração do mecanismo de atribuição do gestor do processo	<AssignmentController><User>adm</User></AssignmentController>
snapshotFrequency	Depreciado. Não é mais utilizado.	0
categoryId	Categoria do processo	Compras
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.

Coluna

Descritivo

Valor de exemplo

formId

Código do formulário

0 - Caso não tenha formulário

192

versionDescription

Descrição da versão

Nova Versão

controlsAttachmentsSecurity

Indica se a segurança de anexo está habilitada

bpmnVersion

true

active

false

processDefinitionVersionPK.processId

Código do processo

categoryStructure

editionMode

Indica se o processo está em edição

fullCategoryStructure

counterSign

inheritFormSecurity

processDefinitionVersionPK.companyId

blockedVersion

processDiagram

processDefinitionVersionPK.version

updateAttachmentsVersion

workflowColleagueRole - inserir significado

*Inserir versão fluig

*Inserir resumo do que faz este dataset

...

workflowRole - inserir significado

*Inserir versão fluig

*Inserir resumo do que faz este dataset

...

FLUIGADHOC - inserir significado

*Inserir versão fluig

*Inserir resumo do que faz este dataset

...

bpmnVersion	Controle indicativo se utiliza componentes não suportados na versão web	(em branco) - Caso seja criado pela web 1 - Caso seja criado pelo studio mas é suportado via web 2 - Caso seja criado pelo studio e não é suportado via web
active	Versão ativo ou inativa
processDefinitionVersionPK.processId	Código do processo	PROCESSO_A
categoryStructure	Depreciado. Não é mais utilizado.	(em branco)
editionMode	Indica se o processo está em edição	true false
fullCategoryStructure	Depreciado. Não é mais utilizado.	(em branco)
counterSign	Exige confirmação de senha na movimentação de todas as atividades	true false
inheritFormSecurity	Registros de formulário herdam segurança	true false
processDefinitionVersionPK.companyId	Código da empresa	1
blockedVersion	Depreciado. Não é mais utilizado.	false
processDiagram	SVG do diagrama	<?xml version="1.0" encoding="UTF-8"?> <svg ... />
processDefinitionVersionPK.version	Versão do processo	3
updateAttachmentsVersion	Atualiza anexos	true false

workflowColleagueRole - Listagem de usuários por papéis

* TOTVS Fluig Plataforma 1.5.1 ou superior

O dataset workflowColleagueRole permite que se consulte os usuários presentes em cada papel cadastrado.

Coluna	Descritivo	Valor de exemplo
workflowColleagueRolePK.companyId	Código da empresa	1
workflowColleagueRolePK.colleagueId	Matricula do usuário	adm
workflowColleagueRolePK.roleId	Código do papel	Comprador

workflowRole - Cadastro de papéis

* TOTVS Fluig Plataforma 1.5.1 ou superior

O dataset workflowRole permite que se consulte os papéis cadastrados no fluig.

...

FLUIGADHOCPROCESS - inserir significado

*Inserir versão fluig

*Inserir resumo do que faz este dataset

Coluna	Descritivo	Valor de exemplo	metadata#id
roleDescription	Nome do papel	Compradores da Empresa
workflowRolePK.companyId	Código da Empresa	1
workflowRolePK.roleId	Código do papel	Comprador

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.

Coluna	Descritivo	Valor de exemplo
metadata#id	Código do registro de formulário	5
metadata#parent_id	Código do formulário	3
metadata#version	Versão do registro do formulário	1000
metadata#card_index_id	Código do formulário	2
metadata#card_index_version	Versão do formulário	1000
metadata#active	Registro ativo	true false
cardid	Código do formulário	2
companyId	Código da empresa	1
detail	Campo "Descrição" no formulário	Tarefas adicionadas
documentid	Código do registro de formulário	5
dueDate	Campo "Prazo de conclusão" no formulário	15/01/2022 (dd/mm/yyyy)
id	Código sequencial dos registros desse formulário	1
meeting	Campo "Nome" no formulário	Tarefas
meetingDate	Campo "Data" no formulário	12/01/2022 (dd/mm/yyyy)
qtativ	Campo oculto no formulário que indica a quantidade de atividades adicionadas	1
tableid	Campo usado para diferenciar tabela pai x filho nos formulário quando existe	principal (Principal é quando não é um registro de uma tabela pai x filho)
version	Versão do registro de formulário	1000

FLUIGADHOCPROCESS - Dados das atividades em solicitações Adhoc/Listar Tarefas

* TOTVS Fluig Plataforma 1.5.1 ou superior

O dataset FLUIGADHOCPROCES permite que se consulte os dados das atividades criadas a partir de um processo listar tarefas ou adhoc.

Coluna	Descritivo	Valor de exemplo
metadata#id	Código do registro de formulário	6
metadata#parent_id	Código do formulário	4
metadata#version	Versão do registro do formulário	1000
metadata#card_index_id	Código do formulário	4
metadata#card_index_version	Versão do formulário	1000
metadata#active	Registro ativo	true false
activity	Campo "Ação" no formulário	Assinar documento
adHocDescription	Campo "Descrição" no formulário pai do processo Listar Tarefas	Tarefas adicionadas
cardid	Código do formulário	4
companyid	Código da empresa	1
deadline	Prazo de Conclusão da atividade	15/01/2022 (dd/mm/yyyy)
Código da empresa	ID do Documento	1
id	Código sequencial dos registros desse formulário	1
observation	Observação incluída na conclusão da atividade	Documento Assinado
opening	Data da criação da tarefa	12/01/2022 16:12:17 (dd/mm/yyyy hh:MM:ss)
request	Código da solicitação que gerou esse registro	1
requestDescription	Descrição do processo que gerou essa atividade	Listar Tarefas
requestText	Ao encerrar a atividade, a concatenação do código da solicitação que gerou o registro e a descrição do processo	1 - Listar Tarefas
requester	Usuário que criou a tarefa	adm
tableid	Campo usado para diferenciar tabela pai x filho nos formulário quando existe	principal (Principal é quando não é um registro de uma tabela pai x filho)
taskStatus	Status da atividade atual	0 - Em andamento 1 - Concluída 2 - Rejeitada
version	Versão do registro de formulário	1000	metadata#parent_id	metadata#version	metadata#card_index_id	metadata#card_index_version	metadata#active	activity	adHocDescription	cardid	companyid	deadline	Prazo de Conclusão	documentid	ID do Documento	id	observation	Observação	opening	request	requestDescription	requestText	requester	tableid	taskStatus	version

Datasets de Arquitetura

...

AccessLog - Log de acesso aos documentos

...

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 168

Nova versão 169

Chave

Datasets de Aprendizado

customFields - Campos customizados dos documentos

destinationArea - Área dos documentos

topic - Assuntos dos documentos

businessPeriod -Cadastro de Expediente

globalCalendar -

Cadastro de feriados

holiday - inserir significado

holiday - Cadastro de feriados

processAttachment - inserir significado

processAttachment - Cadastro de anexos em solicitações

processDefinition -

Cadastro de processos

processDefinitionVersion - inserir significado

processDefinitionVersion - Cadastro de versões de processos

workflowColleagueRole - inserir significado

workflowRole - inserir significado

FLUIGADHOC - inserir significado

workflowColleagueRole - Listagem de usuários por papéis

workflowRole - Cadastro de papéis

FLUIGADHOCPROCESS - inserir significado

FLUIGADHOC - Dados de solicitações Adhoc/Listar Tarefas

FLUIGADHOCPROCESS - Dados das atividades em solicitações Adhoc/Listar Tarefas

Datasets de Arquitetura

AccessLog - Log de acesso aos documentos