Loop namespace
The Loop namespace contains the following classes, enumerations, and interfaces provided by Nintex DocGen for Salesforce.
Classes
| Class | Description |
|---|---|
| Adhoc | Specifies additional ad hoc files available for selection on the DocGen Package run page. |
| Attachment | Represents an ad hoc file to be included as an attachment for a DocGen Package. This class is defined within the AdHoc class. |
| DataObject | Represents the description of a requested object. This class is defined within the ExternalData class. |
| DocumentService | Provides static methods with which to convert and merge documents using Apex. It is useful when you need to consolidate outputs from different DocGen jobs or manually assembled files. |
| ExternalData | Defines classes used to define queries and return query results for the DocGen Package being run. |
| FieldInfo | Stores information about fields for the DataObject class. This class is defined within the ExternalData class. |
| loopMessage | Initiates DocGen Package requests to run asynchronously, meaning it runs in the background. It is ideal for bulk or long-running operations like nightly batch jobs or mass document generation. This doesn’t block the UI and handles large data volumes. |
|
Create a collection of DocGen Package requests to run as a batch. |
|
|
Provides parameters and options for the Process DocGen Package Visualforce Component. It triggers document generation synchronously, meaning it runs immediately and waits for the process to complete. It is great for real-time actions, like when users click a custom button and expect an immediate result. It can be embedded directly into your custom-built interfaces or Apex logic, so users don’t have to switch to another screen, or UI, or use Flow. It provides immediate feedback (like the standard DocGen loading bar) and is more user-facing. |
|
|
Stores information that defines the query for the DocGen Package being run. This class is defined within the ExternalData class. |
|
|
Stores the results of a query for an individual object. This class is defined within the ExternalData class. |
|
|
Stores the results of a query results for all objects returned by a query. This class is defined within the ExternalData class. |
|
|
Stores relationship information for the DocGen Package being run. This class is defined within the ExternalData class. |
|
|
Represents a Veeva Vault article as an ad hoc file that can be included as an attachment to a DocGen Package. This class is defined within the AdHoc class. |
Enumerations
| Enumeration | Description |
|---|---|
| Notification enumeration |
Specifies notification only of errors in the batch run. |
| ThemeStyle enumeration | Describes options for the style theme that can be applied to the Process DocGen Package Visualforce component. |
Interfaces
| Interface | Description |
|---|---|
| IApexDataSource | Represents a data source that can be used in an Apex Data relationship. |
| IAttachmentManager | Represents an attachment manager for ad hoc files to be displayed as available attachments for a DocGen Package. |