interplay ws whitepaper 2

7/27/2019 Interplay WS Whitepaper 2

1/16

Avi

Avid Interplay Web Services

Ver si on 2. 0


2/16

Table of Contents

Over vi ew. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1I nt er pl ay Web Ser vi ces Funct i onal i t y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Asset Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Wor kf l ow Enhancement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3I nf r ast ruct ur e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Fol der Li st i ng . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Check I n an Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Ret r i eve an Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Li nk t o an Exi st i ng Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Met adat a Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Ret r i evi ng Met aSync XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Managi ng Rest r i ct i ons and Reser vat i ons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Sear chi ng . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Managi ng Cat egor i es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Fol der Cr eat i on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Fol der Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Movi ng Asset s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Dupl i cat i ng Asset s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Del et i ng Asset s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Locat or Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Mast er Cl i p Cr eat i on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Sub- Cl i p Cr eat i on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Shot l i s t Cr eat i on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Headf r ame Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Det er mi ni ng Rel at i ves and Li nks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Det er mi ni ng Medi a Fi l e Locat i ons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Locat i ng Br owse Mat er i al . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Li st i ng I ndexed Wor kspaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9User and Gr oup Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Li s t i ng Resol ut i ons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Fi l e St at us . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Wor kf l ow Aut omat i on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Tr ansf er Funct i onal i t y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Tr ansf er abi l i t y Stat us Checki ng . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Medi a Ser vi ces Funct i onal i t y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Cr eat i ng Medi a Ser vi ces J obs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Cont r ol l i ng Medi a Ser vi ces J obs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11J ob Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11J ob Stat us . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Obt ai ni ng Conf i gur at i on I nf or mat i on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Basi c Conf i gur at i on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12St or age I nf or mat i on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12I nt er pl ay Tr ansf er I nf or mat i on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12I nt er pl ay Medi a Ser vi ces I nf or mat i on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

About Asset s and Medi a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Suppor t ed St andar ds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Web Ser vi ces Depl oyment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Ser ver Requi r ement s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14How t o obt ai n I nt er pl ay Web Ser vi ces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14


3/16

Overview

Avi d I nt erpl ay i s a non l i near workf l ow management syst emthat i s abl e

t o connect edi t or s, pr oducer s, desi gner s, ani mat or s, wr i t er s,

assi st ant s, admi ni st r atorseven f i nance and l egal depart ment si n a

r eal - t i me nonl i near product i on envi r onment . I nt erpl ay can be

conf i gur ed t o aut omate rout i ne tasks, t r ack any ki nd of medi a,

st r eaml i ne admi ni st r ati on, pr event unaut hori zed access, and accel erate

t ur naround at ever y step of t he workf l ow, f r ompre- pr oduct i on t o

archi ve.

Avi d I nt er pl ay has a f eat ur e ri ch t ool set whi ch i ncl udes appl i cat i ons

desi gned t o meet t he needs of medi a l i br ari ans, pr oduct i on assi st ant s,

l ogger s, edi t ors and many more. Whi l st t hese t ool s meet t he needs of

t he maj ori t y of users t here i s of t en a r equi r ement t o ext end I nt erpl ay s

f uncti onal i t y out si de the bounds of i t s i n- bui l t t ool set . For exampl e

t here may be a r equi r ement t o i nt erf ace wi t h an ext ernal Di gi t al Asset

Management syst em, or wi t h the medi a t r ansf ers provi ded by a Di gi t al

Del i ver y sol ut i on.

I n or der t o enabl e thi r d part i es t o i nt egr at e t hei r sol ut i ons wi t h Avi d

I nt erpl ay a web servi ces i nt erf ace i s avai l abl e. By exposi ng many of

t he f unct i ons t hat were pr evi ousl y onl y accessi bl e through t he

I nt er pl ay Access appl i cat i on t hi r d par t i es can now i nt egr at e I nt er pl ay

seaml essl y i nt o t hei r cust omi sed aut omated workf l ows.

1


4/16

Interplay Web Services Functionality

I nt er pl ay Web Ser vi ces pr ovi de thi r d par t i es wi t h a ri ch set of f unct i ons

t o i nt egr at e ti ght l y wi t h an I nt er pl ay envi r onment . Cur r ent l y three

mai n f unct i onal i t y areas are support ed asset management , workf l ow

enhancement and over al l i nf r astr uct ur e support as out l i ned i n the

f ol l owi ng paragr aphs.

Asset Management

Fol der navi gat i on and l i st i ng Fol der management , i ncl udi ng owner shi p and per mi ssi ons Asset check- i n, ret r i eval and del et i on Metadata i nput and r etr i eval Managi ng Reser vat i ons and Rest r i ct i ons Sear chi ng Managi ng Categor i es Locat or management Master and Sub- cl i p creat i on Shot l i st creat i on Headf r ame management Determi ni ng Rel at i ves and Li nks Get t i ng Medi a Fi l e det ai l s Ret r i evi ng MetaSync data Get t i ng Str eami ng Medi a

Note t hat many asset management f unct i ons ar e onl y r el evant t o an onl i ne

I nt erpl ay workgroup, some however ar e al so appl i cabl e f or an archi ve

workgroup. Asset management f unct i ons t hat can be used wi t h an ar chi ve

workgr oup i ncl ude:

Asset check- i n Asset r et r i eval Metadata r etr i eval Fol der navi gat i on and l i st i ng Headf r ame management Sear chi ng Fi l e St at us

2


5/16

Any di f f erences i n operat i on between ar chi ve and onl i ne workgroups ar e

not ed under t he i ndi vi dual f unct i on descri pt i ons.

Workflow Enhancement

Checki ng t he st at us of an i t em pr i or t o t r ansf er I ni t i at e t ransfers I ni t i at e Medi a Ser vi ces t asks Moni t or t he st atus of Medi a Servi ces and Tr ansf er t asks Cont r ol Medi a Servi ces and Transf er t asks

Infrastructure

User and Gr oup Management Obt ai ni ng t he l i st of i ndexed workspaces Obt ai ni ng detai l s of Tr ansf er Engi nes and associ ated devi ces Obt ai ni ng conf i gur ati on and ver si on i nf ormati on

The sect i ons whi ch f ol l ow provi de a detai l ed overvi ew f or each of t he

f unct i ons.

Folder Listing

The di r ect chi l dren of any f ol der , i ncl udi ng t he database r oot node,

may be l i sted. I t i s possi bl e t o rest r i ct t he l i sti ng of a f ol der t o

r et ur n onl y Avi d asset s, Fi l e asset s or Fol der s.

Check In an Asset

Avi d asset s are t ypi cal l y ref er enced t hr ough AAF f i l es ( see t he l at er

sect i on) , so i n order t o check an Avi d asset i nt o the database an AAF

f i l e i s upl oaded. I n t he case of a Fi l e asset , such as a J PEG f i l e,

Word document or Adobe Photoshop f i l e f or exampl e t he act ual f i l e i s

upl oaded.

Note t hat onl y Avi d asset s may be checked i nt o an Ar chi ve database and

woul d typi cal l y be used onl y on t he rare occasi on when t he ar chi ve

sol ut i on i t sel f may have detected t hat t he asset has been err oneousl ydel eted f r omt he Ar chi ve database even t hough t he medi a i t sel f st i l l

r esi des i n t he archi ve i t sel f . I f t he archi ve sol ut i on al so hol ds a

copy of t he or i gi nal AAF f i l e t hen i t can be checked i n t o r e- est abl i sh

t he cor r ect st at us of t hat asset . I t woul d al so be possi bl e to updat e

t he Ar chi ve database i n t hi s way f or materi al t hat has been mi gr ated

f r om anot her I nt er pl ay Ar chi ve vi a a data t ape.

3


6/16

Retrieve an Asset

Copi es of both Avi d and Fi l e asset s can be r etr i eved f r om I nt er pl ay.

The r et r i eve f unct i on ef f ect i vel y perf or ms an I nterpl ay Get Lat est

oper ati on whi ch t r ansf ers a copy of t he l atest ver si on of an asset t o

t he cal l i ng wor kstat i on. Not e t hat t hi s does not per f or ma check- out ,

whi ch woul d l ock the asset agai nst changes unt i l a subsequent check- i n

oper ati on.

Note al so t hat i n t he case of Avi d medi a asset s t hi s f unct i on r etr i eves

onl y t he metadata ( see t he l ater sect i on About Asset s and Medi a) and

not t he medi a i t r ef erences. The metadata i nf ormat i on however can be

used t ogether wi t h other Avi d workgr oup API s t o t r ansf er or r etr i eve

t he medi a i t sel f . Another exampl e of t he use of such a f i l e mi ght be

a t hi r d part y l oggi ng sol ut i on. Usi ng t he web servi ces API i t woul d

be possi bl e t o obt ai n the AAF f i l e whi ch r eferences t he medi a i n quest i on,

popul ate i t wi t h l ocator i nf or mati on cor r espondi ng t o t he l ogged shots,

and t hen check i t back i nt o I nt erpl ay.

Link to an Existing Asset

Thi s f unct i on al l ows t he cal l er t o cr eate a l i nk t o an exi st i ng Avi d

asset , t he l i nk bei ng pl aced i n a f ol der speci f i ed by t he cal l er .

Metadata Exchange

Metadata associ ated wi t h I nt erpl ay asset s i s t ypi cal l y accessed t hr ough

t he use of at t r i but es. Some at t r i but es ar e desi gnat ed as System

at t r i but es, and ar e t ypi cal l y read onl y. User at t r i but es can bot h be

r ead and wr i t t en t hr ough t he web servi ces i nt erf ace, whi ch can al so

be used t o cr eat e appl i cat i on speci f i c cust omat t r i but es. Such cust om

at t r i but es can be di spl ayed by I nt er pl ay appl i cat i ons such as I nt er pl ay

Access, t hey can al so be seen i n t he bi n col umns of an Avi d edi t or.

I t i s possi bl e t o search customatt r i but es. Functi onal i t y i s al so

pr ovi ded t o di scover what cust om att r i but es ar e cur r ent l y def i ned.

Metadata associ ated wi t h asset s i n an Ar chi ve database i s r ead onl y,

i t i s not possi bl e t o modi f y any metadata associ at ed wi t h an ar chi ved

asset .

4


7/16

Retrieving MetaSync XML

Avi d MetaSync i s a t echnol ogy associ ated wi t h t he Avi d edi t or f ami l y

t hat enabl es XML f ormat t ed dat a to be ref erenced on t he t i mel i ne and

edi t ed as i f i t were a medi a segment . Met aSync empowers workf l ows such

as subt i t l i ng, cl ose capt i oni ng and i nt eracti ve f uncti onal i t y. The

GetMetaSyncXML f unct i on al l ows t he metasync dat a t o be rer i eved f r om

a sequence.

Managing Restrictions and Reservations

Reser vat i ons are ef f ect i vel y del ete pr otect i ons t hat may be pl aced

on a f ol der t o pr event t he asset s i t cont ai ns bei ng del eted i nadver t ent l y.

Fol ders associ ated wi t h newl y creat ed pr oj ect s are aut omati cal l y

r eser ved by the system. I f an asset , or copy of an asset , exi st s i n

a reserved f ol der anywher e i n t he database t hen i t wi l l not nor mal l y

be possi bl e t o del et e t hat asset . Cal l s t o suppor t t he addi t i on, r emoval

and l i st i ng of r eser vat i ons ar e pr ovi ded.

Rest r i ct i ons are t i mecode del i mi t ed f l ags associ at ed wi t h i ndi vi dual

medi a asset s and are t ypi cal l y used t o i dent i f y materi al t hat may have

r est r i ct ed r i ght s. Any at t empt t o use such r est r i ct ed medi a typi cal l y

r esul t s i n a warni ng message bei ng pr esent ed t o the operat or. Cal l s

t o suppor t t he addi t i on and l i st i ng of r eservat i ons ar e support ed.

Searching

Searches can be made usi ng web ser vi ces whi ch ar e ver y si mi l ar t o t hose

of f ered by t he advanced search capabi l i t y of I nt erpl ay Access. Sear ches

ar e per f or med by set t i ng cr i t er i a f or one or mor e at t r i but es, wi t h t he

cr i t eri a l i nked by l ogi cal operat or s such as AND and OR. The pr eci se

cr i t eri a t hat can be appl i ed depends on t he nat ur e of t he att r i but e,

e. g. whet her i t i s t ext , dat e/ t i me, et c. The sear ch cri t eri a cur r ent l y

avai l abl e ar e:

EQUALS: The at t r i but e val ue must be an exact mat ch NOT_EQUALS: The at t r i but e val ue can be anyt hi ng except an exact

mat ch

CONTAI NS: The sear ch phr ase must be cont ai ned somewhere i n theat t r i but e val ue

NOT_CONTAI NS: The sear ch phrase must not be contai ned anywherei n t he at t ri but e val ue

5


8/16

LESS_THAN: Usef ul f or date- based searches t o f i nd matches bef oret he gi ven dat e and t i me

LESS_THAN_OR_EQUAL_TO: Li ke LESS_THAN, but i ncl usi ve of t hepassed i n date and t i me

GREATER_THAN: Usef ul f or dat e- based sear ches t o f i nd matches af t ert he gi ven dat e and t i me

GREATER_THAN_OR_EQUAL_TO: Li ke GREATER_THAN, but i ncl usi ve of t hepassed i n date and t i me

Note t hat searchi ng t akes pl ace wi t hi n a def i ned f ol der l ocat i on and

i ncl udes al l f ol der s bel ow i t . Not e al so that t he web ser vi ces sear ch

appl i es to a si ngl e database onl y, i t does not search si mul t aneousl y

acr oss mul t i pl e workgr oups nor pass t he cri t er i a t o an exter nal

f ederated sear ch pl ug- i n.

Managing Categories

Categori es enabl e gr oups of r el ated I nt er pl ay asset s t o be easi l y

i dent i f i ed and l ocat ed. Cal l s ar e pr ovi ded t o l i st bot h t he cat egor i es

cur r ent l y def i ned i n the syst emand those associ ated wi t h a gi ven asset ,

as wel l as assi gni ng cat egori es to an asset .

Folder Creation

The API al l ows a t hi r d par t y sol ut i on t o cr eat e new f ol ders wi t hi n t he

I nt erpl ay database. Fol der s may be creat ed si ngl y, or by mul t i pl e paths.

I n bot h cases i t i s possi bl e t o speci f y nest ed pat hs f or t he f ol der s

whi ch ar e to be cr eat ed. I nt erpl ay Web Servi ces wi l l creat e

aut omat i cal l y any i nt er medi at e l evel f ol der s t hat ar e requi r ed.

Folder Management

Funct i ons ar e pr ovi ded f or t he management of f ol der owner shi p and

database r ol es, i . e. enabl i ng more pr eci se cont r ol over t he access

r i ght s t hat i ndi vi dual user s and gr oups have t o speci f i c f ol der s i n

t he dat abase.

Moving Assets

Any asset , whether i t i s an Avi d asset , Fi l e asset or even an ent i r e

f ol der, can be moved t o a di f f er ent l ocat i on i n t he dat abase. Thi s

f unct i on coul d be used as par t of a workf l ow management operat i on, i n

whi ch asset s are moved t o di f f erent f ol der s as a pr oj ect pr ogr esses,

e. g. unassi gned, i n pr ogr ess, wai t i ng r evi ew, appr oved, etc.

6


9/16

Duplicating Assets

Thi s cal l al l ows an asset , ei t her Avi d or Fi l e, t o be dupl i cat ed ( i . e.

copi ed) t o another l ocati on i n t he database. I n t he case of an Avi d

asset , such as a sequence, a new sequence havi ng al l t he charact eri st i cs

of t he ori gi nal i s creat ed but wi t h i t s own uni que i dent i f i cat i on. Thi s

can enabl e workf l ows whi ch requi r e, f or exampl e, new sequences t o be

creat ed f r oma pr e- exi st i ng t empl at e. The Dupl i cat e cal l al so al l ows

an opt i onal set of metadat a at t r i but es t o be associ ated wi t h the new

i t em, t hus maki ng i t a rel at i vel y easy t ask t o cust omi se t he newl y

cr eated asset .

Deleting Assets

A Del et e Asset s cal l pr ovi des a r i ch set of asset del et i on f unct i ons.

Usi ng t he cal l asset s can be del eted and, opt i onal l y, t he medi a

associ ated wi t h them. Fur t her when medi a del eti on i s r equest ed i t i s

possi bl e to speci f y whi ch medi a resol ut i ons are t o be del eted.

The Del et e Asset s cal l can al so be i nvoked i n a si mul at i on, or

i nf ormat i on onl y mode. I n t hi s mode the cal l does not del ete any asset s

but wi l l r et ur n a l i st of al l t hose asset s and associ at ed medi a f i l es

t hat woul d have been del et ed had the command been execut ed. Thi s coul d

al l ow t he cal l er t o ver i f y the accur acy of t he del et e oper at i on, e. g.

by seeki ng user conf i r mat i on, bef ore execut i ng t he operat i on.

The Del et e Asset s cal l may al so be used t o del et e empty f ol ders f r om

t he database.

Locator Management

Three f unct i ons ar e provi ded i n suppor t of l ocat or management: get ,

save and r emove. Get Locat or s r et r i eves a l i st of al l t he l ocat or s

associ ated wi t h a desi gnated cl i p. Save l ocator s can be used ei t her

t o add new l ocat ors t o a cl i p or modi f y exi st i ng ones whi l st r emove

l ocat or s del et es exi st i ng l ocat or s f r om t he desi gnat ed cl i p.

St art i ng wi t h I nt erpl ay Web Servi ces 2. 0 a more advanced f ormof l ocat or

data was i nt r oduced. Pri or t o 2. 0 l ocat ors were i dent i f i ed by ti mecode

or f r ame of f set t ogether wi t h a si mpl e numeri cal i ndex. Versi on 2. 0

i nt r oduced a uni que i dent i f i er f or each l ocat or . As a r esul t t wo set s

of l ocat or management f unct i ons are avai l abl e, r ef erenci ng ei t her pre- ,

or post - 2. 0 r el eases.

7


10/16

Master Clip Creation

The Cr eate Mast er Cl i p f unct i on ef f ect i vel y enabl es a pl acehol der cl i p

t o be creat ed. The cl i p has no medi a but does have essent i al metadata

such as dur at i on and st art t i mecode. The medi a wi l l t ypi cal l y be added

l ater ( at t hi s t i me, batch capt ur e i s t he onl y suppor t ed method f or

addi ng medi a l ater) .

Sub-Clip Creation

The Cr eat e Sub- cl i p f unct i on al l ows a new sub- cl i p t o be cr eated i n

t he I nt erpl ay database. The sub- cl i p r ef erences a desi gnated master

cl i p t oget her wi t h t he desi r ed of f set i nt o t he cl i p and t he dur at i on

of t he sub- cl i p. Addi t i onal l y a headf r ame may be pr ovi ded and i t i s

al so possi bl e t o set user metadata f or t he sub- cl i p.

Shotlist CreationI nt er pl ay Web Ser vi ces pr ovi des t he abi l i t y f or user s t o cr eat e

shot l i st s, i . e. Avi d Sequences composed of mul t i pl e cl i p segment s

l i nked by cut s onl y t r ansi t i ons. Typi cal l y essent i al met adat a f or t he

sequence wi l l be pr ovi ded, such as start t i mecode, any l ocat or s, etc.

t oget her wi t h a l i st of r ef er ences t o mast er cl i ps st or ed i n I nt er pl ay

t ogether wi t h t hei r I N poi nt s and dur ati ons.

Headframe Management

Two f unct i ons ar e pr ovi ded f or headf r ame management . These al l ow a new

headf r ame t o be pr ovi ded f or an Avi d asset t ogether wi t h the abi l i t y

t o ret r i eve the exi st i ng headf r ame.

When used wi t h an Ar chi ve workgr oup i t i s not possi bl e to update the

headf r ame, onl y ret r i eve i t .

Determining Relatives and Links

Frequent l y i t i s desi r abl e t o deter mi ne ei t her whi ch asset s ar e used

i n a part i cul ar sequence or wi t h whi ch sequence( s) a part i cul ar asset

i s associ at ed. A si ngl e Fi ndRel at i ves cal l del i vers t hi s f uncti onal i t y.

Anot her r el ated r equi r ement i s t o be abl e t o l ocat e al l t he i nst ances

of a gi ven asset i n t he I nt erpl ay database. For exampl e newl y i ngest ed

mat er i al i s t ypi cal l y checked i n t o an i ngest cat al ogue, l at er t he i t em

may be used i n a pr oj ect and theref ore i s checked i n as par t of t he

pr oj ect bi n, each i nst ance of t he asset bei ng ef f ect i vel y an al i as

8


11/16

poi nt i ng t o t he asset i t sel f . A Fi ndLi nks cal l i s pr ovi ded t o l ocat e

al l such r ef er ences.

Determining Media File Locations

Somet i mes when deal i ng wi t h mast er cl i ps i t i s necessar y to l ocat e the

actual medi a f i l es whi ch const i t ut e the cl i p. A Get Fi l eDet ai l s cal l

i s pr ovi ded f or t hi s pur pose. I n addi t i on t o t he l ocat i on, ot her det ai l s,

such as t r ack, st at us, and f or mat , ar e returned f or each f i l e.

Locating Browse Material

I nt erpl ay 2. 0 i nt r oduced a Wi de Ar ea Network browsi ng capabi l i t y based

on t he use of Qui ckTi me st r eami ng medi a wi t h a total audi o/ vi deo

bandwi dt h of j ust under 1Mbs. Usi ng I nt erpl ay Web Servi ces a thi r d part y

can r etr i eve a r ef erence to the Qui ckTi me st r eami ng asset , and t hus

i nt egr at e I nt er pl ay br owsi ng wi t hi n t hei r own appl i cat i on.

Listing Indexed Workspaces

Rel ated t o the l ocat i on of t he medi a f i l es are t he shared st orage

workspaces cur r ent l y i ndexed by the Medi a I ndexer. A cal l i s pr ovi ded

t o l i st t hose wor kspaces and i s par t i cul ar l y usef ul f or devel oper s

creat i ng i ngest sol ut i ons.

User and Group Management

I nt er pl ay Web Ser vi ces pr ovi des a r i ch set of f unct i ons f or t he

management of user s and gr oups. The f unct i ons i ncl ude the abi l i t y t o:

Cr eate new users Modi f y exi st i ng users Cr eate new user groups Modi f y exi st i ng user gr oups, e. g. permi ssi ons such as Read,

Read/ Wr i t e, etc.

Del ete exi st i ng user gr oupsNote that i n order t o modi f y user s t he web servi ces cl i ent must have

admi ni st r ati on r i ght s. Al so, i n t he same way as f or t hose cr eat ed by

t he I nt er pl ay Admi ni st r ator appl i cat i on, users t hemsel ves have no

access rights unt i l t hey are associ ated wi t h one or more groups.

Listing Resolutions

The Get Resol ut i ons quer y r et urns a l i st of al l t he medi a r esol ut i ons

associ ated wi t h a gi ven asset and i s a usef ul pr ecur sor t o a cal l t o

9


12/16

del ete asset s. Paramet ers associ ated wi t h t he Get Resol ut i ons cal l can

r est r i ct t he r esul t s t o onl i ne resol ut i ons onl y and/ or pr ovi de det ai l ed

i nf or mat i on about t he di f f er ent r esol ut i ons.

File Status

The Set Fi l eStat us cal l i s speci f i cal l y provi ded f or use wi t h an Ar chi ve

database. I t al l ows t he archi ve sol ut i on t o update t he st atus of any

f i l es t hat ar e associ at ed wi t h a par t i cul ar asset , e. g. some audi o dat a

associ ated wi t h a master cl i p has been permanent l y del eted f r omt he

archi ve. On compl eti on of t he cal l t he di spl ayed st at us of t he archi ve

i t emwi l l be updat ed t o ref l ect t he tr ue ar chi ve condi t i on. Thi s cal l

i s i nt ended f or synchr oni sati on pur poses onl y.

Workflow Automation

Several f unct i ons ar e pr ovi ded t o manage workf l ow aut omat i on i ncl udi ng

both I nt erpl ay Transf er and Medi a Ser vi ces f unct i onal i t y.

Transfer Functionality

Two t r ansf er f unct i ons ar e pr ovi ded of f er i ng send t o pl ayback and send

t o workgroup t r ansf ers . The send to workgroup f unct i on sends desi gnated

asset s t o a remote wor kgr oup wi t h the opt i on t o speci f y t he dest i nati on

workspace. Send to pl ayback sends an Avi d sequence t o a speci f i c pl ayback

devi ce. Note t hat t he CheckSequenceI sReadyForXf er shoul d be cal l ed

before at t empt i ng a send to pl ayback t r ansf er as i t i s not al ways

possi bl e t o guarantee the success of such an operat i on. Many f actors

can i nf l uence thi s, i ncl udi ng one or more r eferenced asset s bei ng

of f l i ne i n t he resol ut i on r equi r ed, or ef f ects needi ng t o be

r ender ed. For det ai l s of t he API s t hat ar e avai l abl e to devel oper s t o

i mpl ement t he r equi si t e I nt er pl ay Tr ansf er i nt er f ace f or a speci f i c

devi ce see ht t p: / / www. avi d. com/ us/ par t ner s/ api s. aspx f or more

detai l s .

Transferability Status Checking

I nterpl ay Web Ser vi ces i ncl udes a CheckSequenceI sReadyForXf er cal l

whi ch can be used t o quer y a sequence pr i or t o at t empt i ng an aut omat ed

send to pl ayback. The cal l wi l l r eport whether t he sequence i s i ndeed

r eady to be sent , and i f i t i s not wi l l i ndi cat e the r eason why.

10
http://www.avid.com/us/partners/apis.aspxhttp://www.avid.com/us/partners/apis.aspx


13/16

Media Services Functionality

Several f unct i ons ar e pr ovi ded t o manage medi a servi ces t asks,

i ncl udi ng creat i on, cont r ol and del et i on.

Creating Media Services Jobs

Two f unct i ons ar e provi ded t o cr eat e a new medi a ser vi ces j ob, and

t ypi cal l y ref l ect t he functi onal i t y that i s provi ded by I nt erpl ay

Access. The f i r st f unct i on al l ows a j ob t o be cr eat ed based on a

pr evi ousl y def i ned pr of i l e ( obt ai ned t hr ough t he use of t he l i st

pr of i l es f unct i on descr i bed bel ow) whi l st t he second al l ows the

speci f i c parameters t o be def i ned on a per j ob basi s.

Controlling Jobs

Three f unct i ons are provi ded here t o pause, r esume and r et r y j obs.

These f unct i ons are cur r ent l y onl y suppor t ed on I nter pl ay Transf er

j obs.

Job Management

Two j ob management f unct i ons are avai l abl e t o cancel and del et e j obs

r especti vel y.

Job Status

Al l aut omat i on t asks, i ncl udi ng t hose f or I nt er pl ay Tr ansf er , r et ur n

a j ob I D as par t of a successf ul i ni t i at i on. The j ob I D can be passed

t o a Get J ob St at us f unct i on whi ch wi l l r epor t t he status, e. g. r unni ng,

paused, etc. as wel l as the percent age compl et i on, f or t he speci f i ed

j ob.

11


14/16

Obtaining Configuration Information

A number of cal l s provi de i nf ormat i on about t he syst emt o whi ch t he

web servi ces cur r ent l y i nt er f aces, i ncl udi ng t he Web Servi ces syst em

i t sel f , t he I nt er pl ay (and Ar chi ve i f used) syst ems t o whi ch i t connect s

as wel l as other systemel ement s such as I nt er pl ay Transf er, I nt erpl ay

Medi a Servi ces and I SI S st orage envi r onment s.

Basic Configuration

Two r out i nes provi de basi c i nf ormat i on about t he I nterpl ay and Web

Servi ces envi r onment . The f i r st pr ovi des basi c i nf or mati on about t he

workgr oup(s) suppor t ed by t he web ser vi ces i mpl ement at i on, and i ncl udes

t he name(s) of t he workgroup( s) and the addr esses of t he associ ated

I nt erpl ay and Ar chi ve engi nes. Thi s cal l does not r equi r e any

cr edent i al s and can be used by i nt egr ator s t o assi st i n t hei r own

conf i gur at i on tool s and UI s.

The second cal l i s mor e speci f i c and r et urns ver si on i nf or mat i on f or

a desi gnat ed wor kgr oup, i ncl udi ng the i nst al l ed ver si on of I nt er pl ay

Web Servi ces, t he I nt erpl ay Engi ne and Ar chi ve Engi ne i f pr esent .

Storage Information

A si ngl e f unct i on al l ows al l i ndexed workspaces i n the workgr oup to

be determi ned.

Interplay Transfer Information

Two f unct i ons are al so provi ded her e. The f i r st r et urns a l i st of al l

I nt erpl ay Transf er engi nes conf i gur ed i n t he workgroup, t he second

l i st s al l t he i ngest , pl ayback and workgr oup devi ces conf i gur ed on a

gi ven engi ne.

Interplay Media Services Information

A si ngl e f uncti on al l ows a thi r d par t y to di scover al l t he pr of i l escur r ent l y def i ned i n t he associ ated medi a servi ces envi r onment .

Typi cal l y t he cal l wi l l speci f y whi ch medi a ser vi ce( s) prof i l es ar e

r equi r ed, e. g. archi ve, t ranscode, et c.

12


15/16

About Assets and Media

Note t hat many f unct i ons are concer ned wi t h asset s t hat, i n thei r t ur n,

r eference act ual medi a whi ch i s t ypi cal l y l ocat ed on associ at ed Avi d

shar ed st orage. Whi l st I nt erpl ay Web Servi ces al l ow access t o t he assets

whi ch r ef erence t he medi a, t hey do not cur r ent l y pr ovi de di r ect access

t o the medi a i t sel f , such access woul d typi cal l y be achi eved t hr ough

t he use of one of Avi d s workgr oup API s

( ht t p: / / www. avi d. com/ us/ par t ner s/ api s. aspx) or t hr ough the use of t he

Avi d Medi aTool ki t ( ht t p: / / www. avi d. com/ us/ part ners/ amt . aspx) .

Vi r t ual l y al l Avi d medi a asset s are ref er enced wi t hi n I nt er pl ay through

AAF f i l es. AAF (Advanced Aut hori ng For mat ) f i l es can be cr eat ed usi ng

a publ i c Open Sour ce tool ki t whi ch i s avai l abl e f r omt he Advanced Medi a

Workf l ow Associ at i on ( ht t p: / / www. amwa. t v/ ) f ormal l y known as t he

Advanced Author i ng Associ at i on.

Supported Standards

I nterpl ay Web Ser vi ces ar e based on SOAP 1. 1 and are compat i bl e wi t h

t he most commonl y used web ser vi ces f r ameworks. Avi d has t est ed t he

servi ces f or i nt eroperabi l i t y wi t h:

. Net 2. 0 Sun Met r o f or J ava ( J AX- WS)

Note t hat si nce web servi ces are wel l adopt ed, I nt erpl ay WS i s l i kel y

t o work wi t h ot her f r ameworks and l anguages l i ke J ava Axi s 2. 0, Pyt hon,

Per l and ot hers, al t hough t hese have not been speci f i cal l y t est ed by

Avi d.

Web Services Deployment

I nt erpl ay web servi ces ar e cur r ent l y depl oyed as SOAP ser vi ces runni ng

on an Apache Tomcat server . The web servi ces i nst al l er i nst al l s t he

ser ver t oget her wi t h al l r el evant suppor t i ng f i l es. Not e t hat t he

l ocati on of t he web servi ces server shoul d be chosen car eful l y i n order

t o avoi d any adver se ef f ect on I nt erpl ay operat i on. Avi d Prof essi onal

Servi ces wi l l be happy t o advi se as t o the most appr opr i at e l ocat i on

f or a part i cul ar i nstal l at i on.

13
http://www.avid.com/us/partners/apis.aspxhttp://www.avid.com/us/partners/amt.aspxhttp://www.amwa.tv/http://www.amwa.tv/http://www.avid.com/us/partners/amt.aspxhttp://www.avid.com/us/partners/apis.aspx


16/16

14

Server Requirements

Whi l st t here ar e no speci f i c hardware r equi r ement s t o support I nt er pl ay

Web Ser vi ces a moder n Wi ndows machi ne ( ~2GHz, 2+ GB RAM) i n t he same

net wor k as t he I nt er pl ay Engi ne i s r equi r ed, t ypi cal l y conf i gur ed as

a Wi ndows Ser ver . Note that an appropr i atel y hi gher perf ormance server

shoul d be suppl i ed i f i t i s al so r equi r ed t o host addi t i onal i nt er f aces

such as i NEWS Web Ser vi ces. For t est i ng and devel opment , I nterpl ay WS

can r un on t he I nt er pl ay Engi ne i t sel f , but t hi s i s not suppor t ed f or

product i on envi r onment s.

How to obtain Interplay Web Services

The I nter pl ay web ser vi ces API i s avai l abl e t o devel oper s on r equest .

Request s shoul d be made usi ng t he web f orm avai l abl e at

ht t p: / / avi d. f or mbi n. com/ f or ms/ avi d- avi d_web_ser vi ces_si gnup
http://avid.formbin.com/forms/avid-avid_web_services_signuphttp://avid.formbin.com/forms/avid-avid_web_services_signup

interplay ws whitepaper 2

Documents