Essentials {module}

This is a mandatory module that forms the framework of DUO and allows it to communicate with an MYOB Exo database. It provides screens and widgets that are used by many of the other modules.

Module Functions  {Essentials}

Function

Description

Database Access

DB Connection, Staff Login, Licensing, Help > About, DB Update

ExoProtocolHandler

Callouts to run MYOB Exo screens

Clarity Report Interfaces

Calls Clarity Forms and Reports. Uses either ExoProtocol or Clarity.exe

Communication

Outlook, Exo Message Service, Google Maps, Social Media, Phone

Company Widget

Debtors, Creditors, Non-Accounts (read only)

  Cmpy Contact Widget

Company Contacts Grid {list}                            Use with Company Widget

  Contact Widget

Contacts (read/write)

Stock Widgets

Stock Items, Stock Levels (read only)

Extra Fields Widget

Extra Fields {panel}

Serviceable Units Widget

Serviceable Units (read only), Grid {list}

Activities Widget

Activities & Tasks (read/write), Grid {list}

Order Details Widget

Sales Orders, Purchase Orders, Opportunities, Job Quotes (read only)

  Sales Order Hist Widget

Sales Order History Viewer {grid and reading pane}

History Notes Widget

Edit History Notes. Adds HTML support.

Exo Functional Support

Narratives, Custom Buttons, Exo Business Alerts

View Archived

View archived Sales Orders, Purchase Orders and Inwards Goods

Documents

An improved Exo Document Manager

Module Overview {Essentials}

The Essentials module provides basic functions, screens, and widgets to produce an Exo compatible application. This document splits them into Classes (inheritable functionality) and Windows (real screens in the system).

·         Classes: These are the components from which functional windows are derived. They are not actual windows themselves. By having rich features defined once in classes that are used by actual windows DUO can ensure consistency and stability. Later we describe the user functionality provided by these classes and how to operate windows that use them.

o   epForm: extends the system menu (left click the icon top right of title-bar). Adds Save/Restore position, Show/Hide Hints, Shrink/Grow for compact view, Toggle Ribbon / Toolbar.

o   epAppForm: Provides Toolbar/Ribbon, ID Bar (grey, under toolbar), Status bar (at bottom of screen), Quick Jump icon (left of status bar). Provides generic toolbar button functions (including custom buttons). It also has understanding of Exo entities (companies, stock items, etc) and keeps a list of entity IDs for a real window (e.g. a company knows about its debtor, contacts etc) and provides these IDs to associated / docked widgets. Inherits epForm.

o   epSettings: {non-visual} Gets database and operating environment settings such as profile settings, registry settings, and DUO configuration / connection settings, etc.

o   epClarity: {non-visual} Provides an interface to launch Clarity Business Forms and Reports via either  ExoProtocolHandler to Exonet.exe or just launch Clarity.exe. It is aware of the Exo *.CLF classes (see Clarity manual for I= parameter) and handles all requests for in-workflow printing e.g. packing slips etc.

o   epMenu: Builds content for menus (main and pop-up), toolbars, and Ribbons.

o   epGrid: Provides a grid with options (right click popup menu) such as visible column settings, copy to clipboard, grid print, grid print (to printer), print preview (to screen), printer setup.

o   epDockForm: The container class for a dockable widget.

o   epSearchForm: Provides a tabbed form with a search grid on the first tab, plus additional tabs to house functions associated with the item selected from the search grid.  One or more additional tabs can be dashboards to house dockable widgets.  

·         Windows: These are DUO windows (screens) that are not module specific.

o   Login: Database authentication and connection (by staff)

o   Base form: Provides application level menu

o   Object Locks: A pop-screen used for locking certain records to one user at a time.

o   Help > About – Registration, Connection, Environment, Current User, and EULA information.

o   Configurator – Maintains DUO.xml which includes a connection editor. See B – Installation

·         Search Grids {generic}: Usually the first tab of most screens. Additional tabs can contain additional business functions (such as Scan Pick) or act as Dashboards (to house dockable widgets). The generic functionality of these is provided by the Classes described above.

·         Dockable Widgets – These are DUO windows that can be placed on dashboard tabs within a window. The generic operation of Widgets is discussed under the section for the epDockForm class. The widgets provided include:

o   Company, Company Contacts,

o   Stock Item, Stock Levels,

o   Orders, Order History,

o   Extra Fields, History Notes, Documents, Activities 

o   Custom Grids

·         Classes:  These are controls that appear as part of a screen or are non-visual.

o   Module Functions – describes the common elements of this window class

o   Grids – operating grids, grid settings, printing grids, copy to clipboard

o   Exo Links: These are functions that leverage functionality in MYOB Exo

§  Linking via MYOB Exo Protocol Handler to launch Exo screens

§  Running Clarity for reporting and business forms

·         Help About: This should be in the windows section, but it makes more sense to describe it last.


 

DUO for EXO     DUO for EXO     © Dyameta Technology Ltd                     Previous Topic           Next Topic           Home