Change a SharePoint list or library

From Nintex K2 Cloud Update 21 onwards there are two different apps for SharePoint Online. The legacy Nintex K2 Cloud for SharePoint app: used for SharePoint upgraded tenants, and the Nintex K2 Cloud (SPFx) app: used for new tenants.

When a list or library changes (such as adding a new column, or changing the list or library name), and application elements such as SmartObjects or forms were previously generated for that list or library, you must update the associated SmartObjects, and potentially the views, forms, and workflows as well. SharePoint list or library changes are detected and a warning displayed like 'Warning: the library and SmartObject are out of sync' on the Application page. This warning provides links that can automatically update the generated artifacts for the list/library by regenerating the SmartObjects, views, and forms. Click the appropriate link to regenerate only the SmartObjects, or the SmartObjects, views, and forms.


  • When regenerating customized views and forms, any customizations to those items will be lost.
  • If you are using the generated SmartObjects in a workflow, in a SmartForm or in code outside of the SharePoint application's generated elements, you may also need to update those items manually to handle the changes to the SmartObject.

You may also see this warning when you have deployed an application to a target list/library with a structure different to the source list/library. In some cases you may be able to safely ignore this message. See the KB article KB002528: Known Issue: "The list and SmartObject are out of sync" warning message when Viewing List or Library Artifacts for more information.

Criteria

The SharePoint item is checked for changes that would impact a SmartObject property or method, such as:

  • adding or removing a column
  • modifying a column's type (changing from text to number, for example)
  • the maximum value of a number field
  • scope (for people and group fields)
  • adding a content type (which means methods need to be added to the SmartObjects)
  • changing the list or library name

The Create Application page displays a warning message in the Data section if the product detects unsupported fields in the list/library.

Similarly, a warning displays in the Form section if the product supports a SharePoint field at the SmartObject level but not at the form level (Managed Metadata Fields, for example). You can still generate and use the form, but the system will not generate controls for the unsupported fields on the generated form.

For unsupported lists and libraries (for example a Data Connection Library), the product does not create a SmartObject nor the associated forms and views. For these unsupported lists and libraries, the Create Application page displays an error message and prevent you from creating any artifacts, as shown below.

For more information see Supported artifacts.

Considerations

  • , when you execute the List’s SmartObject GetList method (using TesterTool or Management), the system truncates parts of the data or JSON/XML tags. As a result, the returned data does not match the way it is stored in SharePoint. To fix this you must manually add the RemoveSPNoteXMLWrapper appSetting to the ServiceBroker, SourceCode.SmartObject.Service.SharePoint.dll.config file.

    • True = Truncated (cleaner but may lose some data fidelity)

    • False = Not truncated (shows XML encapsulation from SharePoint)

    Important to know that if the List contains a Rich Text multiple line of text control and the you decide to set the appsetting to false (disabling wrapping) Microsoft XML encapsulation will display. You will have to decides on which behaviour they would prefer to have.