Data
Provides access to Xenomorph DataServices loading and saving functions.
The following operations are supported. For a formal definition, please review the Service Description.
-
AddCategory
This method adds a new user-defined item category to the given database. You are able to define your own properties (i.e. characteristics) for each category you add. -
AddPropertyDef
This method adds a new property to the given category within a database. You are able to define the data type of the property and also storage characteristics. -
BackupXDB
This method creates a backup copy of an existing Xenomorph database to a specified directory as seen by the Xenomorph server which owns the database. -
BaskLoadDef
This method loads the definition of a basket stored under a given item code in a database. -
BaskSaveDef
This method saves the definition of a basket under a given item code in a database. -
DatabaseAddCodeType
This method adds a new code type to the given database -
DatabaseAddDataSource
This method adds a new data source to the given database. -
DatabaseCreate
This method can be used to create a database on a local or remote machine. -
DeleteItem
Deletes the specified item for the given database, code and Code Type. -
DeleteProp
Deletes the data associated with the specified property for the given database, code and code type. For properties that are stored historically, a property value on a specific date rather than on all dates can be deleted if desired. -
ItemCodeAdd
This method adds or updates a code and Code Type pair for an existing item in a given database. -
ItemCodeDelete
This method deletes a code and code type pair from an existing item in a given database. -
ItemQuery
Runs a query in the context of a given item on the server associated with the target item's database. -
LoadDivs
This function loads the dividend schedule (with optional filtering) associated with a given item on a given date. -
LoadNProps
This method loads N properties, for one or more item codes in a given database. You can choose to supply a target date for which you wish to retrieve data - if this is not supplied, the latest value(s) available will be returned. -
LoadProp
This method loads the value associated with a given property for the given item code and database. You can optionally specify the date for which the value should be returned. -
LoadPropSeries
This method loads a series of values associated with a given property for the given item code and database. You can specify the start and end dates for which the property values should be returned and also the step between data points (in days). -
LoadSeries
This method loads a historical data series for a given series name, item code and database. You can specify the start and end dates and also the day step between data points. -
LoadTwoSeries
This method loads two historical data series for the given series names, itemcodes and databases, on matching dates. You can specify the start and end dates and also the day step between data points. -
LoadValue
This method loads the value associated with a given date in a given historical series, for the given item code and database. -
Query
Runs a query on a target server. -
SaveDateTime
This method saves a value to a given date / time property for the given item code and database. -
SaveDivs
This function saves a dividend schedule for a given item on a given date to a database, optionally overwriting existing schedules, if required. -
SaveItem
Creates or modifies the given item for the given database, code and code type. -
SaveItemDescription
This method saves a new description for a given item code and database. -
SaveItemRef
This method saves a value to a given reference property for the given item code and database. -
SaveList
This method saves a Xenomorph.List to a given list property for the given item code and database. -
SaveLogical
This method saves a value to a given logical property for the given item code and database. -
SaveMatrix
This method saves matrix data to a given matrix property for the given item code and database. -
SaveSeries2
This method saves a historical data series, under a given series name and item code to the given database. -
SaveText
This method saves text to a given text property for the given item code and database. -
SaveSeries
MessageName="SaveTimeSeries"
This method saves a historical data series, under a given series name and item code, to the given database. -
SaveValue
This method saves a single numeric value to a given property, as identified by the series name argument.