Please enable JavaScript to view this site.

Process Designer

Navigation: Javascript API > General

Change overview

Scroll Prev Top Next More

All JobRouter JavaScript API changes are listed here.

Changes in version 2023.2

Following features were added for the JobRouter App:

jr_show_subtable_field

jr_hide_subtable_field

jr_set_subtable_field_readonly

jr_get_location

Changes in version 5.1

The definitions of the API functions is available as npm package. The package can be included in an IDE to get auto-complete suggestions for the API functions when developing your own scripts.

Changes in version 5.0

Additional functions are supported in the mobile dialog for the JobRouter App. For more information, see chapter Mobile View.

Changes in version 4.3

The following functions were added:

jr_open_section

jr_close_section

As of version 4.3.5 the functions jr_viewer_stamp_create, jr_viewer_stamp_activate, jr_viewer_stamp_remove can be used not only in the dialog integrations, but also in the FILE and ATTACHMENT elements.

Changes in version 4.2

The deprecated function jr_refresh was removed. Alternatively, the functions jr_sql_refresh and jr_subtable_refresh are available.

The functions jr_viewer_stamp_create, jr_viewer_stamp_activate, jr_viewer_stamp_remove were added to manage the stamps for a JobViewer 2 integration dynamically. After their creation, the user can place the stamps on a document.

Changes in version 4.1

The function jr_set_step_action_label was added.

Additionally, the function jr_set_disabled was activated for mobile forms. It works as usual, but it is not possible to disable single RADIO elements of a specific RadioButton group.

The function jr_sql_refresh is available for mobile forms to activate SQL_LIST elements.

With the mobile form function jr_set_value the form element value can be changed.

The functions jr_show_table_column and jr_hide_table_column were added, whereby columns of SQL table elements can be displayed and hidden.

Changes in version 4.0

Placeholders in process messages used in JavaScript support the same format as used for messages in PHP now: #{Placeholder}. The previous format [Placeholder] will be supported furthermore, but is defined as outdated and should be converted in the existing process message.

A function can be added as last parameter to all API functions, where hitherto an alert has been displayed when an error occurred. This function will be performed in case of an error instead of the usual error processing .

The following functions were added:

jr_set_window_title

jr_show_step_action

jr_hide_step_action

New functions are available to display messages in a form:

jr_notify_success

jr_notify_info

jr_notify_warn

jr_notify_error

The following functions were modified:

jr_show_subtable_column
The new optional parameter radioValue make it possible to display specific columns of a RadioButton group.

jr_hide_subtable_column
The new optional parameter radioValue makes it possible to hide specific columns of a RadioButton group.

jr_get_label and jr_set_label
This function enables the access to the title of a form page.

jr_select_pagejr_select_page
As of now this function supports only the name of the page to open in the form and doesn't support the the index number of the page any more.

Additionally, the JavaScript-API was activated for mobile clients and the following functions were added, whose functioning corresponds with the previous behavior of JobRouter:

jr_get_value

jr_hide

jr_set_required

jr_show

Changes in version 3.8

The following functions were added:

jr_get_instance_id

jr_get_subtable_checked_row_ids

jr_set_background_color

jr_set_table_background_color

Changes in version 3.7

The following functions were modified:

jr_add_subtable_row
In version 3.7.0 the parameter for the number of rows was changed so that besides the number also the content of the rows can be committed as JavaScript objects. Furthermore, the parameter finishCallback was added.

Changes in version 3.6

The following functions were added:

jr_subtable_init

jr_set_dialog_unchanged

jr_has_dialog_changed

jr_disable_dialog_changecheck

jr_enable_dialog_changecheck

jr_is_dialog_changecheck_enabled

onUnload for forms

The following functions were modified:

jr_add_subtable_row
In version 3.6.1 the optional parameter ignore MaxRows was added.

jr_remove_subtable_row
In version 3.6.1 the optional parameter ignoreMinRows was added.

Changes in version 3.5

The following functions were added:

jr_execute_dialog_function

Changes in version 3.4

The following functions were added and documented:

jr_reset_value

jr_show_page

jr_hide_page

jr_select_page

jr_get_table_value

jr_allow_send

jr_get_subtable_count

jr_get_subtable_max_id

jr_set_subtable_display_value

Additionally, this manual describes new form results that are performed when the form actions are confirmed (like for example, requests, assignments, etc.).

Changes in version 3.2

In version 3.2 the JobRouter JavaScript API was released.