GZTW.AyaNova.BLL
A workorder that is used to generate service work orders
on a schedule.
Calculate generate date based on service date and
threshold span and unit
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create item
Parent ID
New Item
Retrieve item
Data reader
item from database
Fetch from db
Persist object to database
Parent object
Parents transaction object
Initial created date of this object
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
Unique ID of this object
Incremental number from sql server
ID of Status the service workorder will set to when generated
ID of root object this belongs to (workorder)
Desired day of the week to force service to
Date that generator will stop Processing this PM
(expiry date)
After this date it will flip to inactive and
remain for the user to delete or reactivate
True=included in pm and makes workorders etc
False=on hold, not used, not included in automatic pm stuff
Span of GenerateSpanUnits of time between workorder
generations (for time based pm's)
How far in advance to generate the workorder
This is the number of ThresholdSpanUnits of time in advance of
NextServiceDate to generate the service workorder.
For example, if this value is 5, the ThresholdSpanUnits is Days
and the NextServiceDate is March 12 then the workorder will be generated
on March 7th, 5 days in advance of the service date.
Date of next PM service.
This will be the date used for the ServiceDate field
in the service workorder.
This value is originally set when the PM is first created and
is then carried forward automatically when a service workorder is created off
this PM, as well all other dates within the PM workorder are also carried forward
relative to this date. This ensures that a scheduled tech for example one day after
service date (follow up) still gets created one day after the new service date.
The service workorder will be generated
on or in advance of this date depending on the settings
in the threshold fields.
A unit of time used in conjunction with the value of
GenerateSpan to determine the frequency of PM service.
(I.E. if this is set to AyaUnitsOfTime.Months and
GenerateSpan is set to 6 then a service workorder will be generated
every 6 months)
A unit of time used in conjunction with the value of
ThresholdSpan to determine how far in advance of the
NextServiceDate to generate a service workorder
Read only list for reports and grid display
Check if item in collection
Internal method used by list factory
Get all Items (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Criteria for identifying existing object
Read only list for reports and grid display
Check if item in collection
Internal method used by list factory
Get all Items (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Criteria for identifying existing object
Read only list for reports and grid display
Check if item in collection
Internal method used by list factory
Get all Items (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Criteria for identifying existing object
User enters a discount to be applied to part at time of data entry
Discount applied as specified by contract
Discount applied for other reason. Review notes as to why.
Guid ID of root object (Workorder which may be a Service, ServiceTemplate,
WorkorderQuote, QuoteTemplate, PM, or PMTemplate
This is a user definable date and time in the event the request came many hours
previously, but was created at a later date and they wish to identify "actual"
response time from when the request actually occurred - not via the Created
attribute. Default value is the WorkorderItem mCreated attribute
Brief summary of what the service item is for For display on lists, reports,
schedule screen etc Corresponds to probs.brief in AyaNova 1.9.4.4
Used to identify for the dispatched technican what service is to be performed
Corresponds to probs.notes in AyaNova v1
ID of WorkorderItemType
Status selected for WorkorderItems - uses object Status which is also used by
WorkorderStatus - this allows reports to be based on either or WorkorderStatus
from Workorder object able to update this field When this WorkorderItem Status
is marked as closed any parts set to Reserved results in a popup alerting user
that there are parts yet reserved and not yet set to UsedIService - can't
closed until changed
WorkorderItemParts child collection
WorkorderItemScheduledUsers child collection
WorkorderItemLabors child collection
WorkorderItemMiscExpenses child collection
WorkorderItemTravels child collection
WorkorderItemTasks child collection
0..1 ratioWorkorderItemOutsideService object
WorkorderItemLoans child collection
ID of unit being serviced can be null
If UnitID has a value, than this is available
If a unit selected, service provided under warranty for this unit
Private constructor to prevent direct instantiation
Called by workorder items collection object
when called in turn by workorder object that is read only due to
security or closed or service completed
Either true or the rights allowed for the current user
Sets all parts for this workorder item
to part status "UsedInService"
Helper for GUI, if user selects more parts than are in stock
and indicates they want to request them from the purchaser
this function will move the quantity indicated to the request line
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
New item
Get Item
Update child
Called by collection and by the Update method in this object
to remove all child collections and workorder item itself
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Used to identify for the dispatched technican what service is to be performed
WorkorderItemMiscExpenses child collection
WorkorderItemLoans child collection
WorkorderItemLabors child collection
0..1 ratioWorkorderItemOutsideService object
WorkorderItemParts child collection
WorkorderItemPartRequests child collection
WorkorderItemScheduledUsers child collection
WorkorderItemTasks child collection
WorkorderItemTravels child collection
If UnitID has a value, than this is available
Status selected for WorkorderItems - uses object Status which is also used by
WorkorderStatus - this allows reports to be based on either or WorkorderStatus
from Workorder object able to update this field When this WorkorderItem Status
is marked as closed any parts set to Reserved results in a popup alerting user
that there are parts yet reserved and not yet set to UsedIService - can't
closed until changed
ID of unit being serviced
If a unit selected, service provided under warranty for this unit
This is a user definable date and time in the event the request came many hours
previously, but was created at a later date and they wish to identify "actual"
response time from when the request actually occurred - not via the Created
attribute. Default value is the WorkorderItem mCreated attribute
For pm setting and other internal use
ID of WorkorderItemType
Brief summary of what the service item is for For display on lists, reports,
schedule screen etc Corresponds to prob.brief in AyaNova v1
Custom1
Custom2
Custom3
Custom4
Custom5
Custom6
Custom7
Custom8
Custom9
Custom0
True means there are WorkorderItemPartRequest items
still on order and not fully received
A workorder item can not be deleted if there are part requests on order
as it would break inventory
No current or past warranty
Expired - had a warranty but has now expired
Active warranty / in-warranty
This is the special account used only for updates, for customizing layout, etc
This is a user that can be assigned to a workorder or schedule. identified by
(tech) next to name
UnitModels for choosing in combo boxes etc
Check if item in collection
Get all UnitModels
Get one specific UnitModel only but with all the pick list info
Get item by index
Returns display text that matches passed in itemid value
Returns display text that matches passed in itemid value
Properties
@returns
Criteria for identifying existing object
Individual task assignment to a task group
ID of TaskGroup this task belongs with
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create item
Parent ID
New Item
Retrieve item
Data reader
item from database
Fetch from db
Persist object to database
Parent object
Parents transaction object
Initial created date of this object
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
Unique ID of this object
ID of TaskGroup this task belongs with
All rates with type
Check if item in collection
Check if item in collection
Get all Rates
Only Active rates that are not contract rates will
be flagged as Selectable=true;
Get all Rates and if contract forces a subset of rates
then it flags all rates not in the forced contract rates
as Selectable=false.
Note that if a contract does not *force* contract rates only then the returned
list will flag as selectable all active contract rates if there are any plus all active regular rates
In other words you can use this regardless of the status of the contract
Id of contract that might affect rates returned
A list of all rates with selectable set according to contract
Get all Rates and flag Active ones as Selectable=true regardless of whether they are contract only or not
This is used in scenarios where it's valid to see and select any rate
it should never be used in conjunction with another object's rate setting
where a contract with contract rates only is in effect.
Get item by index
Returns RatePickListInfo item that matches passed in itemid value
@returns
True if this rate is active and allowed under
current contract if any (Contract.ContractRatesOnly)
Criteria for identifying existing object
Remove Priority by passing it in
Remove by Guid value of ID
Add a new Priority to the collection
Add Priority by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve Priority by index
Index
Criteria for identifying existing object
Read only list of PartInventorys.
Not required for grid but must be implemented
Check if item in collection
Internal method used by list factory
Get all PartByWarehouseInventory (filtered by crit)
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
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.
Get all available notifications for delivery
Process an event/subscription record
and insert into list
Gets all the info necessary for delivery as well
as for removing the notify event after sucessful delivery
Get item by index
Criteria for identifying existing object
Any text displayed to the user will be held here.
i.e English, French, Spanish, German
i.e "wo.category"
i.e "Category"
i.e "Workorder Category"
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
Root version of new item
Child version of new item
Get Item - Editable root version
Get item - Child version
Delete LocalizedText Item
Populate this object from the values in the datareader passed to it
Called by DataPortal to delete/add/update data into the database
Editable root version
Update - Child version
Remove a Localized Text record from the database
i.e "Category"
i.e "Workorder Category"
i.e "wo.category"
i.e English, French, Spanish, German
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Criteria for identifying existing object
A simple lightweight name/value item
that can be inserted into a grid
Guid ID of contact
The point is so that if can not list all phone numbers, this is the default
number that will be displayed default is the first one entered is true, all
others are false. But if another is made true, then this one becomes false
Additional phone entered are then set to false automatically User has ability
to change true and false
Could be phone, fax, cell etc
Default can be set from regional settings (or global settings?)
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create item
Parent ID
New Item
Retrieve item
Data reader
item from database
Fetch from db
Persist object to database
Parent object
Parents transaction object
Initial created date of this object
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
Unique ID of this object
Could be phone, fax, cell etc
Localized text of phone type
Localized text of complete phone record
including descriptive name of phone type, country code etc etc
Full phone number without phone type descriptive string
Guid ID of contact
Default can be set from regional settings (or global settings?)
This is so that if can not list all phone numbers, this is the default
number that will be displayed default is the first one entered is true, all
others are false. But if another is made true, then this one becomes false
Additional phone entered are then set to false automatically User has ability
to change true and false
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Get new object
Check for the existance of a WorkorderStatus
in the database
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Name of item
Description
ARGB color
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
New quote
Called by DataPortal to delete/add/update data into the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
ID of user that is responsible for this quote
Will take as default the mCreator ID, but user can select from list of
schedulable and non-schedulable users
ID of root object this address belongs to (workorder)
When you present your quote to your customer, it helps to add some words
introducing the quote to the customer, or maybe even reminding them what the
quote is for and what it will cover.
Very useful if you have to re-send to the client
This is in addition to the Workorder object Summary field as that is limited in
lenght
Incremental number from sql server
Date quote requested initially
Defaults to one month from mCreated date, but user can edit if needed
Date quote details are still able to be approved and converted to a Service
object
DateSubmitted - date quote submitted to client
Date client approves the quote
if empty then client has not approved quote
(this is set when the quote is converted to a workorder if empty)
Status of the quote
Set the DB generated visible ID number
to a new user chosen starting point
Read only list for reports and grid display
Check if item in collection
Internal method used by list factory
Get all Items (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Criteria for identifying existing object
Used to track travel for service
both for billing back to client and
for techs to track their own travel for re-imbursement etc
Private constructor to prevent direct instantiation
Called by parent collection object
when called in turn by workorder object that is read only due to
security or closed or service completed
Either true or the rights allowed for the current user
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
New item
Get Item
Update child
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Notes about WorkorderItemTravel
This is additional information for the tech themselves - Appended to the
details, not usually shows on Detailed reports given to client.
UserID selected must be schedulable and active.
If displaying historical information, would show a N/A (non-active) next to the
displayed name, but would not be able to reselect an active and schedulable
user
if a rate that is set as a flat is selected, this field "disappears"?
Guid ID of root object (WorkorderItem)
Sales tax code for rates
this is the collection of scheduled Users that is selected for a WorkorderItem
to display along with start and stop dates (and times)
Remove WorkorderItemScheduledUser by passing it in
Remove WorkorderItemScheduledUser by string of id value
Remove by Guid value of ID
Add a new WorkorderItemScheduledUser to the collection
Sets all items to read / write status
used by workorder object when it's closed or service completed is true
true=Set to read only explicitly, false=set to whatever rights allowed
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
Get items - Grandchild style
Fetch children - grandchild style
Update children
Given a workorder item ID deletes all items for that ID
Called by workorderitems delete
ID of parent workorder item
Database transaction from ascendant item
Retrieve WorkorderItemScheduledUser by index
Index
Retrieve WorkorderItemScheduledUser by string containing Guid value
Remove WorkorderCategory by passing it in
Remove by Guid value of ID
Add a new WorkorderCategory to the collection
Add WorkorderCategory by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve WorkorderCategory by index
Index
Criteria for identifying existing object
List of Vendors for building pick lists
Includes inactive so that they can be shown on old records
in a consistent format
Check if item in collection
Check if item in collection
Get all scheduleable users
Get a list of vendors of one specific type only
Get item by index
Returns VendorPickListInfo item that matches passed in itemid value
@returns
Criteria for identifying existing object
Read only list of SecurityGroups
Check if item in collection
Get list by criteria
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns display text that matches passed in group name value
Name of security group
Properties
@returns
Criteria for identifying existing object
there can be two types of rates. We identify them as service and travel rates.
User may customize as needed, but
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new Rate
Fetch
Check for the existance of a Rate
in the database by ID OR by Name
Guid of Rate
Name of Rate
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get client group name
Get /set active status
Get/set accounting number for rate
get/set cost of rate internally in currancy
if null, sets itself to 0.00
get/set charge of rate internally in currancy
if null, sets itself to 0.00
GUID of ClientGroup this rate is only available for
Default is null
Null indicates avaialble to all clientgroups.
select type of unit of rate to charge - ie charge is per hour, per paper count,
etc
If true then only shows for contract holders
If false always displays
Read only list of PurchaseOrders.
Check if item in collection
Internal method used by list factory
Takes an xml column list and where criteria
and returns a list filtered and sorted accordingly
Takes a single ID and returns a "list" of one object
ID of PurchaseOrder object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
Collection of delivery methods for a notification subscription
Remove by Guid value of ID
Add a new NotifySubscriptionDelivery to the collection
NewItems
Get items - Grandchild style
Fetch children - grandchild style
Update children
Given a NotifySubscription item ID deletes all delivery items for that ID
Called by Subscription delete
ID of parent NotifySubscription object
Database transaction from ascendant item
Retrieve NotifySubscriptionDelivery by index
Index
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
Remove LocalizedText by passing it in
Remove all items from list
Add a new LocalizedText to the collection
Add LocalizedText by passing it in
Check if item in collection
Check if item in deleted collection
NewItems
Get item collection (Root collection style)
Gets all localized text in database (no filter)
Get item collection (Root collection style)
Gets all editable (non custom) localized text in database for locale specified
Get item collection (Root collection style)
Gets all localized text in database for locale specified
including custom fields
Used for export by this class only
Get custom field items only for object specified
used when customizing custom fields for objects
that have 'em (Root collection style)
Object to retrieve the custom fiels for
Create a new localized text collection for a new locale
by copying the contents of an existing locale
This method will throw an exception if there is a locale
already present in the database with the same name as the
newLocaleName parameter.
15 characters maximum. Longer strings will be truncated to 15 characters
The name of an existing locale to act as the source locale
Export Locale localized text collection to an AyaNova Transportable
Locale file (.AYL) at the path indicated
Locale name (i.e. "English")
Full path (including file name) to export to. NOTE: By convention, all AyaNova Locale file names end in the extension .AYL
Import Locale from an AyaNova Transportable Locale file (.AYL) at the path indicated
Full path (including file name) to import.
NOTE: By convention, all AyaNova locale file names end in the extension .AYL
False if Locale with that name already exists, true for any other result
Export Locale localized text collection to an XML file
at the path indicated
Locale name (i.e. "English")
Full path (including file name) to export to.
Import Locale from an XML file at the path indicated
Full path (including file name) to import.
False if Locale with that name already exists, true for any other result
Fetch children root style
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve LocalizedText by index
Index
Criteria for identifying existing object
Create a new locale by duplicating an existing one
Delete a locale
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.
ID of parent integration object
ID of AyaNova Object
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create item
Create a new integration map child object
Parent Integration object
New Item
Retrieve item
Data reader
item from database
Fetch from db
Persist object to database
Parent integratin object
Parents transaction object
Initial created date of this object
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
Unique ID of this object
ID of parent integration object
AyaNova object ID
AyaNova object type
Set/get Foreign ID
This is the integration object ID
Required, 255 ASCII characters max
Set/get Integration object's name
255 unicode characters max
DateTime field indicating the last time integration object was synchronized
Set by the integrating application.
Implementers may use this date as required, it's purpose is to aid in
synchronization and use is optional
If a null or non existant date is desired set this value to
System.DateTime.MinValue as that is the standard used in AyaNova for null dates
Object for use by integration application store
with individual map object
You can store any data you wish in this object, it is
serialized to and from the database in a binary blob / image field.
Typically this would be used to store data about an individual mapped object that is
application specific I.E. create a serializable class or structure to contain
data and store / retrieve via this field.
Don't go overboard with this object it *is* stored in the database and
should not be used to store huge binary objects, this will
only slow down your application and bloat the users database un-necessarily.
32k or less is a good rule of thumb
We may enforce this to 32k or less in future so consider carefully keeping under the
32K limit. If you need to go over this limit regularly then those
objects should be stored with the application that is integrating
outside of AyaNova. I.E. in a separate database or file system.
Set/get Integration object's AyaNovaCheckSum
255 ascii characters max
This is an optional field that can be used to store
a checksum or any string value. It's intended use
is to store a checksum of the fields in the AyaNova
object that are of interest if they are changed.
So, for example, if you were interested in knowing if
an AyaNova object had a specific set of fields changed
since originally being added to this collection
you might generate a checksum on the
fields in question and store it here, then you can later
regenerate a checksum on that object and compare it to this
value to determine quickly if any of the fields of interest
have changed.
If you just want to know if any part of the object was changed
then you would normally track the Modified date of the AyaNova object
and compare it with the lastsync date here, this field is intended
to give more granular control if you are interested only in specific
fields that might have changed.
This could also be useful for comparing objects to see if a select
set of fields are identical
Set/get Integration object's ForeignCheckSum
255 ascii characters max
This is an optional field that can be used to store
a checksum or any string value. It's intended use
is to store a checksum of the fields in the Foreign
object that are of interest if they are changed since
the point they were originally linked but you don't want
to track any changes to the object, only specific ones
to a limited set of data.
(for a more general change tracking method you might compare
the last sync date instead)
This could also be useful for comparing objects to see if a select
set of fields are identical
Global settings
Private constructor to prevent direct instantiation
Returns true if passed in tax code ID
is used as the default anywhere in global settings
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Global Guid
Called by DataPortal to delete/add/update data into the database
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Get service address for this client
Get mailing address object for this client
Returns GoToAddress object if MailToAddress is empty
Default is true (allow)
False means if schedule coflicts occurs, it gives a pop up message indicating
so that you need to change it.
True means it gives a popup letting you know, but lets you go ahead with
schedule.
We do not have an option to turn off popup as should purchase enough licenses
to cover all users.
Default is false
If true, displays region settings and fields
If false, still uses a default region behind the scenes so "ready" to go to use
regions
Default tax for selling parts
Default purchase tax code for parts
Default tax for selling services / rates
Status that identifies when a workorder is completed
Used internally by the program for some functions.
Reset starting number for auto incrementing workorder number
Can only be set higher than current seed value
Reset starting number for auto incrementing quote number
Can only be set higher than current seed value
write only
Reset starting number for auto incrementing Purchase Order number
Can only be set higher than current seed value
write only
Reset starting number for auto incrementing InventoryAdjustment number
Can only be set higher than current seed value
Template for displaying information about a workorder
compactly in summary form on calendars and in lists
and reports
Default is false
If true, activates AyaNova inventory tracking and features
Indexing style to use for AyaNova internal search engine
Default is false.
If data entry is primarily in a language with no spacing or punctuation to
identify the boundaries between words (Chinese, Japanese, Korean, Thai etc) then
setting this value to true will use a 2 character segmentation system
In all other languages with spacing and/or punctuation this value should be false to ensure most accurate word indexing
Default for how old in minutes a workorder has to be and not be closed before
it's considered "stale" (for purposes of notification and display in some lists)
This is used to catch forgotten workorders.
This value is used to set the default CloseByDate by date/time in a service workorder.
Default is false
If true, activates AyaNova notification feature
and causes biz objects to check for notification events
and Process them as part of their normal updating routines
Criteria for identifying existing object
Process a notification list and
deliver appropriately
Log and remove
Abstract class for physically delivering
notification messages.
Performs delivery,
returns true on sucess or false on failure
Indicates message contains enough
info for delivery and/or address
is in the correct format for delivery
Dispatch zone
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new DispatchZone
DispatchZone
Fetch existing DispatchZone
DispatchZone
Datareader
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Get /set active status of DispatchZone
If active = true then DispatchZone is selectable for workorders etc
If active = false then DispatchZone in not selectable, but history can be viewed
Description about DispatchZone
Original sales Name number
Type of phone number i.e telephone, fax, cell, pager, radio
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Get new object
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Name of item
Read only Detailed list of WorkorderServiceTravel items
Check if item in collection
Internal method used by list factory
Get all WorkorderServiceTravel (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItemTravel object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Not for viewing directly, sets the color of the status button
Criteria for identifying existing object
Report data
Private constructor to prevent direct instantiation
Internal method used by list factory
Takes a single ID and returns a "list" of one object
ID of Workorder object
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Criteria for identifying existing object
Read only list of WorkorderPreventiveMaintenance items
Check if item in collection
Internal method used by list factory
Get all WorkorderPreventiveMaintenance (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of Workorder object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
@returns
Criteria for identifying existing object
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.
Remove WorkorderItemPart by passing it in
Remove WorkorderItemPart by string of id value
Remove by Guid value of ID
Add a new WorkorderItemPart to the collection
Sets all items to read / write status
used by workorder object when it's closed or service completed is true
true=Set to read only explicitly, false=set to whatever rights allowed
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
Get items - Grandchild style
Fetch children - grandchild style
Update children
Given a workorder item ID deletes all items for that ID
Called by workorderitems delete
ID of parent workorder item
Database transaction from ascendant item
Retrieve WorkorderItemPart by index
Index
Retrieve WorkorderItemPart by string containing Guid value
Retrieve WorkorderItemPart by Guid value
Read only list of UnitModels.
Check if item in collection
Internal method used by list factory
Get all UnitModel (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of UnitModel object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
Lightweight Read only list of
Scheduleable user ID values in specified ScheduleableUserGroup
Check if item in collection
Check if item in collection
Check if item in collection
Get all Parts
Get item by index
Returns ScheduleableUserGroupUsersListInfo item that matches passed in itemid value
@returns
ID
Criteria for identifying existing object
Private constructor to prevent direct instantiation
Criteria for identifying existing object
Read only list of Reports
Check if item in collection
Internal method used by list factory
Get list by criteria
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
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)
Report
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create new Report
Fetch existing Report
Client Guid
Delete Report (if clients assigned to this group, should be notified)
Client GUID
Export layout to an AyaNova Transportable Report file (.AYR) at the path indicated
Guid of existing report in database
Full path (including file name) to export to. NOTE: By convention, all AyaNova report file names end in the extension .AYR
Import layout from an AyaNova Transportable Report file (.AYR) at the path indicated
Full path (including file name) to import. NOTE: By convention, all AyaNova report file names end in the extension .AYR
False if report with that ID already exists, true for any other result
Called by DataPortal to delete/add/update data into the database
Remove a Report record from the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get name
Set/get ReportKey
Size of binary layout data content
True=reports are visible in print menu
False=reports are not shown in print menu
True if current logged in user has sufficient
rights to view reports
(this does not necessarily indicate that they are allowed to edit them)
Criteria for identifying existing object
Type of rate per unit i.e per hour, per day, per gram, per KM, per nautical
mile etc
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Get new object
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Name of item
Set/get Name of item
Get /set active status
Read only list of Parts that are below their restock level
by vendor.
Used in purchase order entry screen.
Return an empty list
used for initializing grid
Get item by index
Log fields
Criteria for identifying existing object
NotifySubscriber rates collection
Remove NotifySubscription by passing it in
Remove NotifySubscription by string of id value
Remove by Guid value of ID
Add a new NotifySubscription to the collection
Check if item in collection
by it's event id and root object type
Check if item in collection
by it's event id, root object type AND GuidValue
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
GetItems
Fetch children
Populated data reader
Update children
Given a Subscriber ID
retrieves all Subscription id values for that
subscriber, then calls the subscription Shared static direct
delete method to clear out those subscriptions
This is done this way to handle updating the notifyeventofinterest table
properly on deletion
Called by subscriber delete
ID of parent subscriber item
Database transaction from ascendant item
Retrieve NotifySubscription by index
Index
Retrieve NotifySubscription by string containing Guid value
Contains a portable Localized text object data
Used for serializing and de-serializing a locale
(i.e. importing and exporting locales outside the program)
SMTP message delivery
Contract
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new Contract
Contract
Fetch existing Contract
Contract
Contract Guid
Delete Contract
Contract GUID
Called by DataPortal to delete/add/update data into the database
Remove a Contract record .
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Get /set active status of Contract
If active = true then Contract is selectable for workorders etc
If active = false then Contract in not selectable, but history can be viewed
Notes about Contract
Original sales Name number
Most businesses will enter in a discount that a unit receives that is applied
to parts to cut down on the entry involved with this, as then you could enter
in the discount % once, but it would get applied to any part selected for this
unit without having to enter in the actual price for every single part. (note
if client has a discount, and unit has a discount - the discount on the unit
overrides if the unit is selected in the workorder)
Collection of rates that are accessible for this contract
Default = false
If true user can select rate from general rateslist rather than the ones
specifically set for this contract
Custom1
Custom2
Custom3
Custom4
Custom5
Custom6
Custom7
Custom8
Custom9
Custom0
Criteria for identifying existing object
Remove ContactTitle by passing it in
Remove by Guid value of ID
Add a new ContactTitle to the collection
Add ContactTitle by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve ContactTitle by index
Index
Criteria for identifying existing object
Read only Detailed list of WorkorderServiceItem custom field items
Check if item in collection
Internal method used by list factory
Get all (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Not for viewing directly, sets the color of the status button
Criteria for identifying existing object
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
NewItem
Retrieve item
Data reader
item from database
Fetch from db
Update
Initial created date of this object
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
Unique ID of this object
User skill ID
User ID
Remove UnitServiceType by passing it in
Remove by Guid value of ID
Add a new UnitServiceType to the collection
Add UnitServiceType by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve UnitServiceType by index
Index
Criteria for identifying existing object
Remove UnitModelCategory by passing it in
Remove by Guid value of ID
Add a new UnitModelCategory to the collection
Add UnitModelCategory by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve UnitModelCategory by index
Index
Criteria for identifying existing object
An ReportDataSetAdapter is used to convert data in an object
or collection into a ReportDataSet suitable for using with AyaNova reporting
methods.
Given a data source
returns an arraylist containing
ColumnInfo structures
for each column found
Fills the DataSet with data from an object or collection.
The name of the DataTable being filled is will be the class name of
the object acting as the data source. The
DataTable will be inserted if it doesn't already exist in the DataSet.
A reference to the DataSet to be filled.
A reference to the object or collection acting as a data source.
Fills the DataSet with data from an object or collection.
The name of the DataTable being filled is specified as a parameter. The
DataTable will be inserted if it doesn't already exist in the DataSet.
A reference to the DataSet to be filled.
A reference to the object or collection acting as a data source.
Fills a DataTable with data values from an object or collection.
A reference to the DataTable to be filled.
A reference to the object or collection acting as a data source.
Read only list of PurchaseOrders
ready to be received for a particular vendor
Check if item in collection
Get all PurchaseOrder (filtered by crit)
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Properties
@returns
Criteria for identifying existing object
Read only list of PartInventoryAdjustments.
Check if item in collection
Internal method used by list factory
Get all PartInventoryAdjustment (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of PartInventoryAdjustment object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
Report data
Private constructor to prevent direct instantiation
Takes a single ID and returns a "list" of one object
ID of PartInventoryAdjustment object
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Criteria for identifying existing object
This identifies the physical parts in stock
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Get new object
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
if true, does show in select list; if false then is not selectable, but can
still bring up history etc
default is true
Remove PartAssembly by passing it in
Remove by Guid value of ID
Add a new PartAssembly to the collection
Add PartAssembly by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve PartAssembly by index
Index
Criteria for identifying existing object
User selected delivery method for a single notification subscription
New
Retrieve item
Data reader
item from database
Fetch from db
Persist object to database
Parents transaction object
Initial created date of this object
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
ID of parent subscription
ID of delivery method
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.
Private constructor to prevent direct instantiation
used by all shared Add/Update methods but not by any of the remove methods
Constructor for remove all / specific event method
Object's events to be removed regardless of status
0=all events, non-zero means specific event only
Constructor for RemoveDeliveredEvent method
NotifyEvent ID to be removed
Constructor for subscription related remove events methods
Add a new event if no matching one already exists or
replaces a matching existing event.
Add a new event if no matching one already exists or
replaces a matching existing event.
Add a new pending event if no matching one already exists or
replaces an unProcessed matching existing event.
If the pending until date is empty then will simply remove any
existing matching pending event, otherwise will add/update it
Any pre-existing matching event found is replaced.
Removes all events for a given object ID
This is used within objects when they are deleted to
ensure no events remain related to them.
It is also used for updating objects like schedule markers where
a slight change, i.e. scheduleableusergroup change could
render a lot of the user specific events meaningless since
the entire group of users could change with a small change in the
schedulemarker. In a case like that, this method is called to
wipe out the entire event list for that object and a new one
is created
ID of deleted object
Removes a specific event for a given object ID
This is used within objects when they are changed in some way that
renders the event meaningless, i.e. if a client's contractexpires is set to empty
Removes a specific event for a specific user
This is used when a user unsubscribes from a specfic event to ensure
that there are no event's for that event and subscriber left floating
Removes an event that has been delivered
Used by notification delivery Processor to remove events
that have been delivered but not touch ones that are fresh since
delivery
Called by DataPortal to delete/add/update data into the database
List of LoanItems for choosing in UI
Check if item in collection
Get a list of all LoanItems
Get one loan item
Guid of loan item
Get item by index
Returns LoanItemPickListInfo item that matches passed in itemid value
@returns
Criteria for identifying existing object
Collection of AssignedDoc items
Remove AssignedDoc by passing it in
Remove AssignedDoc by string of id value
Remove by Guid value of ID
Add a new AssignedDoc to the collection
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
GetItems
Fetch children
Populated data reader
Update children
Retrieve AssignedDoc by index
Index
Retrieve AssignedDoc by string containing Guid value
Read only list for reports and grid display
Check if item in collection
Internal method used by list factory
Get all Items (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Criteria for identifying existing object
this is the collection of parts for this service item that are requested
by the user due to being out of stock
Remove WorkorderItemPartRequest by passing it in
Remove WorkorderItemPartRequest by string of id value
Remove by Guid value of ID
Add a new WorkorderItemPartRequest to the collection
Sets all items to read / write status
used by workorder object when it's closed or service completed is true
true=Set to read only explicitly, false=set to whatever rights allowed
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
Get items - Grandchild style
Fetch children - grandchild style
Update children
Given a workorder item ID deletes all items for that ID
Called by workorderitems delete
ID of parent workorder item
Database transaction from ascendant item
Retrieve WorkorderItemPartRequest by index
Index
Retrieve WorkorderItemPartRequest by string containing Guid value
Private constructor to prevent direct instantiation
Called by parent collection object
when called in turn by workorder object that is read only due to
security or closed or service completed
Either true or the rights allowed for the current user
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
New item
Get Item
Update child
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Notes
GUID of Tax code used for charges
Guid ID of root object (WorkorderItem)
Retail amount to charge client Can be 0
ReturnDate
Date expected to be returned
Date loaned out
ID of loan item being loaned
List of users for picking from formatted according
to various templates
Check if item in collection
Check if item in collection by userID
and Active
Get all scheduleable users
Get item by index
Returns UserListScheduleableInfo item that matches passed in itemid value
Return name in selected format
@returns
Criteria for identifying existing object
A user certification assigned to a specific user
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
NewItem
Retrieve item
Data reader
item from database
Fetch from db
Update
Initial created date of this object
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
Unique ID of this object
Certification ID
User ID
Date certificate or training validation begins
Date certificate or training is valid until
Read only list of UnitMeterReadings.
Check if item in collection
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
Read only list of Units.
Check if item in collection
Internal method used by list factory
Get all Unit (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of Unit object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
Type and ID object
Used to pass identification of objects around
User interface in tag properties of menu items etc
Source that the schedulemarker applies to
If selected, than the Regions group list is populated
If selected, than the user group list (schedulable and active only) is
populated
Collection of ScheduleableUserGroupUser items in a task group
Remove ScheduleableUserGroupUser by passing it in
Remove ScheduleableUserGroupUser by string of id value
Remove by Guid value of ID
Add a new ScheduleableUserGroupUser to the collection
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
GetItems
Fetch children
Populated data reader
Update children
Retrieve ScheduleableUserGroupUser by index
Index
Retrieve ScheduleableUserGroupUser by string containing Guid value
Summary description for ReportDataSet.
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Get new object
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Name of item
Remove PartWarehouse by passing it in
Remove by Guid value of ID
Add a new PartWarehouse to the collection
Add PartWarehouse by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve PartWarehouse by index
Index
Criteria for identifying existing object
Part serial
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create new PartSerial
PartSerial
Fetch existing PartSerial
PartSerial
Datareader
Given a part serial record ID returns the serial number
that is stored in that part serial record or an empty
string if not found
Guid value of partserial record
String serial number or empty string if not found
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Part
Warehouse
SerialNumber
set by collection if this serial number
is a duplicate of another in the collection
so that broken rule will be set
(assumes no two partID's that are the same will have the same
serial number if serialized part)
DateReceived
DateReceived internal version used
by inventory affecting objects
Date consumed
WorkorderItemPartID record
indicates which workorder item part record this part
was used on
ID of PartInventoryAdjustmentItem object
that caused the adjustment to happen
Purchase order receipt record ID
Indicates which receipt this was entered from
Available for consumption
General list of parts for display / reporting in UI
Check if item in collection
Takes a single ID and returns a "list" of one object
ID of Part object
Internal method used by list factory
Get all Part (filtered by crit)
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
@returns
Criteria for identifying existing object
Summary description for NotifySubscriptionList.
Get bindable list of notification subscriptions for display (only) in grid
Return an empty list
used for initializing grid
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Contains a subscription record
@returns
PopUp message delivery
Remove ContactPhone by passing it in
Remove ContactPhone by string of id value
Remove by Guid value of ID
Add a new ContactPhone to the collection
Sets passed in phone id default to true
all others to false
Iterates through collection and gets the default phone record
Iterates through collection and gets the fax number or an empty string if none found
Iterates through collection and gets the phone number that is not a
default number or a fax number if none found then an empty string is returned
Ensures one contact is set to default
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
Get items - Grandchild style
Fetch children - grandchild style
Update children
Given a Contact ID deletes all items for that ID
Called by Contact delete
ID of parent Contact item
Database transaction from ascendant item
Retrieve ContactPhone by index
Index
Retrieve ContactPhone by string containing Guid value
Retrieve ContactPhone by Guid value
Read only list of client work orders
Displayed in AyaNova WBI for client logins
Check if item in collection
Get all Workorders for a specified head office
(returns all workorders for all clients under headOfficeID)
Get all Workorders for a specified client
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
Read only list of clients.
Check if item in collection
Internal method used by list factory
Takes an xml column list and where criteria
and returns a list filtered and sorted accordingly
Takes a single ID and returns a "list" of one object
ID of Client object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
Read only list for reports and grid display
Check if item in collection
Internal method used by list factory
Get all WorkorderServiceLoans (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItemLoan object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Not for viewing directly, sets the color of the status button
Criteria for identifying existing object
Quote parts
Check if item in collection
Internal method used by list factory
Get all Items (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Criteria for identifying existing object
Read only list for reports and grid display
Check if item in collection
Internal method used by list factory
Get all Items (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Criteria for identifying existing object
Read only list for reports and grid display
Check if item in collection
Internal method used by list factory
Get all Items (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Criteria for identifying existing object
Read only list for reports and grid display
Check if item in collection
Internal method used by list factory
Get all Items (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Criteria for identifying existing object
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
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Get new object
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Name of item
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Get new object
GetItem
Fetch
Update
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Guid ID of securitygroup this right belongs to
Get / Set the abbreviated right code for this UserRight. Setting is validated
to conform to list of potential rights.
List of users for picking from formatted according
to various templates
Get all scheduleable users
Get item by index
@returns
Criteria for identifying existing object
Remove TaxCode by passing it in
Remove by Guid value of ID
Add a new TaxCode to the collection
Add TaxCode by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve TaxCode by index
Index
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Criteria for identifying existing object
Individual ScheduleableUser assignment to a ScheduleableUser group
ID of ScheduleableUserGroup this ScheduleableUser belongs with
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create item
Parent ID
New Item
Retrieve item
Data reader
item from database
Fetch from db
Persist object to database
Parent object
Parents transaction object
Initial created date of this object
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
Unique ID of this object
ID of ScheduleableUserGroup this ScheduleableUser belongs with
Regional settings, a level between Global and User settings.
User setting has priority over regional which has priority over company
wide setting
Address of AyaNova company - used in PO's and reports
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Get new object
Region Guid
Delete Region
Region GUID
Called by DataPortal to delete/add/update data into the database
Remove a Region record from the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Name of item
Get mailing address object for this region
(Note: this address is deliberately not indexed for searching)
Criteria for identifying existing object
Report data
Private constructor to prevent direct instantiation
Takes a single ID and returns a "list" of one object
ID of PurchaseOrderReceipt object
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Criteria for identifying existing object
Read only list of Parts that are below their restock level
by vendor.
Used in purchase order entry screen.
Return an empty list
used for initializing grid
Get item by index
Log fields
Criteria for identifying existing object
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new PartWarehouse
Fetch existing PartWarehouse
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get client group name
Get /set active status of client group
If active = true then PartWarehouse is selectable for workorders etc
If active = false then PartWarehouse in not selectable, but history can be
viewed
Remove PartInventoryAdjustmentItem by passing it in
Remove PartInventoryAdjustmentItem by string of id value
Remove by Guid value of ID
Parent Adjustment object
Checks if grandchildren are dirty
Checks if grandchildren are valid
Remove empty items (qty zero)
Sets broken rule for item
if it's a duplicate in collection
Only one instance of same part / warehouse allowed
in collection to avoid several potential ways of damaging integrity
of serial numbers and inventory
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
GetItems
Fetch children
Populated data reader
Retrieve PartInventoryAdjustmentItem by index
Index
Retrieve PartInventoryAdjustmentItem by string containing Guid value
Retrieve PartInventoryAdjustmentItem by Guid value
AyaNova NotifyDeliveryLog used to insert new
notification delivery events in the database.
Also removes all delivery log entries more than 30 days old
Called by DataPortal to delete/add/update data into the database
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.
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Test for existance of integration for
specified app id.
Use this to ensure that your integration data
exists in the database before attempting to fetch it
or create it.
Unique application ID
Create new Integration
Uniqe integrating application ID. This must never change once used.
Empty integration object
Fetch existing Integration
Integration
Integration Guid
Delete Integration
Integration applicationID
Called by DataPortal to delete/add/update data into the database
Remove a Integration record .
Internal Unique GUID value of Integration record in database
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Collection of Integration data mappings
for this integration
This collection is used to map id values between an external
integration application and AyaNova.
For example the optional QuickBooks interface uses this
collection to map the AyaNova object type and ID of objects with
their counterpart in QuickBooks.
Get /set active status of Integration
This is set by an AyaNova user to turn on or off integration
AyaNova does not and can not enforce this setting, it is up to the external
program developer to honour this setting if applicable.
It is intended to provide a method for the AyaNova user to temporarily
disable integration for a particular application
The name should be a descriptive name of the product
integrated with AyaNova. It is displayed to the user
through the user interface when viewing the integration log
and managing integration products.
For example the AyaNova add on QBI for integrating with QuickBooks
is identified as "AyaNova QBI" so users understand which application
they are dealing with.
This is a required field 1-255 Unicode characters
DateTime field indicating the last time integration was performed
Set by the external application.
Implementers may use this date as required however it is strongly recommended
that it be set to the last date and time that integration was performed as it will
be displayed to the end user and may assist in troubleshooting.
If a null or non existant date is desired set this value to
System.DateTime.MinValue as that is the standard used in AyaNova for null dates
Unique GUID application ID value
This required field identifies the integration application
uniquely. It should be a standard value used to identify the application
for all users. In other words always stick to the same AppID value don't generate
a unique one for each site using your integration application.
Use the separate AppVersion field for version control
The required AppVersion field is used for version control
by the external integrating application.
It is displayed to the user
through the user interface.
Typically this will be a version value such as 2.4.4
however you can put anything you want in this field so
"2008" is acceptible.
This is a required field 1-25 unicode characters
The SyncCheckPoint field is provided for the convenience of the
external program to maintain a checkpoint for syncronization
error recovery.
For example the AyaNova add on QBI for integrating with QuickBooks
uses this field for error recovery if there is an error processing
a request. It contains the last ID of the last message sent to QuickBooks
for processing so that recovery can be made in case of failure.
You can store any data you wish in this field, it is not displayed in the
user interface of AyaNova
This is an optional field 0-255 ASCII characters
Object for use by integration application to persist user settings
You can store any data you wish in this object, it is
serialized to and from the database in a binary blob / image field.
Typically this would be used to persist an integrating applications
settings. I.E. create a serializable class or structure to contain
settings and store / retrieve via this field.
Don't go overboard with this setting it *is* stored in the database and
should not be used to store huge binary objects that do not change, this will
only slow down your application and bloat the users database un-necessarily.
32k or less is a good rule of thumb
Criteria for identifying existing object
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
Filter for restricting results in main grid lists
Created by user and shared amongst all users
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Get new object
Fetch Grid filter requested
Delete Filter
Region GUID
Called by DataPortal to delete/add/update data into the database
Remove a filter record from the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Name of item
Set/get GridKey filter applies to
This is the equivalent of the ReportKey specified
in the report key property of the read only collections
Set/get FilterXML of filter
This is generated at the UI level and is not settable manually
If not empty restricts displaying this
filter to the matching user id
This value overrides the security group ID property
If not empty restricts displaying this
filter to users who are members of the
matching security group
This value is ignored if the OnlyUserID
property is set to non empty
Used to identify an item in the ui combo box list of filters
that represents that no filter has been selected and
no filtering is applied. Also allows user to select to defilter
grid quickly and easily
Used to identify an item in the UI combo box list of filters
that represents that a filter is unsaved due to user modification
Criteria for identifying existing object
No status set
(editable)
Accepted for service
(Not editable / locked and closed)
Declined for service
(editable)
Read only list of ClientServiceRequests
Check if item in collection
Internal method used by list factory
Get all ClientServiceRequest (filtered by crit)
Get all ClientServiceRequest for a specified head office
(returns all requests for all clients under headOfficeID)
Get all ClientServiceRequest for a specified client
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
Remove ClientNoteType by passing it in
Add a new ClientNoteType to the collection
Add ClientNoteType by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve ClientNoteType by index
Index
Criteria for identifying existing object
Remove ClientGroup by passing it in
Remove by Guid value of ID
Add a new ClientGroup to the collection
Add ClientGroup by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve ClientGroup by index
Index
Criteria for identifying existing object
Used to quickly fetch a single Bool record from the db
Private constructor to prevent direct instantiation
Criteria for identifying existing object
Remove WorkorderStatus by passing it in
Remove by Guid value of ID
Add a new WorkorderStatus to the collection
Add WorkorderStatus by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve WorkorderStatus by index
Index
Criteria for identifying existing object
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new WorkorderItemType
Fetch existing WorkorderItemType
Datareader
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get client group name
Get /set active status of client group
If active = true then WorkorderItemType is selectable for workorders etc
If active = false then WorkorderItemType in not selectable, but history can be
viewed
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
Private constructor to prevent direct instantiation
Get internal Guid ID value of workorder from string
representation of workorder or quote or pm number
Service number, Quote number or Preventive maintenance number
Type of workorder (service, quote, pm)
Guid of workorder in database or Guid.Empty if not found or input string invalid
Criteria for identifying existing object
Check if item in collection
Internal method used by list factory
Takes an xml column list and where criteria
and returns a list filtered and sorted accordingly
Takes a single ID and returns a "list" of one object
ID of Vendor object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Properties
@returns
Criteria for identifying existing object
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new UnitModelCategory
Fetch existing UnitModelCategory
Datareader
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get client group name
Get /set active status of client group
If active = true then UnitModelCategory is selectable for workorders etc
If active = false then UnitModelCategory in not selectable, but history can be
viewed
Read only list of TaxCodes
Check if item in collection
Get all TaxCode (unfiltered as it's not used in an interface but for calcs)
Get item by index
Returns item that matches passed in itemid value
Properties
Decimal amount for this tax
decimal amount for this tax
default is false
True indicates that where this is applied is tax exempt
default is false
True indicates that where this is applied is tax exempt
Default is false
If true, than the TaxB amount is determined from the total of itemcost + TaxA
amount X TaxB
@returns
Get internal id number Read only property because it's set internally, not
externally
Criteria for identifying existing object
List of Tasks for building pick lists
Includes inactive so that they can be shown on old records
in a consistent format
Check if item in collection
Get all scheduleable users
Get item by index
Returns TaskPickListInfo item that matches passed in itemid value
@returns
Criteria for identifying existing object
TaskGroup - a preselected group of individual tasks
that can be used to quickly select a slew of tasks
with one selection
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new TaskGroup
Fetch existing TaskGroup
Client Guid
Delete TaskGroup (if clients assigned to this group, should be notified)
Client GUID
Called by DataPortal to delete/add/update data into the database
Remove a TaskGroup record from the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get client group name
Get /set active status of client group
If active = true then TaskGroup is selectable for workorders etc
If active = false then TaskGroup in not selectable, but history can be
viewed
Tasks collection
Criteria for identifying existing object
Remove ObjectCustomField by passing it in
Check if item in collection
Check if item in deleted collection
NewItems
Fetch children root style
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve ObjectCustomField by index
Index
Retrieve ObjectCustomField by string containing form's name value
Criteria for identifying existing object
Used by Windows forms user interface to
hold settings pertaining to custom fields
so we know how to display them
Private constructor to prevent direct instantiation
Get new object
GetItem
Fetch
Update
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
ObjectName
FieldName
Visible
FieldType
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
Guid ID of root object (contract)
ID of rate (this brings over the name, account number, etc check with john if
need more
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create item
Parent ID
New Item
Retrieve item
Data reader
item from database
Fetch from db
Persist object to database
Parent object
Parents transaction object
Initial created date of this object
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
Unique ID of this object
Guid ID of root object (contract)
ID of rate (this brings over the name, account number, etc check with john if
need more
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)
Convert localized text key to enum value
key of enum value
Int of enum or -1 on fail to match
Address object - stores physical location or postal address
(Editable Child)
makes replacements to any characters that might be
in a source string so that they conform to mapquest url specs
Get Longitude as string
No indication of East / West
It is up to caller to check decimal value of
Longitude separately to determine if required
Format desired
Return string with degrees and other symbols
String representation of Longitude
Get Latitude as string
No indication of North / South
It is up to caller to check decimal value of
latitude separately to determine if required
Format desired
Return string with degrees and other symbols
String representation of Latitude
Get full Longitude as string using default format
Get Longitude as string in desired format
Format desired
Return string with degrees and other symbols
String representation of Longitude
Convert decimal Latitude to full string representation in default format
Get Latitude as string
Includes localized North or South text prefix
Format desired
Return string with degrees and other symbols
String representation of Latitude
Convert decimal degrees to String representation
of Degrees minutes seconds
Negative input is not converted to West or South,
all input is returned as absolute value (with no sign)
it is up to the caller to add the direction.
Convert decimal degrees to String representation
of Degrees minutes and decimal minutes (no seconds)
Negative input is not converted to West or South,
all input is returned as as absolute value (with no sign)
it is up to the caller to add the direction.
Set Longitude from string
Expects a '-' sign for West longitudes
any character other than a digit, decimal (period) or a - sign is
ignored completely and not used in parsing
Accepted types of co-ordinates are:
Decimal degrees: "-49.3435"
Degree decimal minutes: "49°22.456"
Degrees Minutes Seconds Decimal seconds: "49° 22' 13.456''"
Degree symbols are ignored and thus optional as well as minute ' or seconds '' symbols
traditionally used. All that is important is that there is a space or non-numeric character
between the groups of digits.
If a single number is found it is assumed to be decimal degrees.
If two separate numbers are found it is assumed to be Degree decimal minutes
If three separate groups of numbers are found it is assumed to be Degress minutes seconds
String indicating coordinate
Set Latitude from string
Expects a '-' sign for South Latitudes
any character other than a digit, decimal (period) or a - sign is
ignored completely and not used in parsing
Accepted types of co-ordinates are:
Decimal degrees: "-49.3435"
Degree decimal minutes: "49°22.456"
Degrees Minutes Seconds Decimal seconds: "49° 22' 13.456''"
Degree symbols are ignored and thus optional as well as minute ' or seconds '' symbols
traditionally used. All that is important is that there is a space or non-numeric character
between the groups of digits.
If a single number is found it is assumed to be decimal degrees.
If two separate numbers are found it is assumed to be Degree decimal minutes
If three separate groups of numbers are found it is assumed to be Degress minutes seconds
String indicating coordinate
Parse a string coordinate and return a double coordinate value
Negative symbol must be first character if a south latitude or
a west longitude is input. All characters other than digits,
decimal point (one only) and negative symbol are ignored.
Accepted types of co-ordinates are:
Decimal degrees: "-49.3435"
Degree decimal minutes: "49°22.456"
Degrees Minutes Seconds Decimal seconds: "49° 22' 13.456''"
Degree symbols are ignored and thus optional as well as minute ' or seconds '' symbols
traditionally used. All that is important is that there is a space or non-numeric character
between the groups of digits.
If a single number is found it is assumed to be decimal degrees.
If two separate numbers are found it is assumed to be Degree decimal minutes
If three separate groups of numbers are found it is assumed to be Degress minutes seconds
If a null or empty string is the parameter then returns 0
Co-ordinate string
Double coordinate value
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create new Address
Parent MUST set RootObjectID, RootObjectType and IsMailAddress flag
Get an address from passed in data reader
Delete address
copy the contents of one address to another address
Update object to database
RootOjbect type
GUID of root object
Address type (must be mail or physical)
Parent object's transaction object
Populate this object from the values in the datareader passed to it
The root object type this address applies to
Valid settings are:
Unit, HeadOffice, Vendor, Client
Global or Region
ID of object this address belongs to
Type of address (physical (deliver) or postal)
Get/set street address - maximum 255 char
Get/set city for this address - maximum 255 char - may have default
entered by global/regional settings
Get/set state or province for this address - maximum 255 char - may
have default entered by global/regional settings
Get/set country for this address - maximum 255 char - may have default
entered by global/regional settings
Get/set ISO country code for this country, maximum 2 characters
required for all non-US address lookups
Get/set postal code or zip code for this address - maximum 255 char
Returns a valid MapQuest url for
opening a map of address in a web page
Get complete address as single string for display
following US / Canadian postal regulations recommendations:
DELIVERY ADDRESS
CITY/STATE/ZIP
COUNTRY
Longitude in decimal degrees
Latitude in decimal degrees
Longitude as text
SET: parses most text formats of different styles co-ordinates
GET: Returns text formatted as per global coordinate style setting
Latitude as text
SET: parses most text formats of different styles co-ordinates
GET: Returns text formatted as per global coordinate style setting
Get/Set the Hemisphere of the current Latitude coordinate
(0 Latitude is always considered North for display purposes)
Get/Set the Hemisphere of the current Longitude coordinate
(0 Longitude is always considered West for display purposes)
ID of the one and only Global object's address
(since a global object has no ID itself, this value is
used as the ID for it)
Criteria for identifying existing object
Type converter for an Address object
only ToString is implemented
and displays the same information as the
FullAddress property
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create item
Parent ID
New Item
Retrieve item
Data reader
item from database
Fetch from db
Persist object to database
Parent object
Parents transaction object
Initial created date of this object
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
Unique ID of this object
ID of Workorder (type = WorkorderPreventiveMaintenance) that this WorkorderService object was
created from
If not made from a PreventiveMaintenanc can be null
ID of Workorder (type WorkorderQuote) that this WorkorderService object was created from
If not made from a quote, than can be null
ID of ClientRequest that this WorkorderService object was created from
If not made from a ClientRequest can be null
Not editable by the user
Incremental number from sql server
** USE AS A READ ONLY FIELD ONLY **
It is writeable only for the purpose of initial import
into a fresh, empty database
but should never normally be set after that.
Takes first the created date but than can be overwritten by the user i.e
WorkorderService info was obtained yesterday, but not actually created til today. this
way user can edit the ServiceDate and use for response time etc
direct access to smartdate value
used by workorder dal code to
flag client last service date
Status of entire service workorder
One invoice number for entire workorder and all of its service items - if
indivdual service items invoiced out separately, they should move the items to
their own workorder.
ID of root object this address belongs to (workorder)
This is a user definable date and time used to indicate when a service workorder
should be closed by. It's used to identify workorders that have been left to
languish and not serviced promptly.
A user needs the special Object.WorkorderService.CloseByDate right to be able
to modify this even if they have full rights to the workorder object itself
Smart date version used by workorder notification Processor
Set the DB generated visible ID number
to a new user chosen starting point
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
Remove WorkorderItemMiscExpense by passing it in
Remove WorkorderItemMiscExpense by string of id value
Remove by Guid value of ID
Add a new WorkorderItemMiscExpense to the collection
Sets all items to read / write status
used by workorder object when it's closed or service completed is true
true=Set to read only explicitly, false=set to whatever rights allowed
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
Get items - Grandchild style
Fetch children - grandchild style
Update children
Given a workorder item ID deletes all items for that ID
Called by workorderitems delete
ID of parent workorder item
Database transaction from ascendant item
Retrieve WorkorderItemMiscExpense by index
Index
Retrieve WorkorderItemMiscExpense by string containing Guid value
this is the collection of labor objects (actual labor and service performed) in
relation to this service item.
Remove WorkorderItemLabor by passing it in
Remove WorkorderItemLabor by string of id value
Remove by Guid value of ID
Add a new WorkorderItemLabor to the collection
Sets all items to read / write status
used by workorder object when it's closed or service completed is true
true=Set to read only explicitly, false=set to whatever rights allowed
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
Get items - Grandchild style
Fetch children - grandchild style
Update children
Given a workorder item ID deletes all items for that ID
Called by workorderitems delete
ID of parent workorder item
Database transaction from ascendant item
Retrieve WorkorderItemLabor by index
Index
Retrieve WorkorderItemLabor by string containing Guid value
Private constructor to prevent direct instantiation
Applies this labor entry to service bank
and sets ServiceBankID
Populate TypeAndID object
Rate currency per unit for banked currency calcs
Called by parent collection object
when called in turn by workorder object that is read only due to
security or closed or service completed
Either true or the rights allowed for the current user
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
New item
Get Item
Update child
ID of service bank record created from this labor record
Is set when apply service bank is called
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
UserID selected must be schedulable and active.
If displaying historical information, would show a N/A (non-active) next to the
displayed name, but would not be able to reselect an active and schedulable
user
if a rate that is set as a flat is selected, this field "disappears"?
Details of service performed, prints on reports given to customers
Guid ID of root object (WorkorderItem)
Sales tax code for rates
Client name / value list
Get VendorsWithReceivablePONVList object
Fetch name value list
Certificate or training a schedulable user has achieved
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Get new object
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Name of item
Used to quickly fetch a single saved Unit's name
from the database in the currently selected UnitNameFormat style
Private constructor to prevent direct instantiation
Fetches and formats a unit name
Guid value of existing unit in database
Unit name formatted to current global UnitNameFormat setting
Fetches and formats a workorder item's unit name
Guid value of existing WorkorderItem record in database
Unit name formatted to current global UnitNameFormat setting, empty if no unit on workorderitem
Fetches and formats a workorder item outside service's unit name
Guid value of existing WorkorderItemOutsideService record in database
Unit name formatted to current global UnitNameFormat setting, empty if no unit on workorderitem
Criteria for identifying existing object
Remove UIUserGridLastView by passing it in
Remove UIUserGridLastView by string of GridKey name
Add a new UIUserGridLastView to the collection
Add a new UIUserGridLastView to the collection
by copying from someone elses
Check if item in collection
Check if item in collection by GridKey name
Check if item in deleted collection
NewItems
Get item collection (Root collection style)
Fetch children root style
Editable Root Collection Update
Retrieve UIUserGridLastView by index
Index
Retrieve UIUserGridLastView by string containing GridKey's name value
If the GridKey in question is not found, a new one is created and if the
manager account has one for that GridKey then it's settings are copied to it
before returning.
This ensures that new users get the managers grid settings if they haven't
made their own yet.
Criteria for identifying existing object
Used in PO's, invoices, parts, services to determine if an item has tax
applied or not.
if true, does show in wo select list; if false then is not selectable, but can
still bring up history etc
default is true
Decimal amount for this tax
decimal amount for this tax
default is false
True indicates that where this is applied is tax exempt
default is false
True indicates that where this is applied is tax exempt
Default is false
If true, than the TaxB amount is determined from the total of itemcost + TaxA
amount X TaxB
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Get new object
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Name of item
Get /set active status of TaxCode
If active = true then taxcode is selectable
If active = false then texcode in not selectable
Decimal amount for this tax
decimal amount for this tax
default is false
True indicates that where this is applied is tax exempt
default is false
True indicates that where this is applied is tax exempt
Default is false
If true, than the TaxB amount is determined from the total of itemcost + TaxA
amount X TaxB
Read only list of Reports
Check if item in collection
Get all Report (unfiltered as it's not bound)
Get item by index
Returns item that matches passed in itemid value
Properties
@returns
Set/get Name of item
Criteria for identifying existing object
Used internally to confirm the existance of a
Report before importation
Private constructor to prevent direct instantiation
Criteria for identifying existing object
An ReportDataSetAdapterOriginal is used to convert data in an object
or collection into a ReportDataSet suitable for using with AyaNova reporting
methods.
Fills the DataSet with data from an object or collection.
The name of the DataTable being filled is will be the class name of
the object acting as the data source. The
DataTable will be inserted if it doesn't already exist in the DataSet.
A reference to the DataSet to be filled.
A reference to the object or collection acting as a data source.
Fills the DataSet with data from an object or collection.
The name of the DataTable being filled is specified as a parameter. The
DataTable will be inserted if it doesn't already exist in the DataSet.
A reference to the DataSet to be filled.
A reference to the object or collection acting as a data source.
Fills a DataTable with data values from an object or collection.
A reference to the DataTable to be filled.
A reference to the object or collection acting as a data source.
Used to turn a date and time object
into a string representation which is localized
and relative to current date/time
Private constructor to prevent direct instantiation
Convert relative date to string representation
Date used as "now".
this is a parameter rather than getting current date/time here
because in a lengthy operation it could vary the display incorrectly
Date to be reformatted into a relative string
String representation of relative date i.e. "3 days 34 minutes ago"
simple abs function
Convert relative SmartDate to string representation
Date used as "now".
this is a parameter rather than getting current date/time here
because in a lengthy operation it could vary the display incorrectly
Date to be reformatted into a relative string
String representation of relative date i.e. "3 days 34 minutes ago"
Or an empty string if the date is empty
Criteria for identifying existing object
Remove RateUnitChargeDescription by passing it in
Add a new RateUnitChargeDescription to the collection
Add RateUnitChargeDescription by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve RateUnitChargeDescription by index
Index
Criteria for identifying existing object
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.
Private constructor to prevent direct instantiation
Retrieve a snapshot of current
inventory values
ID of part
ID of warehouse (Use Guid.Empty for default warehouse)
PartByWarehouseInventoryValuesFetcher object
Retrieve a snapshot of current
inventory values frozen within a transaction
ID of part
ID of warehouse (Use Guid.Empty for default warehouse)
Database transaction
Criteria for identifying existing object
Used internally by LocalizedTextTable for static get text direct method
this ensures dataportal friendliness
Private constructor to prevent direct instantiation
Load the localized text string for the Key provided
Localized text key i.e. "Address.Label.City"
Load the localized text string for the Key provided
from the Locale provided
Localized text key i.e. "Address.Label.City"
Locale key, i.e. "English"
Criteria for identifying existing object
Generic name / value list
Get GenericNVList object
Fetch name value list
Criteria for identifying existing object
Remove Contact by passing it in
Remove Contact by string of id value
Remove by Guid value of ID
Add new
Ensures one contact is set to default
Checks if grandchildren are dirty
Checks if grandchildren are valid
Iterates through collection and sets the default contact id
to true for to contact id passed in
Sets any other contacts if they are primarycontact=true to false
Iterates through collection and gets the default contact
Returns a string containing the primary contact's
default contact info
(i.e. Email address and all phones collection)
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
GetItems
Fetch children
Populated data reader
Update
Given a RootObject ID
retrieves all Contact id values for that
RootObject, then calls the child and grandchild Shared static direct
delete methods to clear out those collections, then finally
removes all Contacts for that RootObject
Called by various rootobjects with contacts delete methods
ID of parent RootObject item
Database transaction from ascendant item
Retrieve Contact by index
Index
Retrieve Contact by string containing Guid value
Retrieve Contact by Guid value
Read only list of Expense items
Check if item in collection
Internal method used by list factory
Get all (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItemMiscExpense object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Not for viewing directly, sets the color of the status button
Criteria for identifying existing object
Read only list of WorkorderQuote items
Check if item in collection
Internal method used by list factory
Get all WorkorderQuote (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of Workorder object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Criteria for identifying existing object
Read only list for reports and grid display
Check if item in collection
Internal method used by list factory
Get all Items (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Criteria for identifying existing object
Read only list for reports and grid display
Check if item in collection
Internal method used by list factory
Get all Items (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Criteria for identifying existing object
List of active Service Workorders for client specified
(active meaning not closed and not set to service completed
and type of Service)
Check if item in collection
Get all Workorders owned by client specified
Client owning Workorders
Get item by index
Returns WorkorderPickListInfo item that matches passed in itemid value
@returns
Criteria for identifying existing object
Remove UserSkill by passing it in
Remove by Guid value of ID
Add a new UserSkill to the collection
Add UserSkill by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve UserSkill by index
Index
Criteria for identifying existing object
User - anyone with access to AyaNova
Private constructor to prevent direct instantiation
responsible for setting object default values
Set the MD5 hashes for the password and login
Return name in selected format
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Return name in selected format
Create new user
Fetch existing user
Client Guid
Delete user
User GUID
Used to quickly retrieve a user's language setting
User ID
Users language setting string
How many times the user indicated appears
on a workorder item scheduled user record
Scheduleable user
Only count when on open workorder
Count of workorder item scheduled user records for user
Called by DataPortal to delete/add/update data into the database
Remove a user record .
Login account
Login password
Default language to present to user.
Corresponds to the Locale field in the
LocalizedText table in AyaNova database
Guid of default Purchase order template to use on new work orders
Note that this may be overriden by similar option in other objects
(depending on situation)
Guid of default WorkorderQuote template to use on new work orders
Note that this may be overriden by similar option in other objects
(depending on situation)
Guid of default work order template to use on new work orders
Note that this may be overriden by similar option in other objects
(depending on situation)
Type of user.
This property can affect license consumption, use with care
or you may lockout all users of AyaNova.
Get /set active status of user
If active = true then user is selectable for workorders if a tech or can log in
etc
If active = false then user in not selectable, but history can be viewed
If usertype is a client login then this is the ID of thier client record ID
otherwise is empty
If usertype is a HeadOffice login then this is the ID of thier HeadOffice record ID
otherwise is empty
Security group Guid this user is a member of
Date record created
Last record modification date
User record ID of person who created this record
User ID of person who modified this record
Users unique identifier (used internally)
Read only
Users first (given) name
Users last (family) name
Initials to idientify user
used in places where a full name can't be fit
May be used for accounting
Some businesses may use employee number for lists rather than the first and
last name - need to be able to have manager set which is desired.
Email address for sending text messages
Maximum number of text in a single message this pager can handle
Users primary contact phone number
Users second / alternative phone
Users email address
Collection of certifications this user posesses
Collection of skills assigned to user
Notes
If user is a subcontractor, than this field would contain ID of vendor that is
specified as a SubContractor
Collection of assigned documents assigned to this user
Region GUID that user is assigned to.
Dispatch zone GUID
If true, than scheduleable user is a subcontractor
Default warehouse for this user to select parts from
Custom1
Custom2
Custom3
Custom4
Custom5
Custom6
Custom7
Custom8
Custom9
Custom0
Selected color is used for background
behind users' schedule in calendar displays
LastView - key of last view (form) user
was viewing when they last closed the program.
This is used to ensure they start with the same view
they had before.
If this is blank or invalid then the UI will start with the
first view they have rights to see.
Used internally here to
weed out attempts to set properties when read only
or administrator or a utility account
Indicator if user is Built-in Administrator account
(Administrator user properties are almost all read only
check this before attempting to set)
Indicator if user is a Notification server account
(Notification server user properties are almost all read only
check this before attempting to set)
User is scheduleable
True if user is client or headoffice user type
True if user is client login
True if user is client login
Guid of built in Administrator account
return true if current logged in user is the admin user
Criteria for identifying existing object
Clear all UI Layout settings
copy all UI Layout settings
Remove UnitOfMeasure by passing it in
Remove by Guid value of ID
Add a new UnitOfMeasure to the collection
Add UnitOfMeasure by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve UnitOfMeasure by index
Index
Criteria for identifying existing object
Purchase order Items
Remove PurchaseOrderItem by passing it in
Remove PurchaseOrderItem by string of id value
Remove by Guid value of ID
Add a new PurchaseOrderItem to the collection
Set all items to read only
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
GetItems
Fetch children
Populated data reader
Update children
Retrieve PurchaseOrderItem by index
Index
Retrieve PurchaseOrderItem by string containing Guid value
Read only list of Priorities
Check if item in collection
Get all Priority (unfiltered as it's not bound)
Get item by index
Returns item that matches passed in itemid value
Properties
@returns
Set/get Name of item
Criteria for identifying existing object
Notification delivery setting
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create new NotifyDeliverySetting
NotifyDeliverySetting
Fetch existing NotifyDeliverySetting
NotifyDeliverySetting
Datareader
Populate this object from the values in the datareader passed to it
Get internal id number
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Descriptive Name of delivery method
AyaNova User ID of notification delivery subscriber
Physical delivery method from built in choices of NotifyDeliveryMethods
Address for delivery
could be an SMS email address, internet mail address etc
Not used by all delivery methods
Desired format for message that is sent to user via method chosen
Maximum characters after which message sent to user
is cut off
A value of zero indicates message should *not* be truncated at all
Event windows - object containing
information about when delivery can be made
for this notification delivery setting
AyaNova IntegrationLog used to insert integration events in the database.
Automatically removes all log entries more than 45 days old
Private constructor to prevent direct instantiation
Used to log an entry visible to Administrative users
regarding an integration event of interest
Use this object with your integration application if you wish
to log events that are visible to the users within AyaNova itself.
This is the preferred way of logging an integration application, at a minimum
any errors should be logged here so that end users who can't get your application
to work will get a meaningful message here about it.
The integration object will log various events here automatically as it is
accessed, but that is no substitute for logging from the integrating application
itself.
Guid of integration application
500 Unicode character maximum (will truncate).
Date and time of the event is logged automatically so no need to include that
information in the message.
Called by DataPortal to delete/add/update data into the database
List of GridFilters for building pick lists
Contains list filter to use directly against grids
Check if item in collection
Check if item in collection
Returns grid filter pick list
containing all grid filters specified user
has access to.
For UI performance reasons this list returns all
filters for all grid keys, it's up to the UI to display
only the appropriate ones for the grid in question
(Admin user get's all grid filters regardless)
AyaNova User object reference
Get item by index
Returns GridFilterPickListInfo item that matches passed in itemid value
@returns
returns the filter portion of the xml
as a datatable object
Criteria for identifying existing object
Read only Detailed list of WorkorderServiceScheduledUser items
Check if item in collection
Internal method used by list factory
Get all WorkorderItemScheduledUsers (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItemScheduledUser object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Not for viewing directly, sets the color of the status button
Criteria for identifying existing object
Read only Detailed list of WorkorderServicePart items
Check if item in collection
Internal method used by list factory
Get all WorkorderItemParts (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItemPart object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Not for viewing directly, sets the color of the status button
Criteria for identifying existing object
Read only list for reports and grid display
Check if item in collection
Internal method used by list factory
Get all Items (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Not for viewing directly, sets the color of the status button
Criteria for identifying existing object
List of Service Work orders that are invoiceable
for building pick lists
(Read only collection)
Check if item in collection
Get all billable work orders
Work orders are considered billable if they are set to ServiceCompleted=true
and Closed=true
Filter by status or Guid.Empty for any status
Get item by index
Returns WorkorderServiceBillableListInfo item that matches passed in itemid value
@returns
Work order internal ID
Client internal ID
Client name
Workorder status
Visible sequential workorder number
Date of service
Status color in ARGB integer format
Workorder project
Criteria for identifying existing object
this is the collection of actual travel incurred in relation to this
WorkorderItem
Remove WorkorderItemTravel by passing it in
Remove WorkorderItemTravel by string of id value
Remove by Guid value of ID
Add a new WorkorderItemTravel to the collection
Sets all items to read / write status
used by workorder object when it's closed or service completed is true
true=Set to read only explicitly, false=set to whatever rights allowed
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
Get items - Grandchild style
Fetch children - grandchild style
Update children
Given a workorder item ID deletes all items for that ID
Called by workorderitems delete
ID of parent workorder item
Database transaction from ascendant item
Retrieve WorkorderItemTravel by index
Index
Retrieve WorkorderItemTravel by string containing Guid value
this is the collection of WorkorderItems for a specific workorder
Called by any one of the delete methods
if there is only one left then it throws
and exception (UI should ensure this never happens)
Remove WorkorderItem by passing it in
Will throw an exception if attempt to delete
the last workorder item. A workorder must have at
last one workorder item and the UI should ensure the
user can not even attempt to delete it.
Remove WorkorderItem by string of id value
Will throw an exception if attempt to delete
the last workorder item. A workorder must have at
last one workorder item and the UI should ensure the
user can not even attempt to delete it.
Remove by Guid value of ID
Will throw an exception if attempt to delete
the last workorder item. A workorder must have at
last one workorder item and the UI should ensure the
user can not even attempt to delete it.
Add a new WorkorderItem to the collection
Sets all items to read / write status
used by workorder object when it's closed or service completed is true
true=Set to read only explicitly, false=set to whatever rights allowed
Check if item in collection
Check if item in collection by string of ID value
Check if item in collection by ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
GetItems
Fetch children
Populated data reader
Update children
Given a workorder ID
retrieves all workorder item id values for that
workorder, then calls the child and grandchild Shared static direct
delete methods to clear out those collections, then finally
removes all workorder items of that workorder ID
Called by Workorder delete
ID of parent workorder item
Database transaction from ascendant item
Retrieve WorkorderItem by index
Index
Retrieve WorkorderItem by string containing Guid value
Retrieve WorkorderItem by Guid value
Used to quickly fetch a workorder id
from the database give an descendant object id
Returns Guid.empty on fail
Private constructor to prevent direct instantiation
Fetch existing Workorder ID by related item ID
Given a rootobjectType and an ID returns the Guid of
the work order that hosts
that rootobject type and ID
Workorder
Related objec (child/grandchild etc) Guid
Criteria for identifying existing object
Remove UserRight by passing it in
Remove UserRight by string of id value
Remove by Guid value of ID
Add a new UserRight to the collection
Add a new UserRight and set it's right name and security level
to the collection
Check if item in collection
Check if item in collection by Right name
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
GetItems
Fetch children
Populated data reader
Update children
Retrieve UserRight by index
Index
Retrieve UserRight by string containing Right name value
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
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Get new object
ServiceBank Guid
Records a reverse entry in the service bank.
(used when a banked WorkorderItemLabor is deleted)
Called by DataPortal to delete/add/update data into the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get user record ID of person who created this record
Criteria for identifying existing object
Read only collection of search results
Check if item in collection
Internal method used by list factory
(Actually is search string)
Process search and return list of results
Return an empty list
used for initializing grid
Get item by index
Returns SearchResultListInfo item that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
@returns
Object to open to view this search results original record
If this object is not a child or grandchild, then this is the same as RootObjectID
Criteria for identifying existing object
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.
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new PurchaseOrder
PurchaseOrder
Fetch existing PurchaseOrder
PurchaseOrder
PurchaseOrder Guid
Delete PurchaseOrder
PurchaseOrder GUID
Called by DataPortal to delete/add/update data into the database
Remove a PurchaseOrder record .
Purchase order items child collection
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Notes about PurchaseOrder
Status of purchase order
Any status change is valid
with the following exceptions:
If a P.O. status is currently:
ClosedFullReceived - can not be changed to anything
Any status beyond OpenNotYetOrdered can not be
changed back to OpenNotYetOrdered. I.E. once a P.O. is
OnOrder of some kind it can not be taken back to OpenNotYetOrdered
Notes that may be displayed or printied on po when sent to vendor
Expected date of receiving
Internal version giving access to smartdate object
Date PO was ordered. Defaults to date created, but may be edited
Internal version giving access to smartdate object
Readonly as generated by AyaNova itself
Additional reference number for the PO to cooinside with PONumber
If a drop shipment to a client this is the client
If Guid.Empty then it's a regular order
Custom1
Custom2
Custom3
Custom4
Custom5
Custom6
Custom7
Custom8
Custom9
Custom0
Criteria for identifying existing object
Set the DB generated visible ID number
to a new user chosen starting point
Project
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
returns new item with null serial number that is a duplicate of the ID called
originally
Project ID that you want to make a duplicate copy of
Create new Project
Project
Fetch existing Project
Project
Project Guid
Delete Project
Project GUID
Called by DataPortal to delete/add/update data into the database
Remove a Project record .
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Get /set active status of Project
If active = true then Project is selectable for workorders etc
If active = false then Project in not selectable, but history can be viewed
Notes about Project
Original sales Name number
AyaNova user (schedulable or non-scheduleable) selected to indicate who is
"overseeing" the project
Custom1
Custom2
Custom3
Custom4
Custom5
Custom6
Custom7
Custom8
Custom9
Custom0
Criteria for identifying existing object
Read only list of NotifyPopUps.
Used to display popup notifications
in AyaNova user interface
Get all NotifyPopUp entries
for current logged in user
Return an empty list
used for initializing grid
Get item by index
Fields
Criteria for identifying existing object
User interface helper methods and properties
for managing subscriptions to notification events
Provides lists and data tables for managing notification through
the user interface
Utility list of events that can be subscribed to
NotifySubscriber - used to flag already subscribed events
DataTable containing events that can be subscribed to and already subscribed events flagged as subscribed
West of the prime meridian
(Royal Astronomical Observatory in Greenwich, England)
East of the prime meridian
(Royal Astronomical Observatory in Greenwich, England)
Read only list of HeadOffices.
Check if item in collection
Internal method used by list factory
Takes an xml column list and where criteria
and returns a list filtered and sorted accordingly
Takes a single ID and returns a "list" of one object
ID of HeadOffice object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Properties
@returns
Criteria for identifying existing object
GenProcess notifications and preventive maintenance
Process notifications and generate pm workorders
from outside the AyaNova user interface
Decimal degrees (DDD.ddd°)
Degrees minutes (DDD° MM.mmm)
Degrees Minutes Seconds (DDD° MM' SS.sss')
Contract rates collection
Remove ContractRate by passing it in
Remove ContractRate by string of id value
Remove by Guid value of ID
Add a new ContractRate to the collection
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
GetItems
Fetch children
Populated data reader
Update children
Retrieve ContractRate by index
Index
Retrieve ContractRate by string containing Guid value
Used as illegal default to ensure
that parent object sets this correctly
Business phone
Cell phone
Fax
Pager
Home phone
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Get new object
Parent is responsible for RootObjectID, RootObjectType and DocumentID
Populate this object from the values in the datareader passed to it
RootObject Type
RootObjectID
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Description of item
URL for document
This could be an internet URL, a UNC path and file name or a
drive letter path filename to the file in question
Basically this is anything that is understood by the Windows Shell
Maximum of 4000 characters
A single workorder for a client
Used by PM system for recurring service.
An estimate provided to a client for approval that if approved gets copied to a
Service
Report data
Private constructor to prevent direct instantiation
Internal method used by list factory
Takes a single ID and returns a "list" of one object
ID of Workorder object
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Criteria for identifying existing object
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......
ID of WorkorderItem this task belongs with
Whether completed, incomplete, not applicable Default is 0 (incomplete)
Back reference to group it came from
Called by parent collection object
when called in turn by workorder object that is read only due to
security or closed or service completed
Either true or the rights allowed for the current user
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create item
Parent ID
New Item
Retrieve item
Data reader
item from database
Fetch from db
Persist object to database
Parent object
Parents transaction object
Initial created date of this object
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
Unique ID of this object
Whether completed, incomplete, not applicable Default is 0 (incomplete)
ID of WorkorderItem this task belongs with
Used to quickly fetch descriptive information
for identifying a work order item part request and service workorder to user
during notification Processing
Private constructor to prevent direct instantiation
Criteria for identifying existing object
WorkorderItemPartRequest
ID of purchase order item if part is OnOrder
Warehouse GUID
Private constructor to prevent direct instantiation
Called by parent collection object
when called in turn by workorder object that is read only due to
security or closed or service completed
Either true or the rights allowed for the current user
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
New item
Get Item
Called by PurchaseOrderReceipt when parts are received against a request
this method ensures that the request record get's updated accordingly
notification is sent if subscribed to and finally creates a part record for the workorder
item ready for the tech
Update child
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Guid ID of root object (WorkorderItem)
Warehouse GUID
ID of purchase order item if part is OnOrder
Flag to indicate if this WorkorderItemPartRequest
is on order.
(has a purchase order item ID and has less received than the quantity
requested)
Quantity of parts requested
Quantity of parts received to date against this request
Handle receipt of inventory that fulfills
request
Guid ID of root object (WorkorderItem)
Descriptive name for miscelaneous expense
Description regarding this miscellaneous expense such as explanation i.e Hotel
overnight, store bought as part out of stock, etc
Actual total cost dollar amount including taxes if any of item
Tax dollar portion of TotalCost If company needs to separate taxes paid on it
(i.e tech purchased part from a store for use at the client site, need to
identify sales tax separately from cost of item for accounting purposes)
Retail amount to charge client Can be null
If true, than ChargeAmount is to be charged back to customer If false, than
internal data only
ID of tax code for this item Identifies the tax to be applied to the expense if
to be charged to the client
TotalCost was paid by schedulable User and they need to be reimbursed
GUID of schedulable and active User to be reimbursed
If displaying historical information, would show a N/A (non-active) next to the
displayed name, but would not be able to reselect an active and schedulable
user
Can assign to a scheduleable User without setting a scheduled time and date -
for those that let tech decide when to schedule User can be null (unassigned)
Private constructor to prevent direct instantiation
Called by parent collection object
when called in turn by workorder object that is read only due to
security or closed or service completed
Either true or the rights allowed for the current user
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
New item
Get Item
Update child
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Description regarding this miscellaneous expense such as explanation i.e Hotel
overnight, store bought as part out of stock, etc
GUID of schedulable and active User to be reimbursed
Guid ID of root object (WorkorderItem)
TotalCost was paid by schedulable User and they need to be reimbursed
Retail amount to charge client Can be null
ID of tax code for this item Identifies the tax to be applied to the expense if
to be charged to the client
If true, than ChargeAmount is to be charged back to customer If false, than
internal data only
Descriptive name for miscelaneous expense
Tax dollar portion of TotalCost If company needs to separate taxes paid on it
(i.e tech purchased part from a store for use at the client site, need to
identify sales tax separately from cost of item for accounting purposes)
Actual total cost dollar amount including taxes if any of item
List of users for picking from formatted according
to various templates
Get all scheduleable users
Get item by index
@returns
Criteria for identifying existing object
List of units for criteria
formatted according to user prefs
Check if item in collection
Check if item in collection by UnitID
Get a list of units owned by a specific client
or self owned.
Client Guid for units owned by a specific client only
or Guid.Empty for all units that are self-owned
Get a list of all units
Get one specific unit only but with all the pick list info
Get item by index
Returns UnitPickListInfo item that matches passed in itemid value
Return unitname in selected format
Return unitname in current global selected format
@returns
Criteria for identifying existing object
UnitModel object
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new UnitModel
UnitModel
Fetch existing UnitModel
UnitModel
UnitModel Guid
Delete UnitModel
UnitModel GUID
Called by DataPortal to delete/add/update data into the database
Remove a UnitModel record .
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Get /set active status of UnitModel
If active = true then UnitModel is selectable for workorders etc
If active = false then UnitModel in not selectable, but history can be viewed
Notes about UnitModel
Name
For reporting and grouping purposes. For example, washing maching and dryer
would be in category "Appliances" whereas a printer or scanner would be in
"Computer Equipment"
Default is false
If true, can not have LifeTimeWarranty
Notifies user of this and DiscontinuedDate when unit with this unitmodel is
selected in a workorder
If Discontinued selected, able to enter in discontinued date
Default is false
If true, DiscontinuedWarranty not applicable
Warranty length in months
Ignored if LifeTimeWarranty selected
Information on warranty terms
Displays in workorder when unit with this unitmodel selected
String as mixed numbers and letters
Date unitmodel introduced/released
Custom1
Custom2
Custom3
Custom4
Custom5
Custom6
Custom7
Custom8
Custom9
Custom0
Criteria for identifying existing object
Unit meter reading entry
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new UnitMeterReading
Fetch existing UnitMeterReading
Client Guid
Delete UnitMeterReading (if clients assigned to this group, should be notified)
Client GUID
Called by DataPortal to delete/add/update data into the database
Remove a UnitMeterReading record from the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Date meterreading taken
If a meter reading is entered via the workorder screen
then the workorder item is stored here as a back reference
Criteria for identifying existing object
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
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
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
Check if item in collection
Get all scheduleable users
Get item by index
Returns ScheduleableUserGroupPickListInfo item that matches passed in itemid value
@returns
Criteria for identifying existing object
Item received
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create item
Parent ID
New Item
Retrieve item
Data reader
item from database
Fetch from db
Persist object to database
Parent object
Parents transaction object
Initial created date of this object
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
Unique ID of this object
Serial numbers collection for received part, 0 to many
ID of parent
Part Guid
Warehouse guid
ID of PurchaseOrder
ID of PurchaseOrderItem
Actual vendor cost of item when received
Actual quantity received
Remove PartSerial by passing it in
Remove PartSerial by string of id value
Remove by Guid value of ID
Add a new PartSerial to the collection
Sets broken rule for serial number item
if it's a duplicate in collection
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
Get items - Grandchild style
(root object can be WorkorderItem, PurchaseOrderItem, Warehouse etc)
Fetch children - grandchild style
Update children
Retrieve PartSerial by index
Index
Retrieve PartSerial by string containing Guid value
Retrieve PartSerial by Guid value
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
Check if item in collection
Check if item in collection by ID
Get all Parts
Get one part
Guid of part
Get all parts from a specific vendor
Guid of vendor
Get item by index
Returns PartPickListInfo item that matches passed in itemid value
Return name in selected format
@returns
Criteria for identifying existing object
Remove PartCategory by passing it in
Remove by Guid value of ID
Add a new PartCategory to the collection
Add PartCategory by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve PartCategory by index
Index
Criteria for identifying existing object
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
Guid ID of root object (UserID from Subscriber parent object)
TAkes the date of an event and returns true
if it's within the range the user set in this subscription
Used by the NotificationList object for dated type
events when generating
notifications to send out to users
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Used by UI code to weed out already selected
delivery methods in delivery method selector forms
Create item standalone editable root version
Subscriber ID
New Item
Retrieve item - Editable root version
Delete NotifySubscription Item
Create item Child version
Parent subscriber object
New Item
Retrieve item
Data reader
item from database
Fetch from db
Persist object to database
Parent object
Parents transaction object
Called by DataPortal to delete/add/update data into the database
Editable root version
Remove a record from the database
This handles deleting a subscription record and updating notifyeventofinterest accordingly
It's called internally here and also by the parent collection
It also removes any events that might be present in the NotifyEvent queue
Initial created date of this object
Initial created date of this object
as SmartDate (used by display list)
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
Unique ID of this object
UserID (parent SubscriberID) of this object
Get /set event publisher root object type
Read only once saved
Get /set event publisher's particulare event type subscribed to
Read only once saved
Get /set time span units of SpanRange for calculating
event date with pending type events
Can be changed after saving
Get /set time span unit of time for calculating
event date with pending type events
Can be changed after saving
Returns the localized text key describing the
currently set notification event
If the event associated with this subscription
is a type of event that the user can select a time
frame for (most pending type events, but not all)
If the event associated with this subscription
uses the GuidValue property then returns true.
Used by some events where an additional Int value
needs to be specified in the subscription
can *not* be changed after saving
Criteria for identifying existing object
Methods of delivering an AyaNova event notification to
the user.
Popup message box within AyaNova user interface
SMTP - Internet email
SMS device
AyaNova memo
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.
Most compact format
Messages are formatted as compactly as possible using abbreviations
and as little text as possible.
Most critical information first followed by increasingly
less critical information.
Most verbose format
As much information as possible that is relevant is included
in a full text format (no abbreviations, message formatted
for viewing not compactness)
Read only list of Memos.
Check if item in collection
Takes a single ID and returns a "list" of one object
ID of Memo object
Internal method used by list factory
Get all Memo (filtered by crit)
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
AyaNova Memo between AyaNova users
used to create new Memo message only
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Get new object
Memo Guid
Delete Memo
Memo GUID
Called by DataPortal to delete/add/update data into the database
Remove a Memo record from the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Set created date
only used for importing
old MAIL from AyaNova CE
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Subject of item
Required, can't be empty
Set/get Subject of item
From whom
To whom
Viewed - user has read the message
Criteria for identifying existing object
Update eMemo messages
Holds the localized text for use by user interface
Private constructor to prevent direct instantiation
returns the localized text for the key provided
from the in-memory Hashtable
If key not found, returns key back
Get the localized text key from the localized string
used to reverse lookup enum values in grid filters
A string of localized text
The key for the string provided or an empty string if nothing found that matches
Load the localized text for the local provided
Text key of locale i.e. "English", "Francais", "Espanol", "Klingon" etc
Given a LocalizedText key queries the database and returns the localized text
This is used by the biz objects for reporting errors and for
retrieving object names for reporting purposes
It is not used by the UI which has a copy of this entire object instatiated for the
lifetime of the UI code
This is necessary because in a Remote DataPortal situation
the biz objects at the server will not have access to an in-memory copy of the entire localized text table.
(note that this method subcontracts this call to a dataPortal friendly fetcher class
Given a LocalizedText key and Locale
queries the database and returns the localized text string for that key and locale
This is used by the biz objects for reporting errors and for
retrieving object names for reporting purposes
It is not used by the UI which has a copy of this entire object instatiated for the
lifetime of the UI code
This is necessary because in a Remote DataPortal situation
the biz objects at the server will not have access to an in-memory copy of the entire localized text table.
(note that this method subcontracts this call to a dataPortal friendly fetcher class
Criteria for identifying existing object
Read only list of CustomizableObjects
Get list
Return an empty list
used for initializing grid
Get item by index
Properties
@returns
Criteria for identifying existing object
Contact item
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new Contact
Sets RootObjectID, RootObjectType
Get an Contact from passed in data reader
Update object to database
RootOjbect type
GUID of root object
Parent object's sql transaction object
Populate this object from the values in the datareader passed to it
Called by collection and by the Update method in this object
to remove all grandchild collections and Contact item itself
Get internal id number Read only property because it's set internally, not
externally
Contact's phone number collection
RootObject type
ID of root object this Contact belongs to
User ID who created this Contact record
Date this Contact was created
User ID who last modified this record
Last date this Contact was modified
Title for this contact (i.e Mr, Mrs etc)
If true, this is the primary contact for this address object If false, then not
First contact entered is set to true for this address Additional contacts
entered are then set to false automatically User has ability to change true and
false
Email address of contact - hyperlink to email program
Job title for this contact (i.e sales manager, office staff, etc)
i.e phone, fax, followup etc
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Get new object
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Name of item
Read only list of WorkorderService items
Check if item in collection
Internal method used by list factory
Get all WorkorderService (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of Workorder object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Not for viewing directly, sets the color of the status button
Criteria for identifying existing object
Remove UserSkillAssigned by passing it in
Remove UserSkillAssigned by string of id value
Remove by Guid value of ID
Add a new UserSkillAssigned to the collection
Check if item in collection
Check if item in collection by string of ID value
Check if item in collection by string of Skill ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
GetItems
Fetch children
Populated data reader
Update children
Retrieve UserSkillAssigned by index
Index
Retrieve UserSkillAssigned by string containing Guid value
Remove UserCertification by passing it in
Remove by Guid value of ID
Add a new UserCertification to the collection
Add UserCertification by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve UserCertification by index
Index
Criteria for identifying existing object
Purchase order Items
Remove PurchaseOrderReceiptItem by passing it in
Remove PurchaseOrderReceiptItem by string of id value
Remove by Guid value of ID
Add a new PurchaseOrderReceiptItem to the collection
Checks if grandchildren are dirty
Checks if grandchildren are valid
Remove empty received items (qty zero)
Check if item in collection
Check if item in collection by string of ID value
Check if Purchase order item in collection by ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
GetItems
Fetch children
Populated data reader
Update children
Retrieve PurchaseOrderReceiptItem by index
Index
Retrieve PurchaseOrderReceiptItem by string containing Guid value
List of PartWarehouses for building pick lists
Includes inactive so that they can be shown on old records
in a consistent format
Check if item in collection
Get all scheduleable users
Get item by index
Returns PartWarehousePickListInfo item that matches passed in itemid value
@returns
Criteria for identifying existing object
Notify message object used
for transporting notification messages
from a specific object that formatted it
to a delivery provider
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.
Check if item in collection
Get all scheduleable users
Get item by index
Returns NotifyEventWorkorderStatusPickListInfo item that matches passed in itemid value
@returns
Criteria for identifying existing object
List of NotifyDeliverySettings for building pick lists
Check if item in collection
Get all delivery methods for selected user
Get item by index
Returns NotifyDeliverySettingPickListInfo item that matches passed in itemid value
@returns
Criteria for identifying existing object
Read only list of LoanItems
sortable and filterable for user interface.
Check if item in collection
Internal method used by list factory
Get all LoanItem (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of LoanItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Display attributes
@returns
Criteria for identifying existing object
Factory class for returning read only collection lists by key name
Fetch a read only collection list
Key name of collection (same as report name property in collection)
XML Criteria and Order by filter
TOP number of records or -1 for all records
Read only collection object
Integration rates collection
Remove IntegrationMap by passing it in
Remove IntegrationMap by string of internal ID value
Remove by Guid value of ID
Add a new IntegrationMap to the collection
Fetch just the ForeignID string
based on the AyaNova RootObject ID
ID of AyaNova object
Foreign ID or empty string if not found
Check if item in collection by Guid of
AyaNova RootObject ID
Check if item in collection by foreignID value
Check if item in collection by AyaNova type
True if one or more objects of the specified type are found or false if not
NewItems
GetItems
Fetch children
Populated data reader
Update children
Retrieve IntegrationMap by index
Index
Retrieve IntegrationMap by string containing ForeignID value
Note: if you have more than one IntegrationMap with the same ForeignID
this will return the first one found
It is not a good idea to have more than one foreign ID with
the same value if possible.
Retrieve IntegrationMap by AyaNova RootObject ID and type
Note: Since AyaNova ID's are always unique this will
return the correct item without need for the type
SMS message delivery
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
Sets an event for day indicated.
int value of DayOfWeek enum (0=Sunday...6=Saturday)
true=deliver any time of day if active
True=day is enabled for deliver, false=no delivery on this day
Starting time window for delivery (time only is used date is irrelevant)
Ending time window for delivery (time only is used date is irrelevant)
Returns true if a given date/time is within
an event window.
False if not.
An event window structure
this is added to an array of structures to cover a week
of day windows
Factory class for returning editable
root object collections by name
Read only Detailed list of WorkorderServiceLabor items
Check if item in collection
Internal method used by list factory
Get all WorkorderService (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItemLaborID object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Not for viewing directly, sets the color of the status button
Criteria for identifying existing object
List of PM workorders that are ready to
generate service workorders
Used by AyaNova Generator
Get all available PM's that ready for
generating a service workorder
This function can only be called by the Generator
utility
Get item by index
Criteria for identifying existing object
Displays on reports and Parts screen selection. (e.g. each, per 100, per box,
MBF, etc) to identify units of measure for the part
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Get new object
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Name of item
Get /set active status
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Get new object
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
if true, does show in wo select list; if false then is not selectable, but can
still bring up history etc
default is true
Set/get Name of item
Security access rights
Security group
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Get new object
SecurityGroup Guid
Delete SecurityGroup
SecurityGroup GUID
Called by DataPortal to delete/add/update data into the database
Remove a SecurityGroup record from the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Name of item
Rights collection
Indicator if current security group is Built-in AyaNova Administrator group
(AyaNova Administrator group properties are all read only
check this before attempting to set)
Guid of built in Administrator account
Criteria for identifying existing object
ScheduleableUserGroup - a preselected group of individual scheduleable
users. Used for dispatching and display purposes
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new ScheduleableUserGroup
Fetch existing ScheduleableUserGroup
Client Guid
Delete ScheduleableUserGroup (if clients assigned to this group, should be notified)
Client GUID
Called by DataPortal to delete/add/update data into the database
Remove a ScheduleableUserGroup record from the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get client group name
Get /set active status of client group
If active = true then ScheduleableUserGroup is selectable for workorders etc
If active = false then ScheduleableUserGroup in not selectable, but history can be
viewed
ScheduleableUsers collection
Default guid to indicate All Users pseudo group
This is not an actual group stored in the database
Used in lists with ScheduleableUserGroups as
the item that will return all users regardless of group membership
Criteria for identifying existing object
Read only list of Regions
Check if item in collection
Get list by criteria
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Properties
@returns
Criteria for identifying existing object
Remove Rate by passing it in
Remove by Guid value of ID
Add a new Rate to the collection
Add Rate by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve Rate by index
Index
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Criteria for identifying existing object
Report data
Private constructor to prevent direct instantiation
Internal method used by list factory
Takes a single ID and returns a "list" of one object
ID of PurchaseOrder object
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Criteria for identifying existing object
Read only list of Projects
Check if item in collection
Internal method used by list factory
Get all Project (filtered by crit)
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
Manual inventory adjustment
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
called by UI on change of collection of items
Returns a search result object based on search terms
for the ID specified
Create new PartInventoryAdjustment
PartInventoryAdjustment
Fetch existing PartInventoryAdjustment
PartInventoryAdjustment
PartInventoryAdjustment Guid
Called by DataPortal to delete/add/update data into the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user record ID of person who modified this record
Effective date of adjustment (may not be entry date)
Read only DB set unique identity number
Reason for adjustment
Criteria for identifying existing object
Set the DB generated visible ID number
to a new user chosen starting point
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)
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new PartAssembly
Fetch existing PartAssembly
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get client group name
Get /set active status of client group
If active = true then PartAssembly is selectable for workorders etc
If active = false then PartAssembly in not selectable, but history can be
viewed
Head office
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new HeadOffice
HeadOffice
Fetch existing HeadOffice
HeadOffice
HeadOffice Guid
Delete HeadOffice
HeadOffice GUID
Called by DataPortal to delete/add/update data into the database
Remove a HeadOffice record .
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get HeadOffice name
Get /set active status of HeadOffice
If active = true then HeadOffice is selectable for workorders etc
If active = false then HeadOffice in not selectable, but history can be viewed
Get service address for this HeadOffice
Get mailing address object for this HeadOffice
Returns GoToAddress object if MailToAddress is empty
Get Contacts collection for this object
web address of HeadOffice if applicable
can be null
ties into hyerlink to web browser
Corresponds to clients.generalnotes in AyaNova v1
Custom1
Custom2
Custom3
Custom4
Custom5
Custom6
Custom7
Custom8
Custom9
Custom0
If true then banked service is tracked
for this object (hours / money / incidents)
Contract that applies to this object
or Guid.Empty if no contract
Date contract expires and no longer applies
or null if contract does not expire ever
If there is a contract and it has not expired returns true
otherwise false
Criteria for identifying existing object
Read only list of Contracts.
Check if item in collection
Internal method used by list factory
Get all Contract (filtered by crit)
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
List of Clients for building pick lists
Includes inactive so that they can be shown on old records
in a consistent format
Check if item in collection
Check if item in collection
Get all active clients
Get a list of all active clients that share the indicated head office
Get item by index
Returns ClientPickListInfo item that matches passed in itemid value
@returns
Criteria for identifying existing object
A list of appointments
(Read only collection )
Check if item in collection
Get list of all appointments
if UserID==Guid.empty then all appointments for all
active scheduleable users are returned.
If it's set to an Active *and* scheduleable specific user id then all workorders
for that specific user only are returned as well as
all schedulemarkers for all users (since the UI has to
determine if they are applicable or not as some are not
for any specific user at all)
Start date and time
End date and time
A user ID for a specific user's appointments
or Guid.Empty for all user's appointments
A read only collection of appointments (ScheduleMarkers and WorkorderItemScheduledUser data)
Get item by index
Returns AppointmentListInfo item that matches passed in itemid value
@returns
true if there is nothing in this record
false if this record contains a valid appointment
What object type this appointment applies to, can be single user
or another object type that represents a group of users
such as: region, sched user group etc etc
Object ID appointment applies to
Type of appointment
either ScheduleMarker or WorkorderItemScheduledUser
The ID of the schedulemarker or workorderitemscheduleduser object
ID of workorder if this appointment is a scheduled workorder user
ID of workorder item if this appointment is a scheduled workorder user
Visible sequential workorder number of workorder
if this appointment is a scheduled workorder user
Description of appointment, either a schedulemarker
description or a summary of the workorder
formatted according to the workorder
Back color of appointment
could be workorder status or schedmarker colour
Criteria for identifying existing object
Remove WorkorderItemType by passing it in
Remove by Guid value of ID
Add a new WorkorderItemType to the collection
Add WorkorderItemType by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve WorkorderItemType by index
Index
Criteria for identifying existing object
Scheduled user on workorder item.
Can select a time and no user or a user and not time
Private constructor to prevent direct instantiation
Set a broken rule if there is not at *least*
one of the following:
A start date
AND end date or a
ScheduleableUser
entered.
true if broken rule
Called by parent collection object
when called in turn by workorder object that is read only due to
security or closed or service completed
Either true or the rights allowed for the current user
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
New item
Get Item
Update child
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Empty ID indicates there is a scheduled time slot but no active user yet
Estimated amount of minutes that technician service would be required Useful
when no Scheduled daterange specified and tech needs to determine when best to
slot in
Starting date and time
Ending date and time
Starting date and time
Ending date and time
Pre-selected service rate
Guid ID of root object (WorkorderItem)
Workorder
Private constructor to prevent direct instantiation
Returns populated TypeAndID if the client or head office for this workorder is bankable
(If the unit is bankable that's handled separately)
Returns null if not bankable
Returns Contract that is most specific
or null if no contract
Returns ID only of Contract that is most specific to
this workorder or null if no Contract applies at all
Move workorderItem from current workorder to another
(Requires full rights and not a closed or read only workorder)
Sets all parts to used = true on entire workorder
Create a labor object from a scheduled user object to save entry time
Find the workorder item ID that contains the object passed in
Type of workorder item descendant object
ID of descendant of workorder item
Returns true if the serial number record is selected
anywhere in the workorder item parts collections
ID of PartSerial record
A List of Guid's of labor rates selected
anywhere in this work order.
A List of Guid's of units selected
anywhere in this work order.
A List of Guid's of labor users selected
anywhere in this work order.
A List of Guid's of travel user id's selected
anywhere in this work order.
A List of Guid's of travel rates selected
anywhere in this work order.
A List of Guid's of parts selected
anywhere in this work order.
A List of Guid's of Scheduleable users selected
anywhere in this work order.
A List of Guid's of Scheduleable users suggested labor rates selected
anywhere in this work order.
A List of Guid's of Misc expense users selected
anywhere in this work order.
A List of Guid's of Loan items selected
anywhere in this work order.
A List of Guid's of serial numbers selected
anywhere in this work order.
Used to prevent duplicate sn selection by presening
user with only available sn's
A partserial ID to exclude (not add to this list)
even when present. This is used to not exclude the currently selected
serial number during editing
A List of Guid's of workorder item status selected
anywhere in this work orders workorder items collection.
Used to determine which inactive status still need to be added
to list for existing workorders
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new Workorder
Workorder
Fetch existing Workorder
Workorder
Workorder Guid
Fetch existing Workorder by related item ID
Given a rootobjectType and an ID opens the work order that hosts
that rootobject type and ID
Workorder
Related objec (child/grandchild etc) Guid
Generates a service workorder from a Quote type Workorder
ID of Quote
A new service workorder
Generates a service workorder from a PM type Workorder
ID of PM
A new service workorder
Copy workorder item and all it's children
from current workorder to indicated destination workorder
Destination workorder can not be closed and must be the same client
If inventory is being tracked then all quantities from parts
are copied over as reserved quantities and need to be re-selected on destination
to control inventory / serial numbers etc
Loans, Outside service, part requests and Expenses are NOT copied as they are
situation specific.
Called by DataPortal to delete/add/update data into the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Category of workorder
Client this work order applies to
Brief description of the purpose of the workorder as a whole
displays on many reports and in various grids. Should be an overview
of what the service is about for the work order in general.
Need to flesh out a lot more as refers to a collection etc
ID of the FormLayout which is object describing the field positions and field
titles of a workorder input form as designed by a user
GUID of project selected
ID of the source template workorder that this workorder is copied from
(template, quote or PM)
Not from a simple copy of a workorder
Indicates that the workroder object is a template
In addition to Workorder number - may have letters in it, therefore used in
addition to numerial wo number
Onsite indicates at client site
Default is true
Can be set in regional settings
Takes as default name in client contact list when client first selected, but
can be edited by user
Determines if a workorder is a template, a quote, a PM item, a workorder for a
client or an internal workorder
If not a WorkorderPreventiveMaintenance, is null
If a WorkorderPreventiveMaintenance contains the WorkorderPreventiveMaintenance child object
If not a WorkorderService, is null
If a WorkorderService contains the WorkorderService child object
Workorder items collection
If not a quote, is null
If a quote, contains the WorkorderQuote child object
Mirror of global object's UseInventory setting
Flag to indicate that service has been completed for this workorder
When true it means that all but workorder header items will become read only
this property can only be set from true to false by someone with full rights
to the workorder object
Used to close a workorder.
A closed workorder can never be re-opened, so this is a write once setting.
A closed workorder can no longer be edited in any manner permanently.
False if any outstanding parts (not set to "Used in service")
True if all parts are set to used in service.
ID of quote that created this workorder
Set internally when the Quote workorder generates a service
workorder.
ID of PreventiveMaintenance that created this workorder
Set internally when the PM workorder generates a service
workorder.
True if on a service workorder there are any parts with a reserved quantity > 0
Non service workorders (quotes / pm) always return false
Used in Workorder form to determine whether to show the
reserved parts field or not.
Reserved parts are only on workorders generated from P.M. or quotes
when inventory is being used.
True means there are loan items not yet returned
True means there are WorkorderItemPartRequest items
still on order and not fully received
Quick check if workorder is editable or not
Workorder is not editable if insufficient rights to workorder object
Workorder is not editable if closed=true
Workorder is not editable if Servicecompleted=true with the single exception
of ServiceCompleted which can be checked for using the IsServicecompletedEditable property
Confirms if service completed can be changed or not
Use in conjunction with IsEditable to handle
UI enablement of edit controls or to check before
updating through API
Confirms if Invoice number can be changed or not
Invoice number can only be changed if a workorder is set
to service completed=true and not closed
(and user has sufficient rights)
Returns true if workorder type is WorkorderTypes.Service
Returns true if sufficient rights and workorder is not closed
or service completed
Returns true if sufficient rights to save workorder and workorder is not closed
Returns true if sufficient rights to
change close by date
(Object.WorkorderService.CloseByDate)
and workorder is editable
Returns true if sufficient rights to
outside service fields
(Object.WorkorderItemOutsideService)
and workorder is editable
Returns true if sufficient rights to
close a workorder
(Object.Workorder.Close)
and workorder is editable
Criteria for identifying existing object
Move a workorder item to a new workorder
Check if item in collection
Internal method used by list factory
Takes an xml column list and where criteria
and returns a list filtered and sorted accordingly
Takes a single ID and returns a "list" of one object
ID of Vendor object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
Read only list of ServiceBanks.
Check if item in collection
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Properties
@returns
Criteria for identifying existing object
Schedulemarker will have list of schedulable users, regions or Global to select
from
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new ScheduleMarker
Fetch existing ScheduleMarker
Client Guid
Delete ScheduleMarker (if clients assigned to this group, should be notified)
Client GUID
Called by DataPortal to delete/add/update data into the database
Remove a ScheduleMarker record from the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Schedulemarker name
Start date of this schedulemarker
Start date of this schedulemarker
as Date/Time object for use outside of UI binding
Stop date of this scheulde marker
Stop date of this scheulde marker as DateTime
for use outside of form binding
ARGB color for display in UI
ID of source, whether global, a specific region or a specific user
Source that the schedulemarker applies to whether a global schedulemarker, a
selected region or an indivudal user
Returns an arraylist containing the
scheduleable user Guid ID values of
all users affected by / included in this
schedulemarker.
So, for example, if it's one user, only that
user will be in the arraylist, however if it's
a schedulemarker for a dispatchzone then all Guid's for
active scheduleable users in that dispatchzone
will be in the arraylist.
Guid used for Global sources
Criteria for identifying existing object
Pick list for selecting parts
(primarily for work order entry)
Check if item in collection
Get all serial numbers for part and optionally for parts in warehouse selected
Part ID
Warehouse ID or Guid empty for any warehouse
Get all serial numbers selected on
workorder
Get item by index
Returns PartSerialPickListInfo item that matches passed in itemid value
@returns
Criteria for identifying existing object
Summary description for SearchResult.
Contains a portable Locale
Used for serializing and de-serializing a locale
(i.e. importing and exporting locales outside the program)
LoanItem
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new LoanItem
LoanItem
Fetch existing LoanItem
LoanItem
LoanItem Guid
Delete LoanItem
LoanItem GUID
Called by DataPortal to delete/add/update data into the database
Remove a LoanItem record .
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Get /set active status of LoanItem
If active = true then LoanItem is selectable for workorders etc
If active = false then LoanItem in not selectable, but history can be viewed
Notes about unit
Set/get Loan item name
Custom1
Custom2
Custom3
Custom4
Custom5
Custom6
Custom7
Custom8
Custom9
Custom0
Criteria for identifying existing object
Summary description for GenProcessPM.
Loop through PM workorders ready for generation and
Process them / advance dates
Various DB helpers to save duplication
in individual business objects
Return a reader based on query with no parameters
SQL query
Return a reader based on query with no parameters
SQL query
Database transaction
Return a reader based on query and ID parameter
SQL with single ID paramter
ID of record desired
Return a reader based on query and ID parameter
without using parameters for performance in a tight loop
SQL with single ID paramter
ID of record desired
Return a reader based on query and ID parameter
and database transaction
SQL with single ID paramter
ID of record desired
Database transaction
Return a single object value based on query and ID parameter
(returns first column of first row as Object)
SQL with single ID paramter
ID of record desired
Return a single object value based on query and ID parameter
(returns first column of first row as Object)
Within the specified transaction
SQL with single ID paramter
ID of record desired
Database transaction
Return a single object value based on query
(returns first column of first row as Object)
SQL
Return a single object value based on query
within transaction
(returns first column of first row as Object)
SQL
Return a DB generated sequential identity number
Field containing ID value
Table name
Guid of record desired
32bit sequential integer identity value
Insert keywords into search tables
if false then clears any existing keywords out of dictionary first
Used by every object indexed with keywords
to delete that objects keywords from the search dictionary
when that object is deleted under the same transaction
Used by every object with Assigned documents
to delete that objects documents
when that object is deleted under the same transaction
Date comparison down to seconds
Check for record being changed by another user while they were editing it separately
Transaction version, called by objects in collections to avoid timeout on conflict
Used to quickly fetch a single Bool record from the db
Private constructor to prevent direct instantiation
Fetch support info off the remote data portal
Criteria for identifying existing object
Remove ClientNote by passing it in
Remove by Guid value of ID
Add a new ClientNote to the collection
Add ClientNote by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve ClientNote by index
Index
Criteria for identifying existing object
Client
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new Client
Client
Fetch existing Client
Client
Client Guid
Delete Client
Client GUID
Check for the existance of a Client
in the database by ID OR by Name
Guid of client
Name of client
Called by DataPortal to delete/add/update data into the database
Remove a Client record .
If Service created from Client screen itself, it defaults to a specific
workorder template
Note this doesn't apply if you make a workorder "out of the blue" as it doesn't
know who you are going to select until after the template is selected.
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get client name
Get /set active status of client
If active = true then client is selectable for workorders etc
If active = false then client in not selectable, but history can be viewed
Get service address for this client
Get mailing address object for this client
Returns GoToAddress object if MailToAddress is empty
Get Contacts collection for this object
web address of client if applicable
can be null
ties into hyerlink to web browser
popup notes - need a setting to indicate whether to popup only on new workorder,
or popup whenever a change too
Corresponds to clients.alert in AyaNova v1
Default is false
Corresponds to clients.generalnotes in AyaNova v1
Corresponds to clients.technotes in AyaNova v1
These are notes to display on dispatch reports for tech etc
Custom1
Custom2
Custom3
Custom4
Custom5
Custom6
Custom7
Custom8
Custom9
Custom0
If true then banked service is tracked
for this object (hours / money / incidents)
Contract that applies to this object
or Guid.Empty if no contract
Retrieves the name of the contract for this client
or an empty string if there is no contract set
Date contract expires and no longer applies
or null if contract does not expire ever
If there is a contract and it has not expired returns true
otherwise false
Criteria for identifying existing object
Used to quickly fetch descriptive information
for a workorderitemscheduleduser notification
during notification Processing
Private constructor to prevent direct instantiation
Criteria for identifying existing object
Used internally to confirm the existance of a
workorder item part request for the various inventory
related objects
Private constructor to prevent direct instantiation
Criteria for identifying existing object
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.
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new WorkorderCategory
Fetch existing WorkorderCategory
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get client group name
Get /set active status of client group
If active = true then WorkorderCategory is selectable for workorders etc
If active = false then WorkorderCategory in not selectable, but history can be
viewed
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new Vendor
Vendor
Fetch existing Vendor
Vendor
Vendor Guid
Delete Vendor
Vendor GUID
Check for the existance of a Vendor
in the database by ID OR by Name
Guid of Vendor
Name of Vendor
Called by DataPortal to delete/add/update data into the database
Remove a Vendor record .
Localized text of Vendor type
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Vendor name
Get /set active status of Vendor
If active = true then Vendor is selectable for workorders etc
If active = false then Vendor in not selectable, but history can be viewed
Get service address for this Vendor
Get mailing address object for this Vendor
Returns GoToAddress object if MailToAddress is empty
web address of Vendor if applicable
can be null
ties into hyerlink to web browser
Corresponds to Vendors.generalnotes in AyaNova v1
Get Contacts collection for this object
Custom1
Custom2
Custom3
Custom4
Custom5
Custom6
Custom7
Custom8
Custom9
Custom0
Criteria for identifying existing object
Read only list of Users
Check if item in collection
Internal method used by list factory
Get all User (filtered by crit)
Return an empty list
used for clearing a grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
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.
Private constructor to prevent direct instantiation
Get new object
GetItem
Fetch
Update
User ID number
XML fragment used to store grid sql filter criteria, order of columns,
sort order and visibility of columns.
If a filter ID is non empty when this view is applied to a grid then
the saved filter takes precedence and the filter portion of the
xml is not applied to the grid.
If the filter ID is empty then the filter criteria in the XML is used.
Guid of saved filter that was last being used
by the user when they closed AyaNova
Guid.Empty means the filter is not a saved one
and so filter settings are customized and should be used
based on the XML and not the saved filter ID
Returns the order by portion of the xml
as a datatable
returns the filter portion of the xml
as a datatable object
true if there is a filter contained in the last view object
User interface grid layout preferences
Used to store and retrieve user and default
layouts for all grid objects in user interface
Private constructor to prevent direct instantiation
Get Document binary data
Set document binary data
Get new object
Fetch Grid layout requested
If there is no customized version for the user then
the default one will be fetched (UserID=Guid.Empty)
Called by DataPortal to delete/add/update data into the database
User ID this layout applies to, if Guid.Empty then it's
the default layout for the gridkey specified
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Size of binary layout data content
Set/get GridKey of item
Set/get GridSubKey of item
Set/get description of item
Optional property
Criteria for identifying existing object
Remove Task by passing it in
Add a new Task to the collection
Add Task by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve Task by index
Index
Criteria for identifying existing object
Collection of TaskGroupTask items in a task group
Remove TaskGroupTask by passing it in
Remove TaskGroupTask by string of id value
Remove by Guid value of ID
Add a new TaskGroupTask to the collection
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
GetItems
Fetch children
Populated data reader
Update children
Retrieve TaskGroupTask by index
Index
Retrieve TaskGroupTask by string containing Guid value
Read only list of PurchaseOrderReceipts
Check if item in collection
Internal method used by list factory
Get all PurchaseOrderReceipt (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of PurchaseOrderReceipt object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
AyaNova NotifyPopUp used to insert new
notification popup messages into the queue
Private constructor to prevent direct instantiation
paramaterless constructor used for DeleteItem static method call
Delete popup message
Called by DataPortal to delete/add/update data into the database
Remove a Client record .
Criteria for identifying existing object
Used for determining if an event is of interest for notification purposes
Private constructor to prevent direct instantiation
Load a fetcher for event
Check to see if there is interest in the event and object specified
Called internally by the NotifySubscription class when a user deletes or creates a
notification subscription.
This ensures that the EventOfInterest table is kept up to date with subscriptions
Optional event specific data
Criteria for identifying existing object
Add events of interest / update subscriber count
Used to quickly fetch a single name record from the db
Private constructor to prevent direct instantiation
Criteria for identifying existing object
North of the equator
South of the equator
Memo message delivery
ClientServiceRequest
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Sets request status to accepted and
creates a new workorder item in the indicated workorder
with data copied from the CSR to the workorder item.
Neither the workorder or the CSR are saved even though
both are updated by this method.
It is the callers responsibility to save both objects.
Existing open workorder to add this request as a new workorder item
or if Guid.empty then a new workorder is created for this request item
workorder object populated from request
Sets request status to accepted and
creates a new workorder and workorder item
with data copied from the CSR to the workorder item
and various fields in the workorder header.
Neither the workorder or the CSR are saved even though
both are updated by this method.
It is the callers responsibility to save both objects.
New workorder object populated from request
Flags request as rejected
and saves
Create a new client service request
Required, id of client request is for
Fetch existing ClientServiceRequest
ClientServiceRequest
ClientServiceRequest Guid
Delete ClientServiceRequest
ClientServiceRequest GUID
Called by DataPortal to delete/add/update data into the database
Remove a ClientServiceRequest record .
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Details about service required
for technician - > ends up in workorder item
notes field
Short descriptive title of
service required
(ends up in workorder item summary field)
ID of client requesting service
ID of Unit service is requested for
ID of WorkorderItem that
request has been accepted to
(set internally)
Status of request, read write with the exception
that a request that is currently Accepted can not be changed.
Customer selected priority
Object is editable if it's not set to status accepted
and current user is not read only
Criteria for identifying existing object
Client group
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new ClientGroup
Fetch existing ClientGroup
Datareader
Populate this object from the values in the datareader passed to it
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get client group name
Get /set active status of client group
If active = true then clientgroup is selectable for workorders etc
If active = false then clientgroup in not selectable, but history can be
viewed
This exception is thrown when a attempt is made to
retrieve an item from the database that doesn't exist
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
Utility functions and configuration connection data
Take an array of strings and
return a single xml string
containing unique only, lowercase
keywords suitable for passing to a
stored procedure or other function that can
handle very plain xml
Use GlobalSettings.CJKIndex=true to handle Chinese, Japanese, Korean etc
(languages with no easily identifiable word boundaries as in english)
return results as XML or as a string of comma delimited words
An array of 0 to * strings of text
Used to Process users search phrase and preserve wild
cards entered
Instantiates searchable business objects based on type and id (class factory)
and Processes and returns search result for that object
Take an XML fragment containing the grid criteria
extract out the column order, build an ORDERBY
clause and return it as a string
Takes an XML fragment containing the grid criteria
extracts out the filter criteria
builds a WHERE clause
and returns it as a string
Translation
returns an empty string if passed in value is null or empty
else returns Prepend plus passed in string followed by append string
Text to return to the left of sText
string to return if not null or empty
Text to return to the right of sText
Convert a string object name value to
it's value in the database
(prepend with a lowercase a if necessary)
Convert a string DBName value to it's object name value
(remove any lowercase 'a' at start of both halves if necessary)
Returns a collection of display attributes for
a read only business object collection's internal record struct
Return the static property value in a biz object using reflection
Biz object
Name of property
null if property doesn't exist or property value
Subversion used for identifying the biz object
when an interim release is put out that
isn't a version change of the assembly itself.
I.E. when biz object 3.0 was released some internal changes
were required that would not affect the user interface or other
utilities that use this biz object .dll so the assembly was
kept at version 3.0.0 but the subversion was changed so that
users and tech support could identify which version was in use
If the version of the assembly itself was change it would
mean that all dependant assemblies would have to be rebuilt
and users would have to update all those applications even though there
was no change that would affect them directly
Basically it's a hassle saver
Universal Guid to indicate that instead of instantiating an existing
object a new one should be created with it's own id
Used by the AyaNova UI layer to indicate when opening an object for editing if it
should be created first. If this ID is used instead of an actual id then
the UI utility class knows to create the object as new instead of opening an
existing one
Rank and extract best excerpt of specified text and search terms
Do the extraction and ranking
Give a percentage score for a given window of
text in the raw text string
75% of the score is the percentage of all search terms found in the window
25% of the score is the percentage of all characters in the search window that are search term characters
Float value of zero to one hundred
Extract the best scoring excerpt fragments of
raw text
This is the ranking of the source text as it pertains to the
search terms
A rank of zero means either there was no match or the rank that was calculated
was lower than the threshold ranking, either way, no excerpt extraction is done.
It is a percentage value on a scale of 0 to 100
and is weighted:
75% of the score is the percentage of all search terms found in the text
25% of the score is the percentage of all characters in the text that are search term characters
Maximum characters to appear in an extraction
default is 80
Minimum is 10
ExtractionThresholdRank
Extraction will only take place if the rank is
this value or higher
default is 10, maximum is 100 minimum is 0
If true, carriage returns and line feeds will be removed from extract
Extracted text excerpt that best reflects search terms
EnumConverter supporting System.ComponentModel.DescriptionAttribute
Gets Enum Value's Description Attribute
This can be called directly from anywhere to return
the localized text value of an enumeration.
The value you want the description attribute for
The description, if any, else it's .ToString()
Gets the description for certaing named value in an Enumeration
The type of the Enumeration
The name of the Enumeration value
The description, if any, else the passed name
Gets the value of an Enum, based on it's Description Attribute or named value
The Enum type
The description or name of the element
The value, or the passed in description, if it was not found
Report data
Private constructor to prevent direct instantiation
Internal method used by list factory
Takes a single ID and returns a "list" of one object
ID of Workorder object
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Criteria for identifying existing object
WorkorderItemPart
If user using inventory, can select from pre-entered list of serial numbers, or
can enter in manually here or use for what have U
If Part is serialized, quantity must always be 1
Default taken from part inventory - not editable by user
Default taken from part inventory, but can be edited by user
Percentage discount to be applied to the WorkorderItemPart When set discount
reason is also set indicating why the discount was given
If discount is entered or is obtained from Contract, than type occurs. Can be
null if no discount
Warehouse GUID that part was reserved from, or taken out of inventory from, as
well as when specifiy ToBeOrdered, PO knows it is needed for a specific
warehouse
Private constructor to prevent direct instantiation
Called by parent collection object
when called in turn by workorder object that is read only due to
security or closed or service completed
Either true or the rights allowed for the current user
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
New item
Get Item
Update child
This handles deleting a part record and updating inventory accordingly
It's called internally here and also by the collection
Update inventory and serials as a result of part being added / removed
from a workorderitem
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Guid ID of root object (WorkorderItem)
Warehouse GUID that part was reserved from, or taken out of inventory from, as
well as when specifiy ToBeOrdered, PO knows it is needed for a specific
warehouse
Sales tax code for parts
If using AyaNova inventory, this is the ID of the serial number record for this
part
If not using inventory can store serial number here
Stores serials by default when non inventory or
for items imported
Default taken from part inventory
Default taken from part inventory, but can be edited by user
This is a forcible price override that can be
used on a read only workorder item part through
the developers API only, it's not exposed in the user
interface.
It's intention is to allow fine tuning of prices
if they do not match a 3rd party integration application
such as accounting software before invoicing.
If Part is serialized, quantity must always be 1
Reserved quantity
Set internally by a Quote or PreventiveMaintenance
workorder when they are converted to a service workorder
and the global setting UseInventory is true.
Since serial numbers and inventory quantities are not known
at the time of the quote creation or PM creation this serves
as an alternate quantity field.
This is used to indicate to the user the quantity that
was selected on the quote or pm so they can enter the
actual quantity on the service workorder, select serial numbers
be advised of inventory that is out of stock etc
Can be null if no discount
Percentage discount to be applied to the WorkorderItemPart When set discount
reason is also set indicating why the discount was given
True = Part has been consumed
False = Part is only "suggested", not actually consumed yet
True = Part has been removed from inventory
False = Part has not yet affected inventory
General comments
By default, displays list of vendors marked with enumeration of Manufactuer or
ThirdpartyRepair - but can select to show all vendors to select from
By default, displays list of vendors marked with enumeration of Shipper - but
can select to show all vendors to select from
Referred to as RMA or repair number - usually provided by the repair center
shipped to
Number used to track the shipping number when sent
Cost of repair
Price charged to customer for repair.
Cost to ship
Price charged to client for shipping
Date expected to be returned
Actual date of return Derives from shipping/receiving screen or can be edited
by user here
Private constructor to prevent direct instantiation
Sets all to read / write status
used by workorder object when it's closed or service completed is true
true=Set to read only explicitly, false=set to whatever rights allowed
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
New item
(Note: requires rights to Workorder object
*not* WorkorderItemOutsideService object)
Get item
Fetch
Update Grandchild
Given a workorder item ID deletes this item for that ID
Called by workorderitems delete
ID of parent workorder item
Database transaction from ascendant item
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Guid ID of root object (WorkorderItem)
Actual date of return Derives from shipping/receiving screen or can be edited
by user here
Number used to track the shipping number when sent
By default, displays list of vendors marked with enumeration of Shipper - but
can select to show all vendors to select from
Date expected to be returned
Cost of repair
Price charged to customer for repair.
Referred to as RMA or repair number - usually provided by the repair center
shipped to
Cost to ship
Price charged to client for shipping
By default, displays list of vendors marked with enumeration of Manufactuer or
ThirdpartyRepair - but can select to show all vendors to select from
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
Remove WorkorderItemLoan by passing it in
Remove WorkorderItemLoan by string of id value
Remove by Guid value of ID
Add a new WorkorderItemLoan to the collection
Sets all items to read / write status
used by workorder object when it's closed or service completed is true
true=Set to read only explicitly, false=set to whatever rights allowed
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
Get items - Grandchild style
Fetch children - grandchild style
Update children
Given a workorder item ID deletes all items for that ID
Called by workorderitems delete
ID of parent workorder item
Database transaction from ascendant item
Retrieve WorkorderItemLoan by index
Index
Retrieve WorkorderItemLoan by string containing Guid value
Used to quickly fetch a count of all workorders
in database
Private constructor to prevent direct instantiation
Counts workorders
Count
Criteria for identifying existing object
Remove UserCertificationAssigned by passing it in
Remove UserCertificationAssigned by string of id value
Remove by Guid value of ID
Add a new UserCertificationAssigned to the collection
Check if item in collection
Check if item in collection by string of ID value
Check if item in collection by string of Certification ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
GetItems
Fetch children
Populated data reader
Update children
Retrieve UserCertificationAssigned by index
Index
Retrieve UserCertificationAssigned by string containing Guid value
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new UnitServiceType
Fetch existing UnitServiceType
Datareader
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get name
Get /set active status
If active = true then UnitServiceType is selectable for workorders etc
If active = false then UnitServiceType in not selectable, but history can be
viewed
Unit
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Return unitname in selected format
Return unitname in default (Global setting) format
returns new item with null serial number that is a duplicate of the ID called
originally
Unit ID that you want to make a duplicate copy of
Create new Unit
Unit
Fetch existing Unit
Unit
Unit Guid
Delete Unit
Unit GUID
Called by DataPortal to delete/add/update data into the database
Remove a Unit record .
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Get /set active status of Unit
If active = true then Unit is selectable for workorders etc
If active = false then Unit in not selectable, but history can be viewed
Get service address for this Unit
can be used to override client address
if unit is not at client's site
Notes about unit
Overrides any other warranty terms from unitmodel
Terms for the unit's warranty
Client unit assigned to
Vendor ID where purchased from
ID of unit this unit is to be grouped as a child under (null or empty id = no parent)
default is false
if true, unit address is specified in GoToAddress
Original sales receipt number
default is true
if false, than select PurchasedFrom vendor id
Date unit was purchased
Utilized to determine warranty info
Description of unit to display if no model chosen
If a unit is replaced while in warranty (WorkorderItemOutsideService) sets this
unit to inactive, and enters in new units serialnumber that replaced it
Custom1
Custom2
Custom3
Custom4
Custom5
Custom6
Custom7
Custom8
Custom9
Custom0
If true then banked service is tracked
for this object (hours / money / incidents)
If true then meter readings can be entered for this unit
Lifetime warranty which never expires
Warranty length in months
Ignored if LifeTimeWarranty selected
Returns status of warranty
("resolved" because it checks all possible sources
of a warranty to determine status)
Resolved warranty expiry date
(definitive date from either unit model or
this unit's overriden properties)
If there is a lifetime warranty it returns DateTime.MaxValue
If there is no warranty expiry date determineable then it returns null.
Otherwise it returns a DateTime set to warranty expiry date.
Warranty terms resolved
(either from unit model or this units
overriden warranty properties as required)
Returns text of warranty terms or an empty string if none found
or no warranty applicb
Criteria for identifying existing object
User interface grid layout preferences
Used to store and retrieve user and default
layouts for all grid objects in user interface
Private constructor to prevent direct instantiation
Get Document binary data
Set document binary data
Get new object
Fetch shared Grid layout requested
Called by DataPortal to delete/add/update data into the database
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Size of binary layout data content
Set/get GridKey of item
Set/get Name of item
Criteria for identifying existing object
User interface ExplorerBar layout preferences
Used to store and retreive user and default
layouts for all ExplorerBar objects in user interface
Private constructor to prevent direct instantiation
Get new object
Fetch explorer bar layout requested
Called by DataPortal to delete/add/update data into the database
User ID this layout applies to, if Guid.Empty then it's
the default layout for the gridkey specified
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Size of binary layout data content
Set/get GridKey of item
Criteria for identifying existing object
Private constructor to prevent direct instantiation
Criteria for identifying existing object
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.
Private constructor to prevent direct instantiation
Copy all line items from po indicated into
items collection of this receiving
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create new PurchaseOrderReceipt
PurchaseOrderReceipt
Fetch existing PurchaseOrderReceipt
PurchaseOrderReceipt
PurchaseOrderReceipt Guid
Called by DataPortal to add data into the database
Purchase order items child collection
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Date items received
Criteria for identifying existing object
Indivdual item (part) that is selected to be in the PO
Method to flag a quantity of PO items received and close if all received
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create item
Parent ID
New Item
Retrieve item
Data reader
item from database
Fetch from db
Persist object to database
Parent object
Parents transaction object
Initial created date of this object
User ID of who initially created this object
Last modified date of this object
User ID of who last modified this object
Unique ID of this object
GUID of Warehouse this ordered part(s) is destined for
Taxcode ID to use to apply against items Default value is taken from Part record
ID of part ordered
Quantity ordered
PurchaseOrderCost per indvidual or unit of part Updates Part object when received
Workorder number
ID of WorkorderItem from which this part was requested to be ordered
used internally in code
ID of user who requested part on workorderitempartrequest
replicated here in case original workorderitempartrequest record
is removed *after* parts are ordered as an audit
ID of PO
Remove PartByWarehouseInventory by passing it in
Add a new PartByWarehouseInventory to the collection
Add PartByWarehouseInventory by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
PartID
Editable Root Collection Update
Retrieve PartByWarehouseInventory by index
Index
Criteria for identifying existing object
Remove NotifyDeliverySetting by passing it in
Add a new NotifyDeliverySetting to the collection
Add NotifyDeliverySetting by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve NotifyDeliverySetting by index
Index
Retrieve NotifyDeliverySetting by Guid value
Criteria for identifying existing object
Used to quickly fetch a single lightweight read only Memo record from the db
Private constructor to prevent direct instantiation
Generate a new memo as a Reply or Forward based on this fetched read only memo
If true, this is a forward reply to don't set the toID just yet
A memo object with fields filled in ready for typing reply/forward text
Fetch Memo of indicated ID, using specific language for
formatting headers etc.
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get sent date as a relative time formatted object
Set/get Subject of item
Set/get Subject of item
From whom
Replied - user has replied to the message
Viewed - user has viewed the message
Consolidated header for display and replying
From name only for notification etc.
Criteria for identifying existing object
List of Locales defined in localtextinfo table
Check if item in collection
Check if item in collection
Get item by index
Properties
Criteria for identifying existing object
Confirms the presence of an integration
in the AyaNova database
Private constructor to prevent direct instantiation
Criteria for identifying existing object
Global settings ex
Private constructor to prevent direct instantiation
Called by DataPortal to delete/add/update data into the database
Get Database schema version
Get/Set global data
View global data in human readable format
Criteria for identifying existing object
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Get new object
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
User selectable data and time of note
Type of source (i.e workorder, quote, etc)
ID of the source where the note was made "from" i.e made from a workorder, it
would enter the workroder number link here
Used as illegal default to ensure
that parent object sets this correctly
Mailing Address
Physical street address
Read only list of Workorder statuses
Check if item in collection
Get all WorkorderStatus (unfiltered as it's not bound)
Get item by index
Returns item that matches passed in itemid value
Properties
@returns
Set/get Name of item
Criteria for identifying existing object
Read only list for reports and grid display
Check if item in collection
Internal method used by list factory
Get all Items (filtered by crit)
Takes a single ID and returns a "list" of one object
ID of WorkorderItem object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Properties
@returns
Criteria for identifying existing object
Remove WorkorderItemTask by passing it in
Remove WorkorderItemTask by string of id value
Remove by Guid value of ID
Add a new WorkorderItemTask to the collection
Sets all items to read / write status
used by workorder object when it's closed or service completed is true
true=Set to read only explicitly, false=set to whatever rights allowed
Check if item in collection
Check if item in collection by string of ID value
Check if item in deleted collection
Check if item in deleted collection by string of ID value
NewItems
Get items - Grandchild style
Fetch children - grandchild style
Update children
Given a workorder item ID deletes all items for that ID
Called by workorderitems delete
ID of parent workorder item
Database transaction from ascendant item
Retrieve WorkorderItemTask by index
Index
Retrieve WorkorderItemTask by string containing Guid value
Read only list of WorkorderItemPartRequests.
Check if item in collection
Internal method used by list factory
Get all WorkorderItemPartRequest (filtered by crit)
Return an empty list
used for initializing grid
Get item by index
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Read only list of parts requested on workorders
@returns
Criteria for identifying existing object
Used to quickly fetch descriptive information
for identifying a service workorder to user
during notification Processing
Private constructor to prevent direct instantiation
Criteria for identifying existing object
Basic name value list of all
AyaNova users (or one specific) formatted to current users
preferred user name display format
Check if item in collection
Get all Users
Get one specific user only but with all the pick list info
Get item by index
Returns display text that matches passed in itemid value
Returns display text that matches passed in itemid value
Properties
@returns
Criteria for identifying existing object
Remove UIUserFormSetting by passing it in
Remove UIUserFormSetting by string of form name
Add a new UIUserFormSetting to the collection
Add a new UIUserFormSetting to the collection
by copying from someone elses
Check if item in collection
Check if item in collection by form name
Check if item in deleted collection
NewItems
Get item collection (Root collection style)
Fetch children root style
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve UIUserFormSetting by index
Index
Retrieve UIUserFormSetting by string containing form's name value
Criteria for identifying existing object
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.
Private constructor to prevent direct instantiation
Get new object
GetItem
Fetch
Update
User ID number
Size of binary layout data content
Used to quickly fetch current service bank balance for object indicated
Private constructor to prevent direct instantiation
Retrieve current service bank balances
ID of Bankable object
Type of object
ServiceBankCurrentBalanceFetcher object
Criteria for identifying existing object
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.
PartInventoryAdjustmentItem item
Ensures that serial number collection
has as many elements as absolute value of
Quantity adjustment
And also ensures that all serial number items have correct part ID
and Adjustment item ID set
This function tries to preserve existing serial number entries as much
as possible unless a Major change is indicated.
this is important because user may have just selected wrong part initially,
but *had* correctly entered all serial numbers
If true, then wipe all serial numbers previously entered
Sets broken rule if quantity of adjustment is unacceptible
(negative quantity but no accompanying stock available)
Safe to call from anywhere
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Create new PartInventoryAdjustmentItem
Sets RootObjectID, RootObjectType
Get an PartInventoryAdjustmentItem from passed in data reader
Update
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Parent
PartID
set by collection if this item
is a duplicate of another in the collection
so that broken rule will be set
(duplicate meaning same part id and warehouse)
User ID who created this PartInventoryAdjustmentItem record
Date this PartInventoryAdjustmentItem was created
User ID who last modified this record
Last date this PartInventoryAdjustmentItem was modified
Serial numbers collection for adjusted part, 0 to many
GUID of Warehouse this adjustment is for
(Defaults to "default" warehouse in any case)
Quantity change
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
Private constructor to prevent direct instantiation
Criteria for identifying existing object
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
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Get new object
Populate this object from the values in the datareader passed to it
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
if true, does show in wo select list; if false then is not selectable, but can
still bring up history etc
default is true
Set/get Name of item
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Returns a search result object based on search terms
for the ID specified
Create new Part
Part
Fetch existing Part
Part
Part Guid
Check for the existance of a Part
in the database by ID OR by PartNumber
Guid of Part
PartNumber of Part
Used to create part by warehouse inventory records
for missing items
Called by DataPortal to delete/add/update data into the database
Get internal id number Read only property because it's set internally, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Set/get Part name
Get /set active status of Part
If active = true then Part is selectable for workorders etc
If active = false then Part in not selectable, but history can be viewed
Corresponds to Parts.generalnotes in AyaNova v1
Display warning message when part selected
Alternative wholesaler to order from if first does not have
who made it - ie 3COM
Part is made part of a category for display purposes and reporting. A way of
grouping
Displays on reports and Parts screen selection. (e.g. each, per 100, per box,
MBF, etc)
Who distributes is - i.e Ingram
cost dollar amt per part
retail dollar charge for part
Part number as given by the wholesaler - i.e Ingram
Part number as given by the manufacturer - could be scanned in UPC code
15 or less numeric digits as text
default = false Indicates that this part is serialized Triggers prompting for
serial number when part is received in via a purchase number
Note: if an existing part has serial numbers then this can not
be set to false as it would affect history and inventory
part is part of an assembly null = no assembly
Custom1
Custom2
Custom3
Custom4
Custom5
Custom6
Custom7
Custom8
Custom9
Custom0
Criteria for identifying existing object
A user who is subscribing to notification events
Private constructor to prevent direct instantiation
Throw an error when a read only user
tries to set a property
(this should normally never be called unless someone is using the developer api since the UI
should prevent it from happening initially)
Fetch existing NotifySubscriber
for indicated user ID.
If one doesn't exist it will automatically be created.
NotifySubscriber
Delete NotifySubscriber for indicated user
NotifySubscriber UserID
Called by DataPortal to delete/add/update data into the database
Remove a NotifySubscriber record from the database
Get internal id number Read only property because it's set internally, not
externally
Get User id Read only property because it's set on creation / fetch, not
externally
Get created date
Get modified date
Get user record ID of person who created this record
Get user ID of person who modified this record
Get /set active status of NotifySubscriber
Collection of Subscriptions selected for this subscriber
Criteria for identifying existing object
Read only list of NotifyDeliveryLogs.
Get all NotifyDeliveryLog entries
True for all entries for any user, false for current logged in user's ID
Return an empty list
used for initializing grid
Get item by index
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Log fields
Criteria for identifying existing object
Perform common AyaNova maintenance work
Private constructor to prevent direct instantiation
Erases all optional data in the database
except for required elements
Backs up database to path and file specified
Get internal id number Read only property because it's set internally, not
externally
Criteria for ops
Read only list of head offices.
Check if item in collection
Internal method used by list factory
Takes an xml column list and where criteria
and returns a list filtered and sorted accordingly
Takes a single ID and returns a "list" of one object
ID of HeadOffice object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Returns the Detailed report key
which is used to determine which reports and objects
will be used for detailed reports
If empty string then indicates there is no detailed report object or reports
Base object that this list is reporting on
used by shared UI editor to instantiate new objects
when user selects new in UI elements that display this list
(I.E. when user clicks on new in a read only list grid, this is the object type created)
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
The Type of the struct used to store list records
Used to fetch the custom display attributes of the fields
contained within the record to modify the grid display accordingly
Properties
@returns
Criteria for identifying existing object
Remove DispatchZone by passing it in
Remove by Guid value of ID
Add a new DispatchZone to the collection
Add DispatchZone by passing it in
Check if item in collection
Check if item in deleted collection
Get item collection
Fetch children
Editable Root Collection Update
Locale key so that generic list editor
UI code knows what title to give the list in a
grid
Retrieve DispatchZone by index
Index
Criteria for identifying existing object
List of DispatchZones for building pick lists
Includes inactive so that they can be shown on old records
in a consistent format
Check if item in collection
Get all scheduleable users
Get item by index
Returns DispatchZonePickListInfo item that matches passed in itemid value
@returns
Criteria for identifying existing object
Various Database management utilities
Erases all optional data in the database
except for required elements
Advance reference dates
Used to move dates in trial data to be centered on current date
so that people evaluating AyaNova can see scheduled users
and workorders centered around the current date instead of being
stuck in the past when they were first created
Do not use under any circumstances with actual live data,
it will wreak havoc on a production database, the trial data
is designed to work with this method.
Upgrades schema to current version required
Unschedules all users in all workorders
The required schema version to use this AyaNova
Erase an entire database
Advance evaluation data dates to current date
process the date and return it as a db value UTC corrected for
re-insertion into db
Upgrade schema of database to required version
execute DDL statement
execute DDL statement without uppercasing
(for the localized text changes primarily)
Add new right
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.
Read only list of clients.
Check if item in collection
Internal method used by list factory
Takes an xml column list and where criteria
and returns a list filtered and sorted accordingly
Takes a single ID and returns a "list" of one object
ID of Client object
Return an empty list
used for initializing grid
Get item by index
Returns display text that matches passed in itemid value
Returns the report key which is a property of
reports used to link all reports that can be used
with a particular data source.
Properties
@returns
Criteria for identifying existing object