Groovy Script Library | Asite Help Centre

The Groovy scripts enable users to create system tasks that extend beyond those already provided in the user interface. These tasks can be executed by configuring workflow triggers in both pre-mode and post-mode, as part of a workflow or independently of a workflow. Click the links below to access their detailed help:

Groovy Script Library

Groovy Script Objects and Functions

A. Groovy Script Library

Below is the predefined syntax structure of the Asite Groovy Script. Add your script code as mentioned below:

def execute(){

------------------------------------------

// Add your script code in this block

------------------------------------------

}

You can access the attributes of document revision via the Groovy script as mentioned below:

No.	Task Mode	Attribute	Purpose
1	Pre / Post	File Name	To access the name of the selected file revision.
2	Pre / Post	Document Ref	To access the document reference for the selected file revision.
3	Pre / Post	Revision	To access the details of the selected file revision.
4	Pre / Post	Document Title	To access the document title of the selected file revision.
5	Pre / Post	Purpose of Issue	To access the purpose of issuing the selected file revision.
6	Pre / Post	Status	To access the status of the selected file revision or app.
7	Pre / Post	Revision Notes	To access the revision notes for the selected file revision.
8	Pre / Post	Has Attachment	To check if the attachment is available with the chosen file revision.
9	Pre / Post	Attached File Name	To access the name of the attached file with the selected file revision.
10	Pre / Post	isPrivate	To check whether the selected file revision is private or not.
11	Post	Document Path	To access the file path of the chosen file revision.
12	Post	File Size	To access the size of the selected file revision.
13	Post	Project Name	To access the name of the project.
14	Post	Publish Date	To access the publication date of the selected file revision.
15	Post	Publisher Email	To access the email address of the user who published the selected file.
16	Post	Publisher Organization	To access the name of the organisation that published the selected file.
17	Post	Version Number	To access the version number of the selected file revision.
18	Post	Configurable Attributes	To access all types of configurable attributes available for the selected file revision.

You can update the value of the attributes of the document revision via a Groovy script as mentioned below:

No.	Task Mode	Attribute	Purpose
1	Post	Document Title	To update the document title of the selected file revision.
2	Post	Revision Number	To update the revision number for the selected file revision.
3	Post	Revision Notes	To revise the notes for the selected file revision.
4	Post	File Status	To change the status of the selected file revision.
5	Post	DocRef	To update the document reference of the selected file revision.
6	Post	Purpose of Issue	To assign a different purpose for issuing the selected file revision.
7	Post	File Privacy	To update the file privacy of the selected file revision.
8	Post	Configurable Attributes	To update all types of configurable attributes available for the selected file revision.

Below is a list of ready-to-use sample Groovy scripts which can be used directly in Groovy script-based system tasks. Click the Groovy script name to go directly to the concerned Groovy script.

No.	Groovy Script Link and Purpose
1	Access all Attributes of a Document and its Attachments Task Mode: --- \| Context: Document --> Document Type: File
2	Stop the Upload if the Document doesn't have an Attachment and display a Message Task Mode: Pre \| Context: Document --> Document Type: File
3	Stop the Upload if the Document Revision Number is not Numeric and display a Message Task Mode: Pre \| Context: Document --> Document Type: File
4	Update the Document Revision Number to 2 digits if it is 1 digit and is Numeric only, after the Document is uploaded Task Mode: Post \| Context: Document --> Document Type: File
5	Update the Document Title to Uppercase after the Document is Uploaded Task Mode: Post \| Context: Document --> Document Type: File
6	Update the Revision Notes after the Document is Uploaded Task Mode: Post \| Context: Document --> Document Type: File
7	Call Web Service Task Mode: Post \| Context: Document --> Document Type: File
8	Stop the Upload if the Doc Ref doesn't match a Defined Pattern and display a Message Task Mode: Pre \| Context: Document --> Document Type: File
9	Validate Doc Ref Uniqueness at the Project Level Task Mode: Pre \| Context: Document --> Document Type: File
10	Validate Doc Ref Uniqueness at the Project Level by Excluding Linked Documents Task Mode: Pre \| Context: Document --> Document Type: File
11	Validate Doc Ref Uniqueness at the Project Level for the First Revision or Issue Only Task Mode: Pre \| Context: Document --> Document Type: File
12	Validate the Combination of Purpose of Issue and Document Status Abbreviations Task Mode: Pre / On-Load \| Context: Document --> Document Type: File
13	Validate the Combination of Purpose of Issue and Document Status Task Mode: Pre \| Context: Document --> Document Type: File
14	Apply Activity Locks to a Document Task Mode: Post \| Context: Document --> Document Type: File
15	Update Document Status Task Mode: Post \| Context: Document --> Document Type: File
16	Transfer Files to Other Network Locations in Packages Task Mode: Post \| Context: Document --> Document Type: File
17	Distribute Files Based on Email ID Task Mode: Post \| Context: Document --> Document Type: File
18	Distribute Files Based on Role Task Mode: Post \| Context: Document --> Document Type: File
19	Distribute Files Based on Organisation ID Task Mode: Post \| Context: Document --> Document Type: File
20	Distribute Files based on the number of Due Days Task Mode: Post \| Context: Document --> Document Type: File
21	Distribute Files based on the Due Date Task Mode: Post \| Context: Document --> Document Type: File
22	Create Placeholder Task Mode: Post \| Context: Document --> Document Type: File
23	Insert Document Status for Files in PDF format Task Mode: Pre \| Context: Document --> Document Type: File
24	Assign Roles to Users via Form Task Mode: Post \| Context: App
25	Fetch the list of Documents by Custom Attribute and update the Title of all Private Documents from the list Task Mode: Post \| Context: Document --> Document Type: File
26	Cancel Workflows for all the Provided Documents Task Mode: Post \| Context: Document --> Document Type: File
27	Set Document Version to dynamicADecisionVariable, which can be used in the Decision Gateway Condition Task Mode: Post \| Context: Document --> Document Type: File
28	Set the Due Date of a specific timer of a Workflow by fetching the date from the Document's Custom Attribute Task Mode: Post \| Context: Document --> Document Type: File
29	Update Document Attributes Task Mode: Post \| Context: Document --> Document Type: File
30	Configure Download Preference for Renaming Files Using Custom Attribute Values Upon Download Task Mode: On-Load \| Context: Document --> Document Type: File
31	Rename Files Using Custom Attribute Values Upon Download Task Mode: Pre \| Context: Document --> Document Type: File
32	Control the Options on the 'Edit Status' screen Task Mode: On-Load \| Context: Document --> Document Type: File
33	Make any or all of the Document Attributes non-editable on the 'Upload' and 'Edit Attributes' screens Task Mode: On-Load \| Context: Document --> Document Type: File
34	Get details of the Uploaded Documents based on the Current Revision Task Mode: Post \| Context: Document --> Document Type: File
35	Push Associated Files to Bluebeam Studio Task Mode: Post \| Context: App
36	Pull Reviewed Files from Bluebeam Studio Task Mode: Post \| Context: App
37	Embed QR code (of 'Dynamic' type) when downloading and printing the Document Task Mode: Pre \| Context: Document --> Document Type: File
38	Embed QR code (of 'Static' type) while downloading and printing the Document Task Mode: Pre \| Context: Document --> Document Type: File
39	Enable the 'Include QR code' option in the Download Preferences Task Mode: On-Load \| Context: Document --> Document Type: File
40	Display a Colour-coded Status Bar upon QR code scan (for 'Static' QR code type) Task Mode: On-Load \| Context: Document --> Document Type: File
41	Generate Custom XML Output from the Form Data Task Mode: Post \| Context: App
42	Read Data from Custom XML parts of a .docx file and Set Attribute Values in the File Upload screen Task Mode: On-Load \| Context: Document --> Document Type: File
43	Read File Attribute values from the 'Edit Attributes' screen and Update Custom XML parts of the .docx file Task Mode: Post \| Context: Document --> Document Type: File
44	Read Attribute Values for File Status Change and write the Attribute Data into the Custom XML parts of the .docx file Task Mode: Post \| Context: Document --> Document Type: File
45	Available Options for aMessages Task Mode: On-Load \| Context: Document --> Document Type: File
46	Assign Role to Users by Email Task Mode: Post \| Context: App
47	Send Custom Email Notifications Task Mode: Post \| Context: Any
48	Set Private Comment by User Role Task Mode: On-Load \| Context: Document --> Document Type: File
49	Access Current User Task Mode: Pre \| Context: Document --> Document Type: File
50	Cancel Running Workflows on Current, Previous or Superseded Revisions Task Mode: Post \| Context: Document --> Document Type: File
51	Update Form Status Task Mode: Post \| Context: App
52	Stop the Publish Document process if the Document Revision Number is not Numeric and it is not higher than the Previous or Existing Latest Revision Task Mode: Pre \| Context: Document --> Document Type: File
53	Assign Visibility Task Mode: Post \| Context: Document --> Document Type: File
54	Update the status of all the associated documents of the current form Task Mode: Post \| Context: App
55	Distribute Form Task Mode: Post \| Context: App
56	Auto-Incrementing Revision Task Mode: Post \| Context: Document --> Document Type: File
57	Restrict Specific File Types to be Uploaded in the Asite Platform Task Mode: Post \| Context: Document --> Document Type: File
58	Create a New Form by fetching details of an Existing Form Task Mode: Post \| Context: App
59	Create a New File Review or Reply to an Existing File Review Comment Task Mode: On-Load \| Context: Document --> Document Type: File
60	Edit Form Fields Task Mode: Post \| Context: App
61	Dynamic Distribution of Files Based on the User's Email, Role or Distribution Group Task Mode: Post \| Context: Document --> Document Type: File
62	Dynamic Distribution of Files Based on the User's ID, Role or Distribution Group Task Mode: Post \| Context: Document --> Document Type: File
63	Dynamic Distribution of Forms Based on the User's Email, Role or Distribution Group Task Mode: Post \| Context: App
64	Dynamic Distribution of Forms Based on the User's ID, Role or Distribution Group Task Mode: Post \| Context: App
65	Push federated models to 3D Repo and add 3D Repo's Model Viewing URL as a Custom Attribute Task Mode: Post \| Context: Document --> Document Type: File
66	Push issues on a Federated Model to the 3D Repo Task Mode: Post \| Context: Document --> Document Type: File
67	Cancel Workflows of the Current Form Task Mode: Post \| Context: App
68	Stop publishing Files on Files or Placeholders for Associated Records Task Mode: Pre \| Context: Document --> Document Type: File
69	Set dynamicADecisionVariable based on the Form field value, which can be used in the next Decision Gateway Condition Task Mode: Post \| Context: App
70	Set default values for system attribute fields when creating or editing a placeholder Task Mode: On-Load \| Context: Document --> Document Type: Placeholder
71	Set default values for custom attribute fields when creating or editing a placeholder Task Mode: On-Load \| Context: Document --> Document Type: Placeholder
72	Apply Activity Locks on a Placeholder Task Mode: Post \| Context: Document --> Document Type: Placeholder
73	Assign Visibility to a Placeholder Task Mode: Post \| Context: Document --> Document Type: Placeholder
74	Distribute File to Users, Roles, Organisations, and Groups (in a single Transmittal) Task Mode: Post \| Context: Document --> Document Type: File
75	Distribute Placeholder Task Mode: Post \| Context: Document --> Document Type: Placeholder
76	Update attributes of a Placeholder Task Mode: Post \| Context: Document --> Document Type: Placeholder
77	Validate DocRef Uniqueness at the Project Level (for Placeholders) Task Mode: Pre \| Context: Document --> Document Type: File/Placeholder

Check: FAQs

No.	Groovy Script Link and Purpose
1	Access all Attributes of a Document and its Attachments Task Mode: --- \| Context: Document --> Document Type: File
2	Stop the Upload if the Document doesn't have an Attachment and display a Message Task Mode: Pre \| Context: Document --> Document Type: File
3	Stop the Upload if the Document Revision Number is not Numeric and display a Message Task Mode: Pre \| Context: Document --> Document Type: File
4	Update the Document Revision Number to 2 digits if it is 1 digit and is Numeric only, after the Document is uploaded Task Mode: Post \| Context: Document --> Document Type: File
5	Update the Document Title to Uppercase after the Document is Uploaded Task Mode: Post \| Context: Document --> Document Type: File
6	Update the Revision Notes after the Document is Uploaded Task Mode: Post \| Context: Document --> Document Type: File
7	Call Web Service Task Mode: Post \| Context: Document --> Document Type: File
8	Stop the Upload if the Doc Ref doesn't match a Defined Pattern and display a Message Task Mode: Pre \| Context: Document --> Document Type: File
9	Validate Doc Ref Uniqueness at the Project Level Task Mode: Pre \| Context: Document --> Document Type: File
10	Validate Doc Ref Uniqueness at the Project Level by Excluding Linked Documents Task Mode: Pre \| Context: Document --> Document Type: File
11	Validate Doc Ref Uniqueness at the Project Level for the First Revision or Issue Only Task Mode: Pre \| Context: Document --> Document Type: File
12	Validate the Combination of Purpose of Issue and Document Status Abbreviations Task Mode: Pre / On-Load \| Context: Document --> Document Type: File
13	Validate the Combination of Purpose of Issue and Document Status Task Mode: Pre \| Context: Document --> Document Type: File
14	Apply Activity Locks to a Document Task Mode: Post \| Context: Document --> Document Type: File
15	Update Document Status Task Mode: Post \| Context: Document --> Document Type: File
16	Transfer Files to Other Network Locations in Packages Task Mode: Post \| Context: Document --> Document Type: File
17	Distribute Files Based on Email ID Task Mode: Post \| Context: Document --> Document Type: File
18	Distribute Files Based on Role Task Mode: Post \| Context: Document --> Document Type: File
19	Distribute Files Based on Organisation ID Task Mode: Post \| Context: Document --> Document Type: File
20	Distribute Files based on the number of Due Days Task Mode: Post \| Context: Document --> Document Type: File
21	Distribute Files based on the Due Date Task Mode: Post \| Context: Document --> Document Type: File
22	Create Placeholder Task Mode: Post \| Context: Document --> Document Type: File
23	Insert Document Status for Files in PDF format Task Mode: Pre \| Context: Document --> Document Type: File
24	Assign Roles to Users via Form Task Mode: Post \| Context: App
25	Fetch the list of Documents by Custom Attribute and update the Title of all Private Documents from the list Task Mode: Post \| Context: Document --> Document Type: File
26	Cancel Workflows for all the Provided Documents Task Mode: Post \| Context: Document --> Document Type: File
27	Set Document Version to dynamicADecisionVariable, which can be used in the Decision Gateway Condition Task Mode: Post \| Context: Document --> Document Type: File
28	Set the Due Date of a specific timer of a Workflow by fetching the date from the Document's Custom Attribute Task Mode: Post \| Context: Document --> Document Type: File
29	Update Document Attributes Task Mode: Post \| Context: Document --> Document Type: File
30	Configure Download Preference for Renaming Files Using Custom Attribute Values Upon Download Task Mode: On-Load \| Context: Document --> Document Type: File
31	Rename Files Using Custom Attribute Values Upon Download Task Mode: Pre \| Context: Document --> Document Type: File
32	Control the Options on the 'Edit Status' screen Task Mode: On-Load \| Context: Document --> Document Type: File
33	Make any or all of the Document Attributes non-editable on the 'Upload' and 'Edit Attributes' screens Task Mode: On-Load \| Context: Document --> Document Type: File
34	Get details of the Uploaded Documents based on the Current Revision Task Mode: Post \| Context: Document --> Document Type: File
35	Push Associated Files to Bluebeam Studio Task Mode: Post \| Context: App
36	Pull Reviewed Files from Bluebeam Studio Task Mode: Post \| Context: App
37	Embed QR code (of 'Dynamic' type) when downloading and printing the Document Task Mode: Pre \| Context: Document --> Document Type: File
38	Embed QR code (of 'Static' type) while downloading and printing the Document Task Mode: Pre \| Context: Document --> Document Type: File
39	Enable the 'Include QR code' option in the Download Preferences Task Mode: On-Load \| Context: Document --> Document Type: File
40	Display a Colour-coded Status Bar upon QR code scan (for 'Static' QR code type) Task Mode: On-Load \| Context: Document --> Document Type: File
41	Generate Custom XML Output from the Form Data Task Mode: Post \| Context: App
42	Read Data from Custom XML parts of a .docx file and Set Attribute Values in the File Upload screen Task Mode: On-Load \| Context: Document --> Document Type: File
43	Read File Attribute values from the 'Edit Attributes' screen and Update Custom XML parts of the .docx file Task Mode: Post \| Context: Document --> Document Type: File
44	Read Attribute Values for File Status Change and write the Attribute Data into the Custom XML parts of the .docx file Task Mode: Post \| Context: Document --> Document Type: File
45	Available Options for aMessages Task Mode: On-Load \| Context: Document --> Document Type: File
46	Assign Role to Users by Email Task Mode: Post \| Context: App
47	Send Custom Email Notifications Task Mode: Post \| Context: Any
48	Set Private Comment by User Role Task Mode: On-Load \| Context: Document --> Document Type: File
49	Access Current User Task Mode: Pre \| Context: Document --> Document Type: File
50	Cancel Running Workflows on Current, Previous or Superseded Revisions Task Mode: Post \| Context: Document --> Document Type: File
51	Update Form Status Task Mode: Post \| Context: App
52	Stop the Publish Document process if the Document Revision Number is not Numeric and it is not higher than the Previous or Existing Latest Revision Task Mode: Pre \| Context: Document --> Document Type: File
53	Assign Visibility Task Mode: Post \| Context: Document --> Document Type: File
54	Update the status of all the associated documents of the current form Task Mode: Post \| Context: App
55	Distribute Form Task Mode: Post \| Context: App
56	Auto-Incrementing Revision Task Mode: Post \| Context: Document --> Document Type: File
57	Restrict Specific File Types to be Uploaded in the Asite Platform Task Mode: Post \| Context: Document --> Document Type: File
58	Create a New Form by fetching details of an Existing Form Task Mode: Post \| Context: App
59	Create a New File Review or Reply to an Existing File Review Comment Task Mode: On-Load \| Context: Document --> Document Type: File
60	Edit Form Fields Task Mode: Post \| Context: App
61	Dynamic Distribution of Files Based on the User's Email, Role or Distribution Group Task Mode: Post \| Context: Document --> Document Type: File
62	Dynamic Distribution of Files Based on the User's ID, Role or Distribution Group Task Mode: Post \| Context: Document --> Document Type: File
63	Dynamic Distribution of Forms Based on the User's Email, Role or Distribution Group Task Mode: Post \| Context: App
64	Dynamic Distribution of Forms Based on the User's ID, Role or Distribution Group Task Mode: Post \| Context: App
65	Push federated models to 3D Repo and add 3D Repo's Model Viewing URL as a Custom Attribute Task Mode: Post \| Context: Document --> Document Type: File
66	Push issues on a Federated Model to the 3D Repo Task Mode: Post \| Context: Document --> Document Type: File
67	Cancel Workflows of the Current Form Task Mode: Post \| Context: App
68	Stop publishing Files on Files or Placeholders for Associated Records Task Mode: Pre \| Context: Document --> Document Type: File
69	Set dynamicADecisionVariable based on the Form field value, which can be used in the next Decision Gateway Condition Task Mode: Post \| Context: App
70	Set default values for system attribute fields when creating or editing a placeholder Task Mode: On-Load \| Context: Document --> Document Type: Placeholder
71	Set default values for custom attribute fields when creating or editing a placeholder Task Mode: On-Load \| Context: Document --> Document Type: Placeholder
72	Apply Activity Locks on a Placeholder Task Mode: Post \| Context: Document --> Document Type: Placeholder
73	Assign Visibility to a Placeholder Task Mode: Post \| Context: Document --> Document Type: Placeholder
74	Distribute File to Users, Roles, Organisations, and Groups (in a single Transmittal) Task Mode: Post \| Context: Document --> Document Type: File
75	Distribute Placeholder Task Mode: Post \| Context: Document --> Document Type: Placeholder
76	Update attributes of a Placeholder Task Mode: Post \| Context: Document --> Document Type: Placeholder
77	Validate DocRef Uniqueness at the Project Level (for Placeholders) Task Mode: Pre \| Context: Document --> Document Type: File/Placeholder