SysFileStoreManager Class [AX 2012]

The SysFileStoreManager class supplies an API to securely work with files that are supplied by or generated for clients.

Syntax

class SysFileStoreManager extends Object

Run On

Server

Methods

	Method	Description
	addFile	Creates mapping from client side file to server side temporary file.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	close	Marks the active SysFileStore as completed.
	copyFileToClient
	copyFileToServer
	delete	Deletes the active SysFileStore record.
	deleteFile	Deletes the SysFileStoreFile record indicated by the _sysFileStoreFileIdparameter.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	generateUniqueFileName
	getFileNameServer	Retrieves the server side filename for the file indicated by the _sysFileStoreFileId parameter.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	insertSysFileStore
	new	Initializes a new instance of the SysFileStoreManager class. (Overrides the new Method.)
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	parmBatchJobId	Gets or sets the BatchJobId parameter.
	parmDescription	Gets or sets the Description parameter.
	parmSysFileStoreRecId	Gets or sets the SysFileStoreRecId parameter.
	parmUserId	Gets or sets the UserId parameter.
	saveToClient	Saves all the files linked to the active SysFileStore record to the client.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	uploadFile	Uploads a file from client to the server and creates mapping from client side file to server side temporary file.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::assertValidUser	Asserts that the currently logged in user is either a system administrator or is the owner of the _sysFileStore record.
	::construct	Initializes a new instance of the SysFileStoreManager class.
	::copyFileToClient_Client
	::getPackedFileClient
	::getPackedFileServer
	::newFileStoreManager	Creates a new instance of SysFileStoreManager based on the supplied parameters.
	::newFromSysFileStoreFileRecId	Creates a new instance of SysFileStoreManager by using the supplied _sysFileStoreFileRecId parameter.
	::newFromSysFileStoreRecId	Creates a new instance of SysFileStoreManager by using the supplied _sysFileStoreRecId parameter.
	::promptSaveToClient	Prompts the user for a location and saves the file to the client.

Top

Remarks

The RunBaseBatch classes can use this API to upload files that are supplied by the user at the time of scheduling, so that these are available at execution time. Other classes can also use this API to abstract the need for caching, so that files are always processed at server side, without the user having to know about UNC paths.

Inheritance Hierarchy

Object Class
  SysFileStoreManager Class