Publish Environments
Add a Publish Environment
To add a new Publish Environment follow the below steps:
- Go to the backstage of Teneo Studio (Solution tab) and select Publish in the left-side menu
- In the top right-area, click Add Environment
The drop-down menu allows to configure the below listed types of publish environments:
- Web Application: create a publish environment from scratch
- Local File: create a publish environment which allows to save the solution .war file; currently not available on SaaS environments
- Pre-configured: create a publish environment with pre-configured setup.
Note that the configuration options (in the New environment window) divert a little depending on which type of publish environment the user selects.
Each of the above publish environment types provide the options to create Development, QA, and Production environments.
New Environment Window
The New Environment window, in the left-side, contains an overview of the Environment and the target(s).
The user can add or remove targets by clicking Add target/Remove target in the top right side of the window.
When the New Environment window opens, the Publish environment is pre-selected and its configuration properties displayed in the right-side of the view.
To expand the configuration properties of the target, the user should simply click the target in the left-side of the screen.
When the user has finished configuring the properties of both the environment and the target, simply click OK to save the new publish environment and return to the main Teneo Studio window.
Note that the window differs a little depending on which type of environment is added (Web Application, Local File, Pre-configured).
Publish Environment Properties
The configuration of a publishing environment is divided into the following sections:
- Details: give the publish environment a name and a description
- Icons: add an image to the publish environment
- Testing: set an Auto-test threshold which should be met before publishing the solution
- Republish: define if republish to other environments is allowed
- Session Log Server Configuration select the log archive of the solution
- Virtual Assistant: link directly to the published solution
- Scripts: allows to enter the path name of scripts which should be run after a publishing process
Target Properties
When selecting a target the following options are expanded in the right-side view:
- Details: give the target a name and a description
- License: add license details
- Scripts: allows to enter the path name of scripts which should be run after a publishing process
- Tomcat Container Properties: allows to specify the details related to the Tomcat Container, e.g. the server where the web app will be available
- Admin: add details related to the server that hosts the admin interface of the web application deployment
- Deployment: select if hot deploy should be allowed or not.
Under each section several configuration options are available. Please see the Overview of configuration properties for further information.
Manage Environment
The Manage button next to an existing Publishing environment allows the user to edit the environment, publish or to delete the configured environment.
Delete Environment
It is possible to delete an environment, for example if it is no longer needed.
To delete an environment, follow the below steps:
- Click Manage and next Delete environment
- Teneo Studio prompts the user to confirm the deletion of the environment:
- Delete: select this option to delete the environment without unpublishing the solution
- Unpublish and Delete: select this option to unpublish the solution and delete the environment
- Cancel: select this option to cancel the deletion of the environment.
Please note that management of environments (such as delete and unpublish) when using Teneo Studio in SaaS environments must be requested through Support.
Overview of Configuration Properties
Publishing Environment
Publishing Environment | Properties | Description |
---|---|---|
Details | Name | Name of the publishing environment |
Description | Description of the publishing environment | |
Testing | Auto-test Threshold | The success rate on solution level that the Auto-test should meet before publishing on this environment. A warning will pop up when publishing the solution, but even if the success rate is not met the user is able to publish. |
Due Diligence Confirmation | Additional message that appears in the process of publishing to a production environment. | |
Republish | Allow republish to other environments | If ticked, this option allows to republish a saved copy of a solution to other environments than the current one. |
Session Log Server Configuration | Broker Server | The broker server needs to match the one configured during the installation. |
Port | The port needs to match the one configured during the installation. | |
Log Archive | Log Archives are available through a drop-down menu, please note that Log Archives needs to be set up outside Teneo Studio, in Teneo Manager. | |
Topic | ||
Virtual Assistant | Virtual Assistant URL | The URL entered here will be made available directly on the Publish tab of the Solution window for easy navigation to the concerned webpage. |
Scripts | Post Publish Script | Enter the full path name of any script(s) on the server which should be run after a publish action has been completed. Note that in SaaS environments the Post Publish Script is used for automatic publishing. |
Target
Publishing Target | Description | |
---|---|---|
Details | Name | Name of the publication target |
Description | Description of the publication target | |
License | Use remote license file | Tick/untick if a remote license file should be used |
Remote License File Path | When Use remote license file is ticked, specify the path for the remote license file. | |
License Data | When the Use remote license file is unticked, specify the license data here. | |
Scripts | Post Publish Script | Enter the full path name of any script(s) on the server that should run after a publish action has been completed. Note that in SaaS environments the Post Publish Script is used for automatic publishing. |
Tomcat Container Properties | Server | Name or address of the server where the web app will be deployed. |
Port | ||
SSL Protected | Tick this option if the web app is protected with SSL encryption technology. | |
Context Name | The context under which the web app will be created (in the web address, it is the first string after the server's host name). | |
Admin | Admin Server | Server that hosts the admin interface for web application deployment. |
Admin User | User that is allowed to deploy web applications using said server. | |
Admin Password | The password of the admin user. | |
Log Root Directory | This is the directory where Engine will log the dialogues that visitors have with the conversational AI application. | |
Deployment | Allow Hot Deploy | Tick this option to ensure that user sessions will not be interrupted when a publish action only concerns an update of the knowledge base. |