Types

Address object - stores physical location or postal address This object applies to Clients, Vendors, HeadOffice and Unit objects

Type converter for an Address object only ToString is implemented and displays a full address

List of distinct address fields previously entered for autocomplete selection in address editing

A list of appointments (Read only collection )

Collection of AssignedDoc items

Utility functions and configuration connection data

This class converts localized text keys used to display enum values in AyaNova UI to integer enum values suitable for using in queries in database This is required because the Infragistics grid component only gives us the text selected in a filter based on an enum value not the underlying enum or it's value This method is used in conjunction with the GetLocalizedTextKey method in the LocalizedTextTable object by the UI (due to caching)

AyaFile object Storage, retrieval and deletion of files inside the AyaNova database. Automatic compression / decompression. NOTE: There is a 50MB source file size limit

Read only list of files stored inside the database. Used for Wiki feature and for general file management by admin

Properties

Retrieves stats about files stored in the AyaNova database

Used to identify file types for display and internal processing purposes

This exception is thrown when a attempt is made to save a file to the AyaNova database that is larger than the default limit or larger than the admin set limit in global settings (default limit is 50mb)

This exception is thrown when a attempt is made to save an object that has been modified by someone else between the point it was loaded for editing and then saved

Used to quickly fetch a single Bool record from the db

Clear all UI Layout settings

Client

Read only list of ClientServiceRequests

Properties

Client group

Read only list of clients.

Read only list of clients.

Properties

Properties

i.e phone, fax, followup etc

ClientNotifyEvent object Insert and manage client notification events

List of Clients for building pick lists Includes inactive so that they can be shown on old records in a consistent format NOTE: this is used mostly internally so is not regionalized

Returns client notes

ClientServiceRequest

Read only list of ClientServiceRequests

Properties

Read only list of client work orders Displayed in AyaNova WBI for client logins

Read only list of client work orders Displayed in AyaNova WBI for client logins New version for v5 modified to enable built in sorting

Properties

Properties

Flags every CSR that is a member of workorder stated as closed called by workorder when it's closed

DEPRECATED v4.0

Type of phone number i.e telephone, fax, cell, pager, radio

DEPRECATED v4.0

Contract

Read only list of Contracts.

Properties

Rate that is selected to be in a contract. By default only rates selected will be selectable within a service item, or can set to allow all but with these identified as part of contract

Contract rates collection

copy all UI Layout settings

Read only list of CustomizableObjects

Properties

Retrieves useful info about the database server

Various Database management utilities

Various DB helpers to save duplication in individual business objects

Dispatch zone

List of DispatchZones for building pick lists Includes inactive so that they can be shown on old records in a consistent format

DisplayAttribute, used to provide more detailed information to the ui layer about properties in a business object collection in order to simplify display process through reflection

Factory class for returning editable root object collections by name

EnumConverter supporting System.ComponentModel.DescriptionAttribute

Erase an entire database

Advance evaluation data dates to current date

Add events of interest / update subscriber count

An event window structure this is added to an array of structures to cover a week of day windows

Manages a set of event windows for a week Serializable for easy saving to database / file etc Easily confirms if a given date/time is within an allowable window or not

Rank and extract best excerpt of specified text and search terms

This exception is thrown when a attempt is made to retrieve an item from the database that doesn't exist

Follow ups (schedmarkers that are linked to a root object)

Generic name / value list

Memo message delivery

Abstract class for physically delivering notification messages.

PopUp message delivery

GenProcess notifications and preventive maintenance

Process a notification list and deliver appropriately

Process a notification list and deliver appropriately

Summary description for GenProcessPM.

SMS message delivery

SMTP message delivery

Global settings

Filter for restricting results in main grid lists Created by user and shared amongst all users

Grid filter assistance Used by UI to both offer and process user grid filtering choices

List of GridFilters for building pick lists Contains list filter to use directly against grids

A simple lightweight name/value item that can be inserted into a grid

A lightweight cell item that is used to display relative time and is identified as such so it can be sorted by it's base field

Head office

Read only list of head offices.

Read only list of HeadOffices.

Properties

Properties

Integration object This object is used for assisting with integrating 3rd party and AyaNova utility programs with AyaNova It's primary function is to provide an API standard method for storing and retrieving external program data in the AyaNova database for the purposes of integration with AyaNova It also contains a child collection for mapping external data to AyaNova objects The APPID GUID value must be set to uniquely identify the external application. The APPVERSION field is used by the implementer for version control of the data they are storing in AyaNova.

AyaNova IntegrationLog used to insert integration events in the database. Automatically removes all log entries more than 45 days old

Map to tie an integration application's data to AyaNova object records For example: In QuickBooks integration for the optional QBI product this object maps between QuickBooks objects and their corresponding AyaNova object.

Integration rates collection

Factory class for returning read only collection lists by key name

LoanItem

Read only list of LoanItems sortable and filterable for user interface.

Display attributes

List of LoanItems for choosing in UI

Delete a locale

List of Locales defined in localtextinfo table

Properties

Contains a portable Locale Used for serializing and de-serializing a locale (i.e. importing and exporting locales outside the program)

Any text displayed to the user will be held here.

Used internally by LocalizedTextTable for static get text direct method this ensures dataportal friendliness

Contains a portable Localized text object data Used for serializing and de-serializing a locale (i.e. importing and exporting locales outside the program)

Holds the localized text for use by user interface

Perform common AyaNova maintenance work

AyaNova Memo between AyaNova users used to create new Memo message only

Used to quickly fetch a single lightweight read only Memo record from the db

Update eMemo messages

Read only list of Memos.

Properties

Sets all records in the following objects from the source client id to the destination id ClientNote, ClientServiceRequest, PurchaseOrder, Unit, User, WorkOrder, ServiceBank

Used to quickly fetch a single name record from the db

Create a new locale by duplicating an existing one

List of notifications formatted for delivery and screened to be deliverable Loops through all NotifyEvenRecords For pending type events, checks to see if within users selected notification window foreach NotifyEventRecord it adds a NotificationListInfo for each open delivery window for each subscriber to that event As it Processes each deliverable notification it formats it to users locale and preferences for size etc and keeps track of the address and delivery type. End result is a list ready to deliver. As each one is delivered Ok it should be deleted from the NotifyEvent table by the delivery Process that uses this list.

AyaNova NotifyDeliveryLog used to insert new notification delivery events in the database. Also removes all delivery log entries more than 30 days old

Read only list of NotifyDeliveryLogs.

Log fields

Methods of formatting the notification message Used by the delivery procesor for the specific method chosen Basically used to determine how much to condense the message.

Methods of delivering an AyaNova event notification to the user.

Notification delivery setting

List of NotifyDeliverySettings for building pick lists

AyaNova NotifyEvent used to insert new notification events in the database. Event's are Processed appropriately here according to their type and purpose. This class ensures that only events subscribed to are inserted and tags them with the correct user ID for user specific subscriptions.

Used for determining if an event is of interest for notification purposes

User interface helper methods and properties for managing subscriptions to notification events Provides lists and data tables for managing notification through the user interface

List of Workorder statuses not already chosen in a subscribers event subscriptions for building pick lists Ensures user doesn't subscribe to same workorder status event more than once.

Notify message object used for transporting notification messages from a specific object that formatted it to a delivery provider

Contains the unique data required to retrieve a notification message from various notifiable objects Used to pass the arguments to the object and for caching of notification messages

AyaNova NotifyPopUp used to insert new notification popup messages into the queue

Read only list of NotifyPopUps. Used to display popup notifications in AyaNova user interface

Fields

A user who is subscribing to notification events

Switchable (child or root), As child it is part of collection under NotifySubscriber User's selection of events they want to subscribe to being notified about

Collection of delivery methods for a notification subscription

User selected delivery method for a single notification subscription

Summary description for NotifySubscriptionList.

NotifySubscriber rates collection

Used by Windows forms user interface to hold settings pertaining to custom fields so we know how to display them

Quickly fetch any Regionalized object's regionid Used primarily for search feature restrict results to region

Assembly is an object that has a name and id that parts can be assigned to to indicate this is an assembly of those parts. It itself does not have a price as it is for group parts together for assemblies (i.e parts of a bike) as opposed to PartCategory which is to group similar parts (i.e all bikes or all sporting equipment)

This identifies the physical parts in stock

Used to quickly fetch a various inventory related values for a particular part / warehouse combination. WARNING to developer API users: There are potential concurrency issues using this value in a multi-user scenario. This value is intended for read only purposes when displaying in a user interface. The actual value stored in the database is subject to change by other users updating inventory *after* this value is retrieved so it should not be used in any calculations to affect inventory in the database, those should be done through the inventory updating methods provided in other classes which are done within a database transaction with an IsolationLevel of Serializeable.

This is a selectable category that a Part can be a part of. Only one category per part For reporting and displaying purposes. A way of grouping

Checks to see if a part has serial numbers used internally to see if it's valid to set a part to not track serial numbers if it was previously set that way

Manual inventory adjustment

Report data

PartInventoryAdjustmentItem item

Read only list of PartInventoryAdjustments.

Properties

Similar to PartWarehouseInventoryList but for retrieving inventory and serials of a single part specified by part id. Used by AyaNova WBI Only in PartInventoryView page

Properties

Used to quickly fetch a various inventory related values for a particular part over all warehouses combined

General list of parts for display / reporting in UI

General purpose part list for filling pick lists, displaying information about parts in various UI forms to user and performing internal calculations for costs/taxes etc at UI level

Read only list of Parts that are below their restock level by vendor. Used in purchase order entry screen.

Log fields

Part serial

Pick list for selecting parts (primarily for work order entry)

Read only list of PartInventorys.

Properties

List of PartWarehouses for building pick lists Includes inactive so that they can be shown on old records in a consistent format

Read only list of Parts that are below their restock level by vendor. Used in purchase order entry screen.

Log fields

Read only list of Priorities

Properties

Project

Read only list of Projects

Properties

Purchase order Once a purchase order status goes to anything beyond open not yet ordered (i.e. it's ordered) it can not be changed as it follows standard business practices for inventory control.

Report data

Indivdual item (part) that is selected to be in the PO

Purchase order Items

Read only list of PurchaseOrders.

Detailed read only list of PurchaseOrders.

Properties

Properties

Read only list of PurchaseOrders ready to be received for a particular vendor

Properties

Purchase order receipt This is a write once only object Once saved initially it can never be edited again as it follows standar business practices and involves many inventory affected other objects. Corrections must be made through an inventory adjustment as per standard practices.

Report data

Item received

Purchase order Items

Read only list of PurchaseOrderReceipts

Read only list of PurchaseOrderReceipts

Properties

Properties

there can be two types of rates. We identify them as service and travel rates. User may customize as needed, but

All rates with type

Type of rate per unit i.e per hour, per day, per gram, per KM, per nautical mile etc

Handle receipt of inventory that fulfills request

Regional settings, a level between Global and User settings. User setting has priority over regional which has priority over company wide setting

Read only list of Regions

Properties

Used to turn a date and time object into a string representation which is localized and relative to current date/time

Report

Summary description for ReportDataSet.

An ReportDataSetAdapter is used to convert data in an object or collection into a ReportDataSet suitable for using with AyaNova reporting methods.

An ReportDataSetAdapterOriginal is used to convert data in an object or collection into a ReportDataSet suitable for using with AyaNova reporting methods.

Contains a portable report layout design. Used for serializing and de-serializing the design of a report (i.e. importing and exporting reports outside the program)

Read only list of Reports

Properties

Read only list of Reports

Properties

RootObject types. Note that some items here are not strictly root objects, but are included because they need to be identified for other purposes such as indexed keywords etc.

ScheduleableUserGroup - a preselected group of individual scheduleable users. Used for dispatching and display purposes

List of scheduleable user groups for picking in combo boxes etc Includes inactive so that they can be shown on old records in a consistent format

Individual ScheduleableUser assignment to a ScheduleableUser group

Collection of ScheduleableUserGroupUser items in a task group

Lightweight Read only list of Scheduleable user ID values in specified ScheduleableUserGroup

Schedulemarker will have list of schedulable users, regions or Global to select from

Source that the schedulemarker applies to

Upgrade schema of database to required version

Summary description for SearchResult.

Read only collection of search results

Security group

Read only list of SecurityGroups

Properties

Security access rights

Service bank This is a write only object and can not be deleted or modified once saved to protect the integrity of the service bank balances. Adjustments may be made by entering them in as another entry not by changing existing data. This follows standard accounting practices to ensure balance integrity

Used to quickly fetch current service bank balance for object indicated

Read only list of ServiceBanks.

Properties

Custom attribute used to indicate the underlying sql column name for a business object property. Used internally for sorting and filtering in grids. A value of "grid" indicates that the grid should handle sorting for grid columns that are calculated and not provided directly from the data SqlColumnName represents the "display" or text based column SqlValueColumnName represents the underlying value column

Contains a subscription record

TaskGroup - a preselected group of individual tasks that can be used to quickly select a slew of tasks with one selection

Individual task assignment to a task group

Collection of TaskGroupTask items in a task group

List of Tasks for building pick lists Includes inactive so that they can be shown on old records in a consistent format

Used in PO's, invoices, parts, services to determine if an item has tax applied or not.

Read only list of TaxCodes

Properties

List of Templates for building pick lists

Read only list of Template WorkorderPreventiveMaintenance items

Properties

Read only list of Template WorkorderQuote items

Properties

Read only list of Template WorkorderService items

Properties

Resolves which workorder service template is the default. Checks for client template, user template and global template returns most responsible template in order of client, user, global or guid empty if none found

Type and ID object Used to pass identification of objects around User interface in tag properties of menu items and for AyaNova custom URL processing

User interface ExplorerBar layout preferences Used to store and retreive user and default layouts for all ExplorerBar objects in user interface

DEPRECATED - DO NOT USE OLD User interface grid layout preferences WAS Used to store and retrieve user and default layouts for all grid objects in user interface DEPRECATED - DO NOT USE

User interface grid layout preferences Used to store and retrieve user and default layouts for all grid objects in user interface

Used by Windows forms user interface to hold settings pertaining to a forms last size and other pertinent display variables. Used to ensure that the forms appear the same as the user last left them in.

Used by user interface to hold settings pertaining to a grids last filter and order by settings Replaces UIGridLayout for read only main grids to facilitate changeover to saved filters and WBI interface Used to ensure that the grids appear the same as the user last left them in.

Unit

Read only list of Units.

Properties

Unit meter reading entry

Read only list of UnitMeterReadings.

Properties

UnitModel object

Read only list of UnitModels.

Properties

UnitModels for choosing in combo boxes etc

Properties

Used to quickly fetch a single saved Unit's name from the database in the currently selected UnitNameFormat style

Displays on reports and Parts screen selection. (e.g. each, per 100, per box, MBF, etc) to identify units of measure for the part

List of units for criteria formatted according to user prefs

Unset any scheduled users on objects where they can be set i.e. workorder etc. Used by license entry code when a user installs a less than 5 user key into a trial database but does not erase the trial data. This avoids a license violation error and messy manual steps to recover from it.

User - anyone with access to AyaNova

Certificate or training a schedulable user has achieved

A user certification assigned to a specific user

Read only list of Users

List of users for picking from formatted according to various templates

Properties

List of users for picking from formatted according to various templates

List of users for picking from formatted according to various templates

Most recently used object list

Basic name value list of all AyaNova users (or one specific) formatted to current users preferred user name display format

Properties

List of skills this schedulable user has. Than when determining who to schedule for a specific task or workorder where this skill is required, person displatching can bring up all techs with this skill

Properties

Properties

List of Vendors for building pick lists Includes inactive so that they can be shown on old records in a consistent format

Client name / value list

Set the DB generated visible ID number to a new user chosen starting point

Set the DB generated visible ID number to a new user chosen starting point

Set the DB generated visible ID number to a new user chosen starting point

Set the DB generated visible ID number to a new user chosen starting point

WikiPage object

Workorder

Workorder categories are used to “group” workorders into your defined categories. You can then use the category for printing aggregate totals on management reports. It can also be useful for many other purposes and can be used in any way you choose or not at all.

Used to quickly fetch descriptive information for identifying a service workorder to user during notification Processing

Used to quickly fetch a workorder id from the database give an descendant object id Returns Guid.empty on fail

Used to get the internal ID number of a workorder based on it's service number, quote number or preventive maintenance number. Also useful for checking for the existance of a workorder

this is the collection of labor objects (actual labor and service performed) in relation to this service item.

this is the collection of items loaned to client during the course of the service - these may be charged to the client, or may be for internal use only

this is the collection of miscelaneous expenses incurred during the course of the service - these may be charged to the client, or may be for internal use - up to the user whether appears on Workorder report etc

Move a workorder item to a new workorder

WorkorderItemPart

WorkorderItemPartRequest

Read only list of WorkorderItemPartRequests.

Read only list of parts requested on workorders

this is the collection of parts for this service item that are requested by the user due to being out of stock

this is the collection of parts for this service item - whether they are reserved (not yet used), used in service, on order, or needs to be ordered.

this is the collection of WorkorderItems for a specific workorder

Scheduled user on workorder item. Can select a time and no user or a user and not time

Used to quickly fetch descriptive information for a workorderitemscheduleduser notification during notification Processing

this is the collection of scheduled Users that is selected for a WorkorderItem to display along with start and stop dates (and times)

This is a single check item - but a WorkorderItem may have multiples of checks For example, a checklist is a list of all the checks needed to confirm before closing the WorkorderItemTask item and workorder - each is a "checkitem" This way a manager can tie the workorder to these - can't close unless checked off by user logged in -check=Backup all data on harddrive YES/NO -check=Confirm backup is accessible YES/NO -check=install hard drive YES/NO -check=install operating system YES/NO -check=connection to internet YES/NO -check=update windows updates YES/NO -check=restore data from old harddrive YES/NO -check=install program......

Used to track travel for service both for billing back to client and for techs to track their own travel for re-imbursement etc

this is the collection of actual travel incurred in relation to this WorkorderItem

List of active Service Workorders for client specified (active meaning not closed and not set to service completed and type of Service)

Read only list for reports and grid display

Properties

Used to quickly fetch descriptive information for identifying a quote workorder to user

Report data

Read only list for reports and grid display

Properties

Read only list for reports and grid display

Properties

Read only list of WorkorderPreventiveMaintenance items

Read only list for reports and grid display

Properties

List of PM workorders that are ready to generate service workorders Used by AyaNova Generator

Read only list for reports and grid display

Properties

Read only list for reports and grid display

Properties

A workorder that is used to generate service work orders on a schedule.

Read only list for reports and grid display

Properties

Used to quickly fetch descriptive information for identifying a quote workorder to user

Report data

Read only list for reports and grid display

Properties

Read only list for reports and grid display

Properties

Read only list of WorkorderQuote items

Properties

Quote parts

Properties

Read only list for reports and grid display

Properties

Read only list for reports and grid display

Properties

Re-open a closed work order Removes all User notification events for the workorder Will not remove client notifications if pending because they do not store the workorder ID, only an email message so there is a possibility they will get sent out about a closed workorder *after* the work order was reopened.

List of Service Work orders that are invoiceable for building pick lists (Read only collection)

Read only Detailed list of WorkorderServiceItem custom field items

Properties

Report data

Read only list of Expense items

Properties

Read only list for reports and grid display

Properties

Read only Detailed list of WorkorderServiceLabor items

Properties

Read only list of WorkorderService items

Properties

Read only list for reports and grid display

Properties

Read only Detailed list of WorkorderServicePart items

Properties

Read only Detailed list of WorkorderServiceScheduledUser items

Properties

Read only Detailed list of WorkorderServiceTravel items

Properties

Read only list of Workorder statuses

Properties

DEPRECATED V4.0

DEPRECATED v4.0

DEPRECATED V4.0