LiveSettings complex element

The element contains the settings for the Nintex Live.

Syntax


 
<LiveSettings>
    <AllowAnonymous>Boolean</AllowAnonymous>
    <CancelMessage>String</CancelMessage>
    <Expiry i:nil="true">String</Expiry>
    <FormType>String</FormType>
         <InsertReferences xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <MaximumSubmissions>Integer</MaximumSubmissions>
    <Publish>Boolean</Publish>
    <ShortUrl i:nil="true" />String</ShortUrl>
    <ShortenUrl>Boolean</ShortenUrl>
    <SubmissionsPerUser>Integer</SubmissionsPerUser>
    <SubmitMessage>String</SubmitMessage>
    <TimeZone i:nil="true" />String</TimeZone>
    <Url i:nil="true" />String</Url>
    <User i:nil="true" />String</User>
</LiveSettings>
        

Element Characteristics

Characteristic Description
Data type and length String
Default value None
Cardinality 1..1: Required element that occurs only once.

Element Attributes

Attribute Description
  Required.

Relationships

Relationship Element
Parent element Form
Child elements See the child element table.

Parent Element Namespace

Prefix Namespace
d2p1 http://schemas.datacontract.org/2004/07/Nintex.Forms.FormControls

Parent Element

Attribute Description
  Required.

Child Elements

Name Data Type Default value Cardinality Description
AllowAnonymous Boolean false 1..1 Indicates whether the form requires authentication.
CancelMessage String See below 1..1 The text of the cancel message.
Expiry String blank 1..1 The expiry date in Unix time format. For example, a string may be: 1472565600000. A form definition is kept in Nintex Live until the defined “Form Expiry Date” is reached or when the form has been unpublished from Nintex Live. The “Form Expiry Date” property is defined by the form designer when configuring the “Live Settings” for the Nintex form. If no “Form Expiry Date” is specified, the form definition will not expire and will remain in Nintex Live indefinitely.
FormType String ListForm 1..1 The type of the form.
InsertReferences Complex Type See below 1..* References to be applied after deserialization.
MaximumSubmissions Integer 200 1..1 Sets the number of times this form can be submitted.
Publish Boolean false 1..1 Indicates whether the form is to published to Nintex Live Forms.
ShortUrl String blank 1..1 The shortened URL.
ShortenUrl Boolean true 1..1 Indicates whether to shorten the URL or not.
SubmissionsPerUser Integer 1 1..1 Indicates whether to shorten the URL or not.
SubmitMessage String see below 1..1 The submit message text.
TimeZone String blank 1..1 The timezone of the form in Live.
Url String blank 1..1 The URL.
User String blank 1..1 The string of authenticated users.

Notes

Default Cancel Message

<div style="border-bottom: #ffcc66 2px solid; height:48px;overflow:hidden;"<img width="300" height="50" alt="Nintex Forms" src="/_layouts/nintexforms/images/NF_Form_header_Lemon_ffe7a6.png"/></div><p dir="ltr" style="font-family: sans-serif, arial; color: #595959; font-size: 11pt; margin-right: 0px"></p><p dir="ltr" style="font-family: sans-serif, arial; color: #595959; font-size: 11pt; margin-right: 0px"> The form submission has been canceled</p>

InsertReferences

The insert reference element uses the following namespace:
xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"

Submit Message

<div style="border-bottom: #ffcc66 2px solid; height:48px;overflow:hidden;"><img width="300" height="50" alt="Nintex Forms" src="/_layouts/nintexforms/images/NF_Form_header_Lemon_ffe7a6.png"/></div><p dir="ltr" style="font-family: sans-serif, arial; color: #595959; font-size: 11pt; margin-right: 0px"></p><p dir="ltr" style="font-family: sans-serif, arial; color: #595959; font-size: 11pt; margin-right: 0px"> The form has been submitted successfully.</p>

Example

The following example contains an example of the complex element.


 
<LiveSettings>
    <AllowAnonymous>false</AllowAnonymous>
    <CancelMessage><div style="border-bottom: #ffcc66 2px solid; height:48px;overflow:hidden;"><img width="300" height="50" alt="Nintex Forms" src="/_layouts/nintexforms/images/NF_Form_header_Lemon_ffe7a6.png"/></div><p dir="ltr" style="font-family: sans-serif, arial; color: #595959; font-size: 11pt; margin-right: 0px">&#160;&#160;</p><p dir="ltr" style="font-family: sans-serif, arial; color: #595959; font-size: 11pt; margin-right: 0px">&#160;&#160; The form submission has been cancelled.</p></CancelMessage>
    <Expiry i:nil="true" />
    <FormType>ListForm</FormType>
    <InsertReferences xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <MaximumSubmissions>200</MaximumSubmissions>
    <Publish>false</Publish>
    <ShortUrl i:nil="true" />
    <ShortenUrl>true</ShortenUrl>
    <SubmissionsPerUser>1</SubmissionsPerUser>
    <SubmitMessage><div style="border-bottom: #ffcc66 2px solid; height:48px;overflow:hidden;"><img width="300" height="50" alt="Nintex Forms" src="/_layouts/nintexforms/images/NF_Form_header_Lemon_ffe7a6.png"/></div><p dir="ltr" style="font-family: sans-serif, arial; color: #595959; font-size: 11pt; margin-right: 0px">&#160;&#160;</p><p dir="ltr" style="font-family: sans-serif, arial; color: #595959; font-size: 11pt; margin-right: 0px">&#160;&#160; The form has been submitted successfully.</p></SubmitMessage>
    <TimeZone i:nil="true" />
    <Url i:nil="true" />
    <User i:nil="true" />
</LiveSettings>
 

            

Related information

Form XML Complex Elements