Serviço de Calendário

Este guia fornece exemplos de como internalizar a estrutura de calendário da sua organização, bem como exportar os calendários cadastrados no formato CSV.

Exportar Calendários - Exemplo de Implementação CSV

Para exportar os calendários cadastrados na organização no formato .csv, podemos fazer da seguinte maneira.

Configuração do Arquivo `fsense.properties`.

Definição do Serviço

No arquivo fsense.properties, defina o serviço a ser executado ajustando a propriedade service.name para CALENDAR_SERVICE.

    # SERVICO A SER EXECUTADO
    service.name=CALENDAR_SERVICE

Método do Serviço

Configure o método do serviço para EXPORT_CALENDARS através da propriedade service.method.

    # MÉTODO DO SERVIÇO A SER EXECUTADO
    service.method=EXPORT_CALENDARS

Tipo de Exportação

Especifique o tipo de exportação desejado através da propriedade export.type. Defina o como CSV para exportar para um arquivo CSV ou como DATABASE para exportar para um banco de dados. Para esta implementação, defina CSV.

    # TIPO DE EXPORTAÇÃO
    export.type=csv

Parâmetros de Exportação

É possível aplicar um filtro opcional por nome do calendário na exportação de calendários. Defina o parâmetro calendar.name como nome ou parte do nome do calendário que deseja exportar.

    # PARÂMETRO PARA EXPORTAÇÃO DE CALENDÁRIO
    calendar.name=Calendário Padrão

Execução da Aplicação

Após configurar o arquivo fsense.properties, execute a aplicação. A aplicação realizará um requisição HTTP à API fSense para obter os calendários e gerará um arquivo CSV como nome calendars.csv.

======================================================
SELECTED SERVICE [CALENDAR_SERVICE]
======================================================
EXPORTATION TYPE: CSV
======================================================
SELECTED METHOD [EXPORT_CALENDARS]
checking if token is valid?: false
======================================================
Starting authentication process
Getting access token
Token received.
1cdb6c76-0dab-4912-a1fa-771da67a1c55
======================================================
AUTHENTICATION SUCCESS
======================================================
Nº calendars found: 6
Nº Pages found: 1
Getting calendars page: 1/1
======================================================
GENERATING CSV FILE
======================================================
File generated: calendars.csv
Status: saved successfully
File saved in path: ./files/export/calendars.csv
========================================================
EXPORT CALENDARS FINISHED SUCCESSFULLY
========================================================
End of execution.

Os arquivos são armazenados no diretório ./files/export/.

Verificação da Operação

Após a execução da aplicação, abra o arquivo gerado para verificar as calendários exportadas. O arquivo exportado terá uma estrutura semelhante à do exemplo abaixo:

'id','externalCode','name'
'342','','Padrão'
'1016','','Calendário Alternativo'
'1045','','Novo Calendário'
'1048','a9cabe7401d1b83b9f63a906e5aff','Calendário com Código Externo'

Exportar Calendários - Exemplo de Implementação de Banco de Dados

Para exportar os calendários cadastrados na organização, fazendo a persistência no banco de dados, podemos fazer da seguinte maneira.

Configuração do Arquivo `fsense.properties`.

Definição do Serviço

No arquivo fsense.properties, defina o serviço a ser executado ajustando a propriedade service.name para CALENDAR_SERVICE.

    # SERVICO A SER EXECUTADO
    service.name=CALENDAR_SERVICE

Método do Serviço

Configure o método do serviço para EXPORT_CALENDARS através da propriedade service.method.

    # MÉTODO DO SERVIÇO A SER EXECUTADO
    service.method=EXPORT_CALENDARS

Tipo de Exportação

    # TIPO DE EXPORTAÇÃO
    export.type=database

DICA

Certifique-se que o banco de dados está devidamente configurado e a tabela previamente criada.

Se tiver dúvidas, consulte a seção Integração com Banco de Dados.

Parâmetros de Exportação

É possível aplicar um filtro opcional por nome do calendário na exportação de calendários. Defina o parâmetro calendar.name como nome ou parte do nome do calendário que deseja exportar.

    # PARÂMETRO PARA EXPORTAÇÃO DE CALENDÁRIO
    calendar.name=Calendário Padrão

Execução da Aplicação

Após configurar o arquivo fsense.properties, execute a aplicação. A aplicação realizará um requisição HTTP à API fSense para obter os calendários e em seguida, fará a persistência dos dados no banco.

======================================================
SELECTED SERVICE [CALENDAR_SERVICE]
======================================================
EXPORTATION TYPE: DATABASE
==========================================
SELECTED METHOD [EXPORT_CALENDARS]
checking if token is valid?: false
========================================================
Starting authentication process
Getting access token
Token received.
f109f26d-0f50-4e32-a33c-7772e1ee5014
========================================================
AUTHENTICATION SUCCESS
========================================================
Nº calendars found: 3
Nº Pages found: 1
Getting calendars page: 1/1
Open database connection
Saving on tb_calendars
==========================================
Update Count: 3
Database connection close
==========================================
End of execution.

Verificação da Operação

Após a execução da aplicação, abra a ferramenta de banco de dados de sua preferência e faça uma consulta na tabela tb_calendar.

SELECT * FROM tb_calendar;

A tabela terá uma estrutura semelhante à esta:

id	name	external_code
342	Padrão	-
1016	Calendário Alternativo	-
1051	Calendário Teste Importação	-

Exportar Calendário por Código Externo

Para fazer a exportação de um calendário por código externo, podemos fazer da seguinte maneira.

Configuração do Arquivo `fsense.properties`.

Definição do Serviço

No arquivo fsense.properties, defina o serviço a ser executado ajustando a propriedade service.name para CALENDAR_SERVICE.

    # SERVICO A SER EXECUTADO
    service.name=CALENDAR_SERVICE

Método do Serviço

Configure o método do serviço para EXPORT_CALENDAR_BY_EXTERNAL_CODE através da propriedade service.method.

    # MÉTODO DO SERVIÇO A SER EXECUTADO
    service.method=EXPORT_CALENDAR_BY_EXTERNAL_CODE

Tipo de Exportação

    # TIPO DE EXPORTAÇÃO
    export.type=csv

Parâmetros de Exportação

Para exportar um calendário, é preciso preencher o código do externo do calendário que deseja exportar. Defina o parâmetro calendar.externalcode com o valor correspondente ao código externo do calendário.

    # PARÂMETRO PARA EXPORTAÇÃO DE CALENDÁRIO
    calendar.externalcode=a9cabe7401d1b83b9faaaa906e5afff

NOTA

Este campo é obrigatório e deve ser preenchido com o valor do código externo do calendário que você deseja exportar. Se o código externo não for especificado, a exportação não será realizada.

Execução da Aplicação

Após configurar o arquivo fsense.properties, execute a aplicação. A aplicação realizará uma requisição HTTP à API fSense para obter os calendário pelo código externo e gerará um arquivo CSV como nome calendar_external_code_{ codigo externo }.csv. Durante a execução, a aplicação gerará um log semelhante a este.

======================================================
SELECTED SERVICE [CALENDAR_SERVICE]
======================================================
EXPORTATION TYPE: CSV
==========================================
SELECTED METHOD [EXPORT_CALENDAR_BY_EXTERNAL_CODE]
checking if token is valid?: false
========================================================
Starting authentication process
Getting access token
Token received.
1cdb6c76-0dab-4912-a1fa-771da67a1c55
========================================================
AUTHENTICATION SUCCESS
========================================================
GENERATING CSV FILE
=======================================================
File generated: calendar_external_code_a9cabe7401d1b83b9f63a906e5a6e.csv
Status: saved successfully
File saved in path: ./files/export/calendar_external_code_a9cabe7401d1b83b9f63a906e5a6e.csv
========================================================
EXPORT CALENDAR BY EXTERNAL CODE FINISHED SUCCESSFULLY
========================================================
End of execution.

Os arquivos são armazenados no diretório files/export/.

Verificação da Operação

Após a execução da aplicação, abra o arquivo gerado para verifica se o calendário por código externo foi exportado. O arquivo exportado terá uma estrutura semelhante à do exemplo abaixo:

'id','externalCode','name'
'1048','a9cabe7401d1b83b9f63a906e5a6e','Calendário com Código Externo'

Exportar Calendário por Id

Para fazer a exportação de um calendário por id, podemos fazer da seguinte maneira.

Configuração do Arquivo `fsense.properties`.

Definição do Serviço

No arquivo fsense.properties, defina o serviço a ser executado ajustando a propriedade service.name para CALENDAR_SERVICE.

    # SERVICO A SER EXECUTADO
    service.name=CALENDAR_SERVICE

Método do Serviço

Configure o método do serviço para EXPORT_CALENDAR_BY_ID através da propriedade service.method.

    # MÉTODO DO SERVIÇO A SER EXECUTADO
    service.method=EXPORT_CALENDAR_BY_ID

Tipo de Exportação

    # TIPO DE EXPORTAÇÃO
    export.type=csv

Parâmetros de Exportação

Para exportar um calendário, é preciso preencher o id (identificador único) do calendário que deseja exportar. Defina o parâmetro calendar.id com o valor correspondente ao identificador único do calendário.

    # PARÂMETRO PARA EXPORTAÇÃO DE CALENDÁRIO
    calendar.id=1016

NOTA

Este campo é obrigatório e deve ser preenchido com o valor do id do calendário que você deseja exportar. Se o código externo não for especificado, a exportação não será realizada.

Execução da Aplicação

Após configurar o arquivo fsense.properties, execute a aplicação. A aplicação realizará uma requisição HTTP à API fSense para obter os calendário pelo id e gerará um arquivo CSV como nome calendar_id_{ identificador único }.csv. Durante a execução, a aplicação gerará um log semelhante a este.

======================================================
SELECTED SERVICE [CALENDAR_SERVICE]
======================================================
EXPORTATION TYPE: CSV
==========================================
SELECTED METHOD [EXPORT_CALENDAR_BY_ID]
checking if token is valid?: false
========================================================
Starting authentication process
Getting access token
Token received.
1cdb6c76-0dab-4912-a1fa-771da67a1c55
========================================================
AUTHENTICATION SUCCESS
========================================================
GENERATING CSV FILE
=======================================================
File generated: calendar_id_1016.csv
Status: saved successfully
File saved in path: ./files/export/calendar_id_1016.csv
========================================================
EXPORT CALENDAR BY ID FINISHED SUCCESSFULLY
========================================================
End of execution.

Os arquivos são armazenados no diretório files/export/.

Verificação da Operação

Após a execução da aplicação, abra o arquivo gerado para verifica se o calendário por id foi exportado. O arquivo exportado terá uma estrutura semelhante à do exemplo abaixo:

'id','externalCode','name'
'1016','','Calendário Alternativo'

Importar Calendário

Para importar calendários calendários no fSense, a partir de um arquivo CSV, podemos fazer da seguinte maneira:

Definição do Serviço

No arquivo fsense.properties, defina o serviço a ser executado ajustando a propriedade service.name para CALENDAR_SERVICE.

    # SERVICO A SER EXECUTADO
    service.name=CALENDAR_SERVICE

Método do Serviço

Configure o método do serviço para IMPORT_CALENDAR através da propriedade service.method.

    # MÉTODO DO SERVIÇO A SER EXECUTADO
    service.method=IMPORT_CALENDAR

Tipo de Exportação

    # TIPO DE EXPORTAÇÃO
    export.type=csv

Definição do Caminho do Arquivo

É necessário informar o caminho do arquivo CSV contendo as informações dos feriados a serem importados. Se não houver nenhum arquivo pronto, há um modelo disponível no diretório src/main/resources/files/import/holiday_service_import_holiday.csv. Preencha as informações conforme as colunas indicadas no modelo. Configure o caminho para o diretório onde o arquivo CSV está localizado.

    #CAMINHO PARA IMPORTAR O ARQUIVO [O CAMINHO DEVE ESTAR PREVIAMENTE CRIADO]
    path.import = ./src/main/resources/files/import

Nome do Arquivo

Defina o nome do arquivo CSV que contém as informações dos calendários a serem importados.

    #NOME DO ARQUVIO A SER IMPORTADO [file.name=team_import.csv]
    file.name = holiday_service_import_holiday.csv

Configurações do CSV

Configure o delimitador e o qualificador de texto utilizados no arquivo CSV.

#CONFIGURAÇÕES DO CSV

#UTILIZE [VIRGULA] [PONTO E VIRGULA] OU [VAZIO] PARA O PARÂMETRO csv.delimiter
csv.delimiter = ,

#UTILIZE [VAZIO] [ASPAS SIMPLES] OU [ASPAS DUPLAS] PARA O PARÂMETRO csv.text.qualifier
csv.text.qualifier = '

NOTA

Certifique-se que o arquivo CSV esteja no formato correto e que os parâmetros de configurações correspondam ao formato do arquivo.

Execute a aplicação

Após configurar o arquivo fsense.properties, execute a aplicação. A aplicação realizará a leitura do arquivo CSV, processará os dados e importará os calendários para o fSense.

======================================================
SELECTED SERVICE [CALENDAR_SERVICE]
======================================================
EXPORTATION TYPE: CSV
======================================================
SELECTED METHOD [IMPORT_CALENDAR]
IMPORT DATA 1/1
======================================================
checking if token is valid?: false
======================================================
Starting authentication process
Getting access token
Token received.
1cdb6c76-0dab-4912-a1fa-771da67a1c55
======================================================
AUTHENTICATION SUCCESS
======================================================
{id: 1051, externalCode: null, name: Calendário Teste Importação}
======================================================
RESULT OF IMPORT OPERATION
======================================================
Finish of operation: 
Total of requests made: 1
Total of requests successfully: 1
Total of requests failed: 0
======================================================

Verificação da Operação

Após a execução da aplicação, abra o Painel de Gestão Online fSense no seu navegador e faça login. Navegue até a seção Jornadas > Calendário para verificar se os calendários foram importados corretamente. Caso haja algum erro durante a importação, uma mensagem de erro será exibida no console da aplicação. Verifique as mensagens de erro para solucionar possíveis problemas.

Modelo de Arquivo de CSV para importação

Se não houver um arquivo CSV pronto, utilize o modelo disponível no diretório src/main/resources/files/import/calendar_service_import_calendar.csv. Preencha as informações conforme as colunas indicadas no modelo. O arquivo tem uma estrutura semelhante ao exemplo abaixo:

'id','externalCode','name'
'','','Calendário Teste Importação'

Atualizar Calendário

Para atualizar calendários no fSense através do exemplo de integração, podemos fazer da seguinte maneira:

Definição do Serviço

No arquivo fsense.properties, defina o serviço a ser executado ajustando a propriedade service.name para CALENDAR_SERVICE.

    # SERVICO A SER EXECUTADO
    service.name=CALENDAR_SERVICE

Método do Serviço

Configure o método do serviço para UPDATE_CALENDAR através da propriedade service.method.

    # MÉTODO DO SERVIÇO A SER EXECUTADO
    service.method=UPDATE_CALENDAR

Tipo de Exportação

    # TIPO DE EXPORTAÇÃO
    export.type=csv

Definição do Caminho do Arquivo

É necessário informar o caminho do arquivo CSV contendo as informações dos feriados a serem atualizados. Se não houver nenhum arquivo pronto, há um modelo disponível no diretório src/main/resources/files/import/holiday_service_update_holiday.csv. Preencha as informações conforme as colunas indicadas no modelo. Configure o caminho para o diretório onde o arquivo CSV está localizado.

    #CAMINHO PARA IMPORTAR O ARQUIVO [O CAMINHO DEVE ESTAR PREVIAMENTE CRIADO]
    path.import = ./src/main/resources/files/import

Nome do Arquivo

Defina o nome do arquivo CSV que contém as informações dos calendários a serem atualizados.

    #NOME DO ARQUIVO A SER IMPORTADO [file.name=team_import.csv]
    file.name = holiday_service_update_holiday.csv

Configurações do CSV

Configure o delimitador e o qualificador de texto utilizados no arquivo CSV.

#CONFIGURAÇÕES DO CSV

#UTILIZE [VIRGULA] [PONTO E VIRGULA] OU [VAZIO] PARA O PARÂMETRO csv.delimiter
csv.delimiter = ;

#UTILIZE [VAZIO] [ASPAS SIMPLES] OU [ASPAS DUPLAS] PARA O PARÂMETRO csv.text.qualifier
csv.text.qualifier = '

NOTA

Certifique-se que o arquivo CSV esteja no formato correto e que os parâmetros de configurações correspondam ao formato do arquivo.

Execute a aplicação

Após configurar o arquivo fsense.properties, execute a aplicação. A aplicação realizará a leitura do arquivo CSV, processará os dados e atualizará os calendários no fSense.

======================================================
SELECTED SERVICE [CALENDAR_SERVICE]
======================================================
EXPORTATION TYPE: CSV
======================================================
SELECTED METHOD [UPDATE_CALENDAR]
IMPORT DATA 1/1
======================================================
checking if token is valid?: false
======================================================
Starting authentication process
Getting access token
Token received.
1cdb6c76-0dab-4912-a1fa-771da67a1c55
======================================================
AUTHENTICATION SUCCESS
======================================================
{id: 1051, externalCode: null, name: Calendário Teste Importação ATUALIZADO}
======================================================
RESULT OF UPDATE OPERATION
======================================================
Finish of operation: 
Total of requests made: 1
Total of requests successfully: 1
Total of requests failed: 0
======================================================

Verificação da Operação

Após a execução da aplicação, abra o Painel de Gestão Online fSense no seu navegador e faça login. Navegue até a seção Jornadas > Calendário para verificar se os calendários foram atualizados corretamente. Caso haja algum erro durante a atualização, uma mensagem de erro será exibida no console da aplicação. Verifique as mensagens de erro para solucionar possíveis problemas.

Modelo de Arquivo de CSV para importação

Se não houver um arquivo CSV pronto, utilize o modelo disponível no diretório src/main/resources/files/import/calendar_service_update_calendar.csv. Preencha as informações conforme as colunas indicadas no modelo. O arquivo tem uma estrutura semelhante ao exemplo abaixo:

'id','externalCode','name'
'1051','','Calendário Teste Importação ATUALIZADO'

Remover Calendário

Para remover calendários no fSense pela aplicação exemplo de integração, podemos fazer da seguinte forma:

Definição do Serviço

No arquivo fsense.properties, defina o serviço a ser executado ajustando a propriedade service.name para CALENDAR_SERVICE.

#SERVIÇO A SER EXECUTADO
service.name=CALENDAR_SERVICE

Método do Serviço

Configure o método do serviço para DELETE_CALENDAR_BY_ID através da propriedade service.method.

#MÉTODO DO SERVIÇO A SER EXECUTADO
service.method=DELETE_CALENDAR_BY_ID

Tipo de Exportação

Especifique o tipo de exportação desejado através da propriedade export.type. Para esta implementação, defina CSV.

    # TIPO DE EXPORTAÇÃO
    export.type=csv

Definição de Parâmetros de Remoção

Para remover um ou mais calendários, é necessário informar o identificador único do calendário que deseja remover através da propriedade calendar.remove.ids. É possível informar um ou mais ids, basta informá-los separados por vírgula.

#ID DOS CALENDÁRIOS PARA REMOVER
calendar.remove.ids=1016,1045,1051

Execução da Aplicação

Após configurar o arquivo fsense.properties, execute a aplicação. A aplicação realizará uma requisição HTTP à API fSense com os ids marcados para remoção. Durante a execução, a aplicação gerará um log semelhante a este.

==================================================
SELECTED SERVICE [CALENDAR_SERVICE]
==================================================
EXPORTATION TYPE: CSV
==================================================
SELECTED METHOD [DELETE_CALENDAR_BY_ID]
==================================================
checking if token is valid?: false
==================================================
Starting authentication process
Getting access token
Token received.
f109f26d-0f50-4e32-a33c-7772e1ee5014
==================================================
AUTHENTICATION SUCCESS
==================================================
CALENDAR ID TO BE REMOVED:  1045 - 1/5
Calendar id 1045 delete successfully
==================================================
CALENDAR ID TO BE REMOVED:  1046 - 2/5
==================================================
Calendar id 1046 delete successfully
==================================================
CALENDAR ID TO BE REMOVED:  1047 - 3/5
==================================================
Calendar id 1047 delete successfully
==================================================
CALENDAR ID TO BE REMOVED:  1048 - 4/5
==================================================
Calendar id 1048 delete successfully
==================================================
CALENDAR ID TO BE REMOVED:  1051 - 5/5
==================================================
Calendar id 1051 delete successfully
==================================================
RESULT OF DELETE OPERATION
==================================================
Finish of operation: 
Total of requests made: 5
Total of requests successfully: 5
Total of requests failed: 0
==================================================
End of execution.

Verificação da Operação

Após a execução da aplicação, abra o Painel de Gestão Online fSense no seu navegador e faça login. Navegue até a seção Jornadas > Calendário para verificar se os calendários foram removidos corretamente. Caso haja algum erro durante a operação. uma mensagem de erro será exibida no console da aplicação. Verifique as mensagens de erro para solucionar possíveis problemas.

Exportar Associações de Calendário

Para fazer a exportação das associações de calendário, podemos fazer da seguinte maneira.

Configuração do Arquivo `fsense.properties`.

Definição do Serviço

No arquivo fsense.properties, defina o serviço a ser executado ajustando a propriedade service.name para CALENDAR_SERVICE.

    # SERVICO A SER EXECUTADO
    service.name=CALENDAR_SERVICE

Método do Serviço

Configure o método do serviço para EXPORT_CALENDAR_ASSOCIATION através da propriedade service.method.

    # MÉTODO DO SERVIÇO A SER EXECUTADO
    service.method=EXPORT_CALENDAR_ASSOCIATION

Tipo de Exportação

    # TIPO DE EXPORTAÇÃO
    export.type=csv

Parâmetros de Exportação

Para exportar as associações de calendário, é preciso preencher o id (identificador único) do calendário que deseja exportar as associações. Defina o parâmetro calendar.id com o valor correspondente ao identificador único.

    # PARÂMETRO PARA EXPORTAÇÃO DE CALENDÁRIO
    calendar.id=342

NOTA

Este campo é obrigatório e deve ser preenchido com o valor do id do calendário que você deseja exportar as associações. Se o identificador único não for especificado, a exportação não será realizada.

Execução da Aplicação

Após configurar o arquivo fsense.properties, execute a aplicação. A aplicação realizará uma requisição HTTP à API fSense para obter as associações de calendário e gerará um arquivo CSV como nome calendar_id_{ identificador único }_associations.csv. Durante a execução, a aplicação gerará um log semelhante a este.

========================================================
SELECTED SERVICE [CALENDAR_SERVICE]
========================================================
EXPORTATION TYPE: CSV
========================================================
SELECTED METHOD [EXPORT_CALENDAR_ASSOCIATION]
checking if token is valid?: false
========================================================
Starting authentication process
Getting access token
Token received.
f109f26d-0f50-4e32-a33c-7772e1ee5014
========================================================
AUTHENTICATION SUCCESS
========================================================
EXPORTING TO CSV
========================================================
Generating file calendar_id_342_associations.csv
File: calendar_id_342_associations.csv saved successfully
File saved in path: ./files/export/calendar_id_342_associations.csv
EXPORT CALENDAR ASSOCIATION FINISHED SUCCESSFULLY
========================================================
End of execution.

Os arquivos são armazenados no diretório files/export/.

Verificação da Operação

Após a execução da aplicação, abra o arquivo gerado para verifica se as associações de calendário foi exportada. O arquivo exportado terá uma estrutura semelhante à do exemplo abaixo:

'associatedWorkdaysCount','associatedPeopleCount','associatedHolidaysCount','organizationDefault','lastAvailableCalendar'
'14','5','42','true','false'