DevGuide Process Platform 6.1 - Process Frontend Process.

Version: 6.1.0.
Publishing date: 2014-11-26

This article 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.

Configuration

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

Resultmaker.OC.Frontend.config

Web.config

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

DataSelector\web.config

Client Scripts

Interframe 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 interframe 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 singleword 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 interframe 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.

Class: RM_ShowHide

Declaring and Using

Properties

IsHidden

Property: RM_ShowHide.IsHidden

FrontEnd Version: 1.6

Description:

Example:

Methods

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”);

RemoveElementById

Method: RM_ShowHide.RemoveElementById()

FrontEnd Version: 1.6

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

Example:

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");

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");

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");

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");

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();

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();

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();

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);

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();

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();

Modes

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();

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

Hide Modes

*Example: SHobj = GetShowHideObject();

SHobj = AddElementByQuestionName(“TekstField0”);

SHobj. SetToDisabled();

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

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.

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

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:

RM_RenameBackButton("Previous page");

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:

RM_RenameContinueButton("Next page");

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/showingrelated changes that any functions introduced to the "Back" button.

Returns: none

Arguments:

Example:

RM_SetHidingBackButton(true);

RM_HideBackButton

Function: RM_HideBackButton()

FrontEnd Version: 2.11.1

Description: Arbitrarily hides the "Back" button.

Returns: none

Arguments: none

Example:

RM_HideBackButton();

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:

RM_ShowBackButtonWeak();

RM_ShowBackButtonWeak("MyElemennt_id");

RM_ShowBackButtonStrong

Function: RM_ShowBackButtonStrong()

FrontEnd Version: 2.11.1

Description: Arbitrarily shows the "Back" button.

Returns: none

Arguments: none

Example:

RM_ShowBackButtonStrong();

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/showingrelated changes that any functions introduced to the "Continue" button.

Returns: none

Arguments:

Example:

RM_SetHidingContinueButton(true);

RM_HideContinueButton

Function: RM_HideContinueButton()

FrontEnd Version: 2.11.1

Description: Arbitrarily hides the "Continue" button.

Returns: none

Arguments: none

Example:

RM_HideContinueButton();

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:

RM_ShowContinueButtonWeak();

RM_ShowContinueButtonWeak("MyElemennt_id");

RM_ShowContinueButtonStrong

Function: RM_ShowContinueButtonStrong()

FrontEnd Version: 2.11.1

Description: Arbitrarily shows the "Continue" button.

Returns: none

Arguments: none

Example:

RM_ShowContinueButtonStrong();

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/enablingrelated changes that any functions introduced to the "Back" button.

Returns: none

Arguments:

Example:

RM_SetDisablingBackButton(true);

RM_DisableBackButton

Function: RM_DisableBackButton()

FrontEnd Version: 2.11.1

Description: Arbitrarily disables the "Back" button.

Returns: none

Arguments: none

Example:

RM_DisableBackButton();

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:

RM_EnableBackButtonWeak();

RM_EnableBackButtonWeak("MyElemennt_id");

RM_EnableBackButtonStrong

Function: RM_EnableBackButtonStrong()

FrontEnd Version: 2.11.1

Description: Arbitrarily enables the "Back" button.

Returns: none

Arguments: none

Example:

RM_EnableBackButtonStrong();

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/enablingrelated changes that any functions introduced to the "Continue" button.

Returns: none

Arguments:

Example:

RM_SetDisablingContinueButton(true);

RM_DisableContinueButton

Function: RM_DisableContinueButton()

FrontEnd Version: 2.5.4020

Description: Arbitrarily disables the "Continue" button.

Returns: none

Arguments: none

Example:

RM_DisableContinueButton();

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:

RM_EnableContinueButtonWeak();

RM_EnableContinueButtonWeak("MyElemennt_id");

RM_EnableContinueButtonStrong

Function: RM_EnableContinueButtonStrong()

FrontEnd Version: 2.11.1

Description: Arbitrarily enables the "Continue" button.

Returns: none

Arguments: none

Example:

RM_EnableContinueButtonStrong();

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:

RM_EnableContinueButton();

RM_ShowContinueButton

Function: RM_ShowContinueButton(allowingId)

FrontEnd Version: 2.2

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

Returns: none

Arguments:

Example:

RM_ShowContinueButton();

RM_ShowContinueButton("MyElement_id");

RM_ResetBackButton

Function: RM_ResetBackButton()

FrontEnd Version: 2.11.1

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

Returns: none

Arguments: none

Example:

RM_ResetBackButton();

RM_ResetContinueButton

Function: RM_ResetContinueButton()

FrontEnd Version: 2.11

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

Returns: none

Arguments: none

Example:

RM_ResetContinueButton();

Collections

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"';

Functions

Some examples of most used functions

Radio button

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

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

Dropdown

Get: getquestion("MyQuestion").value

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

Checkbox

Get: getquestion("MyQuestion").checked

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

Text area/field

Get: getquestion("MyQuestion").value

Set: getquestion("MyQuestion").value

getquestion

Function: getquestion(question name)

FrontEnd Version: 1.6

Description: Gets a question object for JavaScript manipulation.

Returns: question object

Arguments:

Example:

getquestion("MyQuestion").value = "New Value";

getquestion(“MyQuestion”).focus(); //set focus to the field

getquestion(“MyQuestion”).readOnly = true; //set a field to read only

getquestion(“MyQuestion”).checked = true; //set a check box to checked

getquestion(“MyQuestion”).innerHTML = "fred"; //change the question text to fred.

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:

getdescription("MyQuestion").innerText = "My Description"; This is not very browser compatible

getdescription("MyQuestion").innerHTML = "My <b>Description</b>";

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:

setdescription("MyQuestion", "My Description");

setdescription("MyQuestion", "My <b>Description</b>");

setdescription("MyQuestion", "");

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

}

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;

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"));

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"));

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:

// This example adds 10% to a question’s value.

getquestion("myquestion").value = RM_displaynumber( RM_getnumber("myquestion") * 1.1 );

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:

// This example adds 10% to a question’s value.

getquestion("myquestion").value = RM_displaynumber( RM_getnumber("myquestion") * 1.1 );

getselectedname

Function: getselectedname(question name)

FrontEnd Version: 1.6

Description:

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

Arguments:

Example:

RM_ActivatePDFButton

Function: RM_ActivatePDFButton()

FrontEnd Version: 1.6

Description: “Pushes” the open PDF button.

Returns: none

Arguments: none

Example:

RM_ActivatePDFButton();

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:

Var myProjectID = RM_GetProjectID();

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:

getquestiontextobj("myQuestion").innerHTML = "New question text";

RM_ActivateContinueButton

Function: RM_ActivateContinueButton()

FrontEnd Version: 1.6

Description: “Pushes” the open continue button.

Returns: none

Arguments: none

Example:

RM_ActivateContinueButton();

RM_OpenLink

Function: RM_OpenLink (url)

FrontEnd Version: 1.7.1

Description: Opens a URL in a new window.

Returns: none.

Arguments:

Example:

RM_OpenLink("http://www.yahoo.com/");

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:

RM_MoveNext(0);

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:

var questionType = RM_MoveNext(“MyQuestion”);

RM_OpenCodePicker

Function: RM_OpenCodePicker (pickerName)

FrontEnd Version: 2.4

Description: Runs and / or refreshes a code picker.

Returns: none.

Arguments:

Example:

RM_OpenCodePicker("MyCodePicker");

RM_OpenFileStore

Function: RM_ OpenFileStore (fileStoreName)

FrontEnd Version: 2.4

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

Returns: none.

Arguments:

Example:

RM_OpenFileStore("MyFileStore");

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:

var result = RM_Validate("485734639", "CheckCpr");

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:

RM_GoToActivity("\\myPhase\\myAtivityset\\myActivity");

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:

RM_FormatNumber(“TextField0", 23.2);

GetShowHideObject

Function: GetShowHideObject()

FrontEnd Version:

Description: Gets the ShowHide class object with its functionality.

Returns: none.

Arguments: none

Example:

GetShowHideObject();

RM_ShowHideIconByElem

Function: RM_ShowHideIconByElem(oElem,pShow,pKeepSpace)

FrontEnd Version:

Description: Show or hide icon of specified element object

Returns: none.

Arguments:

Example:

var element = document.getElementById(“TextField0_ID”);

RM_ShowHideIconByElem(element,true,true);

RM_ShowHideIconByName

Function: RM_ShowHideIconByName(pName,pShow,pKeepSpace)

FrontEnd Version:

Description: Show or hide icon of specified element name

Returns: none.

Arguments:

Example:

RM_ShowHideIconByName(”TextField0”,true,true);

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:

var element = document.getElementById(“TextField0_ID”);

getquestiontext(element);

RM_calcnumber

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

FrontEnd Version:

Description: Calculate mathematic operation based on 2 element name

Returns: none.

Arguments:

Example:

RM_calcnumber(”TextField0”,"+","TextFiled1",2);

// Note:If TextField0 have value 5 and TextField1 has value 5, the function will return 10.00

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:

RM_AttachOnLoadEvent(”LoadMap”);

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:

RM_ConditionalAlert('Group0/TextField0', '>=', '10', 'Specialekarakteren skal være 10 eller derover for at kunne søge', 'true');

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.

Returns: none.

Arguments:

Example:

RM_ShowHideElement('Group0', 'Candidates/dt:Fax', '12345' , 'hide', false);

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:

var objShowHideElement = RM_GetShowHideObjectFromElement(elementToShowHide, 'true', 'true');

Events

onclick

FrontEnd Version: 1.6

Description:

Example:

onchange

FrontEnd Version: 1.6

Description:

Example:

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:

// The following example show how the RM_CustomValidation() implements the mandatory return values true or false.

function RM_CustomValidation(){

// Do stuff on submit

// Return true if submit is allowed, false otherwise

var amount = getquestion('DropDown0').value;

if (amount > 1 )

return true;

else{

alert("You selected less than two aircraft");

return false;

}

}

Constants

RM_oneday

FrontEnd Version: 1.6

Description: Represents one day when calculating dates.

Example:

// The following example adds one day to a question of date type.

getquestion("MyQuestion").value = displaydate(getdate("MyQuestion") + RM_oneday);

RM_oneweek

FrontEnd Version: 1.6

Description: Represents one week when calculating dates.

Example:

RM_oneyear

FrontEnd Version: 1.6

Description: Represents one day when calculating dates.

Example:

Debug Client Script

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.

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.

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

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.

Workflow Designer	Manual Workflow Editor

Example:

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

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:

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

Id

FrontEnd Version: 3.0

Description:

The same as StartProject.

Example:

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

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

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

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

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

ProjectListType

FrontEnd Version: 3.0

Description:

Example:

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

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

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

ProjectListSortPending

FrontEnd Version: 3.0. Deprecated in version 6.0

Description:

Options: DateBegin,Subject

Example:

ProjectListSortBy

FrontEnd Version: 3.0 to 6.0.4000

Description:

Deprecated as a querystring parameter.

Example:

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

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:

RM_WorkflowOnly

FrontEnd Version: 3.0 to 5.2

Description:

Deprecated in version 6.0

Example:

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

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

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 How to the the Internal ID from the Transaction level

GoToActivity=\Transaction\WorkflowGroup\FormActivity2

See the related JavaScript function in section RM_GoToActivity.

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

RedirectToSenderURL

FrontEnd Version: 3.0 to 5.2

Description:

Not supported in version 6.0.

Example:

RedirectToSenderText

FrontEnd Version: 3.0 to 5.2

Description:

Not supported in version 6.0.

Example:

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:

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

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.

User object interface

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

ILoginInformation description

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.

Project Level

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.

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) ).

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 Main view: Workflow View

Figure Workflow list view: New Workflows

Figure Workflow list view: Open Workflows

Figure 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:

With this file it is possible to control how the workflow list views are rendered. There are the following different views that can be rendered depending on whether the user is logged in or not:

• <Projects List="New">
• <Projects List="New" LoggedIn="True">
• <Projects List="Running" LoggedIn="True">
• <Projects List="Completed" LoggedIn="True">

Running and Completed projects

The Running and Completed projects type definitions are explained here.

The Div in the first part references Translations from the translation file

<div class="RM_ProjectCompletionSubHeader">

<OCText Name="ProjectList.MyProjects" disable-output-escaping="yes" />

</div>

<div class="RM_ProjectCompletionText">

<OCText Name="ProjectList.LoggedIn.Note" disable-output-escaping="yes" />

</div>

<hr />

<div class="RM_ProjectCompletionSubHeader">

<OCText Name="RunningProjects" disable-output-escaping="yes" />

</div>

<div class="RM_ProjectCompletionText">

<OCText Name="ProjectList.Running.Text" disable-output-escaping="yes" />

</div>

These four OCText elements references translations and the are presented in the places shown in this example, marked with yellow.

The next section, the table and InsertList elements define the columns for the actual project list. The values in the Name attribute are reserved words. It is possible to insert the text elements ProjectText and CreatedDate from the project table of the Process Platform. It is also possible to insert bullits and a delete button. And it is possible to remove these as they are merged with normal html.

<table>

<InsertList>

<tr>

<td>

<Insert Name="Bullet" />

</td>

<td>

<Insert Name="ProjectText" />

</td>

<td>

<Insert Name="CreatedDate" />

</td>

<td>

<Insert Name="Authority" />

</td>

<td>

<Insert Name="Delete" />

</td>

</tr>

</InsertList>

</table>

</div>

</Projects>

Custom Properties

Custom Properties are internal properties on the Process Platform workflow object. They can reside on all levels of the workflow object. It is possible to modify a selected range of Custom Properties in the Advanced Workflow Editor. The editing of these properties have been discontinued in the Workflow Designer.

In the following sections the custom properties adhereing to the different workflow levels are described.

Project Level

projectlistvariable

Custom Property: projectlistvariable

FrontEnd Version: 2.3

Process Designer Version: Not possible to modify in any designer

Description: The projectlistvariable Custom Property is created in order to convey non-static information from the back end to the Process Platform project lists. The Custom Property can be set in Process Engine back end scripts and can be presented on the project list page. Several Custom Properties can be set, so the form an array. The are distinguished on the Key atribute

Attributes:

Example:

Figure : Project list page (not) showing the value from Custom Property

The Custom Properties have to be set like this

<customproperties>

<customproperty name=”projectlistvariable” key=”kl:EmployeePersonDataGroup[1].cpr:CivilRegistrationNumber” value =”0211721111” />

<customproperty name=”projectlistvariable” key=”kl:EmployeePersonDataGroup[1].dkcc:PersonNameGroup[1].dkcc:PersonGivenName” value =”Lars Pedersen” />

</customproperties>

In the project list template insert the following to use the above custom properties.

<Insert Name="Variable" Value="kl:EmployeePersonDataGroup[1].cpr:CivilRegistrationNumber" />

<Insert Name="Variable" Value="kl:EmployeePersonDataGroup[1].dkcc:PersonNameGroup[1].dkcc:PersonGivenName" />

The CustomProperties are set in the following way from the Process Engine backend script:

'--------------------------------

' Insert a new Custom Property

'--------------------------------

option explicit

dim cp, projectListVariables, projectVariable, cpXml

' create the object.

set cp = CreateObject( "Resultmaker.OC.Content.CustomProperties.ProjectCustomProperties" )

' add some data

'cpXml = "<customproperties/>"

cpXml = Project.CustomProperties

cp.LoadXml( cpXml )

' get a list of variables.

set projectListVariables = cp.ProjectListVariables

' create a new variable.

set projectVariable = CreateObject( "Resultmaker.OC.Content.CustomProperties.KeyValueCustomProperty" )

' fill the variable with data.

projectVariable.Key = "fred"

projectVariable.Value = "freddy"

' add variable to customproperties.

Set projectVariable = projectListVariables.AddByValue( projectVariable )

Project.CustomProperties = cp.ToString()

'--------------------------------

' Edit an existing Custom Property

'--------------------------------

option explicit

dim cp, projectListVariables, projectVariable, cpXml

' create the object.

set cp = CreateObject( "Resultmaker.OC.Content.CustomProperties.ProjectCustomProperties" )

' add some data

cpXml = Project.CustomProperties

cp.LoadXml( cpXml )

' get a list of variables.

set projectListVariables = cp.ProjectListVariables

' get the variable.

set projectVariable = projectListVariables( "fred" )

' change the values.

projectVariable.Key = "fred2"

projectVariable.Value = "freddier"

Project.CustomProperties = cp.ToString()

'--------------------------------

' REMOVE an existing Custom Property

'--------------------------------

option explicit

dim cp, projectListVariables, projectVariable, cpXml

' create the object.

set cp = CreateObject( "Resultmaker.OC.Content.CustomProperties.ProjectCustomProperties" )

' add some data

cpXml = Project.CustomProperties

cp.LoadXml( cpXml )

' get a list of variables.

set projectListVariables = cp.ProjectListVariables

' get the variable.

set projectVariable = projectListVariables( "fred" )

' remove variable.

projectListVariables.Remove(projectVariable)

Project.CustomProperties = cp.ToString()

'--------------------------------

' LOOP through the collection

'--------------------------------

option explicit

dim cp, projectListVariables, projectVariable

set cp = CreateObject( "Resultmaker.OC.Content.CustomProperties.ProjectCustomProperties" )

cp.LoadXml( Project.CustomProperties )

for each projectVariable in projectListVariables

MsgBox "name=" & projectVariable.Name & " key="& projectVariable.Key & " value=" & projectVariable.Value

next

showphases

Custom Property: showphases

FrontEnd Version: 2.0 – 6.0

Process Designer Version: 3.3 – 6.0 in both Workflow Designer and Advanced Workflow Designer

Description: Indicates to the FrontEnd whether to show or hide all the phases in the menu. This can be overridden by the showphase Custom Property on the individual phase.

This CustomProperty is valid on the project level.

Attributes:

Example:

<customproperties>

<customproperty name="showphases" value="true" />

</customproperties>

showactivitysets

Custom Property: showactivitysets

FrontEnd Version: 2.0 – 6.0

Process Designer Version: 3.3 – 6.0 in both Workflow Designer and Advanced Workflow Designer

Description: Indicates to the Process Frontend whether to show or hide all the activitysets in the menu. This can be overridden by the showactivityset Custom Property on the individual activityset.

This CustomProperty is valid on the project level.

Attributes:

Example:

<customproperties>

<customproperty name="showactivitysets" value="true" />

</customproperties>

menulabel

Custom Property: menulabel

FrontEnd Version: 1.7.1

Process Designer Version: 3.3 – 6.0 in Advanced Workflow Designer. Not possible with Workflow Designer.

Description: Sets the text displayed on the menu if differs from the project text.

Attributes:

Example:

<customproperties>

<customproperty name="menulabel" value="My Project menu heading" />

</customproperties>

waittext

Custom Property: waittext

FrontEnd Version: 1.8.0

Process Designer Version: 3.3 – 6.0 in Advanced Workflow Designer

Description: Sets the text or HTML displayed when the continue button is pressed.

Attributes:

Example:

<customproperties>

<customproperty name="waittext" value="Please wait while the robots take a long time doing whatever it is robots do." />

</customproperties>

exitlink

Custom Property: exitlink

FrontEnd Version: 2.3

Process Designer Version: 3.3 – 6.0 in both Workflow Designer and Advanced Workflow Designer

Description: The exitlink custom property overrides the “back to project list” link on the projects.

Attributes:

Example:

<customproperties>

<customproperty name="exitlink" text="Back to start" url="http://somewhere/else" />

</customproperties>

projecttype|category

Custom Property: projecttype

FrontEnd Version: 1.6 – 6.0

Process Designer Version: 3.3 – 6.0 in both Workflow Designer and Advanced Workflow Designer

Description: In order to be able to make different project lists, the lists have to be retrieved based on extra information from the project. This information is placed in CustomProperties at the project level under the name projecttype. The value is arbitrary. It is possible to set several project type filters. In Workflow Designer the project property is called Category.

Figur Workflow Designer with the property grid and the Category Selector

Attributes: none.

Sub-tags: insert

Example:

<customproperties>

<customproperty name="projecttype">

SoftwareTest

</customproperty>

</customproperties>

A project can have several project types but they have to be placed in separate CustomProperties:

<customproperty name="projecttype">

SoftwareTest

</customproperty>

<customproperty name="projecttype">

CompanyStart

</customproperty>

To use this CustomProperty functionality, the Frontend has to add an extra argument to the command, which retrieves the project lists. Please note the casing.

A normal command retrieving the full project list looks like this:

<Command Name="GetProjectList2">

<Argument Name="UserName">Virk<Argument>

<Argument Name="UserToken">{o10710-m1ki-k3sy}<Argument>

<Argument Name="LogonType">Anonymous<Argument>

</Command>

The limited project list command looks like this:

<Command Name="GetProjectList2">

<Argument Name="UserName">Virk<Argument>

<Argument Name="UserToken">{o10710-m1ki-k3sy}<Argument>

<Argument Name="LogonType">Anonymous<Argument>

<Argument Name="ProjectTypes">SoftwareTest<Argument>

</Command>

The value of the ProjectTypes argument can be a single word or a comma separated list (CompanyStart,SoftwareTest).

The current list of Categories is fetced from the Process Engine web service, which takes the data from the ProjectTypes.xml file located in the folder c:\FileRepository\private\AccessConfigurationFiles\

The file can be edited to present the necessary categories.

The default installed files looks like this:

If the files is changed, the keep a backup as software updates can overwrite the file.

projectstartpage

Custom Property: projectstartpage

FrontEnd Version: 1.6

Description:

Attributes: none.

Sub-tags: insert

Example:

<customproperties>

<customproperty name="projectstartpage"><table><tr><td><insert name = "welcometext" /></td></tr>

<tr><td>You have now finished the project. Bla, bla, bla. <img src="http://rep.resultmaker.com/ Graphics/Resultmaker/ ResultmakerLogoDarkBlue.gif"></td></tr></table></customproperty>

</customproperties>

insert

Custom Property: insert

FrontEnd Version: 1.6

Description:

Attributes:

Example:

projectendpage

Custom Property: projectendpage

FrontEnd Version: 1.6

Description:

Attributes: none.

Example:

<customproperties>

<customproperty name="projectendpage"><table><tr><td>You have now finished the project. Bla, bla, bla. <img src=”http://rep.resultmaker.com/ Graphics/Resultmaker/ ResultmakerLogoDarkBlue.gif”/></td></tr></table></customproperty>

</customproperties>

projectheader

Custom Property: projectheader

FrontEnd Version: 1.6

Description:

Attributes: none.

Example:

<customproperties>

<customproperty name="projectheader"><table><tr><td>This is project is brought to you by Resultmaker </td></tr></table></customproperty>

</customproperties>

relativenavigation

Custom Property: relativenavigation

FrontEnd Version: 2.5

Description: Causes the user to move to the following activity instead of the next activity when pressing the "Continue" button.

Attributes:

Example:

<customproperties>

<customproperty name="relativenavigation" value="true" />

</customproperties>

backbuttontext

Custom Property: backbuttontext

FrontEnd Version: 2.11.1

Description: Defines the custom text as a caption for the "Back" button. It may be overwritten by the same custom property on Page or Questionnaire level.

Attributes:

Example:

<customproperties>

<customproperty name="backbuttontext" value="Previous page" />

</customproperties>

continuebuttontext

Custom Property: continuebuttontext

FrontEnd Version: 2.11.1

Description: Defines the custom text as a caption for the "Continue" button. It may be overwritten by the same custom property on Page or Questionnaire level.

Attributes:

Example:

<customproperties>

<customproperty name="continuebuttontext" value="Next page" />

</customproperties>

Phase Level

showphase

Custom Property: showphase

FrontEnd Version: 2.0

Description: Indicates to the FrontEnd whether to show or hide the current phase in the menu. This can override the showphases Custom Property on the project level.

This CustomProperty is valid on the phase level.

Attributes:

Example:

<customproperties>

<customproperty name="showphase" value="true" />

</customproperties>

ActivitySet Level

showactivityset

Custom Property: showactivityset

FrontEnd Version: 2.0

Description: Indicates to the FrontEnd whether to show or hide the current activityset in the menu. This can override the showactivitysets Custom Property on the project level.

This CustomProperty is valid on the activitset level.

Attributes:

Example:

<customproperties>

<customproperty name="showactivityset" value="true" />

</customproperties>

Predecessor

Custom Property:

FrontEnd Version:

Description: An activity (activity set, activity) can take an earlier activity on same level as predecessor, which mean that the activity cannot start until the earlier activity has completed.

For a predecessor relation it is possible to set NestedReset, which means the an activity is reset if its predecessor is reset.

Attributes:

Activity Level

waittext

Custom Property: waittext

FrontEnd Version: 1.8.0

Description: Sets the text or HTML displayed when the continue button is pressed. This overrides the Project level waittext custom property.

Attributes:

Example:

<customproperties>

<customproperty name="waittext" value="Please wait while the robots take a long time doing whatever it is robots do." />

</customproperties>

Questionnaire Level

helpid

Custom Property: helpid

FrontEnd Version: 1.6

Description: The helpid custom property is used to identify the html filename that is to be used as the help file for the questionnaire

Attributes:

Example:

<customproperties>

<customproperty name="helpid" value="H73282" />

</customproperties>

exitlink

Custom Property: exitlink

FrontEnd Version: 2.3

Description: The exitlink custom property overrides the “back to project list” link on the projects.

Attributes:

Example:

<customproperties>

<customproperty name="exitlink" text="Back to start" url="http://somewhere/else" />

</customproperties>

backbuttontext

Custom Property: backbuttontext

FrontEnd Version: 2.11.1

Description: Defines the custom text as a caption for the "Back" button. If existing and not empty, it has precedence over the same custom property on Project level. It may be overwritten by the same custom property on Page level.

Attributes:

Example:

<customproperties>

<customproperty name="backbuttontext" value="Previous page" />

</customproperties>

continuebuttontext

Custom Property: continuebuttontext

FrontEnd Version: 2.11.1

Description: Defines the custom text as a caption for the "Continue" button. If existing and not empty, it has precedence over the same custom property on Project level. It may be overwritten by the same custom property on Page level.

Attributes:

Example:

<customproperties>

<customproperty name="continuebuttontext" value="Next page" />

</customproperties>

Page Level

waittext

Custom Property: waittext

FrontEnd Version: 1.8.0

Description: Sets the text or HTML displayed when the continue button is pressed. This overrides the Project level waittext and Activity level waittext custom properties.

Attributes:

Example:

<customproperties>

<customproperty name="waittext" value="Please wait while the robots take a long time doing whatever it is robots do." />

</customproperties>

exitlink

Custom Property: exitlink

FrontEnd Version: 2.3

Description: The exitlink custom property overrides the “back to project list” link on the projects.

Attributes:

Example:

<customproperties>

<customproperty name="exitlink" text="Back to start" url="http://somewhere/else" />

</customproperties>

script

Custom Property: script

FrontEnd Version: 1.6

Description:

Attributes: none.

Example:

<customproperties>

<customproperty name="script">

<![CDATA[

// do some JavaScript. I’m sure Michael has a good example.

]]>

</customproperty>

</customproperties>

buildtable

Custom Property: buildtable

FrontEnd Version: 1.6

Description:

Attributes: none.

Sub-tags: insertquestion

Example:

<customproperties>

<customproperty name="buildtable">

<table>

<tr>

<td>

This is an html text describing testing the buildtable customproperty.

<img src="http://dokumenter.virk.dk/Graphics/Resultmaker/VirkPigen.gif" />

</td>

</tr>

</table>

</customproperty>

</customproperties>

or

<customproperties>

<customproperty name="buildtable">

<table border="1" width="100%">

<tr><td>question here: <insertquestion name="Question3" /></td><td>testing456</td></tr>

<tr><td><insertquestion name="Linetest" questionpart="text" /></td><td><insertquestion name="Linetest" /></td></tr>

<tr><td colspan="2" align="center"><insertquestion name="calctable" /></td></tr>

<tr><td><insertquestion name="Question2" answer="Option3" /></td><td><insertquestion name="Question2" answer="Option1" /></td></tr>

<tr><td><insertquestion name="Question2" answer="opt2" />

<insertpicker name="dstItems" id="picker1">

<map questionname="Question2" field="itemID" />

<map questionname="Question3" field="entryDate" />

</insertpicker>

</td></tr>

<tr><td colspan="2"><insertquestion name="ss11" /></td></tr>

</table>

</customproperty>

</customproperties>

Special tags used in the content of "buildtable":

insertquestion

Tag: insertquestion

FrontEnd Version: 1.6

Description: Inserts a question field inside the table.

Attributes:

Example:

<insertquestion name=”table_name” questionpart=”text”/>

insertpicker (obsolete)

Tag: insertpicker

FrontEnd Version: 1.6

Description: inserts an icon in the layout that opens the CodePicker.

Attributes:

Sub-tags: map

Example:

<insertpicker name="VarekodePicker" id="picker1" language="TranslationsEnglish">

<map questionname="test" field="Varekode" />

<map questionname="test2" field="Varetxt" />

</insertpicker>

insertaddon (obsolete)

Tag: insertaddon

FrontEnd Version: 1.6

Description: inserts an icon in the layout that opens a customised add-on popup window.

Attributes:

Sub-tags: map

Example:

<insertpicker name="VarekodePicker" id="picker1" language="TranslationsEnglish">

<map questionname="test" field="Varekode" />

<map questionname="test2" field="Varetxt" />

</insertpicker>

map (obsolete)

Tag: map

FrontEnd Version: 1.6

Description: Adds a new field to fill by the CodePicker or Addon. The number of map tags should equal the number of return-value tags in the Addon or CodePicker’s configuration file.

Attributes:

backbuttontext

Custom Property: backbuttontext

FrontEnd Version: 2.11.1

Description: Defines the custom text as a caption for the ”Back” button. If existing and not empty, it has precedence over the same custom property on Questionnaire and Project level.

Attributes:

Example:

<customproperties>

<customproperty name="backbuttontext" value="Previous page" />

</customproperties>

backbuttonhidden

Custom Property: backbuttonhidden

FrontEnd Version: 2.11.1

Description: Indicates whether to hide the "Back" button.

Attributes:

Example:

<customproperties>

<customproperty name="backbuttonhidden" value="true" />

</customproperties>

backbuttondisabled

Custom Property: backbuttondisabled

FrontEnd Version: 2.11.1

Description: Indicates whether to disable the "Back" button.

Attributes:

Example:

<customproperties>

<customproperty name="backbuttondisabled" value="true" />

</customproperties>

continuebuttontext

Custom Property: continuebuttontext

FrontEnd Version: 2.11.1

Description: Defines the custom text as a caption for the "Continue" button. If existing and not empty, it has precedence over the same custom property on Questionnaire and Project level.

Attributes:

Example:

<customproperties>

<customproperty name="continuebuttontext" value="Next page" />

</customproperties>

continuebuttonhidden

Custom Property: continuebuttonhidden

FrontEnd Version: 2.11.1

Description: Indicates whether to hide the "Continue" button.

Attributes:

Example:

<customproperties>

<customproperty name="continuebuttonhidden" value="true" />

</customproperties>

continuebuttondisabled

Custom Property: continuebuttondisabled

FrontEnd Version: 2.11.1

Description: Indicates whether to disable the "Continue" button.

Attributes:

Example:

<customproperties>

<customproperty name="continuebuttondisabled" value="true" />

</customproperties>

Question Level

placeholdertext

Custom Property: placeholdertext

FrontEnd Version: 6.0

Description: The text that is placed in a textbox before a textbox contains any data or has focus. Used as descriptive or instructional text.

Attributes:

Example:

<customproperties>

<customproperty name="placeholdertext" value="Please enter your surname." />

</customproperties>

oioexportname

Custom Property: oioexportname

FrontEnd Version: 2.4

Description: The name of the aggregate for the complete signing data. Only needed when multiple signing is used.

Attributes:

Example:

<customproperties>

<customproperty name="oioexportname" value="oc_q_1agg" />

</customproperties>

transactionidquestionname

Custom Property: transactionidquestionname

FrontEnd Version: 2.4

Description: The name of the aggregate for the complete signing data. Only needed when multiple signing is used.

Attributes:

Example:

<customproperties>

<customproperty name="oioexportname" value="oc_q_1agg" />

</customproperties>

signexportname

Custom Property: signexportname

FrontEnd Version: 2.1

Description: The name of the aggregate to get the signing data from the export server.

Attributes:

Example:

<customproperties>

<customproperty name="signexportname" value="oc_q_1agg" />

</customproperties>

signenableskip

Custom Property: signenableskip

FrontEnd Version: 2.1

Description: The name of the aggregate to get the signing data from the export server.

Attributes:

Example:

signcollectionidquestionname

Custom Property: signcollectionidquestionname

FrontEnd Version: 2.1

Description: The question name that contains the collection id for the file attachments.

Attributes:

Example:

applettypequestionname

Custom Property: applettypequestionname

FrontEnd Version: 2.3

Description: Specifies the name of the question that contains what type of applet to use.

Attributes:

Example:

<customproperties>

<customproperty name=" applettypequestionname " value="lite" />

</customproperties>

forceapplettypequestionname

Custom Property: forceapplettypequestionname

FrontEnd Version: 2.3

Description: Specifies the question that determines whether to bypasses the applet detection stage on the client and force it to use the applet specified in the applet type.

Attributes:

Example:

<customproperties>

<customproperty name="forceapplettypequestionname" value="true" />

</customproperties>

exportname

Custom Property: exportname

FrontEnd Version: 1.7.1

Description: The exportname custom property is only applicable inside the PDF Button question type. It specifies the export name.

Attributes:

Example:

<customproperties>

<customproperty name="exportname" value="DP_200A_PDF" />

</customproperties>

attributes

Custom Property: attributes

FrontEnd Version: 1.6

Description:

Attributes: special

Example:

<customproperty name="attributes" onchange="getoptiontest()"/>

displaytextattributes

Custom Property: displaytextattributes

FrontEnd Version: 1.6

Description:

Attributes: special

Example:

<customproperty name="displaytextattributes" onchange="getoptiontest()"/>

default

Custom Property: default

FrontEnd Version: 1.6

Description:

Attributes:

Example:

<customproperties>

<customproperty name="default" value="true" text="Choose Here"/>

</customproperties>

required

Custom Property: required

FrontEnd Version: 1.6

Description:

Attributes:

Example:

<customproperties>

<customproperty name="required" value="true" />

</customproperties>

maxlength

Custom Property: maxlength

FrontEnd Version: 1.6

Description: The maxlength custom property sets the maximum length of the string the user can type inside the field.

Attributes:

Example:

<customproperties>

<customproperty name="maxlength" value="10" />

</customproperties>

hidden

Custom Property: hidden

FrontEnd Version: 1.6

Description: used to place variables and text on the page with out it being displayed. Use this instead of hidden question type. Do not confuse this type of hidden question with RM_SHowHide Scripting Class.

Attributes:

Example:

<customproperties>

<customproperty name="hidden" value="true" />

</customproperties>

displayonly

Custom Property: displayonly

FrontEnd Version: 1.6

Description: Displays the question’s variable or default value on the page and don’t allow any input.

Attributes:

Example:

<customproperties>

<customproperty name="displayonly" value="true" />

</customproperties>

taborder

Custom Property: taborder

FrontEnd Version: 1.7.4

Description: Sets the tab order for the question

Attributes:

Example:

<customproperties>

<customproperty name="taborder" value="3" />

</customproperties>

focus

Custom Property: focus

FrontEnd Version: 1.7.4

Description: Sets the focus on this question when the page is loaded.

Attributes:

Example:

<customproperties>

<customproperty name="focus" value="true" />

</customproperties>

applettype

Custom Property: applettype

FrontEnd Version: 2.3

Description: This custom property is only applicable to the applet question type. This specifies which applet to use

Attributes:

Example:

<customproperties>

<customproperty name="applettype" value="lite" />

</customproperties>

url

Custom Property: url

FrontEnd Version: 2.0

Description: On some question types such as “display link” and .image it is necessary to specify a URL. This is achieved through the url custom property. If this is not found the FrontEnd will look for the URL in an attached backend variable, failing this it will look in the default value. If a URL is still not found the question type will fail.

Attributes: none

Example:

<customproperties>

<customproperty name="url">http://www.yahoo.com/</customproperty>

</customproperties>

openmode

Custom Property: openmode

FrontEnd Version: 2.4

Description: This custom property is only applicable to the link question type.

This sets the mode of the link. E.g. whether it should open in a new window for not.

Attributes:

Example:

<customproperties>

<customproperty name="openmode" value="self" />

</customproperties>

linktext

Custom Property: linktext

FrontEnd Version: 2.4

Description: This custom property is only applicable to the link question type.

This sets the text on the link to something other that the default text.

Attributes:

Example:

<customproperties>

<customproperty name="linktext" value="Link here!" />

</customproperties>

applicationname

Custom Property: applicationname

FrontEnd Version: 2.4

Description: This custom property is only applicable to the codepicker question type.

This sets the name of the codepicker application file to use.

Attributes:

Example:

<customproperties>

<customproperty name="applicationname" value="dstEPS_live" />

</customproperties>

mode

Custom Property: mode

FrontEnd Version: 2.4

Description: This custom property is only applicable to the codepicker question type.

This set the codepicker mode to use. A list of modes is available below.

Attributes:

Example:

<customproperties>

<customproperty name="mode" value="popup" />

</customproperties>

width

Custom Property: width

FrontEnd Version: 2.4

Description: This custom property is only applicable to the codepicker question type.

This sets the width of the codepicker when it is in popup or window modes.

Attributes:

Example:

<customproperties>

<customproperty name="width" value="600" />

</customproperties>

height

Custom Property: height

FrontEnd Version: 2.4

Description: This custom property is only applicable to the codepicker question type.

This sets the height of the codepicker when it is in popup or window modes.

Attributes:

Example:

<customproperties>

<customproperty name=" height" value="400" />

</customproperties>

icon

Custom Property: icon

FrontEnd Version: 2.4

Description: This custom property is only applicable to the codepicker question type.

If this custom property is set is will display the specified icon instead of the default one.

Attributes:

Example:

<customproperties>

<customproperty name=" icon" value="/static/icons/test.gif" />

</customproperties>

positionelement

Custom Property: positionelement

FrontEnd Version: 2.4

Description: This custom property is only applicable to the codepicker question type.

If the this custom property is set the code picker when in popup mode will position it’s self underneath the specified element. (like a date picker)

Attributes:

Example:

<customproperties>

<customproperty name=" positionelement" value="myquestion" />

</customproperties>

mapping

Custom Property: mapping

FrontEnd Version: 2.4

Description: This custom property is only applicable to the codepicker question type.

This custom property contains a number of map elements that are used the map questions with the customproperty fields.

Attributes: none

Sub-tags: map

Example:

<customproperties>

<customproperty name="mapping">

<map questionname="Date" field="date" />

<map questionname="ID" field="id" />

<map questionname="Unit" field="PSIName" />

<map questionname="UnitID" field="PSIPath" />

<map questionname="Period" field="referencePeriod" />

<map questionname="PeriodID" field="referencePeriodCode" />

<map questionname="PathID" field="directionCode" />

<map questionname="PathLabel" field="directionLabel" />

<map questionname="OrganisationID" field="organisationID" />

<map questionname="SelectedOrganisationID" field="selectedOrganisationID" />

<map questionname="AuthorisationID" field="authorisationID" />

<map questionname="Source" field="source" />

<map questionname="Survey" field="survey&ququot; />

<map questionname="AuthorisationsIndicator" field="authorisations" />

</customproperty>

</customproperties>

map

Custom Property: map

FrontEnd Version: 2.4

Description: Adds a field map between the page and the codepicker. The number of map tags should equal the number of return-value tags in the CodePicker’s application file.

Attributes:

Answer Level

attributes

Custom Property: attributes

FrontEnd Version: 1.6

Description:

Attributes: special

Example:

<customproperty name="attributes" onchange="getoptiontest()"/>

displaytextattributes

Custom Property: displaytextattributes

FrontEnd Version: 1.6

Description:

Attributes: special

Example:

<customproperty name="displaytextattributes" onchange="getoptiontest()"/>

taborder

Custom Property: taborder

FrontEnd Version: 1.7.4

Description: Sets the tab order for the answer

Attributes:

Example:

<customproperties>

<customproperty name="taborder" value="3" />

</customproperties>

Flash custom properties

These properties are deprecated.

hideMenuOnFirstPage

Custom Property: hideMenuOnFirstPage

FrontEnd Version: 2.0

Description: Indicates to the Flash FrontEnd to hide the whole menu on the first presentation. This CustomProperty is valid on the project level.

Attributes:

Example:

<customproperties>

<customproperty name="hideMenuOnFirstPage" value="true" />

</customproperties>

flashTheme

Custom Property: flashTheme

FrontEnd Version: 2.0

Description: Indicates to the Flash FrontEnd which theme file to use. This CustomProperty is valid on the project level and on the questionnaire level. The project level will override the default theme and the questionnaire level will override the default and the project level.

Attributes:

Example:

<customproperties>

<customproperty name="flashTheme" value="ToldSkat" />

</customproperties>

foldInOutSpeedExternal

Custom Property: foldInOutSpeedExternal

FrontEnd Version: 2.0

Description: Sets the speed in which the Flash FrontEnd should fold in and out sub levels. This CustomProperty is valid on the project level.

Attributes:

Example:

<customproperties>

<customproperty name="foldInOutSpeedExternal" value="200" />

</customproperties>

menuScrollSpeedExternal

Custom Property: menuScrollSpeedExternal

FrontEnd Version: 2.0

Description: Sets the menu scroll speed to the Flash FrontEnd. This CustomProperty is valid on the project level.

Attributes:

Example:

<customproperties>

<customproperty name="menuScrollSpeedExternal" value="200" />

</customproperties>