Guide to Using the AE.ApplicationInterface
There is some important information to note when using the AE.ApplicationInterface.
Do's
- Log on - execute all actions - log off.
- Open objects in read-only mode if no modification is being made.
- Modify rather than delete and recreate.
- Only use what is required.
- Use mass functions instead of many individual actions if applicable (no mass function available: contact Automic Support).
- Execute complex mass modifications via the AE.ApplicationInterface in a non-production AE environment and transfer your modifications to the production system using the corresponding utility.
Don'ts
- Loops without waiting time (especially for status queries)
- Creating/modifying an object and storing it repeatedly
- Huge and numerous searches using the class "SearchObject"
Important Notes
- The AE.ApplicationInterface mainly facilitates the automation of user interactions.
- When reviewing applications, put the main focus on recurring processes (especially in processing loops) as performance gains are most likely here.
- In high-volume processing using the AE.ApplicationInterface, weigh up the importance of a fast processing time with the importance of non-impaired production system performance. If the performance of the production system is more important, use the AE.ApplicationInterface in such a way that processing is distributed evenly over a longer period of time (e.g. through waiting queues).
- The aim should be to send as few queries as possible to the Automation Engine. Only call the methods Connection.sendRequest() and Connection.sendRequestAndWait() if necessary.
Negative Effects of Badly Designed Applications
- Dialog users rank second because the AE.ApplicationInterface also uses the dialog processes.
- The performance of the whole AE system is negatively affected because calling the AE.ApplicationInterface represents a write access to the AE , resulting in increased I/O database activity.
