Troubleshooting the KTL

[cortexrd]

In this discussion, we'll demonstrate various methods for troubleshooting the KTL, focusing on identifying and addressing the root causes of any issues encountered.

[cortexrd]

Is it the KTL that's causing the issue I'm seeing?

You see something wrong in your app and you'd like to know if it's the KTL or a Knack bug.

It's always a good idea to sort this out before submitting a ticket to Knack. The last thing I want is you guys bothering Knack support team and engineers with any KTL problems!

So please, always do this test first.

There's a provision to quickly disable the KTL locally on your device, without removing the loader, which would affect all other users.

Here's how it's done:

Disabling the KTL

Here's how to do it quickly, without removing the loader:

1. Click on the Version Info Bar and enter 0000 as the password if you don't have the Developer role

2. Click on Bypass KTL

The app will reload but without the KTL code. You will see all the keywords, and can asses if the KTL is causing the issue.

To revert back to normal (with the KTL loaded), you must close the app and restart it.

Norm

[cortexrd]

Testing “special versions” of the KTL

There are 5 versions of the KTL that can be used:

1. Production
2. Beta
3. Development
4. Local
5. Numbered

We will explain what each mean.

Production

The "Production" version, or "Prod," is the default (standard) setting that fetches the most recent official release. This version is used by the majority of users.

Beta

The "Beta" version serves as a preview of the candidate for next production release. It allows users to test new features, verify bug fixes, and evaluate overall stability before it becomes official. After thorough testing, Beta versions are finalized, assigned an official release number, and moved to production.

Development

The "Development" version, or "Dev," is a stage that can encompass a wide range of content, from experimental features to diagnostic tools. It's designed for short-term, individual use and is often unstable. Usage is coordinated directly between the user and the KTL developer, where both parties agree on its contents and application.

Local

The "Local" mode is designed for advanced coders, allowing them to run code directly from their workstation's hard drive via a NodeJS server. This setup facilitates a rapid cycle of editing, saving, and testing changes.

Numbered

A "Numbered" version refers to any specific release within the production environment, either current or previous. Users can revert to an earlier version by manually selecting its number in the KTL system. This rollback feature is particularly useful for diagnosing new issues by identifying the version where a bug first appeared.

Switching between KTL versions

To change KTL versions, access the KTL Developer Tools and click the top button, KTL Code.

Enter a single letter to select the desired code version—'p' for Production, 'b' for Beta, 'd' for Development, 'l' for Local, or enter a specific version number like "0.24.0."

Confirming your choice will refresh the app to the new version, indicated by the Version Info Bar.

Note: This change affects only your device, not others. To update the version for all users, adjust the version in the Builder within the Loader's code, between the two empty single quotes.

The following lowercase strings are accepted:

• empty (for prod)
• beta
• dev
• 0.24.0 (numbered version)
• local is not supported

For example, if I want all users to use the Beta version:

KnackInitAsync = function ($, callback) { // Load the Knack Toolkit Library (KTL)
    (window.LazyLoad = LazyLoad) && LazyLoad.js(['https://ctrnd.s3.amazonaws.com/Lib/KTL/KTL_Start.js'], () => {
        loadKtl($, callback, (typeof KnackApp === 'function' ? KnackApp : null), 'beta' /*KTL version, leave blank to get latest*/, 'min'/*min or full*/);
    })
};

How to get out of a special mode

To go back to production code, simply type the letter “p” and the app will revert to normal.