Catalyst 19.12.2



19.12.2 comes with Self Upgrade 1.0 System.

What is Self Upgrade 1.0 ?

It is a system developed to switch from Dev or Master versions to stable versions or to automate and facilitate the transition between versions.
> Help > Release Notes links are available to access.

This page lists the current version of the server and the released versions. When you enter the versions, you can see the innovations and changes.

If you are using Workcube on Dev and Master branches, it is not recommended to use this branch in production environment. The dev version is a development environment for developers and is likely to encounter potential bugs. The master version is the version in which pre-release QA is done and errors are tried to be fixed. Those who use open source code mostly prefer to work in the Master version. Although this provides speed to see and pull the latest developments, it should not be forgotten that it is a beta version.
-

Workcube Community develops on a universal system called Git, and uses the QDDD approach and working to enable users to work with error-free software and speed up development.

Self Upgrade is developed to make the transition between versions effortless and error-free, and it is open to the authorization of "admin" users.

Self Upgrade works in two ways.

  1. Upgrade from master branch.
  2. Upgrade from version to version.


Attention to those who will switch from master to version!

  1. Get your backup.
    Take a backup of the directory where the Workcube files are located. Have backups of your customized files in case of any problem.
    It is very important to back up the objects/xslt, objects/xml and add options folders in order to avoid problems with e-government products.
  2. Make sure Git is installed globally in your Sourcetree installation.
    Click here to verify that Git is installed globally and make any necessary adjustments if not installed globally.
  3. If your Coldfusion version is CF11, make sure your Java version is 1.8.0_212.
    If not, update your version.
  4. Make sure your WRK_LICENSE table has at least 1 row.
    If there are no rows, you can add 1 row manually via the db, with random data.
  5. Make sure your Session Timeout is a minimum of 90 minutes.
    To check: You can display the Control panel > Other pane.
  6. Pull the Workcube to the Master Branch, which is managed with Sourcetree, which(Sourcetree) is installed on Git in the directory where the Workcube files are on your server.
    For this, you must perform the FETCH process first and then the PULL process.
  7. After pulling the master branch, run the updated WRO and languages.
    For this go to Control Panel > System > Maintenace > Workcube Upgrade page, Click the Import button, run all the WRO scripts in the list. Then click on the Language Scripts button, check the Dictionary checkbox, select Last 1 year as the date range and press the Upgrade button.
  8. Make sure that the customizations made specifically for the customer or the AddOption or AddOn files are in their correct places.
    Customer-specific files must be added to the AddOptions_File_Path or AddOptions_Controller_Path fields within the WO records. If these fields are empty, Self Upgrade will update these WO's, if these fields are full, it will not update these WO's.
  9. System Parameter Settings
    The params files are written manually in the master branch. With Self Upgrade, Workcube Params settings have been converted to dynamic settings and JSON file that can be set. Check the fixed existing WMO/params.cfc file on the server. By reading the data in this file, Self Upgrade will create a dynamic JSON form. Make sure the settings are correct.
  10. Buglog
    The buglog.buglogautonotify value is set to true for automatic buglog-error reporting in the system parameter settings. If you do not want the buglog notification to be made automatically, you must set this setting to false.
  11. BigData ve Mongo Settings
    For businesses that want to monitor detailed logs and work with big data, a MongoDB add-on has been made to Workcube. You can get service from our experts to set up MongoDB, connect Mongo to Workcube and use SOLR services.

Self Upgrade Steps 

  • Ask online users to complete their work and logout.
    Before the upgrade, online users must finish their work and log out. During the upgrade, the system cannot be logged in. The system switches to maintenance mode.
  • If you are upgrading from master, fetch and pull the master branch on your server.
    You can do it by going to the Sourcetree interface.
  • Edit System Parameter Settings.
    Check and edit System Parameter settings when going from master to version.
  • Undo developments made to standard files.
    This process returns you to the files that have been officially published by Workcube. It is possible to break away from the main version in Workcube, but it is inconvenient for sustainability. Customized or expanded files should be located in the following two folders. When Self Upgrade finds files that have changed outside of these two folders, it judges that your implementation is not in accordance with standards and quality rules, and harmonizes all non-standard files with the version. In this case, please contact your authorized business partner or system administrator.
    • Addons/Your ProjectFolder
    • V16/add_options
  • Upgrade to Current Version
    Self Upgrade upgrades your system to the version you have chosen at this stage. All new files that have been bugfixed, optimized and compatible with your license are uploaded to your server.
  • Running WROs
    Workcube Data Release Objects run newly opened tables, newly opened or changed columns in your database and are synchronized with the new version database model. WRO also works to save data changes or new settings to the database.
  • Schema Compare
    Opens the new version's data model as 4 schemas (Main / Company / Period / Product) using the "_compare" expression. Thus, after the upgrade process is completed, you can check the manually opened table, column and view controls on the Workdev > SC screen and correct the deficiencies, if any.
    Note: CFServer access passwords are used for this process.
  • Language Upgrade
    It refreshes all words and sentences in the Workcube interface by connecting to Workcube Update Web Services. All dictionary items are refreshed when migrating from master to new version. This process may take a long time depending on the processor, memory and bandwidth capacity of the server. In the transition from version to version, this process only covers the dictionaries that have changed.
    Note: Dictionary items made is special do not change. Dictionary items that have been modified but whose Is Special checkbox are unchecked are crushed.
  • Solution, Family, Module, Objects and Widget Upgrade
    The solution upgrades Workcube objects (fuseaction) and widgets grouped under Job families and Modules. All objects are renewed when switching from master to new version. This process may take a long time depending on the processor, memory and bandwidth capacity of the server. In the transition from version to version, this process only covers the changed objects.
    Note: If the AddOptions_File_Path or AddOptions_Controller_Path fields are filled in the WO records, these objects are not changed. If these fields are empty, Self Upgrade will update these WOs.
  • Application Restart
    After the upgrade, the application is restarted. Login screens will be active.

Transactions that need to be edited on servers that have passed from master to release

  • Check the customized files. Self Upgrade crushes any non-standard customizations. Reconfigure the files you have backed up for your non-standard uses in accordance with the quality rules.
  • Check the authorization groups. Module reporting authority and module power user authorization in authorization groups can prevent users from accessing.
  • Set GDPR authorizations in order to protect personal data in authorization groups. Dynamic payroll, Leave severance report, Overtime report, Wage allowance listing GDPR-Financial top confidential information is shown to selected users.
  • Check and update your e-Government settings and templates.
  • In older versions the templates are located in the objects/xslt folder. Newer versions get the templates from the documents/e_goverment/xslt folder. Check that the templates are in the correct folder, rebuild or move them as needed.
  • If your e-Invoice templates are non-customized and standard usage, check the file path of the following three WOs in Workdev > WO.
    • invoice.popup_preview_invoice > File Path: e_government/display/preview_invoice.cfm
    • popup_create_xml_earchive > File Path: e_government/display/create_xml_earchive.cfm
    • popup_create_xml > File Path: e_government/display/create_xml.cfm
  • If you are using e-Invoice as add options, make the following edits.
    • Change the "v16.objects.cfc.einvoice" path to "v16.e_government.cfc.einvoice" in component usage in the incoming E-Invoice, Taxpayer Transfer and E-Invoice Status Inquiry report.
  • Perform the following checks as HR Leave approval mechanisms go through dynamic process management.
    • Define the approval processes. Update the action files, if any. Otherwise, define the action file suitable for your process from the standard action files.
    • Update the leave periods. (Half-day leave in the Morning, Half-day leave in the Afternoon)
    • Edit the HR Leave detail page XML according to your company working hours. (XML should be edited for each company)
    • For the Permission and Excuse categories from the parameters, define the upper category, if any. You can set the maximum duration for the leave and have the deserved one displayed on the leave screens.
  • Define the Transaction Category and Process for the Additional Allowance.

Recommendation:
Install a Workcube where you can test with the "qa.domain" connected to the production database in the directory where the production server is located. Get new versions here first. Have a new and old version in transitions. Thus, customized codes, sectoral add-ons or potential errors do not harm business continuity.

db access is provided for QA and Production site. However, the document path for designs, codes and digital archive should be for QA setup.

Do not keep the testing phase less than 1 week in the transition between versions. Get users to do the same work in both versions. You're in control of your Mission Critical work.


UPGRADE QUESTIONS AND ANSWERS

  1. I'm getting an error when viewing the release notes page, what should I do?
    This problem usually occurs when your system is running in offline mode, that is, off internet access. The simplest way to eliminate this problem is to make your system accessible to the internet. If this is not possible, you must authorize access to the networg.workcube.com and devcatalyst repo environment.
     
  2. What should I do if I get an error when switching from master to parameter settings configuration form page or when saving parameter settings?
    This problem usually occurs because license information is not logged when your system is first installed. Please contact Workcube.
     
  3. What should I do if I'm having trouble undoing standard file enhances during version migration?
    If any file in your system contains special characters, the discard operation in the Upgrade system may not discard these files. Another point to note is that if you deleted any file directly from the directory, git detects this deletion, and the version system expects you to discard it.

    If the 2 situations I mentioned above are happening at once, manual intervention is required. You can do manual intervention in 2 ways.
    you must discard the file with tools such as git commands or sourcetree-github.
     
  4. What should I do if I get an error in switching to the current version of Workcube?
    Branch changes or pulls are made on git in version migration and patch purchases. Therefore, commands are run on windows via global git. Problems that may occur at this stage are usually caused by git not being installed globally.

    If there is no global installation or if you want to check whether it is installed globally, you can review the article in the link.
    https://stackoverflow.com/questions/26620312/installing-git-in-path-with-github-client-for-windows/49698535#49698535

    Another point to consider is whether your operating system authorizes Git to write in the system home directory. You can check the permissions under right-click on your project home directory > properties > security > Group or Usernames and if there is no authorization, you can give authorization by clicking edit.
     
  5. Some of the stages give an error on the setup screen of the comparison schemes, what should I do?
    If the flag icon is lit red at any stage of the comparison chart setup, you can find out the reason for the error by clicking on the flag icon. The main error experienced at this stage is due to the fact that the sql or cf user information is not entered correctly. If your CF user password is incorrect, your datasource connection cannot be made in Coldfusion and a login connection cannot be established with the sql information you entered. Another error that may occur at this stage is that the SQL Server IP or port information is not entered correctly on the parameter settings page. If the sql server ip or port information is incorrect, the upgrade system cannot install the comparison schemes in your database. If you think that this information is incorrect, you should start the upgrade process from the beginning and enter the correct information on the parameter settings page.
     
  6. Solution, Family, Module, Object, Language etc. I am getting an error in one of the steps while importing, what should I do?
    This problem usually occurs when your system is running in offline mode, that is, without internet access. The simplest method to eliminate this problem is to open your system to internet access. If this is not possible, you will need to grant access to dev.workcube.com and release.workcube.com.

Feedback

Did you find this content helpful?
Related Contents