Groovy Script Library | Asite Help Center

Groovy script enables users in creating system tasks other than the already available tasks on user interface. These can be executed using triggers in pre and post mode, as a part of any workflow or even independent from a workflow. Click on the below links to access their detailed help:

Groovy Script Library

Groovy Script Objects & Functions

A. Groovy Script Library

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

def execute(){

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

// Add your script code in this block

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

}

You can access below mentioned attributes of document revision via groovy script:

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

You can update value of below mentioned attributes of document revision via groovy script:

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

Below is a list of ready to use standard sample groovy scripts which can be used directly in groovy script based system tasks. Click on the groovy script name / purpose to go directly to the concerned groovy script.

No.	Groovy Script Link & Purpose
1	Access attributes of Document & it's attachment Task Mode: --- \| Context: Document
2	Stop upload process if Document doesn't have attachment & display message to User Task Mode: Pre \| Context: Document
3	Stop upload process if Document revision number is not numeric & display message to User Task Mode: Pre \| Context: Document
4	Update Document revision number to two digit if it is in one digit & numeric only, after Document uploaded Task Mode: Post \| Context: Document
5	Update Document title to upper case, after Document uploaded Task Mode: Post \| Context: Document
6	Update Revision notes after Document uploaded Task Mode: Post \| Context: Document
7	Call Web Service Task Mode: Post \| Context: Document
8	Stop upload process if Doc Ref doesn't match with specific pattern & display message to User Task Mode: Pre \| Context: Document
9	Validate Doc Ref Uniqueness at Project Level Task Mode: Pre \| Context: Document
10	Validate Doc Ref Uniqueness at Project Level by excluding linked documents Task Mode: Pre \| Context: Document
11	Validate Doc Ref Uniqueness at Project Level for first revision or issue only Task Mode: Pre \| Context: Document
12	Validate combination of Purpose of Issue and Document Status abbreviations Task Mode: Pre / On-Load \| Context: Document
13	Validate combination of Purpose of Issue & Document Status Task Mode: Pre \| Context: Document
14	Apply Activity Locks to Document Task Mode: Post \| Context: Document
15	Update Document Status Task Mode: Post \| Context: Document
16	Transfer Files to Other Network Location in Packages Task Mode: Post \| Context: Document
17	Distribute Files based on Email ID Task Mode: Post \| Context: Document
18	Distribute Files based on Role Task Mode: Post \| Context: Document
19	Distribute Files based on Organization ID Task Mode: Post \| Context: Document
20	Distribute Files based on Number of Due Days Task Mode: Post \| Context: Document
21	Distribute Files based on Due Date Task Mode: Post \| Context: Document
22	Create Placeholder Task Mode: Post \| Context: Document
23	Insert Document Status for Files in PDF format Task Mode: Pre \| Context: Document
24	Assign Roles to users via Form Task Mode: Post \| Context: App
25	Fetch list of Documents by Custom Attribute and update title of all private Documents from the list Task Mode: Post \| Context: Document
26	Cancel Workflows of all the provided Documents Task Mode: Post \| Context: Document
27	Set Document Version to dynamicADecisionVariable which can be used in Decision Gateway condition Task Mode: Post \| Context: Document
28	Set Due Date of specific timer of Workflow by fetching date from Document's Custom Attribute Task Mode: Post \| Context: Document
29	Update Document Attributes Task Mode: Post \| Context: Document
30	Configure Download Preference for renaming Files using Custom Attribute values upon download Task Mode: On-Load \| Context: Document
31	Rename files with custom attributes upon download Task Mode: Pre \| Context: Document
32	Control options on 'Edit Status' screen Task Mode: On-Load \| Context: Document
33	Make any or all of the document attributes non-editable on 'Upload' and 'Edit Attributes' screen Task Mode: On-Load \| Context: Document
34	Get details of already uploaded documents based on current revision Task Mode: Post \| Context: Document
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) while downloading and printing the document (Supported in Asite Viewer supported file formats only) Task Mode: Pre \| Context: Document
38	Embed QR code (of 'Static' type) while downloading and printing the document (Supported in Asite Viewer supported file formats only) Task Mode: Pre \| Context: Document
39	Enable 'Include QR code' option in download preference Task Mode: On-Load \| Context: Document
40	Display a colour coded status bar upon QR code scan (for 'Static' QR code type) Task Mode: On-Load \| Context: Document
41	Generate Custom XML output from App data Task Mode: Post \| Context: App
42	Read data from custom XML parts of .docx file and set attribute values in File Upload screen Task Mode: On-Load \| Context: Document
43	Read file attribute values from 'Edit Attributes' screen and update custom XML parts of .docx file Task Mode: Post \| Context: Document
44	Read attribute values for file status change and write those data into custom XML parts of .docx file Task Mode: Post \| Context: Document
45	Control options available while creating a new aMessage / replying to an aMessage Task Mode: On-Load \| Context: Document
46	Assign Role to Users by Email Task Mode: Post \| Context: App
47	Send Custom Email Notification Task Mode: Post \| Context: Document/App
48	Set Private Comment by User Role Task Mode: On-Load \| Context: Document
49	Access Current User Task Mode: Pre \| Context: Document
50	Cancel Running Workflows on Current, Previous or Superseded Revisions Task Mode: Post \| Context: Document
51	Update Form Status Task Mode: Post \| Context: App
52	Stop publish document process if Document revision number is not numeric and it is not higher than previous/existing latest revision Task Mode: Pre \| Context: Document
53	Assign Visibility Task Mode: Post \| Context: Document
54	Update status of all the associated documents of current form Task Mode: Post \| Context: App
55	Distribute Form Task Mode: Post \| Context: App
56	Auto Incrementing Revision Task Mode: Post \| Context: Document
57	Restrict specific file types to be uploaded in Asite platform Task Mode: Post \| Context: Document
58	Create New Form by fetching details of an existing Form Task Mode: Post \| Context: App
59	Create New File Review or Reply to Existing File Review Comment Task Mode: On-Load \| Context: Document
60	Edit Form Fields Task Mode: Post \| Context: App
61	Dynamic Distribution of Files based on User's Email, Role or Distribution Group Task Mode: Post \| Context: Document
62	Dynamic Distribution of Files based on the ID of User, Role or Distribution Group Task Mode: Post \| Context: Document
63	Dynamic Distribution of Forms based on User's Email, Role or Distribution Group Task Mode: Post \| Context: App
64	Dynamic Distribution of Forms based on the ID of User, 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
66	Push issues on a federated model to 3D Repo Task Mode: Post \| Context: Document

Check: FAQs

Next Article: Groovy Script - Access all attributes of Document and it's attachment

No.	Groovy Script Link & Purpose
1	Access attributes of Document & it's attachment Task Mode: --- \| Context: Document
2	Stop upload process if Document doesn't have attachment & display message to User Task Mode: Pre \| Context: Document
3	Stop upload process if Document revision number is not numeric & display message to User Task Mode: Pre \| Context: Document
4	Update Document revision number to two digit if it is in one digit & numeric only, after Document uploaded Task Mode: Post \| Context: Document
5	Update Document title to upper case, after Document uploaded Task Mode: Post \| Context: Document
6	Update Revision notes after Document uploaded Task Mode: Post \| Context: Document
7	Call Web Service Task Mode: Post \| Context: Document
8	Stop upload process if Doc Ref doesn't match with specific pattern & display message to User Task Mode: Pre \| Context: Document
9	Validate Doc Ref Uniqueness at Project Level Task Mode: Pre \| Context: Document
10	Validate Doc Ref Uniqueness at Project Level by excluding linked documents Task Mode: Pre \| Context: Document
11	Validate Doc Ref Uniqueness at Project Level for first revision or issue only Task Mode: Pre \| Context: Document
12	Validate combination of Purpose of Issue and Document Status abbreviations Task Mode: Pre / On-Load \| Context: Document
13	Validate combination of Purpose of Issue & Document Status Task Mode: Pre \| Context: Document
14	Apply Activity Locks to Document Task Mode: Post \| Context: Document
15	Update Document Status Task Mode: Post \| Context: Document
16	Transfer Files to Other Network Location in Packages Task Mode: Post \| Context: Document
17	Distribute Files based on Email ID Task Mode: Post \| Context: Document
18	Distribute Files based on Role Task Mode: Post \| Context: Document
19	Distribute Files based on Organization ID Task Mode: Post \| Context: Document
20	Distribute Files based on Number of Due Days Task Mode: Post \| Context: Document
21	Distribute Files based on Due Date Task Mode: Post \| Context: Document
22	Create Placeholder Task Mode: Post \| Context: Document
23	Insert Document Status for Files in PDF format Task Mode: Pre \| Context: Document
24	Assign Roles to users via Form Task Mode: Post \| Context: App
25	Fetch list of Documents by Custom Attribute and update title of all private Documents from the list Task Mode: Post \| Context: Document
26	Cancel Workflows of all the provided Documents Task Mode: Post \| Context: Document
27	Set Document Version to dynamicADecisionVariable which can be used in Decision Gateway condition Task Mode: Post \| Context: Document
28	Set Due Date of specific timer of Workflow by fetching date from Document's Custom Attribute Task Mode: Post \| Context: Document
29	Update Document Attributes Task Mode: Post \| Context: Document
30	Configure Download Preference for renaming Files using Custom Attribute values upon download Task Mode: On-Load \| Context: Document
31	Rename files with custom attributes upon download Task Mode: Pre \| Context: Document
32	Control options on 'Edit Status' screen Task Mode: On-Load \| Context: Document
33	Make any or all of the document attributes non-editable on 'Upload' and 'Edit Attributes' screen Task Mode: On-Load \| Context: Document
34	Get details of already uploaded documents based on current revision Task Mode: Post \| Context: Document
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) while downloading and printing the document (Supported in Asite Viewer supported file formats only) Task Mode: Pre \| Context: Document
38	Embed QR code (of 'Static' type) while downloading and printing the document (Supported in Asite Viewer supported file formats only) Task Mode: Pre \| Context: Document
39	Enable 'Include QR code' option in download preference Task Mode: On-Load \| Context: Document
40	Display a colour coded status bar upon QR code scan (for 'Static' QR code type) Task Mode: On-Load \| Context: Document
41	Generate Custom XML output from App data Task Mode: Post \| Context: App
42	Read data from custom XML parts of .docx file and set attribute values in File Upload screen Task Mode: On-Load \| Context: Document
43	Read file attribute values from 'Edit Attributes' screen and update custom XML parts of .docx file Task Mode: Post \| Context: Document
44	Read attribute values for file status change and write those data into custom XML parts of .docx file Task Mode: Post \| Context: Document
45	Control options available while creating a new aMessage / replying to an aMessage Task Mode: On-Load \| Context: Document
46	Assign Role to Users by Email Task Mode: Post \| Context: App
47	Send Custom Email Notification Task Mode: Post \| Context: Document/App
48	Set Private Comment by User Role Task Mode: On-Load \| Context: Document
49	Access Current User Task Mode: Pre \| Context: Document
50	Cancel Running Workflows on Current, Previous or Superseded Revisions Task Mode: Post \| Context: Document
51	Update Form Status Task Mode: Post \| Context: App
52	Stop publish document process if Document revision number is not numeric and it is not higher than previous/existing latest revision Task Mode: Pre \| Context: Document
53	Assign Visibility Task Mode: Post \| Context: Document
54	Update status of all the associated documents of current form Task Mode: Post \| Context: App
55	Distribute Form Task Mode: Post \| Context: App
56	Auto Incrementing Revision Task Mode: Post \| Context: Document
57	Restrict specific file types to be uploaded in Asite platform Task Mode: Post \| Context: Document
58	Create New Form by fetching details of an existing Form Task Mode: Post \| Context: App
59	Create New File Review or Reply to Existing File Review Comment Task Mode: On-Load \| Context: Document
60	Edit Form Fields Task Mode: Post \| Context: App
61	Dynamic Distribution of Files based on User's Email, Role or Distribution Group Task Mode: Post \| Context: Document
62	Dynamic Distribution of Files based on the ID of User, Role or Distribution Group Task Mode: Post \| Context: Document
63	Dynamic Distribution of Forms based on User's Email, Role or Distribution Group Task Mode: Post \| Context: App
64	Dynamic Distribution of Forms based on the ID of User, 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
66	Push issues on a federated model to 3D Repo Task Mode: Post \| Context: Document