Interface: ATSOps

Provider

<integer>ATSOps.NumProviders() 

Returns the number of registered ATS providers.

<string>ATSOps.GetProviderName <index>ProviderIndex 

Returns the name of the indexed provider as string.

If the index is less than 1 and higher than the number of available providers, returns undefined.

<index>ATSOps.GetActiveProvider() 

Returns the index of the active provider.

<void>ATSOps.SetActiveProvider <index>ProviderIndex 

Sets the the active provider to the indexed provider.

<bool>ATSOps.IsInitialized <index>ProviderIndex 

Returns true if the indexed provider is initialized, false otherwise.

<void>ATSOps.Login <index>ProviderIndex 

Logs in to the indexed provider.

Corresponds to the Server>Log in... option in the Asset Tracking dialog's menu.

<void>ATSOps.Logout <index>ProviderIndex 

Logs out of the indexed provider.

Corresponds to the Server>Logout option in the Asset Tracking dialog's menu.

<void>ATSOps.LaunchProvider<index>ProviderIndex 

Launches the indexed provider.

Corresponds to the Server>Launch Provider... option in the Asset Tracking dialog's menu.

<index>ATSOps.GetNotificationProviderIndex() 

Returns the notification provider index.

<void>ATSOps.LaunchOptions <index>ProviderIndex 

Opens the Options dialog of the indexed provider.

Corresponds to the Server>Options... option in the Asset Tracking dialog's menu.

Asset Selection Access

<integer>ATSOps.NumFilesSelected() 

Returns the number of selected files.

<integer>ATSOps.GetSelectedFiles <&string array>FileList 

FileListis In and Out parameter 

Collects the selected files into the by-reference FileList array.

Returns the number of files collected.

<void>ATSOps.SelectFiles <&string array>FileList 

FileListis In and Out parameter 

Selects the asset files specified by the by-reference FileList array.

The method does not clear the existing selection, but adds to it. To replace the existing selection, call ATSOps.ClearSelection() beforehand.

<void>ATSOps.ClearSelection() 

Clears the selection in the Asset Tracking dialog.

Asset Files Access

<integer>ATSOps.NumFiles() 

Returns the total number of files in the Asset Tracking dialog.

<integer>ATSOps.GetFiles <&string array>FileList 

FileList is In and Out parameter 

Collects all files in the Asset Tracker into the by-reference FileList array.

Returns the number of files collected.

<integer>ATSOps.GetDependentFiles <string>Filename <bool>Recurse <&string array>FileList IncludeOutputFiles:<bool> 

FileList is In and Out parameter 
IncludeOutputFiles default value: true 

Collects the dependent files of the specified filename into the by-reference FileList array.

If the Recurse boolean parameter is set to true, also recurses through all collected files, collecting their dependent files too.

If the IncludeOutputFiles: optional keyword argument is not specified or specified and set to true, output files will also be included in the dependency list. If it is specified and set to false, output files will not be included.

Returns the number of files collected in the FileList array.

Open and Close Projects

<void>ATSOps.OpenFromVault() 

Launches the Opens from Autodesk Vault dialog.

<void>ATSOps.OpenProject <index>ProviderIndex <filename>ProjectPath 

Opens the specified project using the indexed provider.

The call to atsops.openproject() is required in order to stay compliant with MSSCC and 3 ^rd party providers like Perforce, Alienbrain, VSS etc. For consistency, Autodesk Vault also requires a call to atsops.openproject() if no scene file is open in 3ds Max.

atsops.login 2 --using the second provider...
atsops.openproject 2 "C:\\myVault\\3dsmax\\DWFTest"--open the project
fl = #("C:\\myVault\\3dsmax\\DWFTest\\noload.max")--define a file list
atsops.addfiles 2 fl "comment" --add the file list
atsops.logout 2 --log out from the second provider 

<bool>ATSOps.IsProjectOpen <index>ProviderIndex 

Returns true if a project is open for the indexed provider, false otherwise.

<void>ATSOps.CloseProject <index>ProviderIndex 

Closes the current project in the indexed provider.

<void>ATSOps.GetFromProvider <index>ProviderIndex <string>FilterName <string>FilterExtensions <bool>AddAllFilesFilter <bool>MultiSelect <bool>Download <&string array>FileList 

FileList is In and Out parameter 

Opens the Gets Files dialog from the indexed provider using the specified filter Name and filter Extensions strings to initialize the dialog.

If the AddAllFilesFilter parameter is supplied as true, adds the All files (*.*) filter to the dialog.

If MultiSelect is supplied as true, allows multiple selections.

The FileList array passed by-reference will contain the resulting list of files returned by the provider.

Test File Status

<bool>ATSOps.IsFileExcluded <index>ProviderIndex <string>Filename 

Returns true if the specified file is excluded by the indexed provider, false otherwise.

<bool>ATSOps.IsFileShareLocked <index>ProviderIndex <filename>Filename 

Returns true if a file is share locked by an ATS Provider.

A file is considered share locked if the file is checked out by another user at a shared location. Share locked files should be treated as read-only by users who are accessing the file and are not the owner of the lock.

Provider Index is the index of ATS Provider. If ProviderIndex is -1, the method will check all providers for a share locked status.

Filenameis the string that contains the file name.

Available in 3ds Max 9 and higher.

<bool>ATSOps.IsInputFile <filename>Filename 

Returns true if the specified file is an input file and a true dependent file, false if it is an output file or if it is not found.

Available in 3ds Max 9 and higher.

<namesarray>ATSOps.GetFileStatus <index>ProviderIndex <string>Filename 

Returns an array of Name Literals based on the status of the file.

ProviderIndexis the index of ATS Provider. If ProviderIndex is -1, the method will check all providers for the status.

Available in 3ds Max 9 and higher.

myStatus = ATSOps.GetFileStatus 1"C:\\myVault\\myScene.max"
#(#Controlled, #OutOfDate, #Modified)

<bool>ATSOps.TestFileStatus <index>ProviderIndex <string>Filename <enum>Status 

Status enums : {#Unknown | #NotControlled | #Controlled | #CheckedOut | #CheckedOutOther | #OutOfDate | #Deleted | #Missing | #Modified | #Hidden | #ShareLock | #CanCheckin | #CanCheckout | #CanUndoCheckout | #CanGetLatest | #CanAddFile | #CanShowHistory | #CanShowProperties} 

Returns true if the specified file has the supplied status on theindexed provider.

<void>ATSOps.GetFilesByStatus<index>ProviderIndex <enum>Status <&string array>FileList 

Status enums: {#Unknown | #NotControlled | #Controlled | #CheckedOut | #CheckedOutOther | #OutOfDate | #Deleted | #Missing | #Modified | #Hidden | #ShareLock | #CanCheckin | #CanCheckout | #CanUndoCheckout | #CanGetLatest | #CanAddFile | #CanShowHistory | #CanShowProperties} 
FileList is In and Out parameter 

Returns all files that have the supplied status on the indexed provider into the by-reference FileList array.

<namesarray>ATSOps.GetFileSystemStatus <string>Filename 

Returns an array of Name Literals based on the system status of the file.

Possible status Name Literals are:

Available in 3ds Max 9 and higher.

<bool>ATSOps.TestFileSystemStatus <filename>Filename <enum>Status 

Status enums: {#Unknown | #Ok | #Missing | #Found | #NetworkPath} 

Returns true if the given file name has the specified status, false otherwise.

See table above for details.

Available in 3ds Max 9 and higher.

<integer>ATSOps.GetFilesByFileSystemStatus <enum>Status <&filename array>FileList 

Status enums: {#Unknown | #Ok | #Missing | #Found | #NetworkPath} 
FileListis In and Out parameter 

Returns the number of files with the specified system status and and array of the file names via the by-reference parameter FileList.

Checking Files In and Out

<bool>ATSOps.Checkin <index>ProviderIndex <&string array>FileList <&TSTR>Comment 

FileList is In and Out parameter 
Comment is In and Out parameter 

Checks in the files specified by the by-reference FileList array of strings using the by-reference Comment string into the indexed provider.

In 3ds Max 9 and higher, returns true if the action can be performed, false otherwise.

<bool>ATSOps.Checkout <index>ProviderIndex <&string array>FileList <&TSTR>Comment 

FileList is In and Out parameter 
Comment is In and Out parameter 

Checks out the files specified by the by-reference FileList array of strings using the by-reference Comment string into the indexed provider.

In 3ds Max 9 and higher, returns true if the action can be performed, false otherwise.

<bool>ATSOps.UndoCheckout <index>ProviderIndex <&string array>FileList 

FileList is In and Out parameter 

Undoes the check out of the files specified by the by-reference FileList array of strings on the indexed provider.

In 3ds Max 9 and higher, returns true if the action can be performed, false otherwise.

<bool>ATSOps.GetLatest <index>ProviderIndex <&string array>FileList 

FileList is In and Out parameter 

Gets the latest version of the files specified by the by-reference FileList array of strings from the indexed provider.

Corresponds to the File>Get Latest option in the Asset Tracking dialog's menu.

In 3ds Max 9 and higher, returns true if the action can be performed, false otherwise.

<bool>ATSOps.AddFiles <index>ProviderIndex <&filename array>FileList <&TSTR>CommentIsHidden :<&bool array> 

FileList is In parameter 
Comment is In and Out parameter 
IsHidden default value: #() 
IsHidden is In parameter 

Adds the files specified by the by-reference FileList array of strings to the indexed provider, using the by-reference Comment string.

The optional isHidden: keyword argument can be used to provide an array of Boolean values, one for each file on the FileList. A value of true means that the fle will be added with a hidden status (if supported by the Provider).

In 3ds Max 9 and higher, returns true if the action can be performed, false otherwise.

<void>ATSOps.Properties <index>ProviderIndex <&string array>FileList 

FileList is In and Out parameter 

Opens the Properties... dialog for the files specified by the by-reference FileList array of strings with the indexed provider.

Corresponds to the File>Properties... option in the Asset Tracking dialog's menu.

<void>ATSOps.ShowHistory <index>ProviderIndex <&string array>FileList 

FileList is In and Out parameter 

Opens the History... dialog for the files specified by the by-reference FileList array of strings with the indexed provider.

Corresponds to the File>History... option in the Asset Tracking dialog's menu.

The following 8 methods are implemented as menu utility functions which return true when a file is selected in the ATS dialog and the corresponding operation can be performed. When automating ATS functionality using MAXScript, these methods will generally return false! You can use the atsops.TestFileStatus() method to perform these tests as described in the notes below.

<bool>ATSOps.CanCheckin() 

Returns true if checking in is possible in the ATS dialog, false otherwise.

atsops.TestFileStatus providerIndex filename #CanCheckin

<bool>ATSOps.CanCheckout() 

Returns true if checking out is possible in the ATS dialog, false otherwise.

atsops.TestFileStatus providerIndex filename #CanCheckout

<bool>ATSOps.CanUndoCheckout() 

Returns true if checking out can be undone in the ATS dialog, false otherwise.

atsops.TestFileStatus providerIndex filename #CanUndoCheckout

<bool>ATSOps.CanGetLatest() 

Returns true if getting latest is possible in the ATS dialog, false otherwise.

atsops.TestFileStatus providerIndex filename #CanGetLatest

<bool>ATSOps.CanAddFiles() 

Returns true if adding files is possible in the ATS dialog, false otherwise.

atsops.TestFileStatus providerIndex filename #CanAddFile

<bool>ATSOps.CanProperties() 

Returns true if getting the properties is possible in the ATS dialog, false otherwise.

atsops.TestFileStatus providerIndex filename #CanProperties

<bool>ATSOps.CanShowHistory() 

Returns true if showing history is possible in the ATS dialog, false otherwise.

atsops.TestFileStatus providerIndex filename #CanShowHistory

<bool>ATSOps.CanGetFromProvider <index>ProviderIndex 

Returns true if getting from provider is possible in the ATS dialog, false otherwise.

<void>ATSOps.CheckForDependentFiles <index>ProviderIndex <string>Filename 

Checks for files dependent on the supplied file in the indexed provider.

<void>ATSOps.CheckForCheckedOutFiles <index>ProviderIndex 

Checks for checked out files in the indexed provider.

<void>ATSOps.CheckForUnControlledFiles <index>ProviderIndex 

Checks for uncontrolled files in the indexed provider.

<void>ATSOps.CheckForOutDatedFiles <index>ProviderIndex 

Checks for outdated files in the indexed provider.

<void>ATSOps.CheckForSceneFileCheckOut <index>ProviderIndex 

Checks forscene file check-outin the indexed provider.

Working Comments

<void>ATSOps.SetWorkingComment <string>Comment 

Sets the working comment to the supplied string.

<string>ATSOps.GetWorkingComment() 

Returns the working comment as string.

Status Log

<void>ATSOps.AppendStatusLog <string>Status 

Adds the supplied string to the Status Log.

<void>ATSOps.ClearStatusLog() 

Clears the Status Log.

<string>ATSOps.GetStatusLog() 

Returns the Status Log as string.

Notifications

<bool>ATSOps.RegisterNotification <value>Callback <integer>ID 

Registers a notification callback with the specified integer ID.

<void>ATSOps.UnRegisterNotification <integer>ID 

Unregisters the notification callback with the specified ID.

<enum>ATSOps.GetNotificationID() 

GetNotificationID enums: {#NotifyPreLogin | #NotifyPostLogin | #NotifyPreLogout | #NotifyPostLogout | #NotifyPreOpenProject | #NotifyPostOpenProject | #NotifyPreCloseProject | #NotifyPostCloseProject | #NotifyPreLaunchOptions | #NotifyPostLaunchOptions | #NotifyPreLaunchProvider | #NotifyPostLaunchProvider | #NotifyPreCheckin | #NotifyPostCheckin | #NotifyPreCheckout | #NotifyPostCheckout | #NotifyPreUndoCheckout | #NotifyPostUndoCheckout | #NotifyPreAddFiles | #NotifyPostAddFiles | #NotifyPreGetLatest | #NotifyPostGetLatest | #NotifyPreProperties | #NotifyPostProperties | #NotifyPreShowHistory | #NotifyPostShowHistory | #NotifyFileListUpdate | #NotifyPreExploreProvider | #NotifyPostExploreProvider | #NotifyPreGetVersion | #NotifyPostGetVersion} 

Returns the notification ID as a Name Literal.

See table above for description and Integer ID value of the enum.

<integer>ATSOps.GetNotificationFileList <&string array>FileList 

FileList is In and Out parameter 

Writes the notification file list into the by-reference array of strings.

<bool>ATSOps.AddAttachmentToNotificationFileListEntry <index>FileListIndex <string>Filename 

Adds the file specified by the supplied Filename string as an attachment to the indexed file in the notification file list.

<bool>ATSOps.IsNotificationCancelled() 

Returns true if notification was cancelled, false otherwise.

If a message is cancelled by an object that has registered for notifications, all objects that received the notification before it was cancelled will be notified again, but this method will return true to allow the objects to perform any cleanup or undo any action taken.

<bool>ATSOps.AddFileToNotificationFileList <string>Filename 

Adds the supplied file name string to the notification file list. Returns true on success, false otherwise.

<bool>ATSOps.RemoveFileFromNotificationFileList <index>FileListIndex 

Removes the indexed file name from the notification file list.

Returns true on success, false otherwise.

Retargetting

<bool>ATSOps.SetPathOnSelection <filename>NewPath CreateOutputFolder :<bool> 

CreateOutputFolder default value: false 

Assigns the new path to the selection.If the optional CreateOutputFolder: keyword parameter is supplied and is true, the new path will be created if it does not exist.

Note that calling this method will clear the existing selection.

<bool>ATSOps.RetargetCommonRootOfSelection <filename>NewPath CreateOutputFolder:<bool> 

CreateOutputFolder default value: false 

The method will retarget the common root of assets selected in the Asset Tracker to the value passed in. For example, if the selected assets belong to C:/resources/projectA/ but are found in different sub-directories of that folder, then only the C:/resources/projectA/ portion will be repathed.

All selected assets must have a common-root portion.

NewPath is the path portion that will be prepended in place of the common root.

If the optional CreateOutputFolder: keyword parameter is supplied and is true, the new path will be created if it does not exist.

Returns true if the action succeeded and the assets were repathed.

<bool>ATSOps.RetargetSelection <filename>NewPath CreateOutputFolder :<bool> 

CreateOutputFolder default value: false 

Retargets a single selected asset to a new path and file name.

The newPath argument must specify both the path and the file name.

If the optional CreateOutputFolder: keyword parameter is supplied and is true, the new path will be created if it does not exist.

<bool>ATSOps.SetPath <filename>NewPath CreateOutputFolder :<bool> 

CreateOutputFolder default value: false 

Sets the path component of all listed assets to the path passed as first argument.

NewPathis the path value that will be applied to all listed assets.

If the optional CreateOutputFolder: keyword parameter is supplied and is true, the new path will be created if it does not exist.

Returns true if the action succeeds and the asset(s) are repathed.

<bool>ATSOps.RetargetCommonRoot <filename>NewPath CreateOutputFolder :<bool> 

CreateOutputFolder default value: false 

Retargets the common root of all assets listed in the Asset Tracker dialog.

For example, if all assets belong to C:\ but are found in different sub-directories of C:\, then only the C:\ portion of the path will be repathed.

All editable assets must have some common root portion.

NewPath is the path portion that will be prepended in place of the common root.

If the optional CreateOutputFolder: keyword parameter is supplied and is true, the new path will be created if it does not exist.

Returns true if the action succeeded and the assets were repathed.

<bool>ATSOps.RetargetAssets <&maxObject>AssetOwner <filename>OldPath <filename>NewPath CreateOutputFolder :<bool> 

AssetOwner is In and Out parameter 
CreateOutputFolder default value: false 

Retargets the assets of the specified asset owner from the given old path to the new path.

AssetOwner - The ReferenceTarget object from which assets are declared

OldPath - Used to determine which asset to retarget. Any asset declared with this path will be retargeted to NewPath.

NewPath - The retarget value.

If the optional CreateOutputFolder: keyword parameter is supplied and is true, the new path will be created if it does not exist.

This method calls the EnumAuxFiles implementation of ReferenceTarget to get a listing of assets.

Returns true if the action succeeded and at least one assets was repathed, false if no asset was repathed.

File Resolution

<bool>ATSOps.ResolveSelectionToUNC() 

Resolve the paths of the currently selected assets in the Asset Tracker dialog to their UNC equivalents regardless of the current application setting.

One or more assets must be selected in the Asset Tracker dialog - one of the assets must have an absolute path.

Returns true if one or more assets have been resolved to UNC.

Available in 3ds Max 9 and higher.

<bool>ATSOps.ResolveSelectionRelativeToProjectFolder() 

Converts paths selected in the Asset Tracker dialog to relative paths with respect to the project folder.

If the asset is found (meaning that it is found in the search path) in a location other than that pointed to by the absolute path,then the relative path will be calculated based on thisfound location. Otherwise, the absolute path is converted to a relative path relative to the current Project Folder setting, if possible.

One or more assets must be selected and at least one of the assets must have an absolute path.

Returns true if one or more assets are resolved to a path relative to the current Project Folder setting, as long as the absolute path exists on the same drive (or UNC) as the current Project Folder.

Available in 3ds Max 9 and higher.

<bool>ATSOps.ResolveSelectionToAbsolute() 

Converts the paths of one or more assets selected in the Asset Tracker dialog to absolute paths. At least one of the selected assets must have a relative path.

If the asset is found (meaning that it is found in the search path), then the absolute path will point to the found location. If not, then the relative path is converted to an absolute path relativeto the current Project Folder setting.

Returns true if one or more assets have been resolved to absolute paths.

Available in 3ds Max 9 and higher.

<integer>ATSOps.GetResolvedPaths <&filename array>FileList <&filename array>ResolvedFileList 

FileList is In parameter 
ResolvedFileList is In and Out parameter 

Returns the number of resolved paths.

Resolved files are files not found in the location specified within the scene file but found using the standard and user defined search paths.

The list of the files to check should be passed via the FileList parameter.

The by-reference ResolvedFileList parameter will be filled with the resolved file names.

If the file was found at the original location or is still missing (could not be resolved via the search paths), the entry in resolvedFileList will be the same as in fileList.

If the file was resolved the entry in resolvedFileList will contain the resolved file path.

Available in 3ds Max 9 and higher.

<integer>ATSOps.GetDependencyFileList <maxObject>Dependent <&filename array>FileList <bool>includeRefHierarchy 

FileList is Out parameter 

Gets the list of files that are used by the given maxObject.

Dependent is the maxObject for which the file dependencies are to be listed.

fileList is the by-reference array through which the file list is returned.

When includeRefHierarchy is set to true, the method will list dependencies of the entire reference hierarchy. When set to false, the list will be limited to the maxObject itself.

Returns the number of files found.

Working Folder Access

<void>ATSOps.SetWorkingFolder <index>ProviderIndex <filename>Folder 

Sets the working folder of the indexed provider to the specified file name.

Available in 3ds Max 9 and higher.

<filename>ATSOps.GetWorkingFolder <index>ProviderIndex 

Returns the working folder file name of the indexed provider.

Available in 3ds Max 9 and higher.

VersionAccess

<integer>ATSOps.GetMinVersion <index>ProviderIndex <filename>Filename 

Returns the lowest version of the given filename using the indexed provider.

<integer>ATSOps.GetMaxVersion <index>ProviderIndex <filename>Filename 

Returns the highest version of the given filename using the indexed provider.

<bool>ATSOps.GetVersion <index>ProviderIndex <filename>Filename <integer>VersionNumber 

Gets the specified version of the given file using the indexed provider.

Returns true on success, false otherwise.