Versions Compared

Version Old Version 16 New Version 17
Changes made by

yuriy.biryukov

Erick Meijer

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties

Latest Version

2022.20.0.6

Release Date

Download Path

Download

Change Log: 

...

Version

...

Date

...

Description

2023.10.1.1

Release Date

Download Path

Download

Change Log: 

Expand

Version

Date

Description

2023.10.1

  1. Entity Interface Id; added the possibility to define multiple Company Entity_Interface_id. In the configuration screen, you find a new tab, Entity Id, enabling you to link payscale tables to an Entity ID.

  2. Fixed the file name format; when exporting advanced and additional payments, the system generated the wrong file format. 
    File Name Format: 
    payment{custID}{optional client-defined data}{MMDDYYYYhhmmss}.txt
    The section {option client defined data} contains the information if it is advanced, addition or payment, the currency and company entity.

  3. Added the possibility to save the payment and enrollment files in two different directories—see Setup> General > Export Directories to select the directories to be used.

  4. Brightwell accepts the European Nation ID Card if the person does not hold a passport. 
    In Setup> Generate, you can select the travel book code identifying the ENID.

  5. The Brightwell interface supports adding multiple Company Entity_Interface_ID’s in one export file as separate batches. We have added the option “Slit export files by Entity ID in Setup > General. If checked, the plugin creates one export file for each entity id, adding the entity id to the section {option client defined data} of the file name..

  6. Brightwell does not support multiple currencies per account. If a person shifts from one currency to the next, the person needs to be enrolled once more in the new currency with a new unique identifier. We solved this by adding the currency to the PIN. Sample Pin=1234, Currency=USD => Brightwell Account no=1234USD.

    1. Switch on the option 'Allow multiple accounts based on currency' in Setup> General.

    2. In the candidate's tab, we added the following columns; Payscale Currency, Account.

    3. Updated the enrol functionality; only enrol persons linked to the selected currency.

    4. In the waiting for card tab, we improved the Card Received functionality by linking The bank account to the newly formatted account, Pin + Currency.

2022.20.0.6

 

Fixed the issues with disabled export button for Non Superuser

Fixed ‘Tag all/Untag all' buttons

Added the possibility to leave the Date field empty. In such case the Release_Date field in the export file will also be empty

Added the possibility to define the ‘Location’ field in the setup. This field is mandatory, and error will appear if the field is empty.

Changed the rule of the truncating First Name and Last Name fields:

  • FirstName should be truncated to 20 chars if exceeds;

  • LastName should be truncated to 20 chars if exceeds

...

Functionality

User Interface

...


Enroll Brightwell Form appears.
There are 5 tabs: Candidates, Waiting for Card, Members, Exclusion, Payment.

Candidates list all crew fitting to participate in the Brightwell program:

  • Employed state;

  • With current sea-service activity which linked to Opened Client org.unit or its sub-units and Start Date of activity = before or on the selected (on the form) Date;

  • Not a member of e.g. Ocean Pay or Citibank Direct Deposit programs.

    Image Removed


    Image Added



    By default, today's Date is defined.

    The red background indicates that you missed filling some mandatory fields for this person. Just click this record and the system will point you missed fields.
    You have the option to Enroll the selected crew in USD or EUR.
    This is for candidates' registration (a special text. file with all details will be generated).

    • The person will be moved to Waiting For Card page.

      You can also Exclude a candidate from the Brightwell program.

    • Will be moved to Excluded page.

      You can Print the list if needed.

      Help switches you to the Brightwell user manual.


Waiting for Card page lists all crew that is registered but have not received their card yet:

...

You can Print the list if needed. 

Help switches you to the Brightwell user manual.



Members page lists all current members of the program (which were registered and got cards):

...

You can Print the list if needed. 

Help switches you to the Brightwell user manual.


The exclusion page lists all crew that is not yet included in the program or was dismissed:

...

You can Print the list if needed. 

Help switches you to the Brightwell user manual.


The payment page lists persons which are ready for exporting to Brightwell for payments:

...

You will have also the possibility to lock the period of the persons who have already been exported.

Help switches you to the Brightwell user manual.



The Brightwell Navigator is a payments interface that simplifies your payroll distribution and gives your employees better control over their pay.
This document contains everything you will need to create batch files to register and pay your employees.
To be able to pay employees via the Brightwell program the employee will receive a debit card on which the payments are stored.
To receive a debit card the employee needs to be enrolled/registered in the Brightwell program.

...

  1. Click the Setup button to perform the required setup for data exporting:

    Image Removed


    Image Added



    Please define:
    1) Email Notification Address - should include at least one email address to receive file processing results (can be multiple addresses, separated by comma);
    2) Customer ID (mandatory, provided by Brightwell);
    3) Interface Entity ID (mandatory, provided by Brightwell);
    4) Product Group Alias (mandatory, provided by Brightwell);
    5) Card Stock Override Code (optional, provided by Brightwell).

  2. Browse the path on your PC where export files (registration/payment) will be saved.

  3. Each employee who will be paid through Navigator must first be registered.
    Tag needed person(s) who you want to be enrolled into the Brightwell program.

  4. Click Enroll command for the selected crew. Click USD or EUR (depends on person's payment currency).
    You will see two dialog boxes:
    Confirmation:





    Export completion:

    As a result, special text. the file will be generated and saved to your specified location.
    The file format allows you to send Brightwell the information needed to prepare each employee for Navigator enrolment.

    For technical documentation for an enrolment file sent to Brightwell please see Reference > Brightwell Enrollment File Specification.


    File Name Format
    registration{custID}{optional client-defined data}{MMDDYYYYhhmmss}.txt

    Example: registration123_brightwell_02092018165738.txt
    {custID} will be assigned to you by Brightwell Payments.
    {optional client-defined data} should be enclosed by "_". 

    Record Layout
    Please note that even though the specification below displays multiple lines per record, the file must be delivered with all data for a record type on one line.

    Example File:
    01|pr 3.0.1|brighwell Notification@company.com|Email
    02|123| 03P|ANNA||ZELENSKAYA|ADDRESS1|ADDRESS2|CITY|FL|123456789|USA|
    PAS123567|USA|12/31/1980|12/31/2010|100|01/01/1980|
    12345678901|EMPLOYEE@COMPANY.COM|LOCATION|12334121|USA|||ProductGroupAlias|Card stock Override code

    For each enrolment file that was sent, a response file will be received from Brightwell.
    Each Record Type will be indicated as either ‘Accepted’ or ‘Rejected’ (followed by a list of error codes, if any). See Reference > Brightwell Error Codes Table.
    The person will be moved to Waiting For Card page.

  5. You can also Exclude some persons from the Brightwell program.
    They'll be moved to Excluded page.

...

Once the person has received the card, you can tag him and click Card Received to move the person to the Members list.
If click Reset: a person will be moved to the Candidates page back.
You can Print the list if needed.

Help switches you to the Brightwell user manual.

...

Will be moved to the Exclusion page.

Help switches you to the Brightwell user manual.

...

Will be moved to the Candidates page.

Help switches you to the Brightwell user manual.

...

Please note, the Standard Crew List view should be opened.

Warning

Payment procedure in Brightwell Interface is only available for a user who has access to Group Payment under Reports >Payroll Current Period Reports > Field 36 in ACC.


So, users without access to create a Payment list have no access to the Payment tab.

...


  1. To Export data, only tagged persons on the grid will be included.
    Note, when the data is to be refreshed on the grid, all persons are tagged, you can adjust it as you want with Untagged individual.

    Click the Export button.


  2. Warning
    iconfalse
    If you confirm exporting, entry code 994 will be automatically locked.



  3. Payment Brightwell file is generated. 

    The export file will be located in the specified Export directory.
    File Name Format - payment{custID}{optional client-defined data}{MMDDYYYYhhmmss}.txt

    {custID} will be assigned to you by Brightwell Payments.
    {optional client-defined data} should be enclosed by "". (e.g.: _main office) 

    Our example:
    Payment123_brightwellUSD_02192018113124.txt 

    File Name depends on payment currency. 
    For technical documentation for the payment file, please see Reference > Brightwell Payment File Specification.

  4. You will have also the possibility to lock the period of the persons who have already been exported.

  5. You will see a confirmation message that the payment export was completed.

  6. You can perform a setup for payment by defining Payment type.

...

or your FTP area to download the latest patch with the name like APM_Plugin_BWNavigator_2018.X.X.X

Note

Please close the APM application before plugin installation.

...

The process is the same as with Brightwell Interface Plugin installation.

ACC Access Rights

Enabling Brightwell Interface

After a plugin is installed, it appears available for setting up access in Adonis Control Centre > Plugins:



You can enable/disable access per user level/group.
If you have several sites, a plugin needs to be installed and enabled on each one.

Granting Rights for Payment

Payment procedure in Brightwell Interface is only available for the user(s) who has access for Group Payment under Reports > Payroll Current Period Reports > Field 36 in ACC:



Users without access to create a Payment list have no access to the Payment tab in Brightwell.

References


Follow the link to see Brightwell Navigator, Standard File Formats manual:

...