|
|
|
|
check view state
|
For testing: Use to determine if a view exists and if it is a list. Direct Parameter is {collection, user, password, relation, view, allowsEntry}. Returns nothing. The sixth parameter tests if the view allows entry: if true and the view is a list, error 200 is returned. If false, any legal view returns no error. |
|
close process
|
Terminate an open ProcessID. Direct Parameter is a ProcessID. Returns nothing. Always close a process when you are finished with it. The number of open processes allowed is limited by the application license. |
|
create process for retrieve
|
Open a process for retrieving data in segments from the specified view. Direct Parameter is {collection, user, password, relation, view}. Returns a ProcessID. |
|
create process for store
|
Open a process for store one or more records using the specified view. Direct Parameter is {collection, user, password, relation, view}. Returns a ProcessID. |
|
delete recordID
|
See "delete records" |
|
delete recordIDs
|
Using a previously acquired ProcessID, delete one or more records from the collection, using the view specified when the ProcessID was requested. Direct Parameter is {ProcessID, RecordID, [RecordID, ]} The number of RecordIDs that can be sent in one event statement is limited by a preference setting. Returns integer count of records deleted. RecordIDs are acquired when retrieving data. |
|
get partial view data
|
Using a previously acquired ProcessID, retrieve a range of records from the view specified when the ProcessID was requested. Direct parameter is {ProcessID, [Start Record], [How Many To Get], [Indent Subform Records]}. Returns one or more retrieved data records. Start Record is the zero-count ordinal record number of the first record to get. How Many To Get is the number of records to get. Indent Subform Records (a boolean, default is true) controls whether leading field delimiters are used to indicate subform records. See get view data as list for returned data format. |
|
get view data as Helix data
|
Deprecated. Using a previously acquired ProcessID, retrieve a subset of records from the view specified when the ProcessID was requested. See get view data as string for direct parameter details. Returns an AppleScript list of records in legacy (CallHelix 1.x) format. |
|
get view data as list
|
Using a previously acquired ProcessID, retrieve a subset of records from the view specified when the ProcessID was requested. See get view data as string for direct parameter format. See retrieve records as list for returned data format. Set Indent Subform Records to false to suppress list item prefixing. |
|
get view data as string
|
Using a previously acquired ProcessID, retrieve a subset of records from the view specified when the ProcessID was requested. Direct parameter is {ProcessID, DataType} when DataType is 0 (Icon Names) or 1 (Header Data); {ProcessID, DataType, Start Record, How Many To Get, [Indent Subform Records]} when DataType is 2 (Record Data). See retrieve records as string for returned data format. Set Indent Subform Records to false to suppress delimiter prefixing. |
|
get view summary
|
After a ProcessID is requested, delay until the specified view is ready. (Optimized views reduce delays.) Direct parameter is {ProcessID}. Returns a process ready record containing {record count, field delimiter, record delimiter}. |
|
retrieve records as list
|
Get every record on the specified view. Direct parameter is {collection, user, password, relation, view}. Returns an AppleScript list of Helix records. Field data is returned as an AppleScript list. Subform records are returned as discreet records, prefixed with an additional empty list item for each level of subform nesting. |
|
retrieve records as string
|
Get every record on the specified view. Direct parameter is {collection, user, password, relation, view}. Returns an AppleScript list of Helix records. Field data is returned as a string with field and record delimiters included. Subform records are returned as discreet records, prefixed with an additional field delimiter for each level of subform nesting. |
|
store one record
|
Store a text string (with embedded field delimiters) in Helix. Direct parameter is {collection, user, password, relation, view, record data}. See store records for returned data format. Data that fails validation or type checking results in error 1000. |
|
store record
|
See store records |
|
store records
|
Using a previously acquired ProcessID, store one or more records in the view specified when the ProcessID was requested. Direct parameter is {ProcessID, record data, [record data, ]} Each record data parameter is a text string (with embedded field delimiters) to be stored as a record. The number of RecordIDs that can be sent in one event statement is limited by a preference setting. Returns a list of flags indicating success/failure for each attempt. |
|
test view for readiness
|
Deprecated: Use get view summary instead. |