Configuring Pega Plantão as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Pega Plantão option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
You’ll need OAuth2 credentials and a coordinator login to connect to the Pega Plantão API. The following configurations are available:- Client ID: Your OAuth2 Client ID, requested from Pega Plantão support.
- Client Secret: Your OAuth2 Client Secret, requested from Pega Plantão support.
- Username: Login of the Pega Plantão coordinator user that will be used to sync data.
- Password: Password of the Pega Plantão coordinator user.
- Start Date: (Optional) The earliest date to sync for date-filtered streams. When omitted, date-filtered streams sync full history and the daily professional-status stream starts from today.
2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. Select the streams and click Next.3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer, a folder to organize it, a name for each table, and the type of sync. Once you are done configuring, click Next.4. Configure data source
Describe your data source for easy identification within your organization. Define your Trigger based on how often you need data updated. Once you are ready, click Next to finalize the setup.5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button.Some endpoints documented by the Pega Plantão API are not covered by this connector: Afastamentos (absences) has no GET endpoint (only POST/PUT/PATCH/DELETE), and Chamados, Contratos, Demonstrativos, and Fornecedores were out of scope for the initial implementation.
Streams and Fields
Below you’ll find all available data streams from Pega Plantão and their corresponding fields:Grupos
Grupos
| Field | Type |
|---|---|
| GroupId | string |
| Name | string |
Locais
Locais
| Field | Type |
|---|---|
| CodLocal | string |
| CodigoInterno | string |
| Nome | string |
| Descricao | string |
| Endereco | string |
| Cidade | string |
| Estado | string |
| Latitude | number |
| Longitude | number |
| Ativo | boolean |
Setores
Setores
| Field | Type |
|---|---|
| CodSetor | string |
| CodLocal | string |
| CodigoInterno | string |
| Nome | string |
| Descricao | string |
| Ativo | boolean |
Profissionais por Setor
Profissionais por Setor
| Field | Type |
|---|---|
| ProfessionalId | string |
| CodLocal | string |
| CodSetor | string |
| Name | string |
| string | |
| Phone | string |
| Phone1 | string |
| ProfessionalIdUF | string |
| Address | string |
| Address2 | string |
| AddressNumber | integer |
| Town | string |
| Zipcode | string |
| City | string |
| State | string |
| UserType | string |
| InternalCode | string |
| MoreDetails | string |
| CompanyName | string |
| CompanyTradeName | string |
| CNPJ | string |
| CPF | string |
| BankNumber | string |
| BankBranch | string |
| BankAccount | string |
| BankAccountOperation | string |
| AdmissionDate | datetime |
Financeiro
Financeiro
| Field | Type |
|---|---|
| CodigoPlantao | string |
| Local | string |
| CodigoLocal | string |
| Setor | string |
| CodigoSetor | string |
| Inicio | datetime |
| Fim | datetime |
| Tipo | string |
| Valor | number |
| ValorConsiderado | number |
| ProfFixo | string |
| CodigoProfFixo | string |
| ProfFixoStatus | string |
| ProfDePlantao | string |
| CodigoProfDePlantao | string |
| RegistroEntrada | datetime |
| RegistroSaida | datetime |
| DataCriacao | datetime |
Plantões
Plantões
| Field | Type |
|---|---|
| CodigoPlantao | string |
| Local | string |
| CodigoLocal | string |
| Setor | string |
| CodigoSetor | string |
| Inicio | datetime |
| Fim | datetime |
| Tipo | string |
| Valor | number |
| ProfFixo | string |
| CpfProfFixo | string |
| CodigoProfFixo | string |
| ProfFixoStatus | string |
| ProfDePlantao | string |
| CpfProfDePlantao | string |
| CodigoProfDePlantao | string |
| Descricao | string |
| ComentarioInterno | string |
| RegistroEntrada | datetime |
| RegistroSaida | datetime |
| Produtividades | string (JSON) |
| DataCriacao | datetime |
| Anunciado | boolean |
Profissionais (Lista)
Profissionais (Lista)
| Field | Type |
|---|---|
| ProfessionalId | string |
| Name | string |
| string | |
| Phone | string |
| Phone1 | string |
| ProfessionalIdUF | string |
| Address | string |
| Address2 | string |
| AddressNumber | integer |
| Town | string |
| Zipcode | string |
| City | string |
| State | string |
| UserType | string |
| InternalCode | string |
| MoreDetails | string |
| CompanyName | string |
| CompanyTradeName | string |
| CNPJ | string |
| CPF | string |
| BankNumber | string |
| BankBranch | string |
| BankAccount | string |
| BankAccountOperation | string |
| AdmissionDate | datetime |
Profissionais (Detalhes)
Profissionais (Detalhes)
| Field | Type |
|---|---|
| CodProfissional | string |
| string | |
| CodigoProfissao | string |
| CodUfConselhoProfissional | integer |
| RegistroConselhoProfissional | string |
| NomeCompleto | string |
| DataAdmissao | datetime |
| DadosContatoCodUf | integer |
| DadosContatoTelefone | string |
| DadosContatoCelular | string |
| DadosContatoCep | string |
| DadosContatoRua | string |
| DadosContatoNumero | integer |
| DadosContatoComplemento | string |
| DadosContatoCodCidade | integer |
| DadosContatoBairro | string |
| EnviarConvite | boolean |
| Detalhes | string |
| CodInterno | string |
| CPF | string |
| Grupos | array (string) |
Situação dos Profissionais
Situação dos Profissionais
| Field | Type |
|---|---|
| CodProfissional | string |
| DataInicio | string |
| NomeProfissional | string |
| CodSituacao | string |
| Situacao | string |
| HorarioPlantao | datetime |
| HorarioFimPlantao | datetime |
Tipos de Plantão
Tipos de Plantão
| Field | Type |
|---|---|
| TipoPlantaoId | string |
| Nome | string |
| Cor | string |