skuid.model.Model

Indicates whether there are more rows in the dataset beyond the limit requested by the user.

Represents changes to the model which have not yet been committed to the database via save() .

A simple object mapping of row Ids to rows that have changed. Each row is a simple map of field names to values that have changed.

cancel() empties changes. If no changes have been made since the last save() or cancel() , this will be an empty object.

Indicates if a row will be created when no records are returned by the model's query or if the model is set not to query for records on page load, as defined in the Page Designer.

Defines the logic to use when combining the Model conditions. If no conditionLogic is specified, Nintex Apps will combine all conditions using AND logic, e.g. 1 AND 2 AND ...

Example: "(1 AND 2) OR (3 AND 4)"

Model Condition Metadata Object[]

An array of Condition Metadata Objects associated with the model.

An array of rows within the model. To retrieve this array directly, use getRows() .

Each element within the array is a simple map of field names to values. For example, a row within a model with three fields, two from the object, "Name" and "CustomField__c", and one from a lookup relationship, "skuid__AttachmentId__c" from the sObject "skuid__Image__c" via the relationship "Image__r", would be represented as:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    'CustomField__c' : '<custom field value>',
    'Id' : '<18 character record Id>',
    'Id15' : '<15 character record Id>',
    'Image__c' : '<image Id>',
    'Image__r' :
        {
            'Id': '<image Id>',
            'skuid__AttachmentId__c': '<attachment Id>'
        },
    'Name' : '<name value>'
}

Note:  It is typically not best practice to use this object to work with rows or their data. , use the getter APIs getFirstRow() or getRowById() when attempting to work with a row using custom code.

Read-only. Use getRowById() to request a particular row by its ID and createRow() or adoptRows() to add new data to a model.

For the data array, see the documentation for the Model Metadata Object

Note:  Direct use of this property is not recommended.

Model Field Metadata Object []

An array of Field Metadata Objects, one for each field explicitly defined in the model. For example, a model with three fields, two from the object, "Name" and "CustomField__c", and one from a lookup relationship, "skuid__AttachmentId__c" from the sObject "skuid__Image__c" via the relationship "Image__r", would have three elements in this array.

Note:  Unlike the data and dataMap properties, an object's ID field is not included unless explicitly included in the model.

Note:  Fields are not guaranteed to be in any particular order.

Read-only. A simple object map of field names to Model Field Metadata Objects.

Note:  It is recommended to use getField() to request field metadata for a particular field by its name, rather than directly accessing fieldsMap .

You can access the Field Metadata either by standard hierarchical objects (i.e. fieldsMap.Object__r.FieldName ) or by using the fully qualified name via array syntax (i.e. fieldsMap['Object__r.FieldName'] ). For example, a Model with three fields, two from the object, "Name" and "CustomField__c", and one from a lookup relationship, "skuid__AttachmentId__c" from the sObject "skuid__Image__c" via the relationship "Image__r", would be represented as:

1
2
3
4
5
6
7
8
9
10
{
    'CustomField__c' : { <Field Metadata Object> },
    'Image__r' :
        {
            'skuid__AttachmentId__c' : { <Field Metadata Object> }
        },
    'Image__r.skuid__AttachmentId__c' : { <Field Metadata Object> },
    'Name' : { <Field Metadata Object> }
}

For the field array, see the documentation for the Model Field Metadata Object.

Note:  Unlike the data and dataMap properties, fieldsMap does not include ID fields unless they are explicitly included in the model.

Model Field Metadata Object []

An array of Field Metadata Objects used to group an aggregate model. For basic models, this property is null.

A description of the grouping method. One of:

• simple
• rollup

Read-only. Indicates if the model contains changes that have not been committed to the database.

The unique identifier assigned to the model in the Nintex Apps Page Designer.

The Fields to Order Records By Clause defined from the Page Designer. Defines the ORDER BY clause in the model's generated SOQL query.

A corollary to changes . Contains the original value for each field value change which has not yet been committed to the database.

A simple object mapping of row Ids to rows that have changed. Each row is a simple map of field names to the original values before they were changed.

Indicates whether the model should be treated as read-only.

An integer value indicating the maximum number of rows to fetch from the database, as defined in the Page Designer. If the value given was less than 0, then the default is 1. If no value was given, then value will be null (and no limit will be placed on the query).

Note:  When attempting to query for more data, updating the recordsLimit property directly is not recommended and may result in inaccurate data. , consider using the batchSize property of loadAllRemainingRecords() .

Read-only. A simple object map of Nintex Apps Unique Ids to Field objects registered with the model.

The complete generated SOQL statement used to populate the model's data, including requested fields and conditions, as well as any GROUP BY, ORDER BY and LIMIT clauses.

The Model Type as defined in the Page Builder. One of:

• For aggregate models: "aggregate"
• For basic models: in most cases null, though under some circumstances a zero-length string ("")

• row ( object ) -- The row object to be removed from the model. The row object itself must belong to the model. For example, the row object was retrieved using getRowById() or getFirstRow() .

The abandoned row object.

• rows ( object ) -- Array of row objects: The row objects to be removed from the model. The row objects themselves must belong to the model. For example, the row objects should be retrievable using getRowById() or getRows() .

The array of abandoned row objects (if provided) or undefined if no rows or an empty array of rows was provided.

• condition ( skuid.model.Condition ) -- The condition to activate.
• affectPersonalization ( boolean ) -- Optional. If true, and if the condition has a name, then the Nintex Apps Personalization Framework will store the value of this condition indefinitely (if the Page's Personalization Mode is set to Server-side) or for the duration of the browser session (if the Page's Personalization Mode is Client-side) so that the condition's current value will be pulled from the stored value for the running user the next time that the page is loaded.

• rows ( object[] ) -- Required. An array of JavaScript objects to merge in as rows into the model.
• options ( object ) --

  Optional. A simple object with the following properties:

  • doAppend (boolean): Optional. By default, adoptRows() will prepend adopted rows to the Model's existing data rows. if doAppend is set to true, however, then this row will be appended to the end of the model's data rows.
  • notify (boolean): Optional, defaults to true. If false, then Nintex Apps will not publish any events or notify any bound components about this event.

The row objects that were adopted into the model, post-adoption.

object[]

• options ( object ) --

  A simple object with the following properties:

  • doAppend (boolean): Optional. By default, createRow() prepends new rows to the model's data. if doAppend is set to true, however, then this row will be added to the end of the model's data
  • editModeForNewItems (boolean): Optional, defaults to false. If true, then any Items created in response to this new row's creation will be placed into edit mode initially, rather than read mode.
  • additionalConditions ( skuid.model.Condition() [] ): Optional. Condition objects that should be applied to the new row in addition to any active conditions already on the model

The newly created row object.

object

• condition ( skuid.model.Condition ) -- The condition to deactivate
• affectPersonalization ( boolean ) -- Optional. If true, and if the condition has a name, then the Nintex Apps Personalization Framework will store the value of this condition indefinitely (if the Page's Personalization Mode is set to Server-side) or for the duration of the browser session (if the Page's Personalization Mode is Client-side) so that the condition's current value will be pulled from the stored value for the running user the next time that the page is loaded.

• row ( object ) -- The row object to mark for deletion.

• options ( object ) --

  A simple object containing one or more of the following configuration options:

  • additionalConditions ( skuid.model.Condition() ): An array of skuid.model.Condition() objects to limit the data in your model that actually gets exported. These conditions will be applied to rows (if rows is provided), or to all rows in the model (e.g. to model.getRows()), if rows is not provided.
  • doNotAppendRowIdColumn (boolean): Defaults to false. Ordinarily, the ID of each row will be appended as the final column in the exported CSV file, but if this is set to true, then this column will be omitted.
  • fields (object[]): An array of the particular model fields that you want to have included in the export (as the columns). If the model field is a child relationship field, then a template property is required on the field object in order for Nintex Apps to know what fields to show in the column for each row in the child relationship. If a template property is provided and the field is not a valid field in the model, then Nintex Apps will assume that this is a "Template field" and will process merge syntax within the template property in context of each row to compute the value to populate for the given cell.
  • fileName (string): the name of the file that will be generated, e.g. "MyLeads". Defaults to the ID of the model plus "-export-" plus the timestamp in milliseconds, e.g. 'MyLeads-export-128493010283'
  • rows (row[]): an array of the particular data rows in the model that you want to export. If not provided, all rows in the model (filtered optionally by additionalConditions ) will be exported.
  • useAPINamesForHeaders (boolean): Defaults to false, but if true, the API names for fields will be used as column headers instead of the labels. Useful for doing data imports/exports/ETL operations to move data between systems, as opposed to outputting for human readability.

• row ( Object ) -- The Row object within the model to be evaluated.
• field ( String ) -- The id of a specific field to re-evaluate.

The result of the formula evaluation

String|Number

• [options] ( Object ) -- An optional configuration options object
• [options.updatedRows] ( Object[] ) -- Array of rows to reevaluate formula fields on. If not specified, defaults to all rows in the Model.
• [options.preventTrackChanges] ( Boolean ) -- If true, then any changes to formula fields resulting from reevaluation will cause events to be fired and UI components to be notified. Defaults to false.

The Model object, used for chaining

Object

• conditionName ( string ) -- The name of the Condition, as defined in the Page Designer. A Condition's State must be set to "Filterable, Default On/Off" in order for a name to be given to the Condition.
• searchSubconditions ( boolean ) -- Optional, defaults to false. When false, getConditionByName only searches top-level Conditions for name matches. If true, getConditionByName will search Sub-Conditions as well, returning the first Condition or Sub-Condition whose name is conditionName.

The Condition associated with the given name, or false if the Condition name was not recognized.

skuid.model.Condition()

• fieldName ( string ) -- The API name of a field. Can use dot notation to refer to related fields (e.g. "Image__r.Name")

Returns metadata about a field, or false if the field name was not recognized.

Model Field Metadata

• row ( object ) -- The row object from which to extract the value.
• field ( string ) -- The name of the field. Use dot-notation to traverse relationships. (See below)
• noEscape ( boolean ) -- Optional. If true, Nintex Apps will not HTML-escape the field value.

The value of the field for the given row in this Model, or undefined if there is no value for the field on the row.

The value of the field, which may be a string, number, object, array, etc.

• id ( string ) -- The ID of the row. Typically an 18-character Salesforce Id, though may also be a Nintex Apps Unique ID for newly created rows that have not been added to the database yet.

A row object

object

• dataConditions ( array ) -- Optional array of skuid.model.Condition objects to apply to filter the Model's rows.
• context ( object ) -- Optional object of context to use for evaluating the supplied dataConditions.

An array all row objects in this Model.

array of row objects

• row ( object ) -- Required. The Model row object to check for unsaved changes.

Returns true if the row has any unsaved changes, otherwise returns false.

boolean

• row ( object ) -- Required. The Model row object to check.

Returns true if the row has been marked for deletion, otherwise returns false.

boolean

• row ( object ) -- Required. The Model row object to check.

Returns true if the row has not yet been committed, otherwise returns false.

boolean

• row ( object ) -- Required. The Model row object to check.

Returns true if the row is new / unsaved and was originally cloned from a preexisting, saved record. Otherwise, returns false.

boolean

• options ( object ) --

  Optional. An object containing optional callbacks to be called:

  • stepCallback ( function(offsetStart,offsetEnd ): Optional. Callback function called immediately after a new "page" of records is retrieved and added into the Model. Two parameters are passed to the callback: offsetStart and offsetEnd, the start and end of the range of database records that were retrieved with the step. Nintex Apps will load N records at a time, where N is the value of the "Max # of records to Retrieve (Limit)" setting on your Model.
  • finishCallback ( function(totalRecordsRetrieved ): Optional. Callback function called when Nintex Apps has finished loading all possible records from the database into a Model, i.e. there are no records in the database that match the Model's Conditions that are not already in the Model. This method is passed one parameter, the final number of rows in the Model, which is equivalent to model.getRows().length at that moment in time.
  • batchSize ( numberOfRecordsToRequest ): Optional. Determines the number of records Nintex Apps will request with each query. This option typically defaults to between 10-20 records, but larger batch sizes may be more ideal for services with long query wait times.

• callback ( function ) -- Optional. A function to be called when the data has been loaded.

• id ( string ) -- The ID of the row to abandon.

The abandoned row object.

object

• condition ( skuid.model.Condition ) -- The Condition to reset.

• options ( object ) --

  Optional. A simple object with the following properties:

  • callback ( function ): Optional. A function to be called upon completion of the save operation.

A Promise object which is resolved upon completion of the save operation.

Note:  Check the totalsuccess property on the result object to confirm that the save operation was successful. The Promise will be rejected if the network request failed.

jQuery Deferred Promise

• condition ( skuid.model.Condition ) -- The Condition to set and activate.
• value(s) ( string or array ) --

  The value(s) to use with the Condition.

  Note: 

  This can be either a single value or an Array of values.

  • If it is a single value and the condition's operator is a multivalue operator (e.g. "in" or "includes"), then "Condition.values" will be set to an Array containing this value.
  • If it is an Array of values and the condition's operator is multivalue, then "Condition.values" will be set to this Array of values.
• affectPersonalization ( boolean ) -- Optional. If true, and if the Condition has a name, then the Nintex Apps Personalization Framework will store the value of this Condition indefinitely (if the Page's Personalization Mode is set to Server-side) or for the duration of the browser session (if the Page's Personalization Mode is Client-side) so that the Condition's current value will be pulled from the stored value for the running User the next time that the page is loaded.

• row ( object ) -- The row object to un-mark for deletion.

• callback ( function ) -- A function to be executed upon completion of the update operation.

The Promise object is resolved upon completion of the update operation.

jQuery Deferred Promise

• row ( object ) -- The row object to update. (Only the ID field is required.)
• updates ( object ) -- A simple object map of one or more API field names to values. For example:

• options ( object ) --

  OPTIONAL. A simple object map of additional settings to pass in to this method call. Supported options include:

  • initiatorId ( string ): The page-unique identifier of the Component, Model, or Field that initiated this updateRow( ) call, as obtainable via a call to .id( ) or a reference to ._GUID on the initiating object. This is essential to use when using updateRow( ) from within a Custom Field Renderer Snippet, in order to prevent infinite rendering loops, since the render( ) method is called on Field objects whenever their associated row has had an update on the associated field. For example if you use updateRow( ) the Name field on an Account row all Fields associated with that row and the Name field will have their render( ) method called after the update has been applied to the row in the Model.

The updated row object.

object

• updates ( object ) -- A map of row Ids to row objects. Each row object is a map of changed field names to new values.
• options ( object ) --

  OPTIONAL. A simple object map of additional settings to pass in to this method call. Supported options include:

  • initiatorId ( string ): The page-unique identifier of the Component, Model, or Field that initiated this updateRows( ) call, as obtainable via a call to .id( ) or a reference to ._GUID on the initiating object. This is essential to use when using updateRows( ) from within a Custom Field Renderer Snippet, in order to prevent infinite rendering loops, since the render( ) method is called on Field objects whenever their associated row has had an update on the associated field. For example if you use updateRows( ) the Name field on an Account row all Fields associated with that row and the Name field will have their render( ) method called after the update has been applied to the row in the Model.

The updated row objects.

object

• severity: the Severity of the Message. Will be "ERROR" for all required field validation messages.
• status: a Status Code for the Message. Will be "REQUIRED_FIELD_MISSING" for all required field validation messages.
• message: a String describing the error that occurred. Will be "Required fields have no value: " + comma-separated list of Field labels.
• fields: An array of the Labels of the Fields that do not have values.