Deploying (Go to Production)
Lynn provides its users with two environments for managing configurations of components and logical flows, these environments are the Development (Developer) environment and the Production (Production) environment.
The step to production tool is oriented to the administration of all configurable and manageable resources between environments, it gives the possibility to visualize by categories or individually the elements that are affected to pass from the development environment to production, this tool also automates the visualization of productive change audit, as well as it is able to store state captures on the environments. The affected categories are:
Application (Tenant): Represents the macro of all elements and categories related to the application.
Kyubo: Resources associated with Lynn's messaging center, where subcategories of this can also be accessed: working groups, skills, agents.
Flow: This category encompasses all elements associated with the flow with the exception of channels. It presents the subcategories: Intentions, action cases.
Users: This includes all users and their corresponding registration between environments.
Widget: Associates the changes in styles associated with the theme editor and configurations.
Cognitive: Configurations associated with cognitive mappings.
In the development environment, users with higher roles than editor oriented to "Lynn Core Certified Developers" certificates will have access to: create, update, delete and read the configurations of each of the components of the flow, in turn it must be considered that in the production environment no change can be made in the developed flow and this will be limited to the visualization and configurations of the productive environment such as the establishment of productive channels, visualization of reports and configurations such as maintenance windows, among others.
Below is the use of the management tool of elements between environments, the one in charge of managing steps to production (PAP) between the Lynn environments.
To access the deployment to production tool, locate the "Deploy to Production" icon within the Tenant's Tools Menu.
You can also access the deployment to production tool by selecting the relevant elements. The selected elements will then be queued for deployment to production; select accept to promote the elements on your list.
Elements marked with a warning are already considered for deployment to production, so they can be removed from your list.
Note:If the option is not available, you must contact Lynn support and request permissions for your access.
Note 2: The preview version of the functionality is identified as the "new deployment tool".
The production step tool will show the Lynn application flowchart in which the existing elements are represented. Press the (+) buttons to expand each branch of the flowchart or (-) to retract it, as shown in the following image:
Note:If your app is not yet available in production, an alert will appear indicating that it will be the first step to production.
From the organizational chart you can make production steps of all components within the application (Tenant) or a particular component. To make a step to production, you just have to click on the element of interest and request its deployment.
Deploying the application.
The Go Live of the application includes the following components:
Kyubo Work Teams.
☑️ Perform integrity validation of the logic flow before deploying flow or entire application.
☑️ Widget configurations are not promoted from PaP application (Tenant) option.
☑️ It is highly recommended to download Snapshots (state captures) from development and production environments before performing a PAP. This will allow you to revert your changes if necessary.
☑️ The cognitive context of the development application will NOT be updated in production with this option.
☑️ Channels connected to the destination environment are not affected by application PaP.
☑️ Once the application PAP is initiated, you cannot cancel the operation.
☑️ By default, when creating a new application (tenant), only the testing environment will be available. After the first move to production, you will see the production environment's production deployment functionality activated.
☑️ For clients requiring an additional environment for testing or QA purposes, they must request activation through their partner or sales advisor. This new environment will act as an intermediate environment between testing and production. To see how the deployment from the QA environment to production is performed, please refer to the section titled Deployment to Production - Application with 3 Environmentsin the same document.
The production deployment of the application provides the options shown in the following image:
Deploy Option: Allows deploying all application components. When selecting the "Deploy" option, you will see two tables (source table and destination table). Source table corresponds to the Development (Testing) environment and will show the total of components to be passed to production. Destination table (Production) will show the components or elements currently available, if this is your first step to production the destination table will not show any elements.
1- To perform the deployment to production, select the "Deploy to Production" (>) button shown in the following image:
1.1 .- Deployment to Production - Application with 3 Environments: For tenants that have the QA environment enabled, the previous window's display changes in the source and destination names. From the testing environment, the source is labeled as Testing, and the destination is labeled as QA. Finally, to make your changes available in the Production environment, you will need to access the QA environment and promote your elements from QA to Production from there.
2- Upon performing this action, Lynn will send an email with the verification code to perform the deployment to production, check your inbox and look for the email sent from the official email address (email@example.com):
3- Use the verification code in the “Verification code” field, then confirm the deployment to production with the “Confirm” button.
4- After confirming your deployment to production, it will be notified that the deployment has started, then you must wait for the loading bar to reach 100%, this will indicate that your deployment to production has been successfully completed.
The progress bar is at 100%
5- Wait 10 seconds for your destination table (Production) to update to verify your changes, or go straight to the Production environment and you will notice that your components have already been promoted.
Option History: The history option of the application shows a summary of the last PAPs that have been performed in this application and identifies the date and the user who executed it.
Option Download Backup: It will allow you to download a state save or "snapshoot" from the requested environment.
Option Apply Backup: It will allow you to apply a backup (BackUp or snapshoot) to the environment, restoring its state to a previous one.
Option Backups: Every time you make a step to production, Lynn will automatically save a backup of the destination (Production). In the "backups" option you can download and apply the last 20 steps to production you have made.
Deploying on Kyubo
Is available for customers using Kyubo, both step up to production and step up to testing for certain components (this to synchronize environments).
Kyubo's step up to production includes:
It is recommended to use this option to promote all the elements available in Kyubo from your application. This option allows to promote Skills and Work Groups from Development to Production and vice versa, but does not allow to promote Agents from production to the development environment.
- Workgroups and Skills Deployment: The deployment of workgroups and skills from development to production or from production to development of the selected components, as in the previous examples, you must press the "Deploy to Production" (>) button and you will see the element in the destination table (Production):
Important Note Regarding Deployment from Production: If you are a Kyubo user, from the production environment you will still have the option to promote workgroups and skills. The other options will be blocked, as shown in the following image.
- Agents: The production deployment of agents allows you to promote the selected agents from the development environment to production:
Deployment of workflow
To promote the flow elements, select the component of your interest and click on "Deploy". As in the previous cases, the source table will be shown on the left showing the development environment (Testing) and the destination table on the right (Production). Select the elements to promote and wait for the process to finish.
The elements in the table will be promoted one by one. If you try to promote more than one element, the pending elements can be cancelled with the (X) button. The table will also show you the elements that have not yet been promoted by displaying the element's name as shown in the image.
Below, we will describe how to deploy everyday components:
- Intents: In this case we will analyze the production deployment of the Intent (INTENT) associated with a case with two actions.
To deploy to production we select the intention option within the organization chart and follow the instructions described above.
From the result shown below we can observe that, when deploying an intention to production, all its associated connections (case and actions) will also be deployed.
- Accions: We will go into production on an action (DIALOGUE_2) associated with a case and an intent.
We will go into production on an action (DIALOGUE_2) associated with a case and an intent. To do the production rollout of the dialogue, we select the Actions option in the org chart and follow the instructions above to do the PAP.
As we can see in the following image, when we go into production of the dialogue, only this action has been passed. This applies to all actions that you want to go into production.
Important: If an action is going live, the intent and case will NOT be pushed to production.
- Cases: We will now proceed to production a case connected with two actions. Note that one of the cases has a navigation mark connected, the navigation marks are associated with an entity.
To proceed to production of a case, within the organization chart we select the cases option and follow the previous instructions to perform the PAP.
After the production phase, we can observe that all actions have been successfully promoted to production, however, it is noteworthy that the entity responsible for the navigation mark has not been promoted to the production environment.
Important: The production phase of a case will only promote it and the actions associated with it.
The production step of users enables other Lynn users to have access to the Tenant and their Views (Layouts). Make sure your user is in the target table in case they don't have access to their views.
Deploying the Widget
Configurations for the widget are not promoted when a general Tenant production step is taken. These design configurations must only be promoted from this option, this option promotes the configured design from your application.
Note: if the associated styles or themes do not update their visual when implementing a change or passing it to production, you can apply the “RefreshCss” instruction, which will force a memory refresh over the associated resources. For this, append to the URL of the widget presented in the embedding script the following bar: *[widgetURL]/RefreshCss
Deploying Cognitive Contexts
This option allows you to promote the cognitive contexts configured in your tenant. This option NO change your cognitive context evaluator in the production environment. If you need to change or update the default cognitive context, go to the destination environment and update it in the cognitive context configurator.
Recommendations and Observations of Interest
Remember that actions on environments must be managed by Lynn certificates and it is strongly recommended to carry out validation and save state actions prior to environment synchronization activity.
Changes made in a logical production pass (PaP) from the management tool between environments will take effect for new sessions managed by the messaging module from the end of the synchronization process and will not affect those already established.
Prefer logical PaP in low traffic time windows.
Remember to update the maintenance window in the application booklet and avoid coinciding your PaP with said window, if required inform our support team of said coincidence with at least 24 hours notice.
Periodically save the status of your application by means of a snapshoot or "state capture", this will be of great help for the progression and maintenance of your application in function of activities of design of logical flow and configurations on the same.