About
Search
Welcome to M-Files Empower – our new support experience. We'd love to hear what you think!Give feedback
Home/System setup and customization/Vault configuration and customization/Event handlers and scripts

Available VBScript variables

Last updated on 3 April 2026

Admin
VBScript code is edited in the Edit VBScript code window available in the following dialogs: The available variables are described in the table below.
Note: When you develop new extensions or edit existing ones, we recommend that you replace VBScript content with Vault Application Framework (VAF) compatible code for future compatibility. For more information on the benefits of VAF development over VBScript, refer to The Vault Application Framework in M-Files Developer Portal.
Note: The M-Files API documentation is available online: M-Files API.
Note: In a shared M-Files Cloud environment, you can only install custom code that M-Files has validated.
Rows 1 to 10 of 40
Variable
Data type
Mode
Use
ActivityID MFilesAPI.TypedValue In The unique ID of the operation that is being processed. Can be used for identifying which events are caused by a certain server operation.
AllowStateTransition Boolean Out Can be used to allow or deny automatic state transition when running the automatic state transition script.
CurrentTransactionID MFilesAPI.TypedValue In The ID of the transaction. If event handlers are executed recursively (so that executing one causes another to be executed), the ID changes on every recursion level.
CurrentUserID MFilesAPI.Number In Contains the ID of the user who performed the action that triggered the script.
CurrentUserSessionInfo MFilesAPI.SessionInfo In Contains information about the login session of the user who caused the operation.
DisplayID MFilesAPI.TypedValue In Contains the object's unique ID. This ID is shown on the object's metadata card when the object is selected in the list. DisplayID can contain both numbers and letters. Often, DisplayID is the same as the object's internal ID whose value can be retrieved with the ObjVer variable. The internal ID can only contain numbers. DisplayID and the internal ID are usually different when the object has been imported from an external database.
FileTransferSessionID MFilesAPI.Number In Contains the user-specific data transfer identifier. The data transfer identifier is created when the data transfer is being started on the server and, at the same time, the same identifier is given to the BeforeFileUpload and BeforeFileDownload event handlers. After completion of the data transfer, the same data transfer identifier will be given to the AfterFileUpload and AfterFileDownload event handlers. This way it is possible to attach the event handlers of type "Before" to the event handlers of type "After".
FileVer MFilesAPI.FileVer In Contains the complete unique ID of the target file, consisting of the file ID and file version.
GetExtensionObject (method) N/A A method for retrieving the extension object defined by the vault application.

Use: GetExtensionObject( <object name> [, application GUID]), where the part [, application GUID] is optional.

For example: Set CK = GetExtensionObject("M-Files.ComplianceKit", "{0CAC5452-631F-4646-AC95-4A06BFB8147E}")

If the application GUID has not been specified, the extension object is searched from all the applications of the vault.
GroupID MFilesAPI.Number In The ID of the target user group.

Property definitions not shown for scripts

The property definitions listed in the following table are not shown by using the PropertyValues variable in scripts:

ID Name
24 Status changed
22 Single file
27 Deleted
28 Deleted by
33 Comment
29 Version label
30 Size on server (this version)
31 Size on server (all versions)
32 Marked for archiving
46 Collection members (documents)
47 Collection members (document collections)
101 Class groups
41 Assignment description
42 Deadline
43 Monitored by
44 Assigned to
45 Marked as complete by
97 Marked as rejected by
79 Workflow Assignment
81 Accessed by me
82 Favorite view
89 Object changed
90 Permissions changed
91 Version label changed
92 Version comment changed
93 Deletion status changed
96 Conflict resolved
105 Object changed for export
106 Object version changed for export

For example, the following piece of script results in a "not found" error:

Dim DeadlineValue
DeadlineValue = PropertyValues.SearchForProperty(42).TypedValue.DisplayValue
Tip: You can use the GetProperties method to get all the properties of a specific object.
Related content

Still need help?

Ask the M-Files Community
Submit a Support Request
Popular links
What is enterprise content management?Business process managementCollaboration solutionsSolutions by industryKey capabilities
About M-Files
Contact usSchedule a demoCareersTrust CenterPrivacy policySecurity Hall of Fame
Resources
Customer Support PortalPartner HubDeveloper PortalUser guideM-Files CommunityTerms and conditions