Histórico da Página
...
Dica | ||
---|---|---|
| ||
A partir da atualização Lake 1.7.0-200714 os datasets internos passam a ter controle de permissionamento pelo Painel de controle. Saiba mais na documentação de Recursos de permissão em APIs e Webservices para mais detalhes. |
Datasets de Aprendizado
...
Nota | ||
---|---|---|
| ||
A partir da atualização 1.6.5-190219, o LMS não faz mais parte da plataforma para novas instalações. Mas, não se preocupe: se você adquiriu a plataforma com o LMS incluso, entre em contato com o Suporte Fluig para que você consiga utiliza-lo normalmente – mesmo após a atualização 1.6.5-190219. Se você não lembra se o LMS está incluso ou não no seu pacote, consulte sua proposta comercial ou entre em contato com o seu ESN. Dica | | |
|
Datasets do Social
...
PostDataset - Dataset dos posts publicados
...
*Obs: O campo followedAliad está documento conforme o retorno do dataset
Datasets de Documentos
...
AccessLog - Log de acesso aos documentos
Lista o log de acessos aos documentos registrados pela plataforma.
Coluna | Descritivo | Valor de Exemplo |
---|---|---|
AccessLogPK.documentId | Código do documento | 10903 |
AccessLogPK.accessDate | Data em que ocorreu o acesso | 2018-08-29 |
AccessLogPK.colleagueId | Matrícula do usuário | fernando.alves |
AccessLogPK.companyId | Código da empresa | 102 |
documentApprovalHistory - documentApprovalHistory - Histórico de aprovações do documento
...
Lista os documentos que estão em check-out. Para saber mais sobre o check-out, consulte nossa documentação de usuário Plataforma ❙ Efetuar check-out do documento.
Coluna | Descritivo | Valor de Exemplo | |||||
---|---|---|---|---|---|---|---|
allocatedDocumentPK.companyId | Código da empresa | 1 | |||||
allocatedDocumentPK.destinationDocument | Código do documento a ser alterado na pasta particular | 12903 | |||||
allocatedDocumentPK.sourceDocument | Código do documento original | 10654 | |||||
allocatedDocumentPK.sourceVersion | Versão do documento original | 1000 | |||||
checkoutDate | Data em que o check-out do documento foi realizado | 2018-08-29 | |||||
active | Indica se o documento está ativo | true / false | |||||
colleagueId | Matrícula do usuário responsável pelo check-out | fernando.alves | |||||
comment | Comentário realizado no momento do check-out | Vou editar porque... | |||||
checkoutTime | Hora em que o check-out do documento foi realizado | 165723 | |||||
checkoutAllowed |
| ||||||
checkinDate |
| ||||||
checkinTime |
|
...
customFields - Campos customizados dos documentos
Lista os Plataforma ❙ Campos customizados dos documentos.
Coluna | Descritivo | Valor de Exemplo |
---|---|---|
customFieldsPK.customFieldId | Código do campo customizado | 1 |
customFieldDescription | Descrição do campo customizado | Quantidade de páginas |
customFieldsPK.companyId | Código da empresa | 102 |
alwaysShow | Indica se está habilitado para mostrar em todos os documentos | true / false |
...
destinationArea - Área dos documentos
Lista as Áreas cadastradas para os documentos.
...
Retorna a configuração de segurança dos documentos.
Coluna | Descritivo | Valor de Exemplo | |||||
---|---|---|---|---|---|---|---|
attributionValue | Valor do atributo de segurança | 6kopfwg3gyubqq1444419140949 | |||||
documentSecurityConfigPK.documentId | Código do documento | 10903 | |||||
downloadEnabled | Indica se está habilitado o download do documento | true / false | |||||
showContent | Indica se está habilitada a visualização do conteúdo do documento | true / false | |||||
documentSecurityConfigPK.companyId | Código da empresa | 102 | |||||
permission | Indica se o documento tem permissão | true / false | |||||
securityLevel | Nível de permissão de acesso ao documento
| 3 | |||||
inheritOriginSecurity | Propriedade que define se herda segurança | true / false | |||||
documentSecurityConfigPK.sequence | Sequência de prioridade do registro da segurança | 1 | |||||
inheritSecurity | Propriedade que define se herda segurança | true / false | |||||
documentSecurityConfigPK.version | Versão do documento | 1000 | |||||
attributionType | Define a atribuição da segurança.
| 1 | |||||
securityVersion |
|
...
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 | |||||
---|---|---|---|---|---|---|---|
processTask.companyId | Código da empresa. | 102 | |||||
processTask.processInstanceId | Número da solicitação. | 24254 | |||||
processTask.movementSequence | Corresponde a quantidade de movimentações da solicitação workflow corrente. | 2 | |||||
choosedColleagueId | Código da matrícula do responsável escolhido para a tarefa. | adm | |||||
choosedSequence | Numero da atividade. | Número interno exemplo 6 | |||||
status | Status da atividade. Estado em que ela se encontra. | 0 - Não completada; 1 - Em consenso 2 - Completa 3 - Transferida 4 - Cancelada | |||||
active | Informa se a tarefa está ativa ou não. | 0 ou false; 1 ou true; | |||||
taskObservation | Mostra os complementos adicionados na tarefa. | "Registrado documento"
| |||||
noticeExpirationRequisitionerDate | Caso esteja marcada a opção de notificar expiração da tarefa para o requisitante, registra a data de notificação. | 2015-08-22 | |||||
noticeExpirationRequisitionerHour | Caso esteja marcada a opção de notificar expiração da tarefa para o requisitante, registra a hora de notificação. | em milisegundos | |||||
noticeExpirationAuthorityDate | Caso esteja marcada a opção de notificar expiração da tarefa para o responsável, registra a data de notificação. | 2015-08-22 | |||||
noticeExpirationAuthorityHour | Caso esteja marcada a opção de notificar expiração da tarefa para o responsável, registra a hora de notificação. | Em milisegundos | |||||
noticeExpirationManagerDate | Caso esteja marcada a opção de notificar expiração da tarefa para o gestor, registra a data de notificação. | 2015-08-22 | |||||
noticeExpirationManagerHour | Caso esteja marcada a opção de notificar expiração da tarefa para o gestor, registra a data de notificação. | Em milisegundos | |||||
taskCompletionDate | Mostra a data de conclusão de uma tarefa. | 2017-06-02T00:00:00-03:00
| |||||
taskCompletionHour | Mostra a hora de conclusão de uma tarefa. | 40533
| |||||
initialTermDate | Caso configurado no processo, mostra a data de início a contar para conclusão da tarefa. | 2017-06-01T00:00:00-03:00
| |||||
initialTermHour | Caso configurado no processo, mostra a hora de início a contar para conclusão da tarefa. | 51661
| |||||
deadlineDate | Caso configurado no processo, mostra a data final para conclusão da tarefa. | 2017-06-02T00:00:00-03:00
| |||||
deadlineHour | Caso configurado no processo, mostra a hora final para conclusão da tarefa. | 40533
| |||||
closureStatus | Marca o status da tarefa, se está em aberto (0) ou se foi finalizada no prazo (1), dentro do tempo de aviso de expiração (2) ou após expirada (3) | int de 0 a 3. Em aberto - 0; Finalizada no prazo - 1; Aviso de expiração - 2; Expirada - 3. | |||||
startDate | Indica a data e hora que foi movimentado para a atividade. Transferências não modificam esta data. | 2017-06-02T11:15:32-03:00 | |||||
assignDate | Indica a data e hora que foi criada a tarefa. Ao transferir uma atividade, a hora da transferência é associada aqui. | 2017-06-02T11:15:32-03:00 | |||||
assignEndDate | Indica data e hora que a tarefa foi concluída ou transferida pelo responsável. | 2017-06-02T11:15:32-03:00 1 - Uma tarefa que foi transferida e depois concluída, o assignEndDate vai marcar a data da transferência e a endDate vai marcar a data da conclusão. 2 - Em uma tarefa em consenso, quando um responsável tomou sua decisão vai gravar no assignEndDate, quando o consenso foi atingido, vai gravar na endDate. 3 - Em uma tarefa simples, onde apenas um usuário movimentou, os dois campos terão o mesmo valor. | |||||
endDate | Indica data e hora que a atividade foi concluída em todas as situações, não somente pelo responsável. Exemplo, consenso, múltiplas transferências. | 2017-06-02T11:15:33-03:00 1 - Uma tarefa que foi transferida e depois concluída, o assignEndDate vai marcar a data da transferência e a endDate vai marcar a data da conclusão. 2 - Em uma tarefa em consenso, quando um responsável tomou sua decisão vai gravar no assignEndDate, quando o consenso foi atingido, vai gravar na endDate. 3 - Em uma tarefa simples, onde apenas um usuário movimentou, os dois campos terão o mesmo valor. | |||||
warningDate | Indica a data e hora em que a tarefa passa a ser considerada em alerta. | 2017-06-02T11:15:32-03:00 | |||||
deadline | Indica a data e hora de expiração da atividade. | 2017-06-02T11:15:32-03:00 | |||||
completeColleagueId |
processState - Atividades do processo
...
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
| 2 | |||||
initialHour | Horário de início em segundos
| 28800 | |||||
businessPeriodPK.periodId | Código do Expediente | Default | |||||
finalHour | Horário de final em segundos
| 43200 |
globalCalendar -
...
Cadastro de feriados
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset globalCalendar permite que se consulte os feriados cadastrados no fluig. Este dataset está depreciado a partir da 1.6.2 e não deve mais ser utilizado. Utilize o dataset holiday.
Coluna | Descritivo | Valor de |
---|
*Inserir versão fluig
*Inserir resumo do que faz este dataset
Coluna | Descritivo | Valor de exemplo | |
---|---|---|---|
holidayDay | Dia do feriado | 7 | |
holidayYear | Ano do feriado | 2022 0 (caso seja um feriado recorrente, ou seja, anual) | |
holidayMonth | Mês do feriado | 1 - Janeiro 2 - Fevereiro ... | |
globalCalendarPK.holidayCalendarId | Descrição do feriado | Independência do Brasil | |
globalCalendarPK.companyId | Código da empresa | 1 | |
dayFormatted | Data do feriado | 02/10/1907-09-2022 (Formato dd-mm- | aaaaaa) |
holiday - inserir significado
*Inserir versão fluig
*Inserir resumo do que faz este dataset
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.
Coluna | Descritivo | Valor de exemplo |
---|---|---|
companyId | Código da empresa | 1 |
holidayDay | Dia do feriado | 7 |
holidayYear | Ano do feriado | 2022 0 (caso seja um feriado recorrente, ou seja, anual) |
holidayMonth | Mês do feriado | 1 - Janeiro 2 - Fevereiro ... |
id | código Código do feriado atribuído pela plataforma | 1 |
holidayCalendarIdHolidayCalendarId | Descrição do feriado | Independência do Brasil |
dayFormatted | Data do feriado |
processAttachment - inserir significado
*Inserir versão fluig
07-09-2022 (Formato dd-mm-aaaa) No caso de feriado recorrente, virá o ano conforme o que foi cadastrado, não 0. |
processAttachment - Cadastro de anexos em solicitações
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset processAttachment permite que se consulte os anexos de processos incluindo formulários da solicitação. *Inserir resumo do que faz este dataset
Coluna | Descritivo | Valor de exemplo |
---|---|---|
processAttachmentPK.companyId | Código da empresa | 1 |
version | Versão do anexo/formulário |
1000 | ||
fieldValue1...fieldValue15 | Campos auxiliares para filtro na central de tarefas. Estes campos persistem os dados do formulário conforme definido nos campos de filtro na configuração do processo | 2022-01-18 Opção 1 123 Nome |
colleagueId | Matrícula do usuário | adm |
attachedDate | Data do anexo | 2022-01-12T10:56:07-03:00 |
processAttachmentPK.processInstanceId | Número da solicitação | 2 |
originalMovementSquence | Sequencial da movimentação que identifica em que momento da solicitação o anexo foi adicionado | 3 |
processAttachmentPK.attachmentSequence | Sequencial de inclusão do anexo | 4 |
documentId | Número do documento | 8996 |
originalThreadSequence |
Número da Thread de movimentação em que o anexo foi adicionado | 0 |
processDefinition -
...
Cadastro de processos
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset processDefinition permite que se consulte o cadastro de processos.
*Inserir versão fluig
*Inserir resumo do que faz este dataset
Coluna | Descritivo | Valor de exemplo | ||||
---|---|---|---|---|---|---|
uniqueCardVersion | Versão única de formulário - | true /false | ||||
periodId | Código do expediente | Default | ||||
deadlineTime | Prazo de conclusão da solicitação em ms | 18000 (5 minutos) | ||||
warningDeadlineTime | Prazo para entrar em alerta do prazo conclusão da solicitação em ms | 10800 (3 minutos) | ||||
processDefinitionPK.processId | Código do processo | PROCESSO_A | ||||
baseDay | Depreciado. Não é mais utilizado. | 0 | ||||
notifyManagerComplements | Notifica gestor quando um complemento ou anexo for adicionado na solicitação | true false | ||||
active | Processo ativo ou inativo | true false | ||||
notifyRequisitionerComplements | Notifica requisitanterequisitante quando um complemento ou anexo for adicionado na solicitação | true false | ||||
managerEngineAllocationId | Mecanismo Código do mecanismo de atribuição do gestor do processo | Usuário Grupo | ||||
processDefinitionPK.companyId | Código da empresa | 1 | ||||
keyWord | Tags do processo | tag1 tag2 | ||||
publicProcess | Mostra se o processo está como público | baseMonth true instructionfalse | ||||
baseMonth | Depreciado. Não é mais utilizado. | 0 | ||||
instruction | Instrução de processos | Texto contendo instruções do processo | ||||
processDescription | Instrução de processos | 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.
...
workflowColleagueRole - inserir significado
*Inserir versão fluig
*Inserir resumo do que faz este dataset
Coluna | Descritivo | Valor de exemplo | |||
---|---|---|---|---|---|
workflowColleagueRolePK.companyIdformId | Código da empresa | workflowColleagueRolePK.colleagueId | Matricula do usuário | workflowColleagueRolePK.roleId | Código do papel |
workflowRole - inserir significado
*Inserir versão fluig
*Inserir resumo do que faz este dataset
...
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 | true false |
bpmnVersion | Controle indicativo se utiliza componentes não suportados na versão web | (em branco) - Caso seja criado pela web 1 - Caso seja criado pelo studio mas é suportado via web 2 - Caso seja criado pelo studio e não é suportado via web |
active | Versão ativo ou inativa | |
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.
Coluna | Descritivo | Valor de exemplo |
---|---|---|
roleDescription | Nome do papel | Compradores da Empresa |
workflowRolePK.companyId | Código da Empresa | 1 |
workflowRolePK.roleId | Código do papel | Comprador |
attributionMecanism - Mecanismos de Atribuição
Lista todos os mecanismos de atribuição cadastrados na plataforma.
Coluna | Descritivo | Valor de Exemplo |
---|---|---|
attributionMecanismPK.attributionMecanismId | Código do mecanismo | Associado |
name | Nome do mecanismo | Atribuição por Associação |
description | Descrição do mecanismo | Permite compor lógicas complexas de atribuição |
attributionMecanismPK.companyId | Código da empresa | 1 |
FLUIGADHOC - Dados de solicitações Adhoc/Listar Tarefas
* TOTVS Fluig Plataforma 1.5.1 ou superior
O dataset FLUIGADHOC permite que se consulte os dados do formulário FLUIGADHOC que é utilizado pelo processo Listar Tarefas, padrão do fluig.
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.
FLUIGADHOC - inserir significado
*Inserir versão fluig
*Inserir resumo do que faz este dataset
Coluna | Descritivo | Valor de exemplo | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata#id | Código do registro de formulário | 6 | |||||||||||
metadata#parent_id | Código do formulário | 4 | |||||||||||
metadata#version | Versão do registro do formulário | 1000 | |||||||||||
metadata#card_index_id | Código do formulário | 4 | |||||||||||
metadata#card_index_version | metadata#activeVersão do formulário | cardid1000 | companyId | Código da empresa | detail | documentid | dueDate | id | meeting | meetingDate | qtativ | tableid | version |
FLUIGADHOCPROCESS - inserir significado
*Inserir versão fluig
*Inserir resumo do que faz este dataset
metadata#active | Registro ativo | true false | ||||||||||
activity | Campo "Ação" no formulário | Assinar documento | ||||||||||
adHocDescription | Campo "Descrição" no formulário pai do processo Listar Tarefas | Tarefas adicionadas | ||||||||||
cardid | Código do formulário | 4 | ||||||||||
companyid | Código da empresa | 1 | ||||||||||
Coluna | Descritivo | Valor de exemplo | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata#id | metadata#parent_id | metadata#version | metadata#card_index_id | metadata#card_index_version | metadata#active | activity | adHocDescription | cardid | companyid | deadline | Prazo de Conclusão da atividade | 15/01/2022 (dd/mm/yyyy) |
Código da empresadocumentid | ID do Documento | 1 | ||||||||||
id | Código sequencial dos registros desse formulário | 1 | ||||||||||
observation | Observação incluída na conclusão da atividade | Documento Assinado | ||||||||||
opening | Data da criação da tarefa | 12/01/2022 16:12:17 (dd/mm/yyyy hh:MM:ss) | ||||||||||
request | requestDescription | requestText | requester | tableid | taskStatus | version |
Datasets de Arquitetura
AccessLog - Log de acesso aos documentos
Lista o log de acessos registrados pela plataforma.
...
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 |
Datasets de Arquitetura
...
...
colleague - Usuários da plataforma
...
Lista todos os grupos cadastrados na plataforma.
Coluna | Descritivo | Valor de Exemplo |
---|---|---|
groupDescription | Descrição do grupo | Desenvolvedores |
groupPK.companyId | Código da empresa | 102 |
groupPK.groupId | Código do grupo | 1 |