Frontend Developers Guide

Contents

1  Context and Definition.1

2  Configuration.1

2.1  Resultmaker.OC.Frontend.config.1

2.2  Web.config.1

2.3  DataSelector\web.config.1

3 Client Scripts.1

3.1 Inter‑frame communication.1

3.2 Class: RM_ShowHide.1

3.2.1 Declaring and Using.1

3.2.2 Properties.1

3.2.3 Methods.1

3.2.4 Modes.1

3.2.5 Correct order of modes.1

3.3 Navigation buttons ("Back"/"Continue") functions.1

3.3.1 RM_RenameBackButton.1

3.3.2 RM_RenameContinueButton.1

3.3.3 RM_SetHidingBackButton.1

3.3.4 RM_HideBackButton.1

3.3.5 RM_ShowBackButtonWeak.1

3.3.6 RM_ShowBackButtonStrong.1

3.3.7 RM_SetHidingContinueButton.1

3.3.8 RM_HideContinueButton.1

3.3.9 RM_ShowContinueButtonWeak.1

3.3.10 RM_ShowContinueButtonStrong.1

3.3.11 RM_SetDisablingBackButton.1

3.3.12 RM_DisableBackButton.1

3.3.13 RM_EnableBackButtonWeak.1

3.3.14 RM_EnableBackButtonStrong.1

3.3.15 RM_SetDisablingContinueButton.1

3.3.16 RM_DisableContinueButton.1

3.3.17 RM_EnableContinueButtonWeak.1

3.3.18 RM_EnableContinueButtonStrong.1

3.3.19 RM_EnableContinueButton.1

3.3.20 RM_ShowContinueButton.1

3.3.21 RM_ResetBackButton.1

3.3.22 RM_ResetContinueButton.1

3.4 Collections.1

3.4.1 RM_Addon_Params.1

3.5 Functions.1

3.5.1  Some examples of most used functions .1

3.5.2 getquestion.1

3.5.3 getdescription (obsolete)1

3.5.4 setdescription.1

3.5.5 getquestionname.1

3.5.6 getanswer.1

3.5.7 getdate.1

3.5.8 displaydate.1

3.5.9 RM_getnumber.1

3.5.10 RM_displaynumber.1

3.5.11 getselectedname.1

3.5.12 RM_ActivatePDFButton.1

3.5.13 RM_GetProjectID..1

3.5.14 getquestiontextobj1

3.5.15 RM_ActivateContinueButton.1

3.5.16 RM_OpenLink.1

3.5.17 RM_MoveNext(0)1

3.5.18 RM_GetQuestionType.1

3.5.19 RM_OpenCodePicker.1

3.5.20 RM_OpenFileStore.1

3.5.21 RM_Validate.1

3.5.22 RM_GoToActivity.1

3.5.23 RM_FormatNumber.1

3.5.24 GetShowHideObject1

3.5.25 RM_ShowHideIconByElem..1

3.5.26 RM_ShowHideIconByName.1

3.5.27 getquestiontext1

3.5.28 RM_calcnumber.1

3.5.29 RM_AttachOnLoadEvent1

3.5.30 RM_ConditionalAlert1

3.5.31 RM_ShowHideElement1

3.5.32 RM_GetShowHideObjectFromElement1

3.5.33 RM_GetLoginUrl1

3.5.34 RM_GetLogoutUrl1

3.5.35 RM_GetElements1

3.5.36 RM_GetAllElements1

3.6 Events.1

3.6.1 onclick.1

3.6.2 onchange.1

3.6.3 RM_CustomValidation()1

3.7 Constants.1

3.7.1 RM_oneday.1

3.7.2 RM_oneweek.1

3.7.3 RM_oneyear.1

3.8 Variables.1

3.8.1 RM_PageType.1

3.8.2 RM_ProjectName.1

3.8.3 RM_ProjectText1

3.8.4 RM_ActivityName.1

3.8.5 RM_ActivityText1

3.8.6 RM_PageNo.1

3.9 Debug Client Script1

3.9.1  Debug Client Script in Microsoft Visual Studio 2005 .1

3.9.2  Debug Client Script in Internet Explorer with Microsoft Script Debugger .1

3.10 Query string API1

3.10.1 ProjectTypeFilter.1

3.10.2 Destination.1

3.10.3 StartProject1

3.10.4 Id.1

3.10.5 SkinName.1

3.10.6 Language.1

3.10.7 ResumeProject1

3.10.8 DefaultProjectListType.1

3.10.9 ProjectListType.1

3.10.10 ProjectListSortNew..1

3.10.11 ProjectListSortRunning.1

3.10.12 ProjectListSortCompleted.1

3.10.13 ProjectListSortPending.1

3.10.14 ProjectListSortBy.1

3.10.15 ProjectListItemsPerPage.1

3.10.16 RM_EnableEnrichedWorkflow..1

3.10.17 RM_WorkflowOnly.1

3.10.18 ResumeCurrent1

3.10.19 ResumeFromInvitation.1

3.10.20 GoToActivity.1

3.10.21 RedirectToSenderURL.1

3.10.22 RedirectToSenderText1

3.10.23 ShowLogin.1

3.10.24 ShowLoginIf1

4  Process Frontend User Object Documentation.1

4.1  User object interface .1

5 Project Properties.1

5.1 Project Level1

5.1.1 DefaultPurposes.1

5.1.2 Purpose rule.1

6 Project list layout1

6.1 Running and Completed projects.1

1          Context and Definition

This document is a guide for developers working with the Process Platform Frontend. It is written for third-party developers as well as in house developers that have the task of working with the system.

2          Configuration

This section describes the configuration settings in the Process Frontend file Resultmaker.OC.FrontEnd.config and the web.config

2.1        Resultmaker.OC.Frontend.config

2.2        Web.config

The web.config contains a few configuration parameters. They are documented here.

2.3        DataSelector\web.config

3          Client Scripts

3.1        Inter‑frame communication

By using the “IFRAME” or “FRAMESET” HTML tags, the main HTML document may contain the frames with their own HTML documents inside.

To enable an inter‑frame communication with the use of JavaScript calls, FrontEnd sets the security domain of the main HTML document (document.domain property in JavaScript) to the shortest possible domain (defined in “SecurityDomain” config setting since v.2.11). E.g. for single‑word domain “MyServer” (usually used inside the intranet) the security domain is set to “MyServer”; for longer names like “MyServer.MyDomain.MyCompany.com” the security domain contains only two last words, i.e. “MyCompany.com” in this example.

In FrontEnd v2.10.0.0 and earlier, this is done only if the main document contains an IFRAME with either codepicker or file store.

In FrontEnd v2.10.0.1 and later, this is done on every page, to enable an inter‑frame communication with any custom HTML document in the frame, and to enable the reliable session timeout handling (refreshing the session, timeout warning etc.).

In every HTML document in the frame that pretends to communicate with the main document it is necessary to set explicitly the security domain to exactly the same value as the main document does. Even if the default security domain is already correct, it is necessary anyway to set it explicitly to this value. Both codepicker and file store do that. In any custom HTML document it is necessary to do the same. For security reasons it is a good practice to set the security domain to the value determined on the server, and not on the client. For details see any available documentation of document.domain property.

3.2       Class: RM_ShowHide

3.2.1         Declaring and Using

3.2.2         Properties

3.2.2.1            IsHidden

Property: RM_ShowHide.IsHidden

FrontEnd Version: 1.6

Description:

Example:

3.2.3         Methods

3.2.3.1            AddElementById

Method: RM_ShowHide.AddElementById()

FrontEnd Version: 1.6

Description: Adds a layout ID to the internal collection of RM_ShowHide object.

Example: SHobj = GetShowHideObject();

SHobj.AddElementById(“row_1”);

3.2.3.2            RemoveElementById

Method: RM_ShowHide.RemoveElementById()

FrontEnd Version: 1.6

Description: Remove a layout ID from the internal collection of RM_ShowHide object.

Example:

3.2.3.3            AddElementByQuestionName

Method: RM_ShowHide.AddElementByQuestionName()

FrontEnd Version: 1.6

Description: Adds a question element and all its answers to the internal collection of RM_ShowHide object.

Example: objShow.AddElementByQuestionName("MyRadio");

3.2.3.4            RemoveElementByQuestionName

Method: RM_ShowHide.RemoveElementQuestionName()

FrontEnd Version: 1.6

Description: Removes a question element and all its answers from the internal collection of RM_ShowHide object.

Example: objShow.RemoveElementByQuestionName("MyRadio");

3.2.3.5            AddElementByAnswerName

Method: RM_ShowHide.AddElementByAnswerName (strQuestion, strAnswer)

FrontEnd Version: 2.5

Description: Adds a single answer (specified by question name and answer name) to the internal collection of RM_ShowHide object.

Example: objShow.AddElementByAnswerName("MyRadio", "Option0");

3.2.3.6            RemoveElementByAnswerName

Method: RM_ShowHide.RemoveElementByAnswerName (strQuestion, strAnswer)

FrontEnd Version: 2.5

Description: Removes a single answer (specified by question name and answer name) from the internal collection of RM_ShowHide object.

Example: objShow.RemoveElementByAnswerName("MyRadio", "Option0");

3.2.3.7            Hide

Method: RM_ShowHide.Hide()

FrontEnd Version: 1.6

*Description: Hides all elements in an internal collection of RM_ShowHide object.

*Example: SHobj = GetShowHideObject();

SHobj.AddElementById(“row_1”);

SHobj.Hide();

3.2.3.8            Show

Method: RM_ShowHide.Show()

FrontEnd Version: 1.6

*Description: Show all elements in an internal collection of RM_ShowHide object.

*Example: SHobj = GetShowHideObject();

SHobj.AddElementById(“row_1”);

SHobj.Show();

3.2.3.9            ClearElements

Method: RM_ShowHide.ClearElements()

FrontEnd Version: 1.6

*Description: Clear all fields in an internal collection of RM_ShowHide object.

*Example: SHobj = GetShowHideObject();

SHobj = AddElementByQuestionName(“TekstField0”);

SHobj.ClearElements();

3.2.3.10      RequiredSet

Method: RM_ShowHide.RequiredSet (bRequired)

FrontEnd Version: 2.5

Description: For bRequired = {true}: marks all included elements as “required” (“*” is added and validation is affected respectively).
For bRequired = {false}: marks all included elements as “not required” (“*” is removed and validation is affected respectively).
Does not affect the elements with “Required” property set to “Required”.
Due to RequiredOn() and RequiredOff() methods this method may be considered as redundant, but in some cases its usage may simplify the conditions in code.

Example: objShow.RequiredSet(true);

3.2.3.11      RequiredOn

Method: RM_ShowHide.RequiredOn()

FrontEnd Version: 2.5

Description: Marks all included elements as “required” (“*” is added and validation is affected respectively). Does not affect the elements with “Required” property set to “Required”.

Example: objShow.RequiredOn();

3.2.3.12      RequiredOff

Method: RM_ShowHide.RequiredOff()

FrontEnd Version: 2.5

Description: Marks all included elements as “not required” (“*” is removed and validation is affected respectively). Does not affect the elements with “Required” property set to “Required”.

Example: objShow.RequiredOff();

3.2.4         Modes

3.2.4.1            Safe Mode

FrontEnd Version: 1.6

*Description: When safe mode is on RM_ShowHide.Hide() will not hide the object, if any fields in the internal collection contains data. Default is off.

Methods: SafeModeOn(), SafeModeOff()

*Example: SHobj = GetShowHideObject();

SHobj = AddElementByQuestionName(“TekstField0”);

SHobj.SafeModeOn();

SHobj.Hide(); //only hide if empty

SHobj.SafeModeOff();

3.2.4.2            Clear Mode

FrontEnd Version: 1.6

*Description: Clears all fields in an internal collection of RM_ShowHide object, next time the object is set to hidden. Default is off.

Methods: ClearModeOn(),ClearModeOff()

*Example: SHobj = GetShowHideObject();

SHobj = AddElementByQuestionName(“TekstField0”);

SHobj.ClearModeOn();

SHobj.Hide(); //hide and clear value

3.2.4.3            Hide Modes

*Example: SHobj = GetShowHideObject();

SHobj.AddElementByQuestionName(“TekstField0”);

SHobj. SetToDisabled();

SHobj.Hide(); //gray out the field

3.2.5         Correct order of modes

Recommended way to turn on/off the different modes

SomeObject.SafeModeOn();

SomeObject.Hide();

SomeObject.SafeModeOff();

SomeObject.ClearModeOn();

Navigating away and to the page will not cause any information to be deleted.

Information will only be deleted when the user activates some hide mechanism like pushing a button.

3.3        Navigation buttons ("Back"/"Continue") functions

3.3.1         RM_RenameBackButton

Function: RM_RenameBackButton(caption text)

FrontEnd Version: 2.11

Description: Defines the custom text as a caption for the "Back" button.

Returns: none

Arguments:

Example:

3.3.2         RM_RenameContinueButton

Function: RM_RenameContinueButton(caption text)

FrontEnd Version: 2.11

Description: Defines the custom text as a caption for the "Continue" button.

Returns: none

Arguments:

Example:

3.3.3         RM_SetHidingBackButton

Function: RM_SetHidingBackButton(hide)

FrontEnd Version: 2.11.1

Description: For hide = {true} it arbitrarily hides the "Back" button; for hide = {false} it arbitrarily shows the "Back" button; for hide = {null} it reverts the arbitrary hiding/showing‑related changes that any functions introduced to the "Back" button.

Returns: none

Arguments:

Example:

3.3.4         RM_HideBackButton

Function: RM_HideBackButton()

FrontEnd Version: 2.11.1

Description: Arbitrarily hides the "Back" button.

Returns: none

Arguments: none

Example:

3.3.5         RM_ShowBackButtonWeak

Function: RM_ShowBackButtonWeak([Id])

FrontEnd Version: 2.11.1

Description: Tries to show the "Back" button by releasing the hiding lock identified by the Id (if supplied), and by reverting the arbitrary hiding. After that the button may remain hidden if there are any other conditions keeping it hidden.

Returns: none

Arguments:

Example:

3.3.6         RM_ShowBackButtonStrong

Function: RM_ShowBackButtonStrong()

FrontEnd Version: 2.11.1

Description: Arbitrarily shows the "Back" button.

Returns: none

Arguments: none

Example:

3.3.7         RM_SetHidingContinueButton

Function: RM_SetHidingContinueButton(hide)

FrontEnd Version: 2.11.1

Description: For hide = {true} it arbitrarily hides the "Continue" button; for hide = {false} it arbitrarily shows the "Continue" button; for hide = {null} it reverts the arbitrary hiding/showing‑related changes that any functions introduced to the "Continue" button.

Returns: none

Arguments:

Example:

3.3.8         RM_HideContinueButton

Function: RM_HideContinueButton()

FrontEnd Version:2.11.1

Description: Arbitrarily hides the "Continue" button.

Returns: none

Arguments: none

Example:

3.3.9         RM_ShowContinueButtonWeak

Function: RM_ShowContinueButtonWeak([Id])

FrontEnd Version: 2.11.1

Description: Tries to show the "Continue" button by releasing the hiding lock identified by the Id (if supplied), and by reverting the arbitrary hiding. After that the button may remain hidden if there are any other conditions keeping it hidden.

Returns: none

Arguments:

Example:

3.3.10     RM_ShowContinueButtonStrong

Function: RM_ShowContinueButtonStrong()

FrontEnd Version: 2.11.1

Description: Arbitrarily shows the "Continue" button.

Returns: none

Arguments: none

Example:

3.3.11     RM_SetDisablingBackButton

Function: RM_SetDisablingBackButton(disable)

FrontEnd Version: 2.11.1

Description: For disable = {true} it arbitrarily disables the "Back" button; for disable = {false} it arbitrarily enables the "Back" button; for disable = {null} it reverts the arbitrary disabling/enabling‑related changes that any functions introduced to the "Back" button.

Returns: none

Arguments:

Example:

3.3.12     RM_DisableBackButton

Function: RM_DisableBackButton()

FrontEnd Version: 2.11.1

Description: Arbitrarily disables the "Back" button.

Returns: none

Arguments: none

Example:

3.3.13     RM_EnableBackButtonWeak

Function: RM_EnableBackButtonWeak([Id])

FrontEnd Version: 2.11.1

Description: Tries to enable the "Back" button by releasing the disabling lock identified by the Id (if supplied), and by reverting the arbitrary disabling. After that the button may remain disabled if there are any other conditions keeping it disabled.

Returns: none

Arguments:

Example:

3.3.14     RM_EnableBackButtonStrong

Function: RM_EnableBackButtonStrong()

FrontEnd Version: 2.11.1

Description: Arbitrarily enables the "Back" button.

Returns: none

Arguments: none

Example:

3.3.15     RM_SetDisablingContinueButton

Function: RM_SetDisablingContinueButton(disable)

FrontEnd Version: 2.11.1

Description: For disable = {true} it arbitrarily disables the "Continue" button; for disable = {false} it arbitrarily enables the "Continue" button; for disable = {null} it reverts the arbitrary disabling/enabling‑related changes that any functions introduced to the "Continue" button.

Returns: none

Arguments:

Example:

3.3.16     RM_DisableContinueButton

Function: RM_DisableContinueButton()

FrontEnd Version: 2.5.4020

Description: Arbitrarily disables the "Continue" button.

Returns: none

Arguments: none

Example:

3.3.17     RM_EnableContinueButtonWeak

Function: RM_EnableContinueButtonWeak([Id])

FrontEnd Version: 2.11.1

Description: Tries to enable the "Continue" button by releasing the disabling lock identified by the Id (if supplied), and by reverting the arbitrary disabling. After that the button may remain disabled if there are any other conditions keeping it disabled.

Returns: none

Arguments:

Example:

3.3.18     RM_EnableContinueButtonStrong

Function: RM_EnableContinueButtonStrong()

FrontEnd Version: 2.11.1

Description: Arbitrarily enables the "Continue" button.

Returns: none

Arguments: none

Example:

3.3.19     RM_EnableContinueButton

Function: RM_EnableContinueButton ()

FrontEnd Version: 2.5.4020

Description: Same as RM_EnableContinueButtonWeak() without arguments; kept for backward compatibility.

Returns: none

Arguments: none

Example:

3.3.20     RM_ShowContinueButton

Function: RM_ShowContinueButton(allowingId)

FrontEnd Version: 2.2

Description: Same as RM_EnableContinueButtonWeak(allowingId); kept for backward compatibility.

Returns: none

Arguments:

Example:

3.3.21     RM_ResetBackButton

Function: RM_ResetBackButton()

FrontEnd Version: 2.11.1

Description: Reverts the arbitrary hiding/showing‑ and disabling/enabling‑related changes that any functions introduced to the "Back" button.

Returns: none

Arguments: none

Example:

3.3.22     RM_ResetContinueButton

Function: RM_ResetContinueButton()

FrontEnd Version: 2.11

Description: Reverts the arbitrary hiding/showing‑ and disabling/enabling‑related changes that any functions introduced to the "Continue" button.

Returns: none

Arguments: none

Example:

3.4       Collections

3.4.1         RM_Addon_Params

Collection: RM_Addon_Params[]

FrontEnd Version: 1.6

Type: string

Description: This collection contains all the parameter strings for the page’s add-on blocks. Change the appropriate string if your add-on needs custom URL parameters. The string will be appended to the end of the URL.

Example:

RM_Addon_Params['MyAddon'] = 'param1="fred"&param2="michael"';

3.5        Functions

3.5.1         Some examples of most used functions

3.5.1.1            Radio button

Get: getanswer("MyQuestion","MyOption").checked

Set: getanswer("MyQuestion","MyOption").checked = true/false

3.5.1.2            Dropdown

Get: getquestion("MyQuestion").value

Set: getquestion("MyQuestion ").value = “MyOption”

3.5.1.3            Checkbox

Get: getquestion("MyQuestion").checked

Set: getquestion("MyQuestion ").checked = true/false

3.5.1.4            Text area/field

Get: getquestion("MyQuestion").value

Set: getquestion("MyQuestion").value

3.5.2         getquestion

Function: getquestion(question name)

FrontEnd Version: 1.6

Description: Gets a question object for JavaScript manipulation.

Returns: question object

Arguments:

Example:

3.5.3         getdescription (obsolete)

Function: getdescription(question name)

FrontEnd Version: 1.6

Description: Gets a description object (of type DIV) for JavaScript manipulation. Modifying the properties of this object affects the description visible on the page, but it doesn’t affect the description visible as a tooltip.

This function is obsolete, maintained for backward compatibility only; use setdescription() instead that affects also the tooltip.

Returns: DIV object

Arguments:

Example:

3.5.4         setdescription

Function: setdescription( question name, description )

FrontEnd Version: 2.6.1

Description: Sets a description text for the specified question. It affects both the description visible on the page and the description visible as a tooltip.

Returns: none

Arguments:

Example:

3.5.5         getquestionname

Function:getquestionname(question object)

FrontEnd Version: 1.6

*Description: Gets the question name. Can be very useful in conjunction with the java script word “this”

Returns: the question name.

Arguments:

* Example: //call this with an event like onChange=”alertTxt(this);”

function alertTxt(obj)

{

var Qname = getquestionname(obj);

alert(getquestion(Qname).value); //writes the value of the field

}

3.5.6         getanswer

Function: getanswer( question name, answer name )

FrontEnd Version: 1.6

*Description: Gets or set the value of a radio button

Returns: the answer object (usually a radio button object)

Arguments:

*Example: getanswer("RadioButton0", "Option1").checked = true;

3.5.7         getdate

Function: getdate( question name )

FrontEnd Version: 1.6

*Description: Used on a date type to return a date in the format of number of milliseconds since the 1 January 1970 (Unix epoch).

Returns: the date as a number so that it can be compared with other dates. (The number of milliseconds since midnight 1 January , 1970.)

Arguments:

*Example: //display the date of today

getquestion("DateField0").value = displaydate(getdate("today"));

3.5.8         displaydate

Function: displaydate( date in number format )

FrontEnd Version: 1.6

*Description: Gets the date in dd-mm-yyyy format.

Returns: The date in our standard text format.

Arguments:

*Example: //display the date of today

getquestion("TekstField0").value = displaydate(getdate("today"));

3.5.9         RM_getnumber

Function: RM_getnumber(question name [, no of decimals])

FrontEnd Version: 1.6

Description: Takes a number in JavaScript format and returns a number as a string with the specified number of decimals in the currently configured number display format.

Returns: A number in JavaScript format so that it can be compared and calculated.

Arguments:

Example:

3.5.10    RM_displaynumber

Function: RM_displaynumber(number [, no of decimals])

FrontEnd Version: 1.6

Description: Displays a number as a string in the current number display format.

Returns:string

Arguments:

Example:

3.5.11    getselectedname

Function:getselectedname(question name)

FrontEnd Version: 1.6

Description:

Returns: the answer text of the answer that is currently selected.

Arguments:

Example:

3.5.12    RM_ActivatePDFButton

Function: RM_ActivatePDFButton()

FrontEnd Version: 1.6

Description: “Pushes” the open PDF button.

Returns: none

Arguments: none

Example:

3.5.13    RM_GetProjectID

Function: RM_GetProjectID()

FrontEnd Version: 1.6

Description: Returns the current project ID.

Returns: a string containing the current project ID.

Arguments: none

Example:

3.5.14    getquestiontextobj

Function: getquestiontextobj (question name)

FrontEnd Version: 1.6

Description: Gets the question text object so that the question text can be changed at runtime.

Returns: a div object containing the question text.

Arguments:

Example:

3.5.15    RM_ActivateContinueButton

Function:RM_ActivateContinueButton()

FrontEnd Version: 1.6

Description: “Pushes” the open continue button.

Returns: none

Arguments: none

Example:

3.5.16    RM_OpenLink

Function:RM_OpenLink (url)

FrontEnd Version: 1.7.1

Description: Opens a URL in a new window.

Returns:none.

Arguments:

Example:

3.5.17    RM_MoveNext(0)

Function:RM_MoveNext(0)

FrontEnd Version: 2.2

Description: Prevents the project to proceed, it submits, but stays on the same page.

Returns:none.

Arguments:

Example:

3.5.18    RM_GetQuestionType

Function:RM_GetQuestionType(question)

FrontEnd Version: 2.4

Description: Gets the type as a string of the given question.

Returns: The question type as a string.

Arguments:

Example:

3.5.19    RM_OpenCodePicker

Function:RM_OpenCodePicker (pickerName)

FrontEnd Version: 2.4

Description: Runs and / or refreshes a code picker.

Returns:none.

Arguments:

Example:

3.5.20    RM_OpenFileStore

Function:RM_ OpenFileStore (fileStoreName)

FrontEnd Version: 2.4

Description: Runs and / or refreshes a File Store client.

Returns:none.

Arguments:

Example:

3.5.21    RM_Validate

Function: RM_Validate(input, validation)

FrontEnd Version: 2.4

Description: Validates a string using standard validation routines.

Returns: True or the error message as a string.

Arguments:

Example:

3.5.22     RM_GoToActivity

Function: RM_GoToActivity(activity)

FrontEnd Version: 2.4

Description: Redirects to the specified activity. You need to specify the phase, activityset and activity separated by backslashes (\).The path takes the format of \phase\ativityset\activity. The path must start with a backslash.

Returns: none.

Arguments:

Example:

3.5.23    RM_ FormatNumber

Function: RM_FormatNumber(qname,rmNumber)

FrontEnd Version: 6.0

Description: This function formats, validates and inserts a number (rmNumber) into the specified form question (qname). The format will be applied according to the form questions properties set in the Process Designer. The function works with the question types percentage, per mille, decimal, currency and integer.

Returns: none.

Arguments:

Example:

3.5.24    GetShowHideObject

Function: GetShowHideObject()

FrontEnd Version:

Description: Gets the ShowHide class object with its functionality.

Returns: none.

Arguments: none

Example:

3.5.25     RM_ShowHideIconByElem

Function: RM_ShowHideIconByElem(oElem,pShow,pKeepSpace)

FrontEnd Version:

Description: Show or hide icon of specified element object

Returns: none.

Arguments:

Example:

3.5.26     RM_ShowHideIconByName

Function: RM_ShowHideIconByName(pName,pShow,pKeepSpace)

FrontEnd Version:

Description: Show or hide icon of specified element name

Returns: none.

Arguments:

Example:

3.5.27     getquestiontext

Function: getquestiontext(RM_obj)

FrontEnd Version:

Description: Show or hide icon of specified element name

Returns: The text on specified question element object.

Arguments:

Example:

3.5.28     RM_calcnumber

Function: RM_calcnumber(qname1,operator,qname2,pDecimals)

FrontEnd Version:

Description: Calculate mathematic operation based on 2 element name

Returns: none.

Arguments:

Example:

3.5.29     RM_AttachOnLoadEvent

Function: RM_AttachOnLoadEvent( FunctionName )

FrontEnd Version: 6.0

Description: This function will try to schedule a call to the javascript function given in the “FunctionName” input parameter on the OnLoad event of the page. That is you can use this function, if your code needs to run OnLoad. If it is not possible to attach the function call to the OnLoad event, a delay of 100 ms is made and and the function is called at that time.

Returns: none.

Arguments:

Example:

3.5.30    RM_ConditionalAlert

Function: RM_ConditionalAlert(elementToOperateBy, logicalOperator, conditionValue, alertIfFalseMessage)

FrontEnd Version: 6.0

Description: This function will try to schedule a call to the javascript function given in the “FunctionName” input parameter on the OnLoad event of the page. That is you can use this function, if your code needs to run OnLoad. If it is not possible to attach the function call to the OnLoad event, a delay of 100 ms is made and and the function is called at that time.

Returns: boolean

Arguments:

Example:

3.5.31    RM_ShowHideElement

Function: RM_ShowHideElement(elementToShowHide, elementToOperateBy, conditionValue, showHideAction, clearModeOn)

FrontEnd Version: 6.0

Description: Shows or hides the specified element, based on the specified element and show hide action.

If the condition is not met, the opposite show/hide action is activated.

Returns: none.

Arguments:

Example:

3.5.32    RM_GetShowHideObjectFromElement

Function: RM_GetShowHideObjectFromElement(element, clearModeOn, setToCollapse)

FrontEnd Version: 6.0

Description: Get the show hide element by specifying the question element name.

Returns: object.

Arguments:

Example:

3.5.33    RM_GetLoginUrl

Function:RM_GetLoginUrl ()

FrontEnd Version: 6.2

Description: Returns the URL the Frontend targets to log in.

Returns: The login URL as a string.

Arguments: None

Example:

3.5.34    RM_GetLogoutUrl

Function: RM_GetLogoutUrl()

FrontEnd Version: 6.2

Description: Returns the URL the Frontend targets to log out.

Returns: The logout URL as a strin g.

Arguments: None

Example:

3.5.35 RM_GetElements

Function: RM_GetElements(groupName, elementTypes)

FrontEnd Version: 6.2 RC3

Description: Returns the elements in a given group.

Returns: An array of element objects from the supplied group.

Arguments:

Example:

            var elements = RM_GetElements("ParentGroup\Group1", "Text");
            elements.forEach(function(element) { 
                // List all text elements' name and value. 
                console.log("Element Name: " + getquestionname(element) + ", Element Value: " + element.value); 
            }); 
        

3.5.36 RM_GetAllElements

Function: RM_GetAllElements(elementTypes)

FrontEnd Version: 6.2 RC3

Description: Returns the elements on a page.

Returns: An array of element objects from the page.

Arguments:

Example:

            var pageElements = RM_GetAllElements("Symbolic");
            pageElements.forEach(function(element) { 
                // List all page's symbolic elements name and value. 
                console.log("Element Name: " + getquestionname(element) + ", Element Value: " + element.value); 
            }); 
        

3.6        Events

3.6.1         onclick

FrontEnd Version: 1.6

Description:

Example:

3.6.2         onchange

FrontEnd Version: 1.6

Description:

Example:

3.6.3         RM_CustomValidation()

FrontEnd Version: 1.6

Description: The RM_CustomValidation() function is a function that can be implemented by developers and is called as part of the page submit.

The function must implement its own validation alerts and return the validation result as either true or false. Returning true will allow the page to be submitted, false will not.

Example:

3.7        Constants

3.7.1         RM_oneday

FrontEnd Version: 1.6

Description: Represents one day when calculating dates.

Example:

3.7.2         RM_oneweek

FrontEnd Version: 1.6

Description: Represents one week when calculating dates.

Example:

3.7.3         RM_oneyear

FrontEnd Version: 1.6

Description: Represents one year when calculating dates.

Example:

3.8       Variables

3.8.1         RM_PageType

FrontEnd Version: 6.2

Description: Variable containing the textual representation of the page type. This information is provided for custom scripts as well as injected 3. party JavaScript frameworks – which could be pulled in to handle analytics or error handling, which could benefit from the right context. Can have the following values: Project, ErrorPage or ProjectList.

3.8.2         RM_ProjectName

FrontEnd Version: 6.2

Description: Variable containing the textual representation of the internal workflow Id. This information is provided for custom scripts as well as injected 3. party JavaScript frameworks – which could be pulled in to handle analytics or error handling, which could benefit from the right context.

3.8.3         RM_ProjectText

FrontEnd Version: 6.2

Description: Variable containing the textual representation of the reader friendly workflow name. This information is provided for custom scripts as well as injected 3. party JavaScript frameworks – which could be pulled in to handle analytics or error handling, which could benefit from the right context.

3.8.4         RM_ActivityName

FrontEnd Version: 6.2

Description: Variable containing the textual representation of the internal activity id of the current workflow activity. This information is provided for custom scripts as well as injected 3. party JavaScript frameworks – which could be pulled in to handle analytics or error handling, which could benefit from the right context.

3.8.5         RM_ActivityText

FrontEnd Version: 6.2

Description: Variable containing the textual representation of the reader friendly activity name of the current workflow activity. This information is provided for custom scripts as well as injected 3. party JavaScript frameworks – which could be pulled in to handle analytics or error handling, which could benefit from the right context.

3.8.6         RM_PageNo

FrontEnd Version: 6.2

Description: Variable containing the textual representation of page number of the current form page. This information is provided for custom scripts as well as injected 3. party JavaScript frameworks – which could be pulled in to handle analytics or error handling, which could benefit from the right context. This is almost always 0 as best praxis is one page per form.

3.9       Debug Client Script

3.9.1         Debug Client Script in Microsoft Visual Studio 2005

It is possible to debug client scripts in the following way:

1. Open the page you want to debug in a browser
2. Start Microsoft Visual Studio and choose Debug and Attach to Process…
3. In the Attach to Process window find your process and Attach
4. Open Script Explorer, if not open already, choose Debug, Windows and Script Explorer
5. Double click the file containing the script you want do debug
6. Set breakpoint(s) in the file
7. Refresh the browser window, and you are ready to debug in Microsoft Visual Studio.

3.9.2         Debug Client Script in Internet Explorer with Microsoft Script Debugger

First you need to install Microsoft Script Debugger from Microsoft

http://www.microsoft.com/downloads/info.aspx?na=22&p=1&SrcDisplayLang=en&SrcCategoryId=&SrcFamilyId=&u=%2fdownloads%2fdetails.aspx%3fFamilyID%3d2f465be0-94fd-4569-b3c4-dffdf19ccd99%26DisplayLang%3den

In your client code write “debugger;” where you want to debug from, and choose the Script Debugger when the page is loaded. If installed it is also possible use Microsoft Visual Studio this way.

This will only works if you uncheck the checkbox Disable script debugging (Internet Explorer) in advanced options.

3.10   Query string API

This section describes the Process FrontEnd query string api.

A typical url with query string could look like this:

http://ServerName/RMFrontEnd/Default.aspx?id=newworkflow

3.10.1     ProjectTypeFilter

FrontEnd Version: 3.0

Description:

Setting the ProjectTypeFilter results in the project lists being filtered by the name that is specified in the value. This corresponds to the Categories set in the properties of the Workflow Designer in the Process Designer 3.3 and later. ProjectTypeFilter also corresponds to the Main Categories set in the custom properties in the Manual Workflow Editor.

Example:

http://ServerName/RMFrontEnd/Default.aspx?ProjectTypeFilter=CompanyStart

3.10.2     Destination

FrontEnd Version: 3.0 to 6.0.4000

Description:

The same as ProjectTypeFilter.

This parameter is deprecated but still supported until version 6.0.4000.

Example:

3.10.3     StartProject

FrontEnd Version: 3.0

Description:

This parameter will start a workflow from a workflow template with the name specified in the parameter. This will spawn a workflow instance.

Example:

http://ServerName/RMFrontEnd/Default.aspx?StartProject=newworkflow

3.10.4     Id

FrontEnd Version: 3.0

Description:

The same as StartProject.

Example:

http://ServerName/RMFrontEnd/Default.aspx?id=newworkflow

3.10.5     SkinName

FrontEnd Version: 3.0

Description:

It is possible to define several skins. These skins are stored in the following folder structure.

The SkinName parameter overwrites the skin value set in the Resultmaker.OC.FrontEnd.config.

Example:

https://ServerName/RMFrontEnd/Default.aspx?Skinname=SkinTest

3.10.6     Language

FrontEnd Version: 6.0.5300

Description:

With this querystring parameter, it is possible to specify the language to use for the application texts. The language texts are taken from a file stored in the folder /Layouts/Presentation/Translations/ in the Frontend with the file name Translations.[Language].xml. The language parameter value must be the language ISO code i.e. en, ge, da, se etc.

Example:

https://ServerName/RMFrontEnd/Default.aspx?Language=da

3.10.7     ResumeProject

FrontEnd Version: 3.0

Description:

With this querystring parameter it is possible to resume a project/workflow with a given project id. The logged in user is validated for the proper permissions for the workflow.

Example:

https://ServerName/RMFrontEnd/Default.aspx?ResumeProject=1001

3.10.8     DefaultProjectListType

FrontEnd Version: 3.0

Description:

This parameter makes it possible by query string to access a specific type of Project list, New Projects, Running Projects, Completed Projects.

Valid options are "N" ("New"), "R" ("Running"), "C" ("Completed").

Note that "P" ("Pending") is deprecated in version 6.0.

Example:

https://ServerName/RMFrontEnd/Default.aspx?DefaultProjectListType=R

3.10.9     ProjectListType

FrontEnd Version: 3.0

Description:

Example:

3.10.10                    ProjectListSortNew

FrontEnd Version: 3.0

Description:

Specifies how to sort the project list for new projects/workflows.

Sorting by multiple columns is possible by comma separation of the columns and descenting sorting is possible.

Options: "CreatedDate desc,ProjectText desc, Authority desc"

Example:

https://ServerName/RMFrontEnd/Default.aspx?ProjectListSortNew=ProjectText,Authority

3.10.11                    ProjectListSortRunning

FrontEnd Version: 3.0

Description:

Specifies how to sort the project list for started/running projects/workflows.

Sorting by multiple columns is possible by comma separation of the columns and descenting sorting is possible.

Options: "CreatedDate desc,ProjectText desc, Authority desc"

Example:

https://ServerName/RMFrontEnd/Default.aspx?ProjectListSortRunning=ProjectText,Authority

3.10.12                    ProjectListSortCompleted

FrontEnd Version: 3.0

Description:

Specifies how to sort the project list for finished projects/workflows.

Sorting by multiple columns is possible by comma separation of the columns and descenting sorting is possible.

Options: "CreatedDate desc,ProjectText,Authority"

Example:

https://ServerName/RMFrontEnd/Default.aspx?ProjectListSortCompleted=ProjectText,Authority

3.10.13                    ProjectListSortPending

FrontEnd Version: 3.0. Deprecated in version 6.0

Description:

Options: DateBegin,Subject

Example:

3.10.14                    ProjectListSortBy

FrontEnd Version: 3.0 to 6.0.4000

Description:

Deprecated as a querystring parameter.

Example:

3.10.15                    ProjectListItemsPerPage

FrontEnd Version: 3.0

Description:

Specifies how many projects/workflows to display per page on the project list pages.

Example:

https://ServerName/RMFrontEnd/Default.aspx?ProjectListItemsPerPage=80

3.10.16                    RM_EnableEnrichedWorkflow

FrontEnd Version: 3.0 to 5.2

Description:

Specifies whether to show the enriched workflow menu or not. Requires AllowEnrichedWorkflow to be set to 1.

Deprecated in version 6.0

Example:

3.10.17                    RM_WorkflowOnly

FrontEnd Version: 3.0 to 5.2

Description:

Deprecated in version 6.0

Example:

3.10.18                    ResumeCurrent

FrontEnd Version: 3.0

Description:

Specifies that the Frontend should resume the workflow based on the workflow ID stored in the ASP.NET session.

Example:

https://ServerName/RMFrontEnd/Default.aspx?ResumeCurrent=1

3.10.19                    ResumeFromInvitation

FrontEnd Version: 3.0

Description:

The ResumeFromInvitation functionality makes it possible to send a link to a third party user, and invite this user to a workflow instance in a specified workflow role. The workflow instance id, the role name to give the third party user access to is stored in the TokenService and a token to that information is issued in the form of a guid. This Tokenservice guid is the value of the ResumeFromInvitation query string parameter.

Example:

https://ServerName/RMFrontEnd/Default.aspx?ResumeFromInvitation=4e0f09df-250c-4513-995a-61b6d51d5a39

3.10.20                    GoToActivity

FrontEnd Version: 3.0

Description:

Specify a path to the activity from the activities Internal ID. Activity levels are separated by a backslash “\”. The Internal IDs can be found in the Process Designer.

Figur 1 How to the the Internal ID from the Transaction level

GoToActivity=\Transaction\WorkflowGroup\FormActivity2

See the related JavaScript function in section 3.5.22.

Note that this query string parameter only works in conjunction with StartProject/ID or ResumeProject, ResumeCurrent or ResumeFromInvitation.

Example:

http://Server/RMFrontEnd/default.aspx?id=SoftwareTest_QueryString_GoToActivity&GoToActivity=\Transaction\Group\Act2

3.10.21                    RedirectToSenderURL

FrontEnd Version: 3.0 to 5.2

Description:

Not supported in version 6.0.

Example:

3.10.22                    RedirectToSenderText

FrontEnd Version: 3.0 to 5.2

Description:

Not supported in version 6.0.

Example:

3.10.23                    ShowLogin

FrontEnd Version: 3.0 to 5.2

Description:

Setting this parameter to 1 will show the login page. Note that the parameter will not be removed, so that subsequent get requests to the same url, will show the login page again.

No longer supported in 6.0.

Example:

3.10.24                    ShowLoginIf

FrontEnd Version: 3.0 to 5.2

Description:

Setting this parameter to 1 will show the login page if the user is not logged in.

This functionality requires that a login, username/password or certificate login, is enabled.

No longer supported in 6.0.

Example:

http://server/RMFrontEnd/default.aspx?ShowLoginIf=1

4          Process Frontend User Object Documentation

This section describes the Process Frontend user object interface and its implementations.

The user object has to be provided by the platform to the Process Frontend during log-on and will be accessible within the running session. The object hides actual implementation of user handling on the platform, which thereby has to be implemented by the platform provider.

4.1        User object interface

The section describes the interface ILoginInformation for the Resultmaker user object.

ILoginInformation description

5          Project Properties

Project properties are the properties a project has on different levels. They are the properties, which can be edited in the Process Designer.

5.1        Project Level

5.1.1         DefaultPurposes

Default purposes are a list of purposes, which are evaluated at project start time. It is possible to use several purposes separated by commas.

5.1.2         Purpose rule

The purpose rule property determines the conditions under which a work flow item is presented or hidden in the flow, based on the runtime purposes set and the value of the purpose rule property.

The purposes can be AND, OR, NOT. The default value is OR. Advanced purpose rules can be constructed such as:

Not (PurposeA AND PurposeB OR (PurposeB AND PurposeC) ).

6          Project list layout

The Resultmaker Process Frontend consists of a series of different views. The main view is the workflow view where the workflow execution is rendered. Another series of important pages are the workflow/project list pages. This section describes the format of the Frontend Project List XML file and how to change the layout of the project list pages.

Figure 2 Main view: Workflow View

Figure 3 Workflow list view: New Workflows

Figure 4 Workflow list view: Open Workflows

Figure 5 Workflow list view: Closed Workflows

The Workflow list view in Figure 2-4 can be controlled by the file DefaultProjectListTemplate.xml. This file is located in the folder \Layouts\Presentation\Default\ProjectListTemplates\ in the RMFrontEnd virtual folder.

The typical full path the the file is:

C:\Inetpub\wwwroot\RMFrontEnd\Layouts\Presentation\Default\ProjectListTemplates\DefaultProjectListTemplate.xml

The file has the following basic structure.

Out of the box, the full file looks like this: