Method: Perfion.WriteFile( … )

• Syntax
• Method Parameters
• Example 1
• Example 2

Will write any file and image stored by Perfion to a file. For images it can resize, change the image format and change the aspect by exact fitting or cropping or smart fitting. It performs all of the same well known image manipulation functionality as the Media Server, and the syntax is identical.
This method will also check if the file you intend to write has already been written, and only spend time on retrieving and updating the file if its timestamp is different from the file stored in Perfion.
This method is also capable of writing multiple files, e.g. from a Multi-valued feature in Perfion.

Syntax

{ScriptObject} WriteFile( string id = "", string file = "{@id}{@par}", string par = "", string root = "" )

All the parameters to this method are optional. Therefore it is recommend to include them by name, as shown in the examples below. The behavior of each parameter is described in the following table.

Method Parameters

Alternative:
As an alternative to the above template naming. You can also specify the name exactly as you want it, or specify a ';' separated list of filenames to be used when multiple id's are requested. In the latter case, the number of filenames must of course match the number of id's requested.|

Example 1

Below automatically takes the image-ids from the current Map-entry, and generates filenames based on the specified template by including the static part "Binaries/SKUImage-" and concatenating this with a lookup from the current Input-row of the "{SKU}" followed by a name-part "{@par}" constructed automatically based on the requested image parameters.
The root-path is taken from a global variable named $RootPath.
The image is requested as "size=200x200&format=web", meaning to fit within 200x200 pixels and be delivered in one of the web-formats (jpg, gif or png).
The method returns a simple object that delivers the OutFileName (which is the name the file was written as based on the file-naming-template, rootpath etc. This OutFileName is written to the Value of the Output-row so it contains information about where the file is. Voila!

var info = Perfion.WriteFile(
file: "Binaries/SKUImage-{SKU}{@par}",
root: "{=$RootPath}",
par: "size=200x200&format=web" );
Value = info.OutFileName;

Example 2

Below example is a tiny bit more advanced? It shows how a multivalued image feature could be written. Again by using a file-naming template, but this time including the @index parameter to make sure each image get a unique name, since they would otherwise end up with the same name (in this example). You can of course always use the unique Perfion Guid ID, but sometimes you want to export the images or files by using other more readable names.

var info = Perfion.WriteFile(
file: "Binaries/SKUMultiImages-{SKU}[{@index}]*{@par}",
root: "C:/FileRoot/",
par: "size=300x200&format=web" );
Value = info.OutFileName;