eForms Assistant Setup
The eForms Assistant Setup page provides the setup needed to configure eForms Assistant for use in an environment. It is primarily intended to be a "set it and forget it" page. However, it does provide a few pieces of functionality that may be useful after the initial setup is complete. Before first using this page to set up the eForms Assistant, you must obtain your specific Client Key values from Gideon Taylor. These can be obtained by sending a request to Gideon Taylor Support.
Navigation: Main Menu > Manage GT eForms 3.x > GT Functional Setup > GT System Setup > eForms Assistant Setup
eForms Assistant Environment Setup
NOTE: To make sure this setup data does not require special consideration during environment refreshes, we recommended adding ALL Client Keys and Database Names to the lowest environment being configured. As this data is migrated up your environment stack, each key will need to be activated in the target environment only once. After the setup has made it to production, each key should have been activated and future refreshes of lower environments will automatically use the correct key based on the Database Name.
Information should be entered into the eForms Assistant Enrollment Setup grid.
| Field | Value |
|---|---|
| Enabled | This checkbox can be used to globally enable or disable the eForms Assistant chat interface everywhere in the current environment. It is only editable on the row matching the current Database Name and only after the Client Key has been activated for that row. |
| Database | The value entered here must the Database Name for the environment exactly. (This is the value returned by %DBName in PeopleCode) |
| Client Key | These values are provided to you by Gideon Taylor and are a unique identifier for each environment. You can find information on recieving your Client Keys here |
| Activate Key | This button sends a request to the eForms Assistant to activate the Client Key. Each key can only be activated once. The button is only enabled for the row where the Database Name matches the current system value, and it will be disabled once the key has been successfully activated. When entering a new key value, you will need to save the page before you can use this button. |
| Client Info | Once the client key is activated, clicking this button will send a basic info request to the eForms Assistant web service. It’s a quick way to check that your current environment is successfully communicating with the service. |
NOTE: As mentioned on the page, once a client key has been activated, it can no longer be changed. If for some reason a change needs to occur, please contact Gideon Taylor Support.
Deploying the eForms Assistant Tile
The eForms Assistant tile can be used as a way for users to launch the assistant from any Homepage. Deploying the eForms Assistant tile is optional. Clicking the Deploy Button will create a new eForms Assistant tile and place it in a tile folder named GT eForms User Tools. It is not added to a homepage by default, but once created you may add it to any Homepage where it will be useful to your end users. Note: After clicking the Deploy Button, you may need to refresh the page the first time to see the updated deployment status.
More information about the eForms Assistant can be found on these pages:
Enabling eForms Assistant
eForms Assistant Form Type Configuration