TITLE | VALUE | |
---|---|---|
NAME | DENTVAU CHUNK REPORTS | |
DESCRIPTION | This RPC allows the GUI to both queue and poll dental reports utilizing chunking of data returned. | |
TAG | CHUNK | |
ROUTINE | DENTVAU | |
INPUT PARAMETERS | SEQUENCE NUMBER | 1 |
INPUT PARAMETER | DENTRPT | |
DESCRIPTION | This is the index of the report type you wish to run: D = Delete Indicated Report via Handle 1 = Dental Device Report 2 = Adverse Events Report This parameter is not required when polling for report data. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 2 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 2 |
INPUT PARAMETER | DENTTIME | |
DESCRIPTION | This is the date/time at which you wish to schedule the report to run. This parameter is not required and if not passed will default to schedule the report to process as soon as possible. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 14 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 3 |
INPUT PARAMETER | DENTHNDL | |
DESCRIPTION | This is the handle by which a report can be identified. If not passed in, the handle will default to current_date/time~user_DUZ~report_type. If handle is passed in and a report with the given handle does not exist, a new report will be generated with the input handle. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 50 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 4 |
INPUT PARAMETER | DENTSTRT | |
DESCRIPTION | This is the last IEN returned in the previous data chunk. If not passed in, the RPC assumes this is an initial call and will start returning data from the beginning. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 30 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 5 |
INPUT PARAMETER | DENTPAR | |
DESCRIPTION | This parameter can store multiple parameters which you want to pass into reports. Below are the available parameters for each report: DEVICE TRACKING: n/a ADVERSE EVENTS: DENTPAR("START") = Starting date DENTPAR("END") = Ending date DENTPAR("STATUS") = The statuses you wish to have returned. Each status is to be delimited by ";" (i.e. "0;2"). 0 = Active 1 = Resolved 2 = Deleted | |
PARAMETER TYPE | LIST | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 245 | |
RETURN VALUE TYPE | GLOBAL ARRAY | |
RETURN PARAMETER DESCRIPTION | If queuing a new report, the results will be formatted as follows: List[1] = p1^p2 p1 = Task # p2 = Report Handle If polling for data, the results will be formatted as follows: List[n] = Report Data will be unique to each report type, though some common elements include: $$APPEND$$ = Data returned for a single entry is greater than the RPC Broker can handle, therefore any node with this prefix is a continuation of the data from the previous node. $$WP$$ = This prefix indicates Word Processing data associated with the previous data entry. If deleting a report, the results will be formatted as follows: List[1] = 1^*report handle* report deleted If an error occurs in any of these scenarios, the result will be formatted as follows: List[1] = -1^error_message | |
AVAILABILITY | AGREEMENT | |
INACTIVE | ||
CLIENT MANAGER | ||
WORD WRAP ON | TRUE | |
VERSION | ||
SUPPRESS RDV USER SETUP | ||
APP PROXY ALLOWED |