|
|
|
check view state
«constant Chhc»
|
For testing: Use to determine if a view exists and if it is a list. Direct Parameter is {collection, user, password, relation, view, [true/false]}. Returns nothing. The sixth parameter is optional, and is used to test if the view allows entry: if true and the view is a list, error 200 is returned. |
close process
«constant CHcp»
|
Terminate an open ProcessID. Direct Parameter is a single ProcessID. Returns nothing. It is important to close a process when you are finished with it. The number of simultaneous processes that can be open at one time is controlled by the application license. |
create process for retrieve
«constant CHrs»
|
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
«constant CHss»
|
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
«constant CHdR»
|
See "delete records" |
delete recordIDs
«constant CHdz»
|
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
«constant CHrA»
|
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 listfor returned data format. |
get view data as Helix data
«constant CHgR»
|
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
«constant CHrL»
|
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
«constant CHgS»
|
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
«constant CHwd»
|
After a ProcessID has been requested, use this command to delay until the specified view is ready for action. (Optimized views reduce delays.) Direct parameter is {ProcessID}. Returns a process ready record containing {record count, field delimiter, record delimiter}. |
retrieve records as list
«constant CHor»
|
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
«constant CHaS»
|
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
«constant CHos»
|
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
«constant CHmS»
|
See store records |
store records
«constant CHsM»
|
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
«constant CHpr»
|
Deprecated: Use get view summary instead. |