The get_process_status message is sent to retrieve the status of the dimension table synchronization process.
Get Concept Synchronization Process Status
To get the process status, the sequence of events is as follows:
- The client specifies a request to obtain status for a specified process_id
- The ontology server returns the status for the specified process status parameters.
- The client updates the progress of the process.
get_ont_process_status Request Message
This message requires the user to specify the process we are obtaining the status for.
Example:
<message_body>
<get_ont_process_status>
<process_id/>
<process_type_cd/>
<process_start_date>
<start_time>2010-04-05T00:00:00.000-04:00</start_time>
<end_time>2010-04-05T00:00:00.000-04:00</end_time>
</process_start_date>
<process_end_date>
<start_time>2010-04-05T00:00:00.000-04:00</start_time>
<end_time>2010-04-05T00:00:00.000-04:00</end_time>
</process_end_date>
<process_status_cd>COMPLETED</process_status_cd>
</get_ont_process_status>
</message_body>
get_ont_process_status Response Message
A status type of DONE or ERROR is specified in the response header. The <message_body> provides process status for the requested process id.
Example:
<message_body>
<ontology_process_status_list>
<ontology_process_status>
<process_id>26</process_id>
<process_step_cd>ONT_SENTTO_CRCLOADER</process_step_cd>
<start_date>2010-04-05T00:00:00.000-04:00</start_date>
<end_date>2010-04-05T00:00:00.000-04:00</end_date>
<process_status_cd>COMPLETED</process_status_cd>
<crc_upload_id>624</crc_upload_id>
<message />
</ontology_process_status>
</ontology_process_status_list>
</message_body>
The process_step_cd provides information about the type of process that is currently in progress. The following codes are in use:
process_step_cd |
Description |
ONT_BUILD_PDO_START |
Indicates that a file containing edited metadata is being created. |
ONT_SENTTO_FRC |
Indicates that the metadata file has been sent to the File Repository Cell (FRC) |
ONT_SENTTO_CRCLOADER |
Indicates that the CRC has been instructed to upload the file sent to the FRC. |
ONT_PATIENT_COUNT_UPDATE |
Indicates that the process is updating the patient count information for the concepts. |
The process_status_cd provides information about the status of the step identified at the process_step_cd.
process_status_cd |
Description |
ERROR |
Indicates that an error occurred |
PROCESSING |
Indicates that the process is in progress |
COMPLETED |
Indicates that the process has competed |
ABORT |
Indicates that the process should set itself to KILLED status because the user started another instance of this process. |
KILLED |
Indicates that the process was killed because the user started another instance of this process. |