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.
Declaration Syntax| C# | Visual Basic | Visual Basic Usage | Visual C++ | J# | JScript | JavaScript | XAML |
[SerializableAttribute] public class Integration : BusinessBase
<SerializableAttribute> _ Public Class Integration _ Inherits BusinessBase
Dim instance As Integration
[SerializableAttribute] public ref class Integration : public BusinessBase
/** @attribute SerializableAttribute */ public class Integration extends BusinessBase
public class Integration extends BusinessBase
GZTW.AyaNova.BLL.Integration = function(); Type.createClass( 'GZTW.AyaNova.BLL.Integration', CSLA.BusinessBase);
Members| All Members | Methods | Properties | Events | ||
| Icon | Member | Description |
|---|---|---|
 | AcceptChanges()()() | (Inherited from UndoableBase.) |
 | Active |
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
|
 | AddBusinessRules()()() | (Inherited from BusinessBase.) |
| AIObject |
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
|
| AppID |
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
|
 | ApplyEdit()()() | (Inherited from BusinessBase.) |
| AppVersion |
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
|
| BeginEdit()()() | (Inherited from BusinessBase.) |
 | BrokenRules()()() | (Inherited from BusinessBase.) |
| BrokenRulesText()()() | (Inherited from BusinessBase.) |
| CancelEdit()()() | (Inherited from BusinessBase.) |
| Clone()()() | (Inherited from BusinessBase.) |
| CopyState()()() | (Inherited from UndoableBase.) |
| Created |
Get created date
|
| Creator |
Get user record ID of person who created this record
|
| CurrentUserID()()() | (Inherited from BusinessBase.) |
| DataPortal_Create(Object) | (Inherited from BusinessBase.) |
| DataPortal_Delete(Object) |
Remove a Integration record .
(Overrides BusinessBase.DataPortal_Delete(Object).) |
| DataPortal_Fetch(Object) | (Overrides BusinessBase.DataPortal_Fetch(Object).) |
| DataPortal_Update()()() |
Called by DataPortal to delete/add/update data into the database
(Overrides BusinessBase.DataPortal_Update()()().) |
| Delete()()() | (Inherited from BusinessBase.) |
 | DeleteItem(Guid) |
Delete Integration
|
| Deserialized()()() | (Inherited from BusinessBase.) |
| DumpState()()() | (Inherited from UndoableBase.) |
| EditLevel()()() | (Inherited from UndoableBase.) |
| Equals(Object) | (Overrides Object.Equals(Object).) |
| Finalize()()() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetBrokenRulesCollection()()() | (Inherited from BusinessBase.) |
| GetBrokenRulesString()()() | (Inherited from BusinessBase.) |
| GetHashCode()()() | (Overrides Object.GetHashCode()()().) |
| GetItem(Guid) |
Fetch existing Integration
|
| GetRight(String) | (Inherited from BusinessBase.) |
| GetType()()() | Gets the Type of the current instance. (Inherited from Object.) |
| ID |
Internal Unique GUID value of Integration record in database
|
| IntegrationExists(Guid) |
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.
|
| IsDeleted()()() | (Inherited from BusinessBase.) |
| IsDirty | (Overrides BusinessBase.IsDirty()()().) |
 | IsDirtyChanged()()() | (Inherited from BindableBase.) |
| IsEditing()()() | (Inherited from BusinessBase.) |
| IsNew()()() | (Inherited from BusinessBase.) |
| IsSavable()()() | (Inherited from BusinessBase.) |
| IsValid | (Overrides BusinessBase.IsValid()()().) |
| LastConnect |
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
|
| Maps |
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.
|
| MarkAsChild()()() | (Inherited from BusinessBase.) |
| MarkDeleted()()() | (Inherited from BusinessBase.) |
| MarkDirty()()() | (Inherited from BusinessBase.) |
| MarkNew()()() | (Inherited from BusinessBase.) |
| MarkOld()()() | (Inherited from BusinessBase.) |
| MemberwiseClone()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Modified |
Get modified date
|
| Modifier |
Get user ID of person who modified this record
|
| Name |
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
|
| NewItem(Guid) |
Create new Integration
|
| Notify()()() | (Inherited from BusinessBase.) |
| OnIsDirtyChanged()()() | (Inherited from BindableBase.) |
| Save()()() | (Inherited from BusinessBase.) |
| Serialized()()() | (Inherited from BusinessBase.) |
| Serializing()()() | (Inherited from BusinessBase.) |
| SyncCheckPoint |
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
|
| ToString()()() | (Overrides Object.ToString()()().) |
| UndoChanges()()() | (Inherited from UndoableBase.) |
Inheritance Hierarchy| Object | ||||
 | BindableBase | |||
| UndoableBase | |||
| BusinessBase | |||
| Integration | |||