User's Manual

ManualsBrandsShayton Equilibrium ManualsKitchen UtensilShayton Equilibrium Kitchen Utensil 2003

MediaRich for SharePoint 2003

Programmer’s Guide

Summary of content (194 pages)

PAGE 1
MediaRich for SharePoint 2003 Programmer’s Guide
PAGE 2
© 2003-2006 Automated Media Processing Solutions, Inc. dba Equilibrium. All Rights Reserved. U.S. Pat. No. 6,792,575 for automated media processing and delivery. Other patents pending. Equilibrium, MediaRich, the MediaRich and Equilibrium logos, and MediaScript are trademarks of Equilibrium. Adobe and Photoshop are registered trademarks of Adobe Systems Inc. All other products or name brands are the trademarks of their respective holders.
PAGE 3
Table of Contents •••••• Chapter 1 Programming MediaRich for SharePoint 5 MediaRich for SharePoint 2003 Features 6 The Application Programming Framework 7 Working with MediaScript 7 Using the processImage Function 8 Deploying a New MediaScript 9 Metadata Support 9 Chapter 2 Using MediaScript 11 The Media Object 12 Preprocessor Directives 12 Using the #include Directive 12 Using the #link Directive 13 Named Arguments 13 File Systems 14 File System Specifiers 14 Creating Custom File System Aliases 15 File
PAGE 4
Text Response Object 153 TextResponse Object Methods 153 ICC Profile Object 155 static function list(colorspace, class) 155 ICC Profile Object Methods 156 IccProfile.
PAGE 5
Chapter 1 Programming MediaRich for SharePoint •••••• MediaRich for SharePoint is a client-server system that allows users to perform image processing tasks using media stored in Microsoft SharePoint Portal Server. It includes an “out-of-the-box” interface where users perform these tasks using either the Export interface, which is available from MediaRich Document Libraries, or the MediaRich MediaCart site, which is available from the MediaRich Browser.
PAGE 6
MediaRich for SharePoint 2003 Features File Format Support MediaRich for SharePoint extends SharePoint’s standard picture library to provide previews of CMYK images, Vector images, and layered Photoshop® ﬁles along with related metadata. It reads and writes many popular ﬁle formats including BMP, WBMP, GIF, JPG, PNG, PCT, TIFF, PDF, TGA, Adobe Illustrator®, and Photoshop PSD or EPS ﬁles.
PAGE 7
The Application Programming Framework MediaRich image processing is controlled by MediaScript, which provides a simple framework that makes writing new scripts easy.
PAGE 8
Using the processImage Function The MediaScript API for SharePoint is comprised of a single function your script must deﬁne. This enables the script to function correctly both as an Export script and a MediaCart script. In the case of the MediaCart, the same script is used for each image in a MediaCart batch. Syntax Media processImage(Media image) The processImage function is the single entry point for all scripts that interoperate with the MediaRich for SharePoint Connector.
PAGE 9
Setting the save parameter “type” determines what type of image the framework is going to save. The save parameters correspond to the parameters that can be passed to the Media object’s save() method. For some formats, such as GIF and JPEG, there are many more parameters that can be speciﬁed. NOTE: For more information about what parameters are available for saving images, see “save()” on page 124. Before returning control to the framework, you must complete a ﬁnal step: resp.
PAGE 10
• • • • • 10 Chapter 1
PAGE 11
Chapter 2 Using MediaScript •••••• All MediaRich image templates are written in MediaScript, an interpreted scripting language based on the ECMAScript Language Speciﬁcation, 3rd edition (which, in turn, is based on Netscape's JavaScript and Microsoft's JScript). By building on top of a widely known scripting language, MediaScript can offer all of the ﬂexibility of a full programming language while remaining easy to use.
PAGE 12
The Media Object The most important built-in object in MediaScript is the Media object, which implements the many image processing features provided by MediaRich. A typical script creates one or more Media objects by either loading image data from a ﬁle or using the Media drawing methods. The script then performs additional image processing operations based on arguments and parameters in the request. Finally, the script generates a response by saving a Media object to the desired output ﬁle format.
PAGE 13
Example #include "process/library.ms"; If your MediaScript uses the XMLdocument object, you need to use the #include directive to specify the xml.ms that installs with MediaRich. Do this by adding the following line at the beginning of your script: #include "sys:xml.ms"; Using the #link Directive The #link directive is a preprocessing ﬂag that is evaluated before the script is parsed or executed.
PAGE 14
All of the functions that use named arguments also accept a single object as an argument. If an object is passed, each of the object's properties corresponds to an argument name/value pair; the property's name is the argument name and the property's value is the argument value. For example, the previous MediaScript could be rewritten as the following: var argsObject; argsObject.name = "out.jpg"; argsObject.quality = 90; img.
PAGE 15
File System Specifier Default Location profiles \MediaRich\Shared\Originals\Profiles read \MediaRich\Shared\Originals\Media results \MediaRich\Shared\Generated\MediaResults scripts \MediaRich\Shared\Originals\Scripts sys \MediaRich\Shared\Originals\Sys write \MediaRich\Shared\Originals\Media All MediaScript operations that take a path default to a reasonable ﬁle system when no speciﬁer is present in the path.
PAGE 16
“\\STOR1\source” and write the output to a web server with a UNC path of “\\WEB1\retail1\images”, append the entries to your local.properties ﬁle, as in the following example: virtualfilesystem.retailIN=\\\\STOR1\\source virtualfilesystem.retailOUT=\\\\WEB1\\retail1\\images NOTE The backslash character (\) is the escape character for MediaRich properties ﬁles. All backslashes in the path must be escaped with an additional backslash.
PAGE 17
HTTP Support Using the FSNet Plug-in The FSNet plug-in can implement HTTP and FTP access via standard URLs by deﬁning virtual ﬁlesystems named “http” and “ftp”. FSNet and MediaRich Virtual Filesystems MediaRich accesses ﬁles by deﬁning a number of virtual ﬁlesystems. A virtual ﬁle system indicates the root of a ﬁle tree located somewhere on either the local ﬁlesystem or on the network.
PAGE 18
A fully speciﬁed HTTP or FTP URL looks like the following: (http|ftp)://:@:/ The , , and portions of the URL are optional. Here are some examples of well formed URLs: http://www.eq.com/images/eq_bw.gif http://joeblow:abcdefg@acomputer/myimages/blah.jpg ftp://ftpserver:1234/public/images/camera.tif FSNet Properties A number of properties can be set in the local.
PAGE 19
File Caching The process of reading a ﬁle over a network can be time consuming. For this reason, ﬁles read via the FTP and HTTP protocols are stored in a local ﬁle cache. Subsequent accesses to the same ﬁle that occur shortly after the ﬁle was last downloaded are served from the cache rather than reread from the network. The RefreshInterval property determines how HTTP and FTP ﬁles are cached.
PAGE 20
Defining Additional FSNet Virtual Filesystems Any number of virtual ﬁlesystems can be deﬁned in addition to standard “http” and “ftp” ﬁlesystems. The only reason to deﬁne additional HTTP or FTP ﬁlesystems would be to associate different property settings with the different ﬁlesystems. For example, if you needed to access network ﬁles via two different proxy servers, you would need two different ﬁlesystems, as the proxy server can not be speciﬁed in a virtual ﬁle path (in a URL).
PAGE 21
The following table lists the properties you can conﬁgure for either FTP or HTTP: Property Usage Disabled Set to 1 to disable the file system, 0 or no entry to enable it Specifier This is the path specifier that denotes this file system. UserName Sets the default user name. Password Sets the default password. UserNameAndPassword Sets the default username and password (separated by “:”). FTP Set to 1 to use FTP protocol, 0 or no entry to use HTTP.
PAGE 22
• • • • • 22 Chapter 2
PAGE 23
Chapter 3 MediaScript Objects and Methods •••••• MediaScript includes a number of built-in objects that you can use to customize your MediaRich requests and responses.
PAGE 24
Error Handling Most MediaScript functions indicate an error condition by throwing an exception rather than returning an error code. Exceptions can be trapped and handled using ECMAScript's standard try/catch/ﬁnally mechanism. For example, the Media object's load() method throws an exception if the ﬁle to be loaded is not found. To trap this exception, you would write something like the following: try { img.load(name @ "missingFile.tga"); } catch (e) { // Here you can recover from the error.
PAGE 25
• • • • • • • • • length() list() mkdir() read() readNextLine() remove() rename() rmdir() write() new File() The File object needs to be constructed using the new File () constructor. Syntax var Test = new File( <"filename"> ); Parameters filename - speciﬁes a string containing the ﬁlename and path with which the object is associated. The default is an empty string. The string must be in quotes. If the string does not specify a ﬁle system the default is the write ﬁle system.
PAGE 26
copy() Copies the File object to a new ﬁlename. The object’s original ﬁlename is unchanged. Syntax