Brazil Compliance Reports

Note: This integration is an extension that is developed outside the normal release schedule to meet specific customer needs. To request one of these extensions, you must submit a Salesforce Service Request to UKG. After the extension is delivered to your tenant, you can edit it accordingly.

Important Before you can configure Brazil Compliance Reports, you must open a support case to enable the Brazil Compliance feature on your tenant. Once the feature is enabled, you can turn on the feature switch and configure your Brazil Compliance Reports.

In compliance with legislation in Brazil, the Brazil Compliance Report extension generates multiple reports that employers provide to local authorities.

This extension relies on two component types to produce the reports:

When the Boomi™ integration completes, the report is available for download from the integration page. Reports remain available for future reference in the configured SFTP location.

Each report is designed with a fixed layout, but labels can be edited in the report properties file.

Reports available in this extension include:

  • Arquivo Eletronico de Jornada (AEJ) Report — Content focuses primarily on modifications made to punches The entries on a timecard that mark the beginning (in-punch) or end (out-punch) of a work interval, such as the beginning of a shift or transfer. after the employee clocks in. Record types vary based on the employee type.

  • Arquivo Fonte de Dados (AFD) Report — Content focuses on the initial collection of the punches. It must be generated by the vendor device or the software where the punches were collected:

    • If certified clocks are used, then the report must be made available by the clock producer.

      • Since UKG is not providing certified clocks to our Brazilian users, all REP-C type employees will be ignored for the AFD report.

    • If punches are added or modified, then the report must be made available by the software provider (in this case UKG). These punches could have been added manually, for example, through Timestamp, API, or mobile devices.

  • Proof of Punch Report — Provides employees with access to their punch information for verification purposes. Offers email delivery directly to the employee.

  • Timecard Mirror Report — Contains employee timecard information relative to the selected date range.

    Note: This extension generates the required digital signature for each report and then uploads the signature file to the same location as the report file.
    AEJ and AFD report files are given a .TXT extension and signature files are given a .P7S extension; Proof of Punch and Timecard Mirror report and signature files are given a .PDF extension.

The Brazil Compliance Reports extension:

  • requires correct configuration of the SFTP location.

  • requires that appropriate SFTP access is granted to those who view generated reports.

  • assumes the correct Brazil Compliance configuration in the People Information record for each individual who is expected to be included in the reports.

  • assumes that the generated report file size does not exceed 1024 KB. When generated report files exceed the maximum size, you must narrow the date range or reduce the number of employees that are returned by the filter.

  • places digitally signed report files in the designated Outbound Directory. In the event of a digital signature failure, unsigned reports are placed in the designated Archive Directory.

  • implements a ten (10) second delay when generating the Proof of Punch and Timecard Mirror Reports. A callback message is shown on the integration run page:

    • Status: In Progress

    • Message: Proof of Punch report / Timecard Mirror report is in progress.

  • optionally delivers the Proof of Punch Report to employees by way of email.

Run the Brazil Compliance Reports integration

After navigating to the integration, the user selects either a Hyperfind or specific employees, time period, and one or more reports.

If the user selects the Proof of Punch Report, they choose whether or not to send the report to the employee.

The user then runs the integration.

View the status

When the integration completes, view the Integration Run Details for run status.

Download files

The user downloads report files from the Output Files section of the Run Integration Details pane. Optionally, the user can choose to download all files in .ZIP format from the same location.

Before you configure the Brazil Compliance Reports integration, you must do the following:

  1. Configure Access to Integrations

  2. Configure the following:

    • Feature Switch: Enable the Brazil Compliance feature switch. See the Feature Switch topic.

    • System Settings: Configure the following Timekeeping Brazil Compliance system settings:
      site.timekeeping.brc.exportFile.PTRPdeveloperEmail,
      site.timekeeping.brc.exportFile.defaultReason,
      site.timekeeping.brc.exportFile.aej.day.paycode A category of time or money that employees earn, for example, Regular Hours, Bonus, or Sick..Duration,
      sitetimekeeping.brc.mirror.combinedPayCode.name.
      See the Timekeeping System Settings topic.

    • Function Access Profiles (FAP): Edit the FAPs assigned to individuals who run the reports.
      Allow the following Manager — Common Setup > Brazil Compliance access control points:
      Setup Items,
      People Record Configuration,
      Retrieve Decrypted PII Data Values via API,
      Digitally Sign Brazil Reports.
      Allow the following Manager — Common Setup > Integrations access control point:
      Allow Manage SFTP.
      See the Function Access Profiles topic. Access

    • Brazil Device Setup: Set up a Brazilian data collection system to comply with Brazilian regulations that govern the use of electronic timekeeping systems. Edit required fields in each setup item:
      Pay Code Attribute Definitions (map the export keys with appropriate paycodes),
      Devices,
      Devices Groups,
      Companies.
      See the Brazil Device Setup topic.

    • Connections: Create a new or edit an existing SFTP Connection with all required parameters; and then test the connection. See the Configure the SFTP Connection topic.

    • Integration List Parameters: Create integration list parameters that identify the Brazil Compliance reporting period and the report list. See the Configure Integration List Parameters topic.

      Name: BrazilComplianceReportingPeriod

      Description: Reporting period list.

      Parameter values:

      NameValue
      Current MonthCurrent Month
      Current YearCurrent Year
      Previous MonthPrevious Month
      Previous YearPrevious Year
      Caution: Parameter values configured in the BrazilComplianceReportingPeriod integration list parameter must match this example.

      Name: BrazilComplianceReportList

      Description: Contains a list of all Brazil Compliance report names from which a selection is made to run a report.

      Parameter values:

      NameValue
      AEJ ReportAEJ Report
      AFD ReportAFD Report
      Proof of Punch ReportProof of Punch Report
      Timecard Mirror ReportTimecard Mirror Report
      Caution: Parameter values configured in the BrazilComplianceReportList integration list parameter must match this example.

    • Extensions Tables: Create the required extension tables that store Brazil Compliance reports data. See the Extension Tables topic.

      • Enter the following in the Commands for execution field for each extension table definition:

      Create TABLE aejrecord
      (
      Company VARCHAR(255),
      RecordType VARCHAR(255),
      FileData VARCHAR(255)
      );

      CREATE TABLE afdrecord (

      Identifier VARCHAR(30),

      Employer VARCHAR(30),

      Rep_Type VARCHAR(30),

      filedata TEXT,

      recordtype VARCHAR(2)

      );

      CREATE TABLE proofofpunch
      (
      Header VARCHAR(255),
      PersonNum VARCHAR(255),
      Nsr VARCHAR(255),
      EmployerName VARCHAR(255),
      EmployerCNPJ VARCHAR(255),
      EmployerIdentifier VARCHAR(255),
      CEInCAEPFnCNO VARCHAR(255),
      Location VARCHAR(255),
      EmployeeName VARCHAR(255),
      EmployeeCPF VARCHAR(255),
      EmployeeIPIN VARCHAR(255),
      PunchDateTime VARCHAR(255),
      PunchSource VARCHAR(255),
      HashCode VARCHAR(255),
      DigitalSignature VARCHAR(255),
      ReportRunDateTime VARCHAR(255)
      );

      Create Table TimecardMirrorReportPeople

      (PersonNumber VARCHAR(255),

      HeaderReport VARCHAR(255),

      EmployerName VARCHAR(255),

      EmployerCNPJ VARCHAR(255),

      EmployerIdentifier VARCHAR(255),

      EmployerCEI VARCHAR(255),

      EmployerCAEPF VARCHAR(255),

      EmployerLocation VARCHAR(255),

      EmployerCNO VARCHAR(255),

      EmployeeName VARCHAR(255),

      EmployeePIS VARCHAR(255),

      EmployeeCPF VARCHAR(255),

      EmployeePrimaryJob VARCHAR(255),

      EmployeeHireDate VARCHAR(255),

      ReportTimePeriod VARCHAR(255),

      VerficationMessage VARCHAR(255),

      ReportRunDate VARCHAR(255),

      TimePeriodStartDate VARCHAR(255)

      );

      Create Table TimecardMirrorReportSchedule
      (
      PersonNumber VARCHAR(255),
      ReportTimePeriod VARCHAR(255),
      HeaderSchedule VARCHAR(255),
      EmployeeScheduleCode VARCHAR(255),
      EmployeeUniqueShiftStartTime1 VARCHAR(255),
      EmployeeUniqueShiftEndTime1 VARCHAR(255),
      EmployeeUniqueSegmentStartTime2 VARCHAR(255),
      EmployeeUniqueSegmentEndTime2 VARCHAR(255)
      );

      Create Table TimecardMirrorReportPunch

      (

      PersonNumber VARCHAR(255),

      ReportTimePeriod VARCHAR(255),

      EmployeePunchDate VARCHAR(255),

      PunchElectronicsSource VARCHAR(255),

      PunchEntry1 VARCHAR(255),

      PunchExit1 VARCHAR(255),

      PunchEntry2 VARCHAR(255),

      PunchExit2 VARCHAR(255),

      PunchEntry3 VARCHAR(255),

      PunchExit3 VARCHAR(255),

      EmployeeScheduleTotalScheduledDurationMins VARCHAR(255),

      EmployeeScheduleTotalScheduleCodeForDay VARCHAR(255),

      EmployeePunchTime VARCHAR(255),

      EmployeePunchType VARCHAR(255),

      EmployeePunchComment VARCHAR(255),

      EmployeePunchDateFormat VARCHAR(255)

      );

  3. Get the URL, User, and Password for the APIGatewayServer.

Important Before you can configure Brazil Compliance Reports, you must open a support case to enable Manage Read Only Reports on your tenant.
Change type Process Description
Initial release This release includes multiple configurable BIRT reports that are generated by way of Boomi™ based on user-selected timeframe or date range, and Hyperfind or specific employees. Completed reports are retrieved from the Report Library.
Proof_of_Punch_Report

Provides employees with access to their punch information for verification purposes.
Timecard_Mirror_Report

Contains information for all punches in the system. Also includes company name and number, address, employee PIS or social security number, and employee hire date. The report consists of two sections: Contractual Employee Schedules and Punch Detail.
  1. UKG Pro Workforce Management report configuration
    1. Customize the report labels.

      1. Unzip the shared .zip file.

      2. Navigate to the properties folder, and then open the properties file.

      3. Provide values for the report strings.

      4. Save the changes, and then add the updated file to the .zip file.

      5. Repeat these steps for each Brazil Compliance Report.
        Proof of Punch Report
        .zip fileProof_of_Punch_Report.zip
        Properties folderProof_of_Punch_Report -> Properties
        Properties filereport_com.kronos.report.data.design.Proof_of_Punch_Report_strings
        Report strings

        NSR
        Employer
        Employer\ CNPJ
        CEI/CAEPF/CNO
        Local
        Employee
        Employee\ CPF
        Punch\ Datetime
        INPI
        Punch\ Source
        Hash
        Digital\ Signature
        Report\ Run\ Datetime
        Page
        of

        Timecard Mirror Report
        .zip fileTimecard_Mirror_Report.zip
        Properties folderTimecard_Mirror_Report -> Properties
        Properties filereport_com.kronos.report.data.design.Timecard_Mirror_Report_strings
        Report strings

        Report\ Issued\ On
        Employer
        CNO
        CAEPF
        Address:
        Employee
        PIS
        CPF
        Employee\ Name
        Primary\ Labour\ Account
        Hire\ Date
        Time\ Period
        Schedule\ Code\ (CH)
        Entry
        Exit
        Date
        Punches\ from\ electronic\ source
        Work\ Performed\ (TimeCard)
        Duration
        CH
        Treatments\ performed\ on\ original\ data
        Time
        Type
        Reason
        Manager's\ Signature
        Page
        of

    2. Localize the report strings.

      1. Unzip the shared file.

      2. Create a new properties file that adheres to the following naming convention:

        report_com.kronos.report.data.design.Proof_of_Punch_Report_strings_<languageCode>_<countryCode>.properties

        Example: report_com.kronos.report.data.design.Proof_of_Punch_Report_strings_en_US.properties

      3. Copy each key and value data pair from the strings properties file, and then paste the content into the new file.

      4. Replace all values after the "=" with required locale data, and then save the properties file.

      5. Zip the file after completing and saving all localization.

    3. Repeat these steps for each Brazil Compliance Report.
      Proof of Punch Report
      .zip fileProof_of_Punch_Report.zip
      Properties folderProof_of_Punch_Report -> Properties
      Localized properties filereport_com.kronos.report.data.design.Proof_of_Punch_Report_strings_<languageCode>_<countryCode>
      Timecard Mirror Report
      .zip fileTimecard_Mirror_Report.zip
      Properties folderTimecard_Mirror_Report -> Properties
      Localized properties filereport_com.kronos.report.data.design. Timecard_Mirror_Report_strings_<languageCode>_<countryCode>
      Note:

      Refer to the table for appropriate character sequences to use in the properties file.

      Character sequence
      CharacterCharacter Sequence
      Space\
      Colon\:
      Semicolon\;
      Blank\t
      Note:

      • If you plan to test the report in your non-production (NPR) environment before implementation in your production (PRD) environment, you must complete each of the following UKG Pro WFM report configuration steps in both NPR and PRD environments.

      • Manage Read Only Reports must be enabled on the tenant in the NPR environment.

  2. Migrate the report data objects (RDO) configuration to the tenant Migrate each Brazil Compliance Report RDO .zip file to the customer tenant using Setup Data Manager (SDM) Moves and manages configuration data across software and hardware environments. (SDM Setup Data Manager moves and manages configuration data across software and hardware environments.).

    1. Log in to the appropriate tenant.

    2. Go to Main Menu > Administration > Setup Data Manager.

    3. Select the Source tenant where the RDO configuration resides, and select the template to copy. It is a .zip file. A message appears in the Source column: Source: Import from <filename>.zip.

    4. Click Tap Review and Publish. The Publish Summary panel appears.

    5. Review the Publish Summary panel. It lists the items that were extracted from the migration file. If you approve, click tap Publish with Comment or just Publish.

    6. Click Tap Go to Publish History at the bottom of the panel to view the status of the data transfer. The Publish History page contains a table that lists the items you have published. If there were errors during the transfer, the button under the Errors column for that row is black.

    7. To view details, click tap the appropriate row and click tap View Selected.

    8. On the History for publish run page, click tap Show all to view the setup data that you published, and the errors that occurred, if any, listed by item type and name.

    9. Repeat these steps for each Brazil Compliance Report.

      • SDM_Proof_of_Punch_Report_RDO.zip

      • SDM_Timecard_Mirror_Report_RDO.zip

  3. Deploy the Brazil Compliance Reports

    Note: The BIRT reports must be redeployed every time changes are made to existing report objects. Re-deployment is not required for integration process changes.

    1. Go to Main Menu > Administration > Application Setup > Common Setup > Manage Read-Only Report.

    2. Click Tap Create, and then select Choose File.

    3. Select a Brazil Compliance Report .zip file, and then click tap Upload.

    4. Click Tap Save after the upload completes.

    5. Go to Main Menu > Administration > Application Setup > Common Setup > Unpublished Reports.

    6. Select the Brazil Compliance Report, and then click tap Publish.

    7. Configure the report-specific fields:

      Report Name <Enter the name as it is configured in the integration list parameter, BrazilComplianceReportList.>
      Default Output Type: PDF
      Output formats: PDF
      Category: Custom Reports
      Report Parameters: Select Mandatory for Report ID and UniqueCode

      Note: The value entered in Report Name must match the report name configured in the Report List integration control parameter.

    8. Click Tap Save to publish the report. See the Unpublished Reports topic.

    Brazil Compliance Reports
    Brazil Compliance Report .zip file Output formats
    Proof_of_Punch_Report.zip PDF
    Timecard_Mirror_Report.zip PDF
  4. Approve the Brazil Compliance Reports

    1. Login to UKG Pro WFM as a Support User.

    2. Go to Main Menu > Administration > Application Setup > Common Setup > Manage Read-Only Report.

    3. Select the Brazil Compliance Report file, and then click tap Review.

    4. Select Approve, and then click tap Apply. This action changes the Approval Status from Pending to Approved.

    5. Repeat these steps for each Brazil Compliance Report.

      • Proof_of_Punch_Report

      • Timecard_Mirror_Report

  5. Configure access to the Brazil Compliance Reports

    Add each Brazil Compliance Report to the Report Data Access Profile assigned to individuals who run the report. See the Report Data Access Profiles topic.

Version Description
iPack_v1

Initial release.

Phase 1 of the Brazil Compliance Reports integration includes the Arquivo Eletronico de Jornada (AEJ), Proof of Punch, and Timecard Mirror Reports.

iPack_v1

Enhancement

  • The integration returned an error when running the AEJ Report when the Punch Audit API did not return a field override to identify the punch type as “In Punch” or “Out Punch”.

  • Date format issues no longer exist in the Proof of Punch and Timecard Mirror Reports.
The integration will now generate the Arquivo Fonte de Dados file (AFD).

Deploy the Brazil Compliance Reports integration

Note: For more information, see the Deploy Integrations topic.

  1. Open the Integration Template Designer: Select Main Menu  > Administration > Application Setup > Integrations Setup > Design Integration Templates.

    Note: If prompted, enter your Username and Password. Click Tap Log in.

  2. Make sure that the Account is correct. If not, select the right account.

  3. Select the Deploy tab > Integration Packs.
  1. From the list in the left column, search for and select the Pro WFM Brazil Compliance Reports Extension integration.

Note: If the integration does not display, select Browse Integration Packs to search for and select the iPack.

  1. Click Tap Install.

  2. From Unattached Environments, select the environment in which to deploy the integration process for the selected integration. Click Tap the double-left arrows button Select items.

Configure the Brazil Compliance Reports integration settings

  1. Select the environment
    1. Select the Manage tab > Atom Management.
    2. Select your environment.
  2. Select environment extensions
    1. In Administration, click tap Environment Extensions.
    2. In Process Filter, click tap the magnifying glass Search button. It can take several seconds before the button becomes active.
  1. Scroll to and select the integration pack: BrazilComplianceReports > BrazilComplianceReports_iPack_v1.

Configure connection settings

Caution: If you select Use Default for the connection settings and process properties, ensure that Value is blank. If Value is not blank, that value overrides the default value whether or not Use Default is selected or cleared. Example: If the default value is abc, but Value shows xyz, the integration uses xyz regardless of the setting of Use Default.

  1. Select Connection Settings.

  2. From the Connection dropdown list, select and configure the following:

    Connection Settings
    Setting Required Actions
    BrazilComplianceReports_iPack_v1_APIGatewayServer Required

    To change the default API gateway server:

    1. Clear Use Default.
    2. Enter the URL to the server.

      Example: <tenantURL>/api
    BrazilComplianceReports_iPack_v1_SFTPServer Required

    The SFTP server setting defines the connection to the file that contains the records. Integrations access only the internal SFTP account.

    To change the default SFTP server parameters:

    1. For each field, clear Use Default.
    2. Enter the following values:

      • Enter the name of the internal Host.

      • Enter the number of the Port for the internal SFTP account.

      • In User, enter the username for the internal SFTP account.

      • In Password, select <Encrypted>. Enter the new password for the internal SFTP account.

      • Click Tap Apply.
    BrazilComplianceReports_iPack_v1_DatabaseServer Required

    The database server setting defines the connection to the file that contains the records.

    To change the default server parameters:

    1. For each field, clear Use Default.
    2. Enter the following values:

      In User, enter the username for the server.

      In Password, select <Encrypted>. Enter the password for the server. Click Tap Apply.

      Enter the Class Name.

      Enter the Connection URL for the database server.
    BrazilComplianceReports_iPack_v1_Locale_CRT Required Enable Override.

Configure process properties

  1. Select Process Properties.

    Caution: Do not edit the default values of the AuthenticationProperties. By default, cookies are enabled and set the values for authentication properties.

  2. Select BrazilComplianceReports_iPack_v1_CRTConfig to set process properties that must be configured before the integration can run. This main process starts the integration process and handles errors.

Process properties
Process property name Column header value
_BrazilComplianceReports_iPack_v1_Locale_CRT

Parameter Name,Locale Policy,Message,Description

Configure cross-reference tables

Cross-reference tables (CRT) are the look-up tables that the integrations use to translate parameter values. One or more data values from the source system can be used to assign one or more parameters in the destination system.

Note:
  • If more than one row matches a reference value, the first match is the output value.
  • If no match is found, the output value can be null, or the integration can produce errors.
  1. Select Cross Reference.

  2. From the Cross Reference dropdown list, select the BrazilComplianceReports_iPack_v1 table.

  3. Select Override, which allows you to:
    • Download the tables when you run the integration
    • Edit the table cells in Extensions
  4. When you finish, click tap OK.

BrazilComplianceReports_iPack_v1_Locale_CRT: Allows translation of messages into different languages.

Brazil Compliance Reports — Locale CRT structure
Column name Description
Parameter Name

Key for which localization is defined.

Warning: Internal parameter; do not change.
Locale Policy Locale Policy.

You can use an asterisk (*) as a wildcard, but put the less-restrictive locale policy names at the bottom of the table because the integration scans cross-reference tables from the top.
Message Message shown in Additional Details, or value of the label defined in the Run Summary section.

Example: Comment was not provided.
Description The description that is shown in Additional Details.

Example: The employee is not assigned a shift.
Note:

  • Localization of integration extensions remains optional, but is supported.

  • The cross-reference table (CRT) holds all messages represented with standard English labels; these apply to all locales when the Locale is set to a wildcard (*).

  • Some or all messages can be translated by adding lines to the table in their preferred translation for specific locales. Messages for the most commonly used Locale Policy should be defined at the top of the CRT.

  • Names of the parameters in the CRT column "Parameter Name" must be used as is. If any parameter value needs to be localized for a different Locale Policy, copy the "Parameter Name" with the * Locale Policy, add a new row to the CRT with the appropriate Locale Policy, and then add the localized values in the Message (or Value) and Description CRT columns.

  • Do not enter values in the CRT column "Description" if it is blank.

  • Do not modify placeholders (<>) or the configurable values that are included in the CRT column "Message" (or "Value").

Brazil Compliance Reports — Locale sample content
Parameter name Locale Policy Message Description
Error_BIRTReportRun Brazilian Portuguese Relatórios falharam no BIRT. Relatórios falharam no BIRT.
Error_CallBackAPIFailed Brazilian Portuguese Código de resposta geral malsucedido recebido da API ao executar o retorno de chamada. Código de resposta geral malsucedido recebido da API ao executar o retorno de chamada.
Error_CompDate Brazilian Portuguese A Data de Início deve ser anterior à Data de Término. A Data de Início deve ser anterior à Data de Término.
Error_DigitalSignApiFailed Brazilian Portuguese Falha na API de assinatura digital. Localize o relatório não assinado no diretório Archive. Falha na API de assinatura digital. Localize o relatório não assinado no diretório Archive.
Error_HyperfindAndLocationSelector Brazilian Portuguese HyperfindAndLocation ou EmployeeID devem ser fornecidos. HyperfindAndLocation ou EmployeeID devem ser fornecidos.
Error_IntializeDefaultTryCatchError Brazilian Portuguese Erro encontrado durante a execução da integração. Consulte Relatório de Processo para obter mais detalhes. Erro encontrado durante a execução da integração. Consulte Relatório de Processo para obter mais detalhes.
Error_InvalidDateFormat Brazilian Portuguese Configuração de formato de data inválida. Formato de data incorreto no parâmetro de integração.
Error_InvalidEmployeeProvided Brazilian Portuguese Funcionário inválido fornecido. Funcionário inválido fornecido.
Error_PayCodeAttribute Brazilian Portuguese Atributo de código de pagamento não configurado corretamente. Atributo de código de pagamento não configurado corretamente.
Error_PIS_eSocial_CPF Brazilian Portuguese PIS, eSocial e CPF não estão presentes. Pelo menos um desses itens deve estar presente para um funcionário. PIS, eSocial e CPF não estão presentes. Pelo menos um desses itens deve estar presente para um funcionário.
Error_ReportingPeriodStartDateEndDate Brazilian Portuguese O ReportingPeriod ou StartDate e EndDate devem ser selecionados. O ReportingPeriod ou StartDate e EndDate devem ser selecionados.
Error_ReportListNotSelected Brazilian Portuguese ReportList deve ser configurado. Lista de relatórios não configurada.
Invalid_Employee_Provided Brazilian Portuguese ID de funcionário inválido fornecido. ID de funcionário inválido.
Label_AEJTotalEmployeesDisqualified Brazilian Portuguese AEJ Total de Funcionários Desqualificados Rótulo de Funcionários Desqualificados Total AEJ.
Label_AEJTotalEmployeesProcessed Brazilian Portuguese AEJ Total de Empregados Processados Rótulo AEJ Total de Funcionários Processados.
Label_AFDTotalEmployeesDisqualified Brazilian Portuguese Total de funcionários da AFD desqualificados Total de funcionários da AFD desqualificados
Label_AFDTotalEmployeesProcessed Brazilian Portuguese Total de funcionários da AFD processados Total de funcionários da AFD processados
Label_ContractualSchedulesHeader Brazilian Portuguese Cronogramas contratuais Rótulo de cabeçalho de cronogramas contratuais.
Label_ErrorMessage Brazilian Portuguese Mensagem de erro: Mensagem de erro:
Label_IntegrationExecutionId Brazilian Portuguese ID de execução Rótulo de ID de execução.
Label_IntegrationTypeName Brazilian Portuguese Tipo de integração Rótulo do tipo de integração.
Label_IntegrationTypeValue Brazilian Portuguese Exportação

Rótulo que exibe o tipo de integração de importação ou exportação.
Label_PersonNumber Brazilian Portuguese Número da pessoa Etiqueta do número da pessoa.
Label_POPBody Brazilian Portuguese Encontre o Relatório de Prova de Perfuração em anexo para a duração selecionada. Corpo do e-mail para o rótulo do relatório de prova de perfuração.
Label_POPSubject Brazilian Portuguese Relatório de prova de punção Assunto do e-mail para o rótulo do Relatório de Prova de Perfuração.
Label_POPTotalEmployeesDisqualified Brazilian Portuguese Prova Total de Funcionários Desqualificados Etiqueta de prova total de soco de funcionários desqualificados.
Label_POPTotalEmployeesProcessed Brazilian Portuguese Prova Total de Funcionários de Punch Processados Rótulo POP total de funcionários processados.
Label_TimecardHeader Brazilian Portuguese Relatório de espelho de cartão de ponto eletrônico Etiqueta de relatório de espelho de cartão de ponto eletrônico.
Label_TimecardMirrorReport Brazilian Portuguese Relatório de espelho de cartão de ponto Rótulo para relatório de espelho de cartão de ponto
Label_TMRTotalEmployeesDisqualified Brazilian Portuguese Cartão de ponto total de funcionários desqualificados Rótulo de desqualificado total de funcionários do cartão de ponto.
Label_TMRTotalEmployeesProcessed Brazilian Portuguese Cartão de ponto Total de funcionários processados Rótulo Total de funcionários processados do cartão de ponto.
Label_TotalEmployeeCount Brazilian Portuguese Contagem total de funcionários Rótulo de contagem total de funcionários.
Label_VerficationMessage Brazilian Portuguese Estou totalmente de acordo com as declarações e informações fornecidas acima, representando as atividades (ocorrências) durante o período de referência. Estou totalmente de acordo com as declarações e informações fornecidas acima, representando as atividades (ocorrências) durante o período de referência.
Message_AdditionalDetailsWithErrors Brazilian Portuguese Integração concluída com erros. Integração concluída com erros.
Message_AdditionalDetailsWithoutErrors Brazilian Portuguese Integração concluída sem erros. Integração concluída sem erros.
Message_CallbackMessagePOP Brazilian Portuguese Em andamento. O relatório Proof of Punch está sendo gerado. Em andamento. O relatório Proof of Punch está sendo gerado.
Message_CallbackMessageTimecard Brazilian Portuguese Em andamento. O relatório Espelho de Cartão de Ponto está sendo gerado. Em andamento. O relatório Espelho de Cartão de Ponto está sendo gerado.
Message_CompanyNameBlank Brazilian Portuguese O Nome da Empresa deve ser configurado. O Relatório AEJ não pode ser gerado porque o funcionário não tem uma atribuição de nome de empresa.
Message_EmailIDBlank Brazilian Portuguese Por favor, forneça o ID do e-mail Por favor, forneça o ID do e-mail.
Message_HyperfindLocationNoEmployeeFound Brazilian Portuguese O Hyperfind selecionado não retornou registros de funcionários. O Hyperfind selecionado não retornou registros de funcionários.
Message_IncorrectDateFormat Brazilian Portuguese Formato de data incorreto. Formato de data incorreto.
Message_IntegrationCompleted Brazilian Portuguese Integração concluída sem erros. Integração concluída sem erros.
Message_IntegrationCompletedWithAdditionalDetails Brazilian Portuguese Integração concluída sem erros. Detalhes adicionais, como desqualificações, podem ser acessados usando o botão abaixo. Integração concluída sem erros. Detalhes adicionais, como desqualificações, podem ser acessados usando o botão abaixo.
Message_IntegrationFailed Brazilian Portuguese Processo concluído com erros de nível de registro. Processo concluído com erros de nível de registro.
Message_IntegrationFailedWithAdditionalDetails Brazilian Portuguese Processo concluído com erros de nível de registro. Detalhes adicionais, como desqualificações, podem ser acessados usando o botão abaixo. Processo concluído com erros de nível de registro. Detalhes adicionais, como desqualificações, podem ser acessados usando o botão abaixo.
Message_PayCodeAttributeBlank Brazilian Portuguese Fornecer atributo de código de pagamento para Funcionário Fornecer atributo de código de pagamento para Funcionário
Message_RepTypeC Brazilian Portuguese Rep Tipo C não suportado. O relatório AFD não pode ser gerado porque o funcionário não tem uma atribuição RepType C.
Message_TimecardReportDeleteComment Brazilian Portuguese Punção incorreta ou duplicada Comentário para perfurações excluídas do relatório de espelho do cartão de ponto
POP_HeaderName Brazilian Portuguese Comprovante de registro de tempo do trabalhador Título de Registro de Tempo do Comprovante de Tempo do Trabalhador.
Error_BIRTReportRun * Reports failed at BIRT. Reports failed at BIRT.
Error_CallBackAPIFailed * General unsuccessful response code received from API when executing call back. General unsuccessful response code received from API when executing call back.
Error_CompDate * Start Date must be earlier than End Date. Start Date must be earlier than End Date.
Error_DigitalSignApiFailed * Digital signature API failed. Please locate the unsigned report in the Archive directory. Digital signature API failed. Please locate the unsigned report in the Archive directory.
Error_HyperfindAndLocationSelector * HyperfindAndLocation or EmployeeID must be provided. HyperfindAndLocation or EmployeeID must be provided.
Error_IntializeDefaultTryCatchError * Error encountered during integration run. Please refer to Process Reporting for more details. Error encountered during integration run. Please refer to Process Reporting for more details.
Error_InvalidDateFormat * Invalid Date Format configuration. Incorrect Date Format in the Integration Parameter.
Error_InvalidEmployeeProvided * Invalid employee provided. Invalid employee provided.
Error_PayCodeAttribute * Paycode attribute not configured correctly. Paycode attribute not configured correctly.
Error_PIS_eSocial_CPF * PIS, eSocial and CPF are not present. At least one of these items must be present for an employee. PIS, eSocial and CPF are not present. At least one of these items must be present for an employee.
Error_ReportingPeriodStartDateEndDate * Either the ReportingPeriod or StartDate and EndDate must be selected. Either the ReportingPeriod or StartDate and EndDate must be selected.
Error_ReportListNotSelected * ReportList must be configured. Report list not configured.
Invalid_Employee_Provided * Invalid Employee ID provided. Invalid Employee ID.
Label_AEJTotalEmployeesDisqualified * AEJ Total Disqualified Employees AEJ Total Disqualified Employees label.
Label_AEJTotalEmployeesProcessed * AEJ Total Employees Processed AEJ Total Employees Processed label.
Label_AFDTotalEmployeesDisqualified * AFD Total Employees Disqualified AFD Total Employees Disqualified
Label_AFDTotalEmployeesProcessed * AFD Total Employees Processed AFD Total Employees Processed
Label_ContractualSchedulesHeader * Contractual schedules Contractual schedules heading label.
Label_ErrorMessage * Error Message Error Message
Label_IntegrationExecutionId * Execution ID Execution ID label.
Label_IntegrationTypeName * Integration type Integration type label.
Label_IntegrationTypeValue * Export Label that displays either import or export integration type.
Label_PersonNumber * Person Number Person Number label.
Label_POPBody * Please find the attached Proof of Punch Report for the selected duration. Email body for Proof of Punch Report label.
Label_POPSubject * Proof of Punch Report Email subject for Proof of Punch Report label.
Label_POPTotalEmployeesDisqualified * Total Proof of Punch Disqualified Employees Total Proof of Punch of Disqualified Employees label.
Label_POPTotalEmployeesProcessed * Total Proof of Punch Employees Processed Total POP of Employees Processed label.
Label_TimecardHeader * Electronic Timecard Mirror Report Electronic Timecard Mirror Report label.
Label_TimecardMirrorReport * Timecard Mirror Report Timecard Mirror Report label.
Label_TMRTotalEmployeesDisqualified * Timecard total Employees Disqualified Timecard total Employees Disqualified label.
Label_TMRTotalEmployeesProcessed * Timecard Total Employees Processed Timecard Total Employees Processed label.
Label_TotalEmployeeCount * Total employee count Total employee count label.
Label_VerficationMessage * I am in complete agreement with the representations and information given above, representing the activities (occurrences) during the reference period. I am in complete agreement with the representations and information given above, representing the activities (occurrences) during the reference period.
Message_AdditionalDetailsWithErrors * Integration completed with errors. Integration completed with errors.
Message_AdditionalDetailsWithoutErrors * Integration completed without errors. Integration completed without errors.
Message_CallbackMessagePOP * In Progress. The Proof of Punch report is generating. In Progress. The Proof of Punch report is generating.
Message_CallbackMessageTimecard * In Progress. The Timecard Mirror report is generating. In Progress. The Timecard Mirror report is generating.
Message_CompanyNameBlank * Company Name must be configured. The AEJ Report cannot be generated because the employee does not have a company name assignment.
Message_EmailIDBlank * Please provide EmailID Please provide Email ID.
Message_HyperfindLocationNoEmployeeFound * The selected Hyperfind returned no employee records. The selected Hyperfind returned no employee records.
Message_IncorrectDateFormat * Incorrect Date Format. Incorrect Date Format.
Message_IntegrationCompleted * Integration completed without errors. Integration completed without errors.
Message_IntegrationCompletedWithAdditionalDetails * Integration completed without errors. Additional details, such as disqualifications, may be accessible using the button below. Integration completed without errors. Additional details, such as disqualifications, may be accessible using the button below.
Message_IntegrationFailed * Process completed with record level errors. Process completed with record level errors.
Message_IntegrationFailedWithAdditionalDetails * Process completed with record level errors. Additional details, such as disqualifications, may be accessible using the button below. Process completed with record level errors. Additional details, such as disqualifications, may be accessible using the button below.
Message_PayCodeAttributeBlank * Provide paycode attribute for Employee. Provide paycode attribute for Employee.
Message_RepTypeC * Rep Type C not supported. The AFD report cannot be generated because the employee does not have a RepType C assignment.
Message_TimecardReportDeleteComment * Incorrect or Duplicate Punch Comment for Deleted Punches of Timecard Mirror Report
POP_HeaderName * Proof of Worker's Time Record Proof of Worker's Time Record heading.

After the integrations are deployed and the connection settings and process properties are configured, install the integrations to make them available for running or scheduling.

Note:
  • An integration template is the configured integration that you deploy to an Atom and then install to make available for running or scheduling.
  • An installed integration is a single instance of an integration that is based on an integration template. When you install an integration, you can define parameters or set parameters to be defined when the integration is run.
  1. Select Main Menu  > Administration > Application Setup > Integrations Setup > Install Integrations.
  2. Click Tap Create .
  3. In Integration Name enter a unique name, such as Brazil Compliance Reports.
  4. (Optional) Enter a Description.

    Note: Do not select API Integration.

  5. In File Access, select Source/Output Download to select a connection.

  6. In Connection, click Internal SFTP.

  7. (Optional) If the person who runs the integration does not have full access to integrations, select Execute Integration with System Account. This allows the integration access to all APIs in the FAP, and the relevant permissions and data, regardless of the FAP and GDAP of the person who runs the integration.

  8. (Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.

  9. Email Notifications

    (Optional)

    1. Select Yes to send email and control center notifications for integration runs.
    2. Enter the email addresses of the recipients for the following types of run status. For multiple recipients, separate the addresses by a comma, but no spaces:

      In Progress — The integration run started and has not finished.

      Completed — The integration ran successfully without errors.

      Failed — The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set A sequence of integrations that can be run on-demand or be scheduled., the integration set stops.

      Completed with Errors — The integration run has errors or could not run.

  10. In Skip Configuration, select None (default) to allow multiple integrations to run at the same time or with the same data without restrictions.

    Note: Do not select Allow Minute Interval.

  11. Integration template and parameters
    1. In Integration Template, select BrazilComplianceReports_iPack_v1.
    2. Click Tap Assign .
    3. In Integration Parameters, you can override default settings. Click Tap Create.
    4. Complete the configuration for each integration control parameter value.

    5. Click Tap Save.

      Repeat this step for each integration control parameter that supports the Brazil Compliance Reports process.

      Integration Parameters
      Parameter name Description / User prompt / Mandatory Template parameter Parameter type
      Hyperfind And Location

      The default Hyperfind or Location query that contains the employees for whom the integration is run.

      Default = 1 (All Home A query that returns a list of employees associated with a manager's employee group. All Home finds people who are active employees or active users as of today. Locations)

      User prompt = Yes

      Mandatory = Yes

      Note: Ad-hoc Hyperfinds are not supported.

      All Home does not include terminated and inactive employees even if they have totals during the period. To include these totals, configure a Hyperfind that includes terminated and inactive employees, and select that Hyperfind in this process property.

      The maximum number of employees in a Hyperfind is 3500. To process more employees, divide the population into smaller Hyperfinds to run sequentially.

      		 HyperfindAndLocation Hyperfind
      Employee ID

      A comma-separated list of specific employees for whom the integration is run.

      When no value is entered, the integration defaults to the Hyperfind And Location parameter.

      To process the integration for only a limited group of employees, enter the person numbers as defined in the source system, each separated by a comma (,) but not spaces.

      User prompt = Yes

      Mandatory = Yes

      		 EmployeeID Text
      Start Date

      Start of the date range for which the report runs.

      User prompt = Yes

      Mandatory = Yes

      Note: Start Date and End Date selections take priority over the Reporting Period.

      		 StartDate Date
      End Date

      End of the date range for which the report runs.

      User prompt = Yes

      Mandatory = Yes

      Note: Start Date and End Date selections take priority over the Reporting Period.

      		 EndDate Date
      Reporting Period

      The integration list parameter which contains the list of predefined durations from which the user selects for the report run.

      Parameter value = BrazilComplianceReportingPeriod

      User prompt = Yes

      Mandatory = Yes

      		 ReportingPeriod Dropdown
      Date Format

      The date format utilized during the report export.

      Supported values:

      dd-MM-yyyy

      dd/MM/yyyy

      yyyy-MM-dd (default)

      yyyy/MM/dd

      User prompt = No

      Mandatory = Yes

      		 DateFormat Text
      Report List

      The integration list parameter which contains the list of reports from which the user selects.

      Parameter value = BrazilComplianceReportList

      User prompt = Yes

      Mandatory = Yes

      		 ReportList List
      Maximum File Size Limit

      The maximum file size that the Digital Signature API supports.

      Default = 1024

      User prompt = No

      Mandatory = Yes

      Warning: This value must not exceed 1024.

      		 MaximumFileSizeLimit Text
      Outbound Directory

      The SFTP directory where signed reports are uploaded.

      Default = /Outbound

      User prompt = No

      Mandatory = Yes

      		 OutboundDirectory Text
      Year Start Date

      Financial year start date entered using DD/MM format.

      Default = 01/01

      User prompt = No

      Mandatory = Yes

      		 YearStartDate Text
      Send Proof of Punch report to employee

      Determines whether to email the Proof of Punch report to the employee.

      Default = False

      User prompt = Yes

      Mandatory = Yes

      		 SendEmailToEmployee Boolean
      Archive Directory

      The SFTP directory where reports that are not signed by the Digital Signature API are uploaded.

      Default = /Outbound/Archive

      User prompt = No

      Mandatory = Yes

      		 ArchiveDirectory Text
  12. Make sure that the generic data access profiles (GDAP) allow access by the people who need to run the installed integrations. Select Administration > Application Setup > Integrations Setup > Access Profiles; see Configure Access to Integrations.

Run integrations to test that the configuration is set up correctly.

Run the integration

  1. Select the integration:
    1. Select Main Menu  > Maintenance > Integrations. 
    2. Click Tap Run an Integration . 
    3. Select the BrazilComplianceReports_iPack_v1 integration from the list. Click Tap Select. 
    4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the system assigns a default name, which ends with a date and time stamp.
  2. Set parameters as follows:
    • Hyperfind And Location: Select a Hyperfind or location query.
    • Employee ID: To process data for only a limited group of employees, enter the person numbers, as defined in the source system, each separated by a comma (,) but no spaces.

      For 3 employees: 13997,15556,20012

    • Start Date: Select the report start date.
    • End Date: Select the report end date.
    • Reporting Period: Select the predefined report duration.
    • Report List: Select the report generation list.
    • Select Proof of Punch report to employee: Select whether to email the Proof of Punch report to the employee.

  3. Select the following:

    • Run Integration: If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter values again. Click Tap Yes to continue, or No to not run the integration and to return to the parameter settings.

  4. Wait for the confirmation that the integration completed or failed. Close the panel.
  5. Click Tap Refresh . 
  6. To see details, select the integration run. Select Run Summary.

Check the results

Status indicators

  •  In-Progress: The run of this integration has not yet completed.
  •  Completed: The integration ran successfully without errors.
  •  Scheduled: This integration is scheduled to run later or repeatedly.
  • (Grayed out) Scheduled but Deleted: This integration is scheduled to run, but the integration template has been deleted. When it runs, it will generate an error. To prevent this error, delete the scheduled integration run.
  •  Completed with Errors: The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.
  •  Failed: The integration run has errors or could not run.
  • To troubleshoot and resolve errors, do the following:

    Check the Run Summary for details.

To check the results in more detail:

  1. Click Tap the tile A container that provides navigation or action from its summary view. for the integration run.
  2. Click Tap Run Summary to see the results of the integration run.

    Example Run Summary details

    Note: The available details vary by integration and configuration.

    • Integration Run Name: Name of this run of the integration.
    • Process Name: Name of any integration set that includes this integration.
    • Integration Name: Name of the installed integration.
    • Integration Reference ID: Unique identifier for this integration run (to help in troubleshooting errors).
    • User: The person or user account that ran the integration.
    • Integration Type: Import, Export, or None
    • Start Date: Date and time when the integration run started.
    • End Date: Date and time when the integration run finished.
    • Status: In-Progress, Completed, Completed with Errors, or Failed.
    • Records Processed: Number of records that were processed.
    • Records Created: Number of records that were created.
    • Errors: Number of records that failed.
    • Source Files, Output File, and Error Files: For file-based import integrations, use Manage SFTP to access the source and output files on the inbound (source) and outbound (destination) SFTP folders. See the Manage SFTP topic.
  3. Log in to the destination system and ensure that the data has been correctly updated.

Note: You can schedule integrations and integration sets to run once later or at a recurring frequency. See the Schedule Integrations topic.

API details
API name Type Resource path Description
Current User Locale API GET /v1/commons/user_preferences/locale_policy?userCurrent=true Returns the current user Locale.
Tenant Default Locale API GET /v1/commons/user_preferences/locale_policy?tenantDefault=true Returns user preferences for the tenant.
Execute Hyperfind API POST /v1/commons/hyperfind/execute Executes a Hyperfind query by ID or qualifier and returns the result.
Person Extension API POST /v1/commons/persons/extensions/multi_read  
Retrieve Schedule API POST /v1/scheduling/schedule/multi_read Returns schedule details.
Retrieve Timecard as Manager POST /v1/timekeeping/timecard/multi_read Retrieves details of Punches from Timecard.
Retrieve System Settings API GET /v1/timekeeping/brazil_compliance/system_settings Returns the details of Brazil system settings.
Retrieve Pay Code Attributes GET /v1/timekeeping/brazil_compliance/paycode_attribute_definitions Returns the Brazil Pay Code Definition details.
Timecard Audit API GET /v1/timekeeping/brazil_compliance/audits/apply_read Returns the punches audit data.
Retrieve Brazil Employee Assignment API POST /v1/commons/persons/brazil_employee_assignments/multi_read Returns the details of Brazil configuration details assigned to the employee.
Retrieve Brazil Device Groups API GET /v1/timekeeping/brazil_compliance/device_groups Returns the details of Brazil device groups.
Get Brazil Company API GET /v1/timekeeping/brazil_compliance/companies Returns the details of Brazil companies.
Execute Report by name POST /v1/platform/reports/{name}/execute Runs a report by name.
Retrieve Executed Report Output by ID GET /v1/platform/report_executions/{id}/file Returns an executed report by ID as an attachment.
Digital Signature POST /v1/timekeeping/brazil_compliance/reports/sign Digitally signs the reports(AEJ and Proof of Punch reports).
AEJ Report
  • File name: AEJ_<Company Name>_<Report Start Date>_<Report End Date>
  • File extension: .TXT and .P7S
  • Delimiter: Pipe (|)
  • Header row: Yes
  • Footer row: Yes
  • Target directory: <OutboundDirectory>

 

AFD Report

  • File name: AFD_Identifier_Employer_REP_Type
  • File extension: .TXT
  • Delimiter:
  • Header row:
  • Footer row:
  • Target directory: <OutboundDirectory>

Proof of Punch Report

  • File name: PUNCH_<EmployeeID>_<StartDate>_<EndDate >.pdf
  • File extension: .PDF
  • Delimiter:
  • Header row: No
  • Footer row: No
  • Target directory: <OutboundDirectory>

Timecard Mirror Report

  • File name: TIMECARD_MIRROR_REPORT_<StartDate>_<EndDate >.pdf
  • File extension: .PDF
  • Delimiter:
  • Header row: No
  • Footer row: No
  • Target directory: <OutboundDirectory>