A list of appointments for scheduleable users in AyaNova This list is what populates the schedule calendar (Read only collection )
AssignedDoc class This is the original method of attaching documents to various objects in AyaNova and is used to link a file location on disk to a business object. If you want to actually store the document itself in the AyaNova database (making it accessible from WBI and location independant) you should use the WikiPage object instead to store documents in the database.
Collection of AssignedDoc items
Utility functions and configuration connection data
AyaFile object Storage, retrieval and deletion of files inside the AyaNova database. Automatic compression / decompression. NOTE: There is a 50MB source file size limit
Retrieves stats about files stored in the AyaNova database for diagnosis and administrative purposes
AyaNova captures and stores signatures as vector data, this class is used to parse the captured signature data for various admin info stored with it as well as generate an image for use in reporting or displaying in UI.
AyaNova client object representing a customer.
Client group - for grouping clients for filtering, sorting and reporting purposes
Editable root collection of ClientGroup objects
Read only detailed list of ClientListDetailed..::..ClientListDetailedInfo objects representing clients used for reporting, not UI
Read only list of ClientNotesReportList..::..ClientNotesReportListInfo objects representing ClientNotes used for reporting (printing) client notes
i.e phone, fax, followup etc
Editable Root collection of ClientNoteType objects
Lightweight list of ClientPickList..::..ClientPickListInfo objects used for quickly fetching a list of clients. Used for user selection and internal API useage by other business objects. NOTE: this is used mostly internally so the default GetList() method is not regionalized
Lightweight method for quickly fetching a Client object's PopupNotes if present Used by UI when opening workorders
Contains request for service entered by the Client directly via WBI or other means
Read only list of ClientServiceRequestList..::..ClientServiceRequestListInfo objects representing ClientServiceRequest objects
Contact's title, i.e. "Mr.", "Mrs.", "Doctor", "Professor" etc
Rate applicable to Contract only
Editable child collection of ContractRate objects
Various DB helpers to save duplication in individual business objects
Dispatch zones, used to group scheduleable users for filtering in Schedule calendar as well as filtering and sorting in grids and reporting purposes
Lightweight list of DispatchZonePickList..::..DispatchZonePickListInfo objects representing DispatchZone objects Includes inactive so that they can be shown on old records in a consistent format
Editable root collection of DispatchZone objects
Generic name / value list
Global settings - stores AyaNova wide defaults and preferences API users: use the GlobalSettings property to ensure you are working with the most current GlobalSettings rather than retrieving this object directly.
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 object representing a parent entity grouping one or more Client objects
Read only detailed list of HeadOfficeListDetailed..::..HeadOfficeListDetailedInfo objects representing HeadOffices used for reporting, not UI
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.
Editable child collection of IntegrationMap objects
LoanItem representing an item that will be loaned or rented to a client and tracked in the WorkorderItemLoan object
Lightweight read only list of LocaleList..::..LocaleListInfo objects representing all the locale (languages) defined in AyaNova
Most user interface element text displayed to the user will be held here. This is the editable root object used to modify a particular localized text entry This is for editing not read only display in a user interface, for that see LocalizedTextTable instead.
Collection of localized text editable root objects This is for editing, not read only display in a user interface, for that see LocalizedTextTable instead.
Create a new locale by duplicating an existing one
Holds the localized text for use by user interface This is the class you want to use if you want to display localized text in your code and this is where you want to access it from: LocaleText
AyaNova Memo between AyaNova users. Used to create *new* Memo message only
Lightweight read only version of Memo object for display only.
Used to quickly fetch a single name record from the db
Lightweight read only list of NotifyDeliveryLogList..::..NotifyDeliveryLogListInfo objects representing log entries regarding notification deliveries
Quickly fetch any Regionalized object's regionid Used primarily for search feature restrict results to region
Part object representing a part used in service
Editable root collection of PartAssembly objects
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)
Editable root collection of PartByWarehouseInventory objects
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.
Editable root collection of PartCategory objects
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
List of detailed adjustment items objects used in detailed report
Read only list of PartInventoryAdjustmentList..::..PartInventoryAdjustmentListInfo objects used in grid lists and summary report
Read only list of PartInventoryAdjustmentListDetailed..::..PartInventoryAdjustmentListDetailedInfo objects used in grid lists detailed reports
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
Used to quickly fetch a various inventory related values for a particular part over all warehouses combined
Lightweight read only list of PartPickList..::..PartPickListInfo objects used for user selection in UI as well as API purposes internally
Read only list of PartRestockRequiredByVendorList..::..PartRestockRequiredByVendorListInfo objects representing Parts that are below their restock level by vendor. Used in purchase order entry screen.
Lightweight read only list of PartSerialPickList..::..PartSerialPickListInfo objects
PartWarehouse class is used to group parts for inventory purposes. Often service company's will have more than one warehouse or consider a service van as a warehouse AyaNova allows any number of warehouses for separate inventory tracking.
Read only list of PartWarehouseInventoryList..::..PartWarehouseInventoryListInfo objects representing the inventory status of all parts. Used for reporting and grid listing.
Lightweight read only list of PartWarehousePickList..::..PartWarehousePickListInfo objects representing PartWarehouse objects for selection in UI and API internal usage by other business objects
Editable Root collection of PartWarehouse objects
Read only collection of PartWorkorderItemRequestByVendorList..::..PartWorkorderItemRequestByVendorListInfo objects representing parts appearing on WorkorderItemPartRequests for specified vendor Used in purchase order entry screen.
Editable root collection of Priority objects
Priority selectable for WorkorderItem objects. Used for filtering, sorting and reporting.
Project object, used to group work orders for sorting, filtering and reporting purposes
Purchase order object representing an order for parts
Read only list of detailed purchase order data used for reporting
Indivdual item (part) that is selected to be in the PO
Editable child collection of PurchaseOrderItem objects
Read only list of PurchaseOrderListDetailed..::..PurchaseOrderListDetailedInfo objects used for reporting.
Read only list of PurchaseOrderListReceivableForVendor..::..PurchaseOrderListReceivableForVendorInfo objects representing PurchaseOrder objects ready to be received for a particular vendor
This is a write once only object. Once saved initially it can never be edited again as it affects many other objects and must follow standard business practices for inventory control. Corrections must be made through an inventory adjustment as per standard practices.
Detailed read only data used for reporting purposes.
Item received on PurchaseOrderReceipt
Editable child collection of PurchaseOrderReceiptItem objects
Read only list of PurchaseOrderReceiptList..::..PurchaseOrderReceiptListInfo objects representing PurchaseOrderReceipt objects. Used for reporting.
Read only list of PurchaseOrderReceiptListDetailed..::..PurchaseOrderReceiptListDetailedInfo objects representing detailed info about PurchaseOrderReceipt objects. Used for reporting purposes.
Service / Travel rates to bill to client
Editable root collection of Rate objects
Type of rate per unit i.e per hour, per day, per gram, per KM, per nautical mile etc
A collection of RateUnitChargeDescription objects
Regions are used in AyaNova to compartmentalize objects and keep them separate. For example a Client can be set to a specific region in which case only users also set to that Region will be able to see and use that Client. In addition some default settings are applied from a regional level between Global and User settings.
Used to turn a date and time object into a string representation which is localized and relative to current date/time
Used internally as "go-between" data source for reporting in cases where reports are based off complex business objects that contain hiearchical linked data sources. Also used to support localized column names and filter out irrelevant and duplicate fields. API users: treat this as a traditional DataSet object which it's derived from.
Read only list of ReportList..::..ReportListInfo objects representing objects. Used for grid lists and reporting (ironically enough).
Lightweight read only list of ReportPickList..::..ReportPickListInfo objects representing objects. Used for choosing reports in UI
ScheduleableUserGroup - a preselected group of individual scheduleable users. Used for dispatching and display purposes
Lightweight read only list of ScheduleableUserGroupPickList..::..ScheduleableUserGroupPickListInfo objects representing ScheduleableUserGroup objects. Used for UI selection and internal processing by business objects.
Individual ScheduleableUser assignment to a ScheduleableUser group
Editable child collection of ScheduleableUserGroupUser objects
Lightweight read only list of ScheduleableUserGroupUsersList..::..ScheduleableUserGroupUsersListInfo objects
A schedulemarker is used to make an entry in the calendar for items that are not workorder item scheduled users. Users make schedule markers to indicate time off, holidays or to remind them to follow up on root objects using the follow up feature etc.
Read only collection of SearchResultList..::..SearchResultListInfo objects
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 internally to quickly check if a bank entry has already been made for the source object type and id and retrieve the bank ID if it is. This is generally used to avoid concurrency issues (another user banks an object moments before the current user does etc)
Used to quickly fetch current service bank balance for object indicated
TaskGroup - a preselected group of individual tasks that can be used to quickly select a slew of tasks with one selection
Editable child collectin of TaskGroupTask objects
Collection of Task objects
Used in PO's, invoices, parts, services to indicate an item is taxable
Lightweight read only list of TaxCode objects for selection in UI
Editable root collection of TaxCode objects
Lightweight read only list of TemplatePickList..::..TemplatePickListInfo objects representing Work order Templates for building pick lists users can select from in AyaNova UI
Read only list of TemplatePreventiveMaintenanceList..::..TemplatePreventiveMaintenanceListInfo objects representing preventive maintenance workorder templates. Used for grid display and reporting.
Read only list of TemplateQuoteList..::..TemplateQuoteListInfo objects representing quote templates. Used in UI grids and reporting.
Read only list of TemplateServiceList..::..TemplateServiceListInfo objects representing Service workorder templates. Used in UI grids and reporting.
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
Single object that uniquely identifies any distinct AyaNova business object. Used in many areas of AyaNova at the busines object and UI levels.
Unit - an item attributed to a specific client that is to be repaired or serviced
Unit meter reading entry
Read only list of UnitMeterReadingList..::..UnitMeterReadingListInfo objects representing UnitMeterReading object. Used in UI and reporting.
Represents a Model of a Unit object. Used for categorization, filtering and sorting in grids, reporting and warranty tracking.
Editable root collection of UnitModelCategory objects. Used to group unit models into categories for reporting and filtering purposes.
Category which a UnitModel can be tagged with for filtering, sorting and reporting purposes
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
Editable root collection of UnitOfMeasure objects
Customizable tag to attribute to the type of service performed on a Unit used by service, quote and PM Workorders
Editable root collection of UnitServiceType objects
User - anyone with access to AyaNova
Certificate or training a schedulable user has achieved
Editable child collection of UserCertificationAssigned objects
Editable root collection of UserCertification objects
Lightweight read only list of UserListScheduleable..::..UserListScheduleableInfo objects representing *Scheduleable* users only. Used in UI picklists and extensively throughout the API internally by other business objects.
Most recently used object list When various objects are opened an entry is made in the user's MRU list so that they can quickly open an item they were recently working on by selecting it in the AyaNova user interface. The tracking of what was opened is done at the business object level which is why each object has several overrides to optionally track MRU or not when an item is opened because code opens objects internally as often as the user initiates from the UI.
Editable root collection of UserMRU objects
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
Supplier of various goods and services depending on type selected.
Workorder object - the heart of AyaNova. This is the parent object of all forms of workorders including quotes, pm, service and template forms.
Editable root collection of WorkorderCategory objects
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
Contains the record of Units sent out for service by a 3rd party.
Read only list of WorkorderItemPartRequestList..::..WorkorderItemPartRequestListInfo objects representing WorkorderItemPartRequest objects. Used in Grid and reporting.
Used to quickly fetch descriptive information for a workorderitemscheduleduser notification during notification Processing
A single task item for a work order
Customizeable type that can be set on WorkorderItem objects for filtering, sorting and reporting purposes
Lightweight read only list of WorkorderItemTypePickList..::..WorkorderItemTypePickListInfo objects representing WorkorderItemType objects. Used for selection in UI and internally by business objects.
Editable root collection of WorkorderItemType objects
Read only list of WorkorderPMCustomList..::..WorkorderPMCustomListInfo objects
Used to quickly fetch descriptive information for identifying a quote workorder to user (Used by NameFetcher)
Detailed preventive maintenance info used in report
Read only list of WorkorderPMItemList..::..WorkorderPMItemListInfo objects used in grids and summary reports
Read only list of WorkorderPMLaborList..::..WorkorderPMLaborListInfo objects used in grid and summary reports
Read only list of WorkorderPMList..::..WorkorderPMListInfo objects used in grids and summary reports
Read only list of WorkorderPMPartList..::..WorkorderPMPartListInfo objects used in grids and summary reports
Read only list of WorkorderPMScheduledUserList..::..WorkorderPMScheduledUserListInfo objects used in grids and summary reports
Read only list of WorkorderPMTravelList..::..WorkorderPMTravelListInfo objects used in grids and summary reports
Read only list of WorkorderQuoteCustomList..::..WorkorderQuoteCustomListInfo objects used in grids and summary reports
Used to quickly fetch descriptive information for identifying a quote workorder to user (Used by NameFetcher)
Detailed quote info for reports
Read only list of WorkorderQuoteItemList..::..WorkorderQuoteItemListInfo objects used in grids and summary reports
Read only list of WorkorderQuoteLaborList..::..WorkorderQuoteLaborListInfo objects used in grids and summary reports
Read only list of WorkorderQuoteList..::..WorkorderQuoteListInfo objects representing quotes and used in grids and summary reports
Read only list of WorkorderQuotePartList objects used in grids and summary reports
Read only list of WorkorderQuoteScheduledUserList..::..WorkorderQuoteScheduledUserListInfo objects used in grids and summary reports
Read only list of WorkorderQuoteTravelList..::..WorkorderQuoteTravelListInfo objects used in grids and summary reports
Read only list of WorkorderServiceBillableList..::..WorkorderServiceBillableListInfo objects representing service work orders that are invoiceable. Used by accounting integration plugins.
Read only list of WorkorderServiceCustomList..::..WorkorderServiceCustomListInfo objects used in grids and summary reports
Detailed service workorder data for reporting
Read only list of WorkorderServiceExpenseList..::..WorkorderServiceExpenseListInfo objects used in grids and summary reports
Read only list of WorkorderServiceItemList..::..WorkorderServiceItemListInfo objects used in grids and summary reports
Read only list of WorkorderServiceLaborList..::..WorkorderServiceLaborListInfo objects used in grids and summary reports
Read only list of WorkorderServiceList..::..WorkorderServiceListInfo objects representing service workorders. Used by grids and summary reports.
Read only list of WorkorderServiceLoanList..::..WorkorderServiceLoanListInfo objects used in grids and summary reports
Read only list of WorkorderServicePartList..::..WorkorderServicePartListInfo objects used in grids and summary reports
Read only list of WorkorderServiceScheduledUserList..::..WorkorderServiceScheduledUserListInfo objects used in grids and summary reports
Read only list of WorkorderServiceTravelList..::..WorkorderServiceTravelListInfo objects used in grids and summary reports
Status selectable for WorkorderService objects for filtering, sorting, reporting and notification purposes
Lightweight read only list of WorkorderStatusPickList..::..WorkorderStatusPickListInfo objects representing WorkorderStatus objects. Used for selection in UI and internally by business objects.
Used to quickly fetch the workorder type for internal processing
Types of addresses used in AyaNova
Used to identify file types for display and internal processing purposes
Used throughout AyaNova wherever a unit of time needs to be selected or acted upon
User chosen priority for their service request
The current status of a customers service request as it progresses through the system
Geographical co-ordinate nomenclature to use
Used by. When a user customizes the custom fields these are the types of display and input they can select from
Hemisphere for setting defaults in UI for co-ordinate inference
Loan item rate period
Prime meridian offset for setting defaults in UI for co-ordinate inference
Used for controlling appearance of parts in user interface
Enumeration used to track Purchase Order through business process from start to closed
Billable service types
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.
Source that the schedulemarker applies to
Used by UI
Security access rights
The style of presentation of a unit to display in the user interface
Variations of User types
Categorization of vendors Used to tag a vendor and filter which areas it appears in lists in the user interface
Warranty status of Unit
Indicates status of task
Selected status types on WorkorderQuote object Used to track progress of quote for reporting and business process purposes
The workorder object can be one of several flavors depending on the purpose it will be used for. This enumeration is used to indicate which type of workorder should be created and or to identify what type of workorder we have.