Schedule and Dispatch Screen Properties

• Published on Apr 16, 2024
• 10 minute(s) read
• TL

Mobileforce Scheduling is built on top of EasyCLM. The key objects used by the Schedule & Dispatch Screen are as follows:

UI

There is no top-level ADL screen type for the schedule and dispatch screen. This is because it is designed to be an inner screen that is invoked after selecting an office.

The URL for the schedule and dispatch screen is

adlwebui/scheduledispatch.php?path=...&s=...&officeId=...

It requires three parameters, path, s, and officeId. path and s are the standard adlwebui parameters. officeId is the ID of the office EasyCLM object to schedule for.

There are two ways one can configure the ADL for the schedule & dispatch screen, depending on whether the application has one office or multiple offices.

ADL for single office scheduling

For single-office scheduling, the office ID is hard-wired into the URL. The adlwebui-extension property causes the web screen to go directly to the given URL instead of using an iframe. Also, it will automatically append the path and s parameters.

<screen type="web" name="Schedule &amp; Dispatch"
        iconportrait="..." iconlandscape="..." acl=""
        url="https://apps.mobileforcesoftware.com/adlwebui/scheduledispatch.php?officeId=1" >
  <data>
    <prop key="screenid">scheddisp</prop>
    <prop key="param-prefix">easyclm-</prop>
    <prop key="adlwebui-extension">1</prop>
    (other props)
  </data>
</screen>

ADL for multiple office scheduling

For multiple-office scheduling, the top-level ADL screen is a datatable screen that displays all offices. It is configured such that clicking on an office will open the schedule & dispatch screen. Also, updates are disabled for this screen.

<screen type="datatable" name="Schedule &amp; Dispatch"
        iconportrait="..." iconlandscape="..." acl=""
        url="https://apps.mobileforcesoftware.com/adapters/easyclm/schema.php#Office" >
  <data>
    <prop key="screenid">scheddisp</prop>
    <prop key="param-prefix">easyclm-</prop>
    <prop key="listitem-link-template-Office">scheduledispatchscreen.php?[[]]&amp;officeId=[id]</prop>
    <prop key="table-actions-Office">list</prop>
    <prop key="content-body-header">Please select an office.</prop>
    (other props)
  </data>
</screen>

Customizing displayed fields

The Schedule & Dispatch screen displays detailed data from tasks, technicians, and appointments. Customers may need to change what info is displayed by default, perhaps showing custom fields. To support this, the Schedule & Dispatch screen uses datatable layouts to allow customization of list data, popups, and detailed info.

To customize a particular list, popup, or object details, create a layout with the layout type set to 'scheduler'. (This layout type can be changed via the ADL property 'layouttype'). The table below shows which UI component maps to which layouts.

Customizing global action buttons

Scheduling often requires customized actions, such as autoscheduling or custom-built tools for a customer. To support this, the Schedule & Dispatch screen allows one to add custom global actions buttons to the top right of the screen. This is done via ADL properties of the form action-button-{id}, where {id} is a unique identifier for the button.

Some example properties are:

<prop key="scheduler-action-button-plugRoute">Plug Route|https://apps.mobileforcesoftware.com/customers/servicevelocity/servicevelocity/calendar/scheduler/php/plug_route.php</prop>
<prop key="scheduler-action-button-smartRoute">Smart Route|https://apps.mobileforcesoftware.com/customers/servicevelocity/servicevelocity/calendar/scheduler/php/smart_route.php</prop>
<prop key="scheduler-action-button-mapAppointment">Map Appt.|https://apps.mobileforcesoftware.com/customers/servicevelocity/servicevelocity/calendar/scheduler/php/mapAppointment.php</prop>

ADL properties

The Dispatch & Schedule ADL screen can be customized through several ADL Properties. These properties can be either in the ADL screen itself or in the parent app or applet elements. These properties can also be prefixed either by the screen's parameter-prefix, specified by the param-prefix ADL screen property, or by the global scheduler- parameter-prefix. This parameter prefix is optional when specified within the screen but required in the app or applet elements.

The table below lists all supported ADL properties.

Task Properties

Calendar Properties

Appointment creation properties

Map properties

Email Properties

Task search filter properties

Datatable integration

Localization

These ADL properties can be used to customize strings displayed in the Schedule & Dispatch screen:

Customization

These ADL properties allow one to customize the actions and display of the screen.