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: ./src/main/resources/files/export/calendars.csv
========================================================
EXPORT CALENDARS FINISHED SUCCESSFULLY
========================================================
End of execution.
Os arquivos são armazenados no diretório src/main/resources/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
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 DATABASE
.
# TIPO DE EXPORTAÇÃO
export.type=database
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.