Documentation of Features

This is just a short list of some of the features available within our website pulled directly from our internal Help system.

Help Manager

Managing Help Text Access and Editing

To control who can edit Help content:

1. Navigate to Client Control > Users.

2. Select a user, then set their permission for Allow to Edit Help.

Users with this permission can edit Help text throughout the system, including any area where a Help button is available. If a user does not have permission and no Help content has been added yet, the Help button will not be visible to them.

Editing Mode Settings

To choose whether Help text is edited in WYSIWYG mode:

• Go to Site Management > Settings (found at the bottom of the menu).

• Look for the option to toggle WYSIWYG editing for Help content.

Adding a Help Button to a Page

To display a Help button on any PHP page, use the following code:

Place the $pgHelp variable wherever you’d like the Help button to appear.

Multi-Language Manager

To make a PHP page support multiple languages, include the following code:

$pgHeader = wtkLang('Language Management');

When a user visits the page with a preferred language other than English, this will trigger the wtkLang function, which automatically adds the string to the wtkLanguage data table (if it's not already there). You can then use the Generate Language via AI feature to create translations for that text.

Once a translation is generated, the system will automatically display the appropriate language to users based on their preferences.

Managing and Editing Translations

You can search for and edit any translated text directly from the Language Management page.

Adding New Language Options

To add new languages for users to select click here or:

1. Go to Lookups.
2. Filter by the LangPref category.
3. Add the desired language options.

Automatic Translation for UI Elements

The wtkLang function is also used automatically for:

1. Form field labels
2. Column headers in reports

This ensures consistent language support across your application.

SQL Report Wizard

Filtering @Tokens@

On this page you will see which tokens can be added within your SQL SELECT or WHERE and they will be automatically replaced by data and passed parameters.

For example, if you put in something like:
WHERE `UserUID` = @UserUID@
that will automatically replace the @UserUID@ with the currently logged in user's UID (wtkUsers.UID). This can be very useful if you want to create a report that only shows a user data related to their account.

Sorting Functionality

Each column that you want to sort should be on a separate line in the "Sorting" box. This function can take 1, 2 or 3 parameters. Note, as usual spaces will be automatically be inserted for WordCaps or snake_case. For example, 'FirstName' will be changed to 'First Name'.

One Parameter

This uses column named `Count` and leaves headers as "Count" and sorts by this column.

Two Parameters

This uses column named `LookupDisplay` but shows the header as "USA State". It sorts by the `LookupDisplay` column.

Three Parameters

This uses column named `DOB` but shows the header as "Birthday". It sorts using u.`BirthDate` column. This is really important when formatting causes problem with sort order. For example if your date format is '%b %D, %Y' then sorting by that would not give the results you want.

Example

Here is an example SQL query and the associated Sort Options.

SELECT p.`UID`, u.`FirstName` AS `Owner`, p.`PetName`, p.`City`,
    DATE_FORMAT(p.`BirthDate`,'%b %D, %Y') AS `DOB`
  FROM `pets` p
   INNER JOIN `wtkUsers` u ON u.`UID` = p.`UserUID`

Sortable Columns

Owner
City, Town
DOB, Birthday, p.`BirthDate`