Icims¶
Bases: QSBase
ICIMS
Overview
The ICIMS class is a specialized component for handling form data interactions within the ICIMS system.
It extends the QSBase class and provides methods for retrieving people data, individual person data,
lists of forms, and form data with specific metrics mappings.
.. table:: Properties :widths: auto
+------------------+----------+--------------------------------------------------------------------------------------+
| Name | Required | Description |
+------------------+----------+--------------------------------------------------------------------------------------+
| type | Yes | Defines the type of data handled by the component. |
+------------------+----------+--------------------------------------------------------------------------------------+
| conditions | No | If any condition is required to do the work. |
+------------------+----------+--------------------------------------------------------------------------------------+
Methods
people
Retrieves a list of people data from the ICIMS system.
Raises:
DataNotFound: If no data is found.
ComponentError: If any other error occurs during execution.
person
Retrieves individual person data from the ICIMS system and adds a person_id to the data.
Raises:
DataNotFound: If no data is found.
ComponentError: If any other error occurs during execution.
forms_list
Retrieves a list of forms from the ICIMS system.
Raises:
DataNotFound: If no data is found.
ComponentError: If any other error occurs during execution.
form_data
Retrieves form data from the ICIMS system and maps internal metrics to output names.
Raises:
DataNotFound: If no data is found.
ComponentError: If any other error occurs during execution.
Return
The methods in this class return the requested data from the ICIMS system, formatted according to the specific requirements of each method.
Example:
```yaml
ICIMS:
type: people
```