Email: info@logicor.net.au

Website: https://logicor.net.au

License: Apache 2.0

Url: http://www.apache.org/licenses/LICENSE-2.0.html

Welcome to the iDrv TMS User Guide. This user manual is created to serve as comprehensive documentation for individuals who will be using iDrv TMS regularly. This guide is intended to be accessible to all users of the system and offers detailed, step-by-step instructions for common tasks, as well as descriptions of the software's features and capabilities.

A Transport Management System (TMS) is a logistical platform designed to assist businesses in efficiently planning, organizing, executing, optimizing, and maintaining documentation to ensure compliance. TMS is indispensable for any enterprise engaged in continuous, well-organized movement, shipping, or receipt of goods, all while minimizing delays. This software has the potential to enhance customer satisfaction, resulting in increased revenue and overall business expansion. iDrv also provides robust administrative functionalities like billing, invoicing, and driver payroll management. Furthermore, it offers support for logistics companies to conscientiously adhere to compliance and road safety regulations. iDrv TMS is here to simplify and streamline business processes for logistics companies, ensuring they operate in a timely, secure, and legally compliant manner.

A third-party API provides a means to access data or functionality from an external system for use in your website or application. Integrating third-party services allows developers to leverage pre-built solutions instead of starting from scratch for the same purpose. Fortunately, TMS has recently made its APIs available to the public. The development team has incorporated RESTful APIs into the system to ensure both safety and security. These APIs can only be accessed via HTTPS and require a valid access token for authentication, which includes the use of OAuth 2.0. In case of errors, the APIs return HTTP response codes, and they both accept and return data in JSON format within the HTTP body.

This collection encompasses the necessary requests to initiate an authorization process. Once this process is successfully completed, iDrv's authorization server will furnish the client with an access token.

iDrv's authorization employs OAuth 2.0 with PKCE, which involves replacing the client_secret with two components: a randomly generated string (verifier) and its hashed counterpart (challenge). This PKCE extension was implemented to enhance security in the token issuance and permission-granting process for our clients.

To generate a code, check this PKCE tool.

Step by Step Guide

Within your third-party application, establish a "log in" hyperlink directing users to iDrv's authorization page. Make sure to incorporate the code challenge within the request parameters, as exemplified in the code snippet below:

Example Request:

  https://authorization-server.com/auth?response_type=code&client_id=CLIENT_ID&redirect_uri=REDIRECT_URI
  &scope=consignements&state=1234zyx&
  code_challenge=CODE_CHALLENGE&code_challenge_method=S256

After being redirected, the user will arrive at a login page where they need to provide their user credentials, which should match those used during the creation of the client. Once the user successfully logs in, they will encounter an authorization prompt. If the user chooses to click 'Allow,' the server will subsequently redirect the user back to your application (via the redirect_uri) and provide an authorization code along with a state parameter.

Example:

https://example-client-app.com/cb?code=AUTH_CODE_HERE&state=1234zyx

Typically, the third-party has the option to store the state value in a cookie and then compare it when the user is redirected back to the website. This precautionary step ensures that your redirection endpoint remains secure and cannot be deceived into attempting to exchange arbitrary authorization codes.

Exchanging Code for Access Token

Once your application obtains an authorization code, the next step involves exchanging it for an access token. In this process, rather than using a client secret, you will incorporate the PKCE secret (code verifier) that was generated at the outset of the flow.

Example Request:

    https://{{BASE_URL}}/oauth/token
    grant_type=authorization_code&
    code=AUTH_CODE_HERE&
    redirect_uri=REDIRECT_URI&
    client_id=CLIENT_ID&
    code_verifier=CODE_VERIFIER

If all the provided values are accurate and the authorization confirms that the verifier aligns with the challenge sent earlier in the authorization flow, an access token will be granted to the user. Example: in json format

    {
    "token_type": "Bearer",
    "expires_in": "expiry",
    "access_token": "issued access token",
    "refresh_token": "issued refresh token"
    }

The PKCE Extension

PKCE (Proof Key for Code Exchange) was initially conceived to safeguard the authorization code flow within mobile applications. However, its capacity to thwart authorization code injection renders it valuable for all types of OAuth clients, including web applications that utilize a client secret.

To adhere to PKCE requirements, the application must possess the capability to create a randomly generated string, which falls within the range of 48 to 128 characters, known as the "code verifier." Additionally, it must compute the URL-safe base64-encoded SHA256 hashed version of this string, referred to as the "code challenge."

To generate a secret and hash, you may click here and check this PKCE helper utility tool.

You can learn more about OAuth and PKCE by clicking here.

iDrv offers support for two authentication methods: OAuth2 and ApiKey (bearer token).

API key

Precisely, a bearer token is employed for making server-side requests. It's imperative to never share these keys and to maintain their security with utmost care.

OAuth 2.0

Everything about OAUTH 2.0 can be found here.

iDrv Security Schemes

These security schemes are the methods employed by iDrv to authorize clients to access specific data directly from the database.

We adhere to the error response format outlined in RFC 7807 also known as Problem Details for HTTP APIs. As with our normal API responses, your client must be prepared to gracefully handle additional members of the response.

This section encompasses technical terminology that could potentially be perplexing for both clients and customers. It also includes the company profile for reference.

You can also refer to the pdf manual of iDrv. Just click the download link below.

[1] Download User Manual

LogiCor Pty Ltd

A leading software company specializing in comprehensive online logistics software solutions. Through the provision of an array of integrated tools accessible on various platforms and devices, we aid companies in establishing efficient logistics systems and services.

Check out their website by clicking this LogiCor Pty Ltd.

On the left side of the screen, you will find the 17 components of iDrv TMS. These components encompass the Dashboard, Jobs, Drivers, Fleet, Fuel, Accounts, Contacts, Breaches, Tracker, Employee Registrations, Settings, Documents, Tasks, Compliance, Messaging, Advanced Search, and the Logicor Website. To gain a deeper understanding of each of these components, please refer to this documentation.

Dashboard

Utilizing graphical and data visualizations, the Dashboard simplifies data comprehension and provides a fundamental overview of the information.

Jobs

The Jobs component displays various job statuses, including pending, dispatched, processing, completed, and canceled jobs. It comprises five subcomponents: Create Bookings, Connotes, Dispatch Planner, Dispatch List, and Activities.

Drivers

The Drivers component enables administrators to oversee all drivers affiliated with the company. This page serves as the central repository for accessing and managing the records and information of all drivers.

Fleet

Fleet management offers the capability to create and maintain fleets along with their associated information and assets. Additionally, you have the option to dispatch your jobs to specific fleets. Fleet Assets management encompasses various aspects such as insurance, fuel, repair and maintenance reporting, registrations, tires, service providers, and services.

Fuel

This component manages both Fuel Costs and Fuel Items records. At the top of the page, you'll find a summary that provides the total fuel cost for the year, month, week, as well as the most recent record.

Accounts

This component presents the company's financial information, covering aspects such as payrolls, invoices, bills, and credit notes.

Contacts

This component facilitates the management of your company's contacts, encompassing employees, customers, and suppliers.

Breaches

This section compiles lists of driver requests and responses related to breaches that occur during work operations and settings.

Tracker

The Map Tracker interface utilizes Google Maps to track and display the locations of drivers and fleets. Additionally, you can make use of the Search Map option to navigate the map more efficiently.

Employee Registrations

Below is the roster of employees along with their registration particulars. You'll find optional buttons like Columns, Summary, Filter List, Print, and Export for added functionality. This component facilitates the administration of various employee registrations, enabling actions such as reviewing, accepting, and rejecting applications.

Settings

To make adjustments to your account settings, job costs, business profile, payroll, route templates, checklists, integrations, and weekly inspections, please navigate to the Settings section.

Documents

In the Documents component, you have the capability to add, edit, update, and delete documents as needed.

Tasks

The Task component displays a list of tasks that have been assigned to each administrator.

Compliance

For each task, the Compliance panel provides a summary of all the compliance requirements relevant to that particular work within a specified time period.

Messaging

The Messaging component allows you to deliver a message via three different channels:

1. Mobile Notifications
2. SMS messages
3. Email

Advance Search

To utilize the Advanced Search feature, simply type the name of the document containing the data you want to access into the search bar.

Logicor Website

To explore and navigate the page, use the Logicor Website component.

Button Functionalities of iDrv TMS.

Driver Component Buttons

Drivers and Fleets Buttons

Fleets and Customers Buttons

Jobs Buttons

The JOBS component adheres to this color-coding rule.

Technical terms and Definitions.

Vehicle accredition is conducted to every vehicle to ensure the safety and quality of each vehicle. Heavy vehicle operators can apply for accreditation under the 3 National Heavy Vehicle Accreditation Scheme (NHVAS) modules:

[1] Mass Management

[2] Maintenance Management

[3] Fatigue Management (Basic or Advanced)

The following guides are an introduction to each module and summarize what operators need to do in order to qualify for accreditation and stay qualified.

[1] Mass Management Click to view.

Operators accredited in the Mass Management module can access additional mass concessions. These concessions allow vehicles to operate at Concessional Mass Limits (CML) for general access to the road network.

[2] Maintenance Management Click to view.

Operators accredited in the Maintenance Management module must maintain their vehicles and comply with all relevant road transport legislation. Some jurisdictions require annual inspections as part of the registration process, but grant exemptions to vehicles with maintenance management.

[3] Fatigue Management Click to view

The Fatigue Management module includes two options, Basic Fatigue Management (BFM) and Advanced Fatigue Management (AFM).

Basic Fatigue Management (BFM) - Operators with BFM accreditation can operate under more flexible work and rest hours, allowing for (among other things) work of up to 14 hours in a 24-hour period. BFM gives operators some flexibility regarding when drivers can work and rest, if the risks of driver fatigue are properly managed.

Advanced Fatigue Management (AFM) - AFM brings a genuine risk management approach to managing heavy vehicle driver fatigue. Rather than prescribing work and rest hours, AFM offers more flexibility than standard hours or BFM in return for the operator demonstrating greater accountability for managing their drivers’ fatigue risks. For more information see Advanced Fatigue Management (AFM).

For more information about Compliance and Accreditations, you can click the links listed below:

[1] Heavy Vehicle National Law and Regulations

[2] Accreditation Modules

Below is the legend for run_status_id.