Scripting events for Assets for InDesign

Prerequisites: The user should be logged in.

Script:

var r = [
[ "path" , "/", "String"] ];
var response = app.elvisPostRequest( "/browse", r );
alert( response );

Result: An alert box with the json that describes all child folders and collections of the root folder of Assets Server.

Prerequisites: The user should be logged in.

Script:

var r = [ ];
var response = app.elvisGetRequest( "/profile", r );
alert( response );

Result: An alert box with the json that describes the profile of the user.

Prerequisites: The user should be logged in.

Script:

var myDoc = app.elvisOpenDocument( "<Elvis_ID>", true );

Result: The document with the passed ID is checked-out and opened.

Prerequisites: The user should be logged in.

Script:

var myDoc = app.elvisOpenDocuments( "<Elvis_ID>","<Elvis_ID>", true );

Result: The documents with the passed IDs are checked-out and opened.

Prerequisites: None.

Script:

app.woodwingLogging = true;

Result: The WoodWing logging is enabled.

Prerequisites: None.

Script:

app.assetsPreferences.useFileCache = true;

Result: Downloaded files are kept in cache when the layout is closed.

Prerequisites: None.

Script:

app.assetsPreferences.maxFileCacheSize = 5;

Result: The maximum file size of the cache folder is set to 5GB.

Prerequisites: None.

Script:

app.assetsPreferences.removeFileFromCacheAfter = 30;

Result: A file is removed from the cache 30 days after it has been added.

Prerequisites: None.

Script:

app.assetsPreferences.autoRelinkToAssetsWhenOpening = true;

Result: Placed images are automatically linked with existing images in Assets Server.

Prerequisites: None.

Script:

app.assetsPreferences.relinkBasedOnInstanceId = true;

Result: Assets Server is forced to first search for files based on their Instance ID when automatically linking images is enabled.

Prerequisites: None.

Script:

app.assetsPreferences.doAutoLogIn = true;

Result: The log-in process to Assets Server starts when InDesign is started or a local document is opened.

Prerequisites: A document with at least one linked image that is not downloaded when opening the document, for example because the latest version was already placed on the document.

Script:

var myDoc = app.documents.item(0);
myDoc.downloadElvisLinks();

Result: The latest versions of all linked files are downloaded to the Elvis Checkouts folder. When the version is newer than the version on the document the link is updated with the contents of the version.

Prerequisites: An opened document that is stored in Assets Server.

Script:

var myDoc = app.documents.item(0);
myDoc.elvisCloseDocument( true, false ); 

Result: The document will be checked-in and closed. The local file will be removed from disk.

Prerequisites: An opened document that is stored in Assets Server.

Script:

var myDoc = app.documents.item(0);myDoc.elvisFixXmpInfoOfPlacements(); 

Result: A check is done for the presence of XMP info for all images that are placed from Assets Server. When the XMP Info is not available, the file is downloaded (when needed) and the XMP Info is applied.

Prerequisites: An opened document that is stored in Assets Server.

Script:

var myDoc = app.documents.item(0);
myDoc.elvisRelinkAll(); 

Result: The document will be checked-in and closed. The local file will be removed from disk.

Prerequisites: A document with at least one linked image that is stored in Assets Server.

Script:

var myDoc = app.documents.item(0);
alert( myDoc.elvisId );

Result: The Assets ID of the document will be shown in an alert dialog.

Prerequisites: A document with at least one linked image stored in Assets Server that is not downloaded when opening the document, for example because the latest version was already placed on the document.

Script:

var myDoc = app.documents.item(0);
var myLink = myDoc.links[0];
myLink.downloadElvisLink();

Result: The latest versions of the first linked Assets file is downloaded to the Elvis Checkouts folder. When the version is newer than the version on the document the link is updated with the contents of the version.

Prerequisites: A document with at least one linked image stored in Assets Server.

Script:

var myDoc = app.documents.item(0);
var myLink = myDoc.links[0];
alert( myLink.elvisId );

Result: Shows an alert with the ID of the link.

Prerequisites: A document with at least one linked image stored in Assets Server.

Script:

var myDoc = app.documents.item(0);
var myLink = myDoc.links[0];
alert( myLink.elvisUrl );

Result: Shows an alert with the Assets URL of the link.

Prerequisites: A document with at least one linked image stored in Assets Server.

Script:

var myDoc = app.documents.item(0);
var myLink = myDoc.links[0];
alert( myLink.elvisPath );

Result: Shows an alert with the path of the linked file.

Prerequisites: A document with at least one linked image stored in Assets Server.

Script:

var myDoc = app.documents.item(0);
var myLink = myDoc.links[0];
alert( myLink.elvisFilePath );

Result: Shows an alert with the path of the linked file.

Prerequisites: An opened or new document.

Script:

var myDoc = app.documents[0];
var myPage = myDoc.pages.item(0);
var myPageItem = myPage.rectangles.add({geometricBounds:["36pt", "36pt", "236pt", "236pt"]});
myPageItem.elvisPlace( "<Elvis_Id>" );
myPageItem.fit(FitOptions.FILL_PROPORTIONALLY);

Result: A page item will be created on the document and the file with the passed <Elvis_Id> will be placed into this frame.