Work in progress
TODO: What is this about
TODO: Content needs to be updated
TODO: SCREENSHOTS
TODO:
- Write a description of what the agent does and what it is for
- Improve download links
- Add screenshots
The user agent is a client software, that can be run on computers used to control a given instrument.
- Admin -> Bookings-> Agent settings -> New item -> select provider
- Then define the settings.
The agent can be installed from here: https://www.dropbox.com/s/fhyxjkumqgii3nv/IrisUserAgentSetup_1.9.1.19.exe?dl=0.
- After installation you will need to configure the agent by selecting adapt settings (the local admin and provider admins do not require bookings by default):
SCREENSHOT
- You will see the settings screen if you are an admin on the computer:
SCREENSHOT
Explanation of the settings:
- IRIS Base URL: URL to your installation of IRIS
- IRIS GUID: found on "Settings" tab of a resource
- IRIS Secre Key: found on "Settings" tab of a resource
- Agent Behavior:
- Options:
- Incl. Local Admins: by default local admins can login without a booking, but in some cases you may want to enforce on local admins
- Show Clock: will show the countdown clock to the user and allow them to end the session
- Send Email Expired: will send an email if a persons booking runs over the defined booking time (but the booking will continue to auto-extend until they logoff)
- Stealth mode: operates in the background and is not enforced
- Allow postponing agent enforcement: defines how long a user can postpone a booking when they login (if not checked they cannot postpone)
- Clock scaling factor: defines how large the clock the user sees is
- Unlock password: this allows the admins to change settings on the agent (as users may have admin rights so can access settings in some cases)
- Logging level: defines the amount of information placed into logs
- Web Proxy Address: only required if your network is behind a proxy server (many are not, contact your IT if you are unsure)
- Web Proxy Options:
- Enabled: enables the proxy option
- BypassOnLocal: will bypass the proxy for local addresses within your network (typically not used in this case)
- Test Connection IRIS: It is suggested to test this and get confirmation of the connection before saving the settings.
- Exit and restart after saving: recommended to keep this checked
- Save, and the agent will restart.
The agent can be installed from here: https://www.dropbox.com/s/nrlofpjlm0fbh8y/IrisUserAgentSetup_1.9.1.16.exe?dl=0.
- After installation you will need to configure the agent by selecting adapt settings:
SCREENSHOT
- You will see the settings screen:
SCREENSHOT
Explanation of the settings:
- IRIS Base URL: URL to your installation of IRIS
- IRIS GUID: found on "Settings" tab of a resource
- IRIS Secre Key: found on "Settings" tab of a resource
- Agent Behavior:
- Enable Auth: enables integrated authentication
- Enforce Logins: enforce logins according to bookings
- Incl. Local Admins: by default local admins can login without a booking, but in some cases you may want to enforce on local admins too
- Req. Booking if Used: Requires a booking if used
- Stealth: operates in the background and is not enforced
- Send Email if Expired: If a user is still logged in after end of booking it will email the user
- Web Proxy Address: only required if your network is behind a proxy server (many are not, contact your IT if you are unsure)
- Web Proxy Options:
- Enabled: enables the proxy option
- BypassOnLocal: will bypass the proxy for local addresses within your network (typically not used in this case)
- Test Connection IRIS: It is suggested to test this and get confirmation of the connection before saving the settings.
- Exit and restart after saving: recommended to keep this checked
- Save, and the agent will restart.