Circle Functions

Circle functions include:

Instance ID

When creating an instance from a template, the website is defined in the template and is shared by all its instances.

All instances access the same webpages and use the same website URLs. The instance ID in the URL is used to differentiate between the instances.

In order to get to the InstanceID value, you need to create an ADOR that includes the GetEnv("InstanceID") function.

For example, to create a URL to a specific webpage using the Instance ID ADOR, e.g. {{ GetEnvInstanceID}}, the URL format should be:

  • http://www.MyDomain.com/{{GetEnvInstanceID}}/{{XMPieRecipientKey}}

  • http://www.MyDomain.com/MyFolder/Landing.html?iid={{GetEnvInstanceID}}&rid={{XMPieRecipientKey}}

Syntax:

GetEnv("InstanceID")

GetTouchpointData

The GetTouchpointDatafunction gets two parameters:

  • Touchpoint friendly identifier, i.e. W1, W2, P5

  • Touchpoint data type, i.e. URL

The function returns the data for the touchpoint defined by these parameters.

The data of the touchpoint will be available only when production is run form Circle. If not running via Circle, production will not fail.

Syntax

GetTouchpointData("Touchpoint friendly identifier", "Touchpoint data type")

Example

GetTouchpointData("W1", "URL")

Returns the landing page URL of the web touchpoint W1 for the specific recipient and Circle project instance.