Fm Billings Recharges

Use this billing method to schedule recharge billing.

This is very similar to the system menu item Fleet / Billing β†’ Recharges. This job includes the Credit Notes functionality. All of your client billing preferences are applied in the same way regardless of how the billing is created except for the differences listed below.

Differences Between Scheduler Job and Manual Billing

Aspect

Scheduler Job (fm / billings / recharges)

Manual Process (Fleet / Billing β†’ Recharges)

Emailing

If the "Delivery" field is set to 'Email', emails are created and sent. You can find them in the Mail Queue at 'Sent' status. If the email cannot be sent, they are stored in the Mail Queue with a 'Failed' status. Go to the Mail Queue to review and then send the corrected emails.

If the "Delivery" field is set to 'Email', billing emails are created and placed in the Mail Queue in 'Pending' status. To complete the process, you need to go to the Mail Queue and send these invoices manually.

Billing Type

Only records for clients with a "Billing Type" of 'Periodic' will be selected.

Records for clients with a "Billing Type" of either 'Any' or 'Periodic' will be selected.

Data Set-up

Set the Clients / Contract Defaults "Billing Type" as 'Periodic' for any client whose invoices should be created by this job.

Job Type

Field

Format

Notes

Module

Drop List

Choose 'fm'

Class

Drop List

Choose 'billings'

Method

Drop List

Choose from combined, periodic, recharges, rechargesFuel

Description

Text

A generic description will populate once a "Method" has been chosen. You can change this to something meaningful to you. This shows as the description on the Scheduler / Schedule tab

Parameters

Channel / Group / Client Selection

Parameter

Format

Notes

Channel Code

Lookup

Enter or look up the Channel Code you want to run the job for. This will then select and invoice only the clients of this channel. If populated, you cannot also choose a "Group Code" or "Client Code". Choosing another filter will remove the "Channel Code" value.

Group Code

Lookup

Enter or look up the "Group Code" you want to run the job for. This will then select and invoice only the clients of this group. If populated, you cannot also choose a "Channel Code" or "Client Code". Choosing another filter will remove the "Group Code" value.

Client Code

Lookup

Enter or look up the "Client Code" you want to run the job for. This will then select and invoice only the contracts that belong to this client. If populated, you cannot also choose a "Channel Code" or "Group Code". Choosing another filter will remove the "Client Code" value.

Delivery and Pay Cycle

Parameter

Format

Notes

Delivery

Drop List

Choose 'Email' to select and email invoices to clients who have "Invoicing Preference" set to 'Email'. The emails will be sent and available for review in the Mail Queue. They will be set to 'Sent' status. The recipients of these emails will be based on the "Use Group Email" flag set up under the Client Contract Defaults. If checked on, then the Group Email will be used; if checked off, then the A/C Payable email will be used. If there is no stored recipient email, the scheduler job will still run, with the emails in the Mail Queue in 'Failed' status. Choose 'Post' when the scheduler is required to run to process the invoices.

Pay Cycle

Drop List

Choose a pay cycle if you want to run this job only for a particular pay cycle. This works in the same way as the Billings / Periodic "Pay Cycle" field. You might use this feature to invoice contracts with a weekly or fortnightly pay cycle throughout the month without accidentally including monthly pay cycles that may be invoiced at a nominated time in the month.

Invoice Date Configuration

Parameter

Format

Notes

Invoice To

Drop List

Use this feature if you want to create billing records before or in the future of their invoice date being reached. Leave this field blank to use the system's run date as the Fleet / Billing "Invoice Date". Options: 'Common Day Past', 'Common Day Future', 'Run Date Plus', 'Payroll Cut Off' (if Client Code is selected)

Invoice To DAY

Drop List

Available options depend on the "Invoice To" selection. Blank: disabled; Common Day Past/Future: 1st, 2nd, 3rd... EOM; Run Date Plus: 1, 2, 3... 31; Payroll Cut Off Days: disabled

Invoice To Date

Display (Calculated)

This is a calculated display field that shows what the next "Invoice To" date will be with the current selections applied. This will calculate if "Invoice To" and Invoice To "Day" are entered. If no entry is made in "Invoice To" field, it will be displayed as blank on save.

Invoice Date

List Box

Options are 'Invoice To' and 'Run Date'. Choose 'Invoice To' to use the calculated "Invoice To Date" as the Fleet / Billing "Invoice Date" when the billing selection and posting is run. Choose 'Run Date' to use the system's run date. If the field is blank, the system will default to using 'Run Date'.

Recharge-Specific Options

Parameter

Format

Notes

Exclude Fuel

Checkbox

If unchecked, all outstanding recharges will be invoiced. This field is checked by default. If checked, only non-fuel recharges will be invoiced. The invoice template and email 'Recharges - Fuel' is used in both cases. You can use the Recharge Fuel scheduled job for fuel recharges only.

Run Times

The billing process requires a range of tables to be locked down while it runs. For this reason, we recommend you set billing jobs to run outside of business hours.


Fm billings rechargesFuel

Use this billing method to schedule recharge fuel billing.

This is very similar to the system menu item Fleet / Billing β†’ Recharge β†’ Fuel. All of your client billing preferences are applied in the same way regardless of how the billing is created except for the differences listed below.

Differences Between Scheduler Job and Manual Billing

Aspect

Scheduler Job (fm / billings / rechargesFuel)

Manual Process (Fleet / Billing β†’ Recharge β†’ Fuel)

Emailing

If the "Delivery" field is set to 'Email', emails are created and sent. You can find them in the Mail Queue at 'Sent' status. If the email cannot be sent, they are stored in the Mail Queue with a 'Failed' status. Go to the Mail Queue to review and then send the corrected emails.

If the "Delivery" field is set to 'Email', billing emails are created and placed in the Mail Queue in 'Pending' status. To complete the process, you need to go to the Mail Queue and send these invoices manually.

Billing Type

Only records for clients with a "Billing Type" of 'Periodic' will be selected.

Records for clients with a "Billing Type" of either 'Any' or 'Periodic' will be selected.

Data Set-up

Set the Clients / Contract Defaults "Billing Type" as 'Periodic' for any client whose invoices should be created by this job.

Job Type

Field

Format

Notes

Module

Drop List

Choose 'fm'

Class

Drop List

Choose 'billings'

Method

Drop List

Choose from combined, periodic, recharges, rechargesFuel

Description

Text

A generic description will populate once a "Method" has been chosen. You can change this to something meaningful to you. This shows as the description on the Scheduler / Schedule tab

Parameters

Channel / Group / Client Selection

Parameter

Format

Notes

Channel Code

Lookup

Enter or look up the Channel Code you want to run the job for. This will then select and invoice only the clients of this channel. If populated, you cannot also choose a "Group Code" or "Client Code". Choosing another filter will remove the "Channel Code" value.

Group Code

Lookup

Enter or look up the "Group Code" you want to run the job for. This will then select and invoice only the clients of this group. If populated, you cannot also choose a "Channel Code" or "Client Code". Choosing another filter will remove the "Group Code" value.

Client Code

Lookup

Enter or look up the "Client Code" you want to run the job for. This will then select and invoice only the contracts that belong to this client. If populated, you cannot also choose a "Channel Code" or "Group Code". Choosing another filter will remove the "Client Code" value.

Delivery and Pay Cycle

Parameter

Format

Notes

Delivery

Drop List

Choose 'Email' to select and email invoices to clients who have "Invoicing Preference" set to 'Email'. The emails will be sent and available for review in the Mail Queue. They will be set to 'Sent' status. The recipients of these emails will be based on the "Use Group Email" flag set up under the Client Contract Defaults. If checked on, then the Group Email will be used; if checked off, then the A/C Payable email will be used. If there is no stored recipient email, the scheduler job will still run, with the emails in the Mail Queue in 'Failed' status. Choose 'Post' when the scheduler is required to run to process the invoices.

Pay Cycle

Drop List

Choose a pay cycle if you want to run this job only for a particular pay cycle. This works in the same way as the Billings / Periodic "Pay Cycle" field. You might use this feature to invoice contracts with a weekly or fortnightly pay cycle throughout the month without accidentally including monthly pay cycles that may be invoiced at a nominated time in the month.

Invoice Date Configuration

Parameter

Format

Notes

Invoice To

Drop List

Use this feature if you want to create billing records before or in the future of their invoice date being reached. Leave this field blank to use the system's run date as the Fleet / Billing "Invoice Date". Options: 'Common Day Past', 'Common Day Future', 'Run Date Plus', 'Payroll Cut Off' (if Client Code is selected)

Invoice To DAY

Drop List

Available options depend on the "Invoice To" selection. Blank: disabled; Common Day Past/Future: 1st, 2nd, 3rd... EOM; Run Date Plus: 1, 2, 3... 31; Payroll Cut Off Days: disabled

Invoice To Date

Display (Calculated)

This is a calculated display field that shows what the next "Invoice To" date will be with the current selections applied. This will calculate if "Invoice To" and Invoice To "Day" are entered. If no entry is made in "Invoice To" field, it will be displayed as blank on save.

Invoice Date

List Box

Options are 'Invoice To' and 'Run Date'. Choose 'Invoice To' to use the calculated "Invoice To Date" as the Fleet / Billing "Invoice Date" when the billing selection and posting is run. Choose 'Run Date' to use the system's run date. If the field is blank, the system will default to using 'Run Date'.

Run Times

The billing process requires a range of tables to be locked down while it runs. For this reason, we recommend you set billing jobs to run outside of business hours.


Fm contracts importEvents

This job imports Road Side Assistance (RSA) call outs from Assist Australia and creates Contract Events against each vehicle. It targets import file(s) stored in your DMZ area. Each file is removed once it has been processed.

Parameters

The Scheduler Job Screen has the following input parameters:

Parameter

Format

Notes

Mandatory

Interface

Lookup

The interface code from fm_interfaces for the RSA supplier providing the files. A search icon is provided to find and select this.

Yes

File Pattern

Text

A regular expression pattern used to match the RSA file(s) within the DMZ Subfolder. For example, ^CRSA[0-9]{4}.txt$ will match CRSA0122.txt, CRSA0123.txt, and so on.

Yes

DMZ Subfolder

Text

The subfolder in the DMZ area where the card file(s) are to be found. If left blank, the DMZ home folder will be used. Subfolders can be nested. Example: 'rsa/out'

No

Scheduler Queue

The queue for this job type shows all successful and failed file imports from the external system, the last ran job, and the next queued job when the recycling flag is set to "yes". It does not record jobs that could not find any file to import. The reason is to keep the queue clean as such jobs usually run at very short intervals. However, when the recycling flag is set to "no", it records all jobs that have run so far and creates many irrelevant queue entries.

Note: This feature has been set up to import a specific file format from Assist Australia. Further development may be required if you wish to make use of this feature. Contact your Account Manager for further information.


Fm mysalpack importPackagingData

This job imports MySalPack employee information and packaging transactions. It targets import file(s) stored in your DMZ area. Each file is removed once it has been processed. Only the latest file is processed. All older files are ignored and deleted because the file contents contain a complete dataset and any older files are immediately irrelevant when a newer file is processed.

Parameters

The Scheduler / Job tab has the following input parameters:

Parameter

Format

Notes

Mandatory

File Pattern

Text

Enter the name of the file followed by an asterisk (*) for the wildcard portion of the file name. For example, the filename may be "MSPExportCatchE7012018-03-1612-33-15.csv". Enter "MSPExportCatchE701_" in the File Pattern field.

Yes

DMZ Subfolder

Text

The subfolder in the DMZ area where the file(s) are to be found. Example: 'clientName-mysalpack/in'

No

MySalPack File

The contents and mapping of MySalPack fields to the corresponding Catch-e fields are detailed in separate documentation.

Scheduler Queue

The Scheduler / Queue for this job shows all successful and failed file imports from the DMZ folder, the last ran job, and the next queued job.

Recycling Setting

When the Scheduler / Job "Recycling" checkbox is checked: The queue does not record jobs that ran but could not find any file to import. This keeps the queue clean as this job is usually set to run frequently. We recommend this setting.

When the "Recycling" checkbox is unchecked: The queue keeps a record of all job runs, even if no file was imported.

Setup Requirements

A specific DMZ folder set up is required to run this job. The DMZ folder is accessed by a third party (MySalPack) to deposit files as part of this process. Further development may be required if you wish to make use of this feature. Contact your Account Manager for further assistance.