Versions Compared

Old Version 19

changes.mady.by.user Sarah Gibson (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Zoe Baldwin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_Banners
_Banners
nameactionflow
nopaneltrue


Excerpt

This page

provides details of the properties for the  Insert excerpt_action_url_action_urlnopaneltrue action node. These are part of actionflows

is for application designers who need to configure functionality for components or events. It explains the properties for the open URL node, which is part of an actionflow.

Overview

Image Modified

Use a 

Insert excerpt
_action_url
_action_url
nopaneltrue
node in an actionflow to open a URL in a new tab once the actionflow has completed. The node can also be used to send emails and call telephone numbers.

Live Search
spaceKey@self
additionalnone
placeholderSearch all help pages
typepage

Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleSections on this page
Table of ContentsmaxLevel3indent12pxstylenone

Examples

Opening a

webpage

Web Page

To open a webpage the open URL node needs a valid URL to be mapped to the URL attribute. The format of the URL must be:

Code Block
'https://www.url.com'

If you want the

URL to open is being provided by a user, it is recommended that a calculate node is used to reformat the value. For example the following switch statement can be used:

application user to provide the URL, use a calculate node ensure the URL has the correct format. For example, the following  expression uses a switch statement to prepend https://www.

Code Block
//for URL's to open correctly they must start with https://www.

switch(
    [startsWith(in.URL, "https://"),
        in.URL
    ],
    [startsWith(in.URL, "www."),   
        "https://" + in.URL
    ],
    
    "https://www." + in.URL
    
)

Image Removed

Image Removed

Calling a telephone number

The Open URL node can also be used to call a telephone number. A valid telephone number must be mapped to the URL attribute in the format:

Code Block
'callto:' + in.TelephoneNumber

The function 'callto:' causes the browser to open an appropriate VoIP client (e.g. Microsoft Teams) which then calls the number provided.

Image Removed

Sending an email

In a similar manner to calling a telephone number, the Open URL node can be used


The following video shows how an application user types a URL into a field, and the web page then opens.

Image Added

The underlying actionflow includes an Open URL node, as follows:

Image Added

Sending an Email

Excerpt
nameemailclient

Use the open URL node to send an email. A valid email address must be mapped to the URL attribute in the format:

Code Block
'mailto:' + in.EmailAddress

The function 'mailto:' causes the browser to open an appropriate email

program (e.g. Outlook)

web client and sets the email address to the one provided.

Image Modified

Adding an email subject, cc, bcc and body text

It is also possible

Provide different URL expressions to populate the email:

  • subject
,
  • cc
,
  • bcc
and
  • body text
by altering the format of the URL expression.

Subject

Code Block
'mailto:' + in.EmailAddress + "?subject=" + in.Subject

//or

'mailto:' + in.EmailAddress + "?subject=Email Subject"
cc

CC

Code Block
'mailto:' + in.EmailAddress + "?cc=" + in.cc1 + "," + in.cc2

//or

'mailto:' + in.EmailAddress + "?cc=someoneelse@email.com, another@email.com"
bcc

BCC

Code Block
'mailto:' + in.EmailAddress + "?bcc=" + in.cc1 + "," + in.cc2

//or

'mailto:' + in.EmailAddress + "?bcc=someoneelse@email.com, another@email.com"

Body

text

Text

Code Block
'mailto:' + in.EmailAddress + "?body=" + in.Body

//or

'mailto:' + in.EmailAddress + "?body=This is the body of the email."

Adding

a new line in the bodye.g. 

Body Text Lines

The body is by default one line, that will wordwrap according to the email client settings. In order to split the body over multiple lines or paragraphs, use: %0d%0a

For example, to generate t he following email body text:

This is the body of the email.

This is the second line of the body of the email.

specify:

Code Block
// use %0d%0a to start a new line

'mailto:' + in.EmailAddress + "?body=This is the body of the email.%0d%0aThis is the second line of the body of the email."
Adding subject, cc, bcc and body

Combining Fields

The following expression shows how to create all the different email fields using one expression:

Code Block
"mailto: " + in.EmailAddress + "?cc=" + in.cc1 + "," + in.cc2 + "&bcc=" + in.bcc + "&subject=" + in.Subject + "&body=" + in.Body


Calling a Telephone Number

Use the Open URL node to make a VoIP call to a telephone number. Map a valid telephone number to the URL attribute as follows:

Code Block
'callto:' + in.TelephoneNumber

The function 'callto:' causes the browser to open an appropriate VoIP client, such as Microsoft Teams. The VoIP client then calls the number provided. This is illustrated in the following video.

Image Added

Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue

Insert excerpt
_property_toolbar
_property_toolbar
nopaneltrue

Insert excerpt
_parent
_parent
nopaneltrue

Basic Settings

FieldDescription
NameEnter the name for the action node.
Insert excerpt
_actionflow_properties
_actionflow_properties
nameshow-name
nopaneltrue

Insert excerpt
_actionflow_properties
_actionflow_properties
nameshow-text
nopaneltrue

Attributes

Each open

url

URL node has

3

the following attributes which can be mapped to.

AttributeTypeDescription
URLwindowName (optional)StringName of the
NameString
The url of the resource to be opened. This can also be the mailto: and callto: functions. See above examples.

Optionally specify the browser window, <iframe> or tab into which to load the specified resource. If no name is provided, PhixFlow opens a new browser window

will always be opened

.

This name

should

must not contain whitespace.

windowFeatures (optional)
FeaturesString
Comma

Optionally specify a comma-separated list of window features in the form:

  • name=value
, or
  • for boolean features, just name. 

These features include options such as:

  • the window's default size and position
,
  • whether or not to open a minimal popup

For details about specifying window

, and so forth. See Window Features for more information

features, see the developer.mozilla.org page Window.open() .

URLStringSpecify the URL of the resource to be opened. This can also be the mailto: and callto: functions, as shown in the examples above.

Insert excerpt
_

property_tabs

description
_

property_tabsnameaccess-h

description
nopaneltrue

Insert excerpt
_

access

audit
_

access

audit
nopaneltrue



Live Search
spaceKey@self
additionalnone
placeholderSearch all help pages
typepage

Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone


Learn More

For links to all pages in this topic, see Understanding Actionflows. 

Insert excerpt
_

audit

terms_changing
_terms_

audit

changing
nopaneltrue