Built-In Namespace _global_

Field Summary
Field Attributes	Field Name and Description
	myData Created by lukemallory on 11/18/14.
	render MB wrapper to abstract opening the template file, etc workflow name: "template"
	REST Created by lukemallory on 11/18/14.

Method Summary
Method Attributes	Method Name and Description
	aCallback(theManagedFile) CallBack for the search.
	addFile(theFile) adds aFiles name to the array of files in the return object in myData
	addFolder(theFolder) adds aFolder name to the array of folders in the return object in myData
	assetIdToPath(theAssetId) Creates a JSON object with the path of the given asset and adds it to myData
	buildCriterion(theJSONSearch) Builds a Boolean criterion
	compressFiles(theSource) Compresses a list of assets given their ID's and adds an object to myData containing the path to the compressed file
	configureSchemaOrSummary(theType) Adds Uri's to the contact sheet url(and specific fields if Summary contact sheet
	createFolder(theSource) Creates a new folder with the given path and adds an object to myData with the path
	decompressFiles(theSource, theDestination) decompresses the given asset and adds an object to myData with the path of the decompressed asset
	fileOrFolderDelete(theSource) Deletes the file or folder and adds an object with the ID/path to myData
	fileOrFolderImport(theSource) Imports the source file or folder and adds an object containing the assetId/folderPath to myData
	folderContents(theSource) Adds an object to myData containing an array of files and an array of folders
	formatResults(theManagedFile) Adds a result to the result array in myData
	generateSearch(theJSONSearch) returns a Search wrapper created from the JSON search object
	getAssets(theAssetOrResolver) uses assets ids from 'src' array from context or the resolver string given
	getField(theAssetId) Adds an object to myData containing the value of the given schema/field
	getSelections() Gets the selection for the given User.
	getXmp(theAssetID) Adds an object to myData containing the xmp of the given asset
	incrementName(theParentPath, theOldName) Used to increment files with the same name test.txt becomes test 1.txt
	main() Removes old files in the restapi temp folder.
	move(theSource, aDest-) Moves the files or folders and adds an object with the ID/path to myData
	pathToAssetId(theSource) Adds an object containing the assetID of the src asset fo myData
	removeOldFiles(theParent) Removes files > 24 hours old in theParentFolder and deletes theParentFolder if it is empty
	rename(theSource, aName) Renames the source file or folder and adds an object to myData containing its assetID/folderPath
	setFields(theSource, theSchema, theField, theValue) writes aVal to the field adds a object to myData containing the written metadata
	submit(theAssetId) Submits the asset to the preview system and adds a JSON object containing the id of the asset to myData context transformation variables include format scale res destcolor path - output path(loading dock if not given)

Field Detail

myData

Created by lukemallory on 11/18/14. Workflow to create folders given paths using a REST call
Defined in: create.js.

render

MB wrapper to abstract opening the template file, etc workflow name: "template"
Defined in: template.js.

REST

Created by lukemallory on 11/18/14. Workflow to return the Path of the (asset/assets) given a list of asset Id's using a REST call
Defined in: assetIdToPath.js.

Method Detail

aCallback(theManagedFile)

CallBack for the search. Adds the results to myData.
Defined in: QuickSearch.js.

Parameters:
theManagedFile

addFile(theFile)

adds aFiles name to the array of files in the return object in myData
Defined in: folderContents.js.

Parameters:
theFile: file to add to the list of files

addFolder(theFolder)

adds aFolder name to the array of folders in the return object in myData
Defined in: folderContents.js.

Parameters:
theFolder: folder to add to the list of files

assetIdToPath(theAssetId)

Creates a JSON object with the path of the given asset and adds it to myData
Defined in: assetIdToPath.js.

Parameters:
theAssetId

buildCriterion(theJSONSearch)

Builds a Boolean criterion
Defined in: Search.js.

Parameters:
theJSONSearch

Returns:: BooleanCriterion

{*} compressFiles(theSource)

Compresses a list of assets given their ID's and adds an object to myData containing the path to the compressed file
Defined in: compressFiles.js.

Parameters:
theSource: - list of asset Ids

Returns:: {*}

{*} configureSchemaOrSummary(theType)

Adds Uri's to the contact sheet url(and specific fields if Summary contact sheet
Defined in: GenerateContactSheet.js.

Parameters:
theType

Returns:: {*}

{*} createFolder(theSource)

Creates a new folder with the given path and adds an object to myData with the path
Defined in: create.js.

Parameters:
theSource: the path to the new folder

Returns:: {*}

decompressFiles(theSource, theDestination)

decompresses the given asset and adds an object to myData with the path of the decompressed asset
Defined in: decompressFiles.js.

Parameters:
theSource
theDestination

fileOrFolderDelete(theSource)

Deletes the file or folder and adds an object with the ID/path to myData
Defined in: delete.js.

Parameters:
theSource: - the Id of the asset to delete or the path of the folder to delete

fileOrFolderImport(theSource)

Imports the source file or folder and adds an object containing the assetId/folderPath to myData
Defined in: import.js.

Parameters:
theSource: the file or folder to import

folderContents(theSource)

Adds an object to myData containing an array of files and an array of folders
Defined in: folderContents.js.

Parameters:
theSource: the path of the folder to get the contents of

formatResults(theManagedFile)

Adds a result to the result array in myData
Defined in: Search.js.

Parameters:
theManagedFile

generateSearch(theJSONSearch)

returns a Search wrapper created from the JSON search object
Defined in: Search.js.

Parameters:
theJSONSearch

Returns:: SearchWrapper

{*} getAssets(theAssetOrResolver)

uses assets ids from 'src' array from context or the resolver string given
Defined in: GenerateContactSheet.js.

Parameters:
theAssetOrResolver

Returns:: {*}

getField(theAssetId)

Adds an object to myData containing the value of the given schema/field
Defined in: getField.js.

Parameters:
theAssetId: - the id of the asset to get the value of

getSelections()

Gets the selection for the given User. Default user is the current user
Defined in: getSavedSelections.js.

getXmp(theAssetID)

Adds an object to myData containing the xmp of the given asset
Defined in: getXmp.js.

Parameters:
theAssetID: - an asset ID

{string} incrementName(theParentPath, theOldName)

Used to increment files with the same name test.txt becomes test 1.txt
Defined in: upload.js.

Parameters:
theParentPath
theOldName

Returns:: {string}

{string} main()

Removes old files in the restapi temp folder. Renditions/Workflows/_internal/restapi/tmp/ Called every 24 hours
Defined in: clean.js.

Returns:: {string}

move(theSource, aDest-)

Moves the files or folders and adds an object with the ID/path to myData
Defined in: move.js.

Parameters:
theSource: -assetId or folderPath to move
aDest-: the path to the destination folder

pathToAssetId(theSource)

Adds an object containing the assetID of the src asset fo myData
Defined in: pathToAssetId.js.

Parameters:
theSource: assetID

removeOldFiles(theParent)

Removes files > 24 hours old in theParentFolder and deletes theParentFolder if it is empty
Defined in: clean.js.

Parameters:
theParent: Managed Folder

rename(theSource, aName)

Renames the source file or folder and adds an object to myData containing its assetID/folderPath
Defined in: rename.js.

Parameters:
theSource: assetID/folderPath
aName: the new name of the asset/folder

setFields(theSource, theSchema, theField, theValue)

writes aVal to the field adds a object to myData containing the written metadata
Defined in: setField.js.

Parameters:
theSource: -asset ID
theSchema
theField
theValue: - value to write to the field

submit(theAssetId)

Submits the asset to the preview system and adds a JSON object containing the id of the asset to myData context transformation variables include format scale res destcolor path - output path(loading dock if not given)
Defined in: submitAssets.js.

Parameters:
theAssetId: the asset ID

Classes

Built-In Namespace _global_