Step by stepStep: | IntroductionOnce in every two months releases with update packages of TOTVS Smart Analytics will be published, which will be available on the Customer Portal, and the client will be free to update the product according to its needs. Packages include the latest default project, with graphic modeling, graphs and Scripts MAQL of modeling, apart from Agent and its configuration files. This article mainly intends to instruct the steps that must be followed to update the whole project. To make the process easier, the route is divided in 2 possible scenarios: - Scenario 1: There is no customization, that is, the customer keeps TOTVS Smart Analytics default project.
- Scenario 2: The The customer customized the project, in order to meet its needs. In this case, the project maintenance and update process is of total responsibility of the user. But in this article, some points will be clarified to make this procedure easier.
The first step, for both scenarios, is to download the package with the new version of TOTVS Smart Analytics and the Agent package, save and extract the packages on the same folder where the older projects are kept. Then, recommendations of good practices are listed, which must be executed before starting the following steps: - From the start moment of the update process, it must be completed until the end, involving modeling, ETL and Agent. If any step is incomplete, errors may occur.
- It is crucial to remove Schedules (appointments) that are on GoodData, in order to not start a new load execution, before the update is completed, which might generate errors.
- For Scenario 2: The user must remain using its own customized project, and edit it as the updates are added, instead of modifying the default project. It is also recommended to backup the customized project before starting.
Once these actions are completed, the user may continue the update process of TOTVS Smart Analytics. The process must always follow the same sequence: first, the update and release of modeling, followed by the project deploy, and finally, update of Agent configuration files. Scenario 1Scenario 2 | Deck of Cards |
|---|
| | Card |
|---|
| default | true |
|---|
| id | Cenário 1 |
|---|
| label | Cenário 1 |
|---|
| Modeling Backup and UpdateOn scenario 1, it is strongly recommended to the user to backup the modeling, in order to avoid future errors that may occur, then publish the latest modeling. Modeling backupFollow the steps below: - Access the model folder within the project structure, right-click in New / Logical Data Model.
|
|
 Image Removed Image Added- Name the file as you wish and click Finish.
|
|
 Image Removed - Image Added
- On the menu window Details (at right) click Import / GoodData Project.
|
|
 Image Removed- Image Added
- Select your project name GoodData, click OK and save the modeling.
|
|
 Image Removed- Image Added
Modeling updateAfter saving the backup, follow the steps below to update the modeling. - At first, open the default project updated on Cloud Connect, following the steps below:
- At left, click on View Navigator / Import. Image Added
|
|
 Image Removed - On the dialog window, select General / Existing Projects into Workspace. Image Added
|
|
 Image Removed - Keep the option Select root directory, and click Browse.
|
|
 Image Removed- Image Added
- Select the path and click the project you wish. The project folder to be selected must have the following structure:
|
|
 Image Removed- Image Added
|
|
Click - Click OK.
- Back on the dialog box, click Finish.
- The project will be opened on the tool.
- Double-click the folder Model
|
|
folder- .
- Double-click the file: TOTVSSA.mdl.
- Click Publish model to server. In this moment, a comparison occurs between the content of GoodData cloud and what is on the local disk.
|
|
 Image Removed- Image Added
- After viewing the modifications (you may also view the script MAQL), click OK, to proceed.
- Wait for the message informing that the modifications were successful and click OK.
ETL process updateThere are two ways to re-deploy the project and update the ETL process of TOTVS Smart Analytics. In one way, you must only access the project in analytics.totvs.com.br, on the other, it is crucial to use the Cloud Connect tool. These very same steps will be followed by users that are eligible for Scenario 2, after other procedures explained on the proper section. |
|
First wayOn the upper Menu click Manage and select - No Menu superior clique em Manage e selecione Data Integration Console. Image Added
|
|
 Image Removed
- In Overview you may view all projects published.
- Select the published project you wish, click Re-deploy.
|
|
 Image Removed- Image Added
On the opened dialog window, click Browse, and select the compacted project where the download was performed on the Client Portal.
|
|
InvoiceIcon following these using this steps on Scenario 2, do not forget to compact the project again, with the customizations . |
|
|
- In Process Type, keep Cloud Connect and in Process Name, keep the same name, preferably.
|
|
 Image Removed- Image Added
- Click Re-Deploy and wait for the load to
|
|
end way Method (using Cloud Connect):- To open the Cloud Connect project, follow the steps from "i" to "vii" illustrated on step A of item Modeling Update above.
- Access Server Explorer / GoodData Projects.
- Select the project you wish to re-deploy, select Set as Working Project for "Totvs Smart Analytics". Image Added
|
|
 Image Removed- In this project selected, expand it clicking on the arrow at the left of the name. Expand the folder Processes again.
- The project that is already on the cloud will appear. Right-click it and select Re-deploy.
|
|
 Image Removed- Image Added
- Wait for the message
|
|
that the was successfully performed- .
Update of Agent configuration files my.properties To update the my.properties file, follow the steps below: - Open the file my.properties, located on the package Agent, with a text program.
|
|
 Image Removed- Image Added
- Complete the information again regarding login, password, project ID, metadata ID and connection with Database (use the previous version, already completed, as reference).
- Upon completing, save the information.
run.bat
In both scenarios, check the status of your run.bat within Agent package. This file must be reference for the new version of the Agent within this very same package, and for my.properties that the user just configured with the steps above. In such cases, the previous version of the customer has extra parameters to improve performance, for example. It that is the case, add the parameter for run.bat updated. Following, two examples of the structure of the run.bat file. One example consists on general structure, the other, illustrates a parameter added in order to improve performance: Image Added Image Added |
|
 Image Removed Image Removed| Card |
|---|
| default | true |
|---|
| id | Cenário 2 |
|---|
| label | Cenário 2 |
|---|
| On scenario 2, the user is responsible for maintenance and update of its project. The update of a customized project demands extreme caution by the user, to not lose its customizations nor updates published, therefore there are some recommendations to follow: |
|
·Do - Do not publish modeling and the project re-deploy from the package downloaded from Portal, because the project published will be replaced and customizations will be lost.
|
|
·The - The first step must be Release Notes analysis (available on the Customer Portal) because all necessary information regarding the update released are there. From it on, the user may evaluate if what was update will interfere in its customizations.
|
|
·As - As previously warned, by proceeding with the update of the customized project, perform it on your local project, never overwrite the standard project of TOTVS Smart Analytics.
ModelingTo simplify the modeling update of users that have customizations, the TOTVS Smart Analytics package integrates MAQL scripts of modeling. Follow the next steps: |
|
a.Access GradeIcon field <IDfield <ID_PROJETO> with the ID regarding its project. |
|
|
b.- Open the MAQL scripts of modeling, copy the script and enter it on the proper space. Image Added
|
|
c.d. on - the access link. Image Added
|
|
e. Success Warning Icon- Image Added
| Nota |
|---|
| If the user does not keep updates as the latest, the MAQL Script of the last publish, would probably be incomplete. Therefore, the user must compare the modeling published on the cloud of its project, with the latest default modeling. You may use the Cloud Connect tool for this analysis. |
ETL process update
With the aid of Release Notes (available on |
|
the the Customer Portal), the user may update the graphs of its project, in order to not interfere with its customizations. By completing the graphs development, as wishes, the user may re-deploy the project, according to the steps of the item ETL process update |
|
of WarningIcon | Remember, use an own project for customizations and updates, and never edit |
|
|
the default the default project of TOTVS Smart Analytics. |
Update of Agent configuration filesmy.properties:
To update my. properties, the user may also need to pay attention. Execute a comparison between the my.properties published on the Customer Portal |
|
and and my.properties customized, to perform the proper alterations. In this case, as suggestion, you may use the text comparison |
|
program WarningIcon | The project ID information, |
|
|
Smart Analytics login, access to Database and path for JDBC may be copied from the previous version, if not edited. |
run.bat
To check this file, follow the same steps of the Scenario 1, |
|
on the item Conclusion
Finally, the update cycle is completed, and from then on, the Schedule of load execution may be executed again. |
