This handler has the ability to have form caching disabled. To disable form caching set disable_caching to "Yes". Disabling caching may negatively impact performance, but it is also necessary when using a single handler to interact with multiple Remedy environments.
This handler returns the request ids (field 1) for all records in the specified form that match the provided query. This is returned in XML format (like below) for use in loops.
It also returns the instance ids (field 179) in a similar format:
It also returns a count of the number of records found. It returns zero if there were no matches (not nil).
| Name | Description | Sample |
|---|---|---|
| server | Remedy Server Name or IP Address | |
| username | Remedy Login Name | |
| password | Remedy Password | ********* |
| port | Remedy TCP Port | 0 |
| prognum | Remedy RPC Prognum | 0 |
| authentication | Remedy Authentication String | |
| enable_debug_logging | Enable debug logging if the value is set to 'Yes'. | No |
| disable_caching | Disable caching if the value is set to 'Yes'. Disabling caching may negatively impact performance, but it is also necessary when using a single handler to interact with multiple Remedy environments. | No |
| Name | Description | Sample |
|---|---|---|
| Error Handling | Determine what to return if an error is encountered. | Error Message |
| Remedy Form: | Remedy Form Name (not display name), eg. People is CTM:People | |
| Query: | The query to search by |
| Name | Description |
|---|---|
| Handler Error Message | Error message if an error was encountered and Error Handling is set to "Error Message". |
| List | |
| RequestIdList | |
| InstanceIdList | |
| Count |
Remedy Generic Find V4 (2020-01-23)
- Updated disable caching logic to improve performance
Remedy Generic Find V4 (2020-01-18)
- Updated readme note about disabling cache
- Removed logging message when cache is disabled
Remedy Generic Find V4 (2019-04-22)
- Updated readme and changelog
Remedy Generic Find V4 (2019-03-25)
- Added ability to disable caching
- Added error message/raise error error handling
Remedy Generic Find V4 (2019-03-25)
- Added NDNF to handler
Remedy Generic Find (2012-05-29)
- Initial version. See README for details.
V2 *Added instance ID list to returned values.
V3 *Generic Handler could not use the preinitializeonfirstload method. Instead getremedy_form is used to load the form and add it to the cache
V4 *Added a count to the returned values.
V4 Update (2017-Jun-27) *Made it possible to return 0 values without causing/raising error.