Documentum D2 4.2 Developers Guide

8/16/2019 Documentum D2 4.2 Developers Guide

1/31

E M C ® ® ® D o c u m e n t u m ® ® ®

D 2

V e r s i o n 4 . 2

D e v e l o p e r s G u i d e

E M C C o r p o r a t i o n C o r p o r a t e H e a d q u a r t e r s :

H o p k i n t o n , M A 0 1 7 4 8 - 9 1 0 3 1 - 5 0 8 - 4 3 5 - 1 0 0 0 w w w . E M C . c o m


2/31

L e g a l N o t i c e

C o p y r i g h t © 2 0 0 5 – 2 0 1 4 E M C C o r p o r a t i o n . A l l R i g h t s R e s e r v e d .

E M C b e l i e v e s t h e i n f o r m a t i o n i n t h i s p u b l i c a t i o n i s a c c u r a t e a s o f i t s p u b l i c a t i o n d a t e . T h e i n f o r m a t i o n i s s u b j e c t t o c h a n g e w i t h o u t n o t i c e .

T H E I N F O R M A T I O N I N T H I S P U B L I C A T I O N I S P R O V I D E D " A S I S . " E M C C O R P O R A T I O N M A K E S N O

R E P R E S E N T A T I O N S O R W A R R A N T I E S O F A N Y K I N D W I T H R E S P E C T T O T H E I N F O R M A T I O N I N T H I S P U B L I C A T I O N , A N D S P E C I F I C A L L Y D I S C L A I M S I M P L I E D W A R R A N T I E S O F M E R C H A N T A B I L I T Y O R F I T N E S S F O R A P A R T I C U L A R P U R P O S E .

U s e , c o p y i n g , a n d d i s t r i b u t i o n o f a n y E M C s o f t w a r e d e s c r i b e d i n t h i s p u b l i c a t i o n r e q u i r e s a n a p p l i c a b l e s o f t w a r e l i c e n s e .

F o r t h e m o s t u p - t o - d a t e l i s t i n g o f E M C p r o d u c t n a m e s , s e e E M C C o r p o r a t i o n T r a d e m a r k s o n E M C . c o m . A d o b e a n d A d o b e P D F L i b r a r y a r e t r a d e m a r k s o r r e g i s t e r e d t r a d e m a r k s o f A d o b e S y s t e m s I n c . i n t h e U . S . a n d o t h e r c o u n t r i e s . A l l o t h e r t r a d e m a r k s u s e d h e r e i n a r e t h e p r o p e r t y o f t h e i r r e s p e c t i v e o w n e r s .

D o c u m e n t a t i o n F e e d b a c k

Y o u r o p i n i o n m a t t e r s . W e w a n t t o h e a r f r o m y o u r e g a r d i n g o u r p r o d u c t d o c u m e n t a t i o n . I f y o u h a v e f e e d b a c k a b o u t h o w w e c a n m a k e o u r d o c u m e n t a t i o n b e t t e r o r e a s i e r t o u s e , p l e a s e s e n d u s y o u r f e e d b a c k d i r e c t l y a t I I G D o c u m e n t a t i o n F e e d b a c k @ e m c . c o m .


3/31

T a b l e o f C o n t e n t s

C h a p t e r 1 E x t e n d i n g D 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

I n t r o d u c t i o n t o E x t e n d i n g D 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

C h a p t e r 2 N e w F e a t u r e s a n d C h a n g e s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

C o n t e n t C h e c k i n S e r v i c e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

C h a p t e r 3 O v e r v i e w i n g t h e A r c h i t e c t u r e o f D 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1

U n d e r s t a n d i n g t h e D 2 C l i e n t A r c h i t e c t u r e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1

U n d e r s t a n d i n g t h e D 2 C o n g A r c h i t e c t u r e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 3

U n d e r s t a n d i n g D 2 F i l e T r a n s f e r . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 4 C h a p t e r 4 B u i l d i n g I n t e g r a t i o n s U s i n g D 2 F S . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 7

U s i n g S O A P t o A l l o w E x t e r n a l A p p l i c a t i o n s t o A f f e c t D 2 P r o c e s s e s a n d

D a t a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 7

G e n e r a t i n g J a v a S t u b L i b r a r i e s t o C a l l D 2 F S U s i n g S O A P . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 7

D 2 F S E x a m p l e s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 8

S e t t i n g U p t h e D 2 F S E x a m p l e s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 8

C h a p t e r 5 U s i n g O p e n A j a x H u b ( O A H ) t o C r e a t e a n d C o n g u r e a S a m p l e E x t e r n a l

W i d g e t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 9

U n d e r s t a n d i n g O p e n A j a x H u b ( O A H ) a n d E x t e r n a l W i d g e t s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 9

S e t t i n g U p t h e S a m p l e E x t e r n a l W i d g e t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 9

W a l k i n g T h r o u g h t h e S a m p l e E x t e r n a l W i d g e t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 0

C h a p t e r 6 C r e a t i n g a n d C o n g u r i n g a C u s t o m P l u g - i n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 3

U n d e r s t a n d i n g C u s t o m P l u g - i n s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 3

O v e r v i e w o f t h e T e m p l a t e P l u g - i n E x a m p l e s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 3

D o w n l o a d i n g a n d S e t t i n g U p t h e T e m p l a t e P l u g - i n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 4

B u i l d i n g , I n s t a l l i n g , a n d V e r i f y i n g t h e T e m p l e P l u g - i n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 5

C o n g u r i n g a M e n u I t e m f o r t h e T e m p l a t e P l u g - i n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 6

C r e a t i n g a N e w P l u g - i n U s i n g t h e T e m p l a t e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 6

C o n g u r i n g a C u s t o m A c t i o n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 7

U n d e r s t a n d i n g S e r v i c e I n t e r f a c e O v e r r i d e s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 8

S e t t i n g U p D 2 S e r v i c e O v e r r i d e s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 0

D e p l o y i n g D 2 P l u g - i n s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1

E M C D o c u m e n t u m D 2 V e r s i o n 4 . 2 D e v e l o p e r s G u i d e 3


4/31


5/31

P r e f a c e

E M C ® D o c u m e n t u m ® D 2 c o n s i s t s o f t w o c o m p o n e n t s :

• D 2 C o n g u r a t i o n : T h e w e b - b a s e d a p p l i c a t i o n , h e r e a f t e r k n o w n a s D 2 C o n g , f o r a d m i n i s t r a t o r s

t o u s e t o c o n g u r e s e t t i n g s s u c h a s a u t o m a t e d c o n t e n t - h a n d l i n g p r o c e s s e s a n d b a c k g r o u n d

s e t t i n g s f o r D 2 C l i e n t .

• D 2 C l i e n t : T h e w e b - b a s e d a p p l i c a t i o n , h e r e a f t e r k n o w n a s D 2 C l i e n t , f o r u s e r s t h a t p r o v i d e s t h e

a b i l i t y t o i n t e r a c t w i t h c o n t e n t i n o n e o r m o r e r e p o s i t o r i e s .

W h e n t h i s g u i d e r e f e r s t o D 2 , i t r e f e r s t o t h e p r o d u c t a s a w h o l e , n o t t h e i n d i v i d u a l c o m p o n e n t s .

I n t e n d e d a u d i e n c e

T h e i n f o r m a t i o n i n t h i s g u i d e i s f o r d e v e l o p e r s w h o c r e a t e a n d c o n g u r e e x t e n s i o n s f o r t h e D 2 u s i n g

t h e D 2 a n d D 2 F o u n d a t i o n S e r v i c e s ( D 2 F S ) A P I .

R e v i s i o n h i s t o r y T h e f o l l o w i n g t a b l e l i s t s c h a n g e s i n t h i s g u i d e .

R e v i s i o n D a t e D e s c r i p t i o n

J a n u a r y 2 0 1 4 I n i t i a l p u b l i c a t i o n .



6/31


7/31

C h a p t e r 1

E x t e n d i n g D 2

T h i s c h a p t e r c o n t a i n s t h e f o l l o w i n g t o p i c s :

• I n t r o d u c t i o n t o E x t e n d i n g D 2

I n t r o d u c t i o n t o E x t e n d i n g D 2

B e f o r e c u s t o m i z i n g D 2 u s i n g e x t e n s i o n s , c a r e f u l l y r e - e x a m i n e t h e f u n c t i o n a l i t y a v a i l a b l e t h r o u g h D 2

a n d i t s o f c i a l p l u g - i n s . I n a l m o s t a l l c a s e s , u s i n g e x i s t i n g c a p a b i l i t i e s t o a c h i e v e y o u r u s e c a s e s

p r o v i d e a c h e a p e r a n d m o r e r e l i a b l e s o l u t i o n .

D 2 o f f e r s t h e f o l l o w i n g m e t h o d s o f e x t e n d i n g D 2 u s i n g t h e D 2 A P I :

• B u i l d i n g i n t e g r a t e d s o l u t i o n s b y u s i n g t h e D 2 F S s e r v i c e s t o i n t e r a c t w i t h t h e D 2 w e b a p p l i c a t i o n .

• U s i n g O p e n A j a x H u b ( O A H ) a n d J a v a s c r i p t t o c r e a t e e x t e r n a l w e b a p p l i c a t i o n s t h a t c a n b e

m a n i p u l a t e d a s i f r a m e s f r o m w i t h i n t h e D 2 w e b a p p l i c a t i o n . • U s i n g D 2 J a v a p a c k a g e s t o c r e a t e a n d c o n g u r e D 2 p l u g - i n s t h a t a d d c u s t o m a c t i o n s o r o v e r r i d e

e x i s t i n g D 2 s e r v i c e s .

Y o u c a n u s e a n y I n t e g r a t e d D e v e l o p m e n t E n v i r o n m e n t ( I D E ) s u c h a s E c l i p s e f o r b u i l d i n g t h e c o d e .



8/31


9/31

C h a p t e r 2

N e w F e a t u r e s a n d C h a n g e s


• C o n t e n t C h e c k i n S e r v i c e

C o n t e n t C h e c k i n S e r v i c e

D 2 4 . 1 p e r f o r m e d c h e c k i n f o r n e w c o n t e n t u s i n g t w o o p e r a t i o n s : p e r f o r m i n g h e c h e c k i n w i t h t h e

c h e c k i n ( ) s e r v i c e a n d t h e n a d d i n g t h e n e w c o n t e n t u s i n g t h e g e t U p l o a d U r l s ( ) s e r v i c e . T h e

D 2 4 . 2 c h e c k i n p r o c e s s u s e s t h e n e w I D o w n l o a d S e r v i c e . g e t C h e c k i n U r l s ( ) s e r v i c e t o

p e r f o r m t h e c h e c k i n o p e r a t i o n a s a s i n g l e , a t o m i c o p e r a t i o n .

T o u s e t h e n e w c h e c k i n p r o c e s s , c e a s e u s a g e o f t h e c h e c k i n ( ) a n d g e t U p l o a d U r l s ( ) s e r v i c e s

a n d u s e t h e g e t C h e c k i n U r l s ( ) s e r v i c e . Y o u c a n c o n t i n u e t o u s e t h e c h e c k i n ( ) s e r v i c e f o r

c o n t e n t - l e s s o b j e c t s a n d t h e g e t U p l o a d U r l s ( ) m e t h o d f o r n o n - c h e c k i n o p e r a t i o n s .

T h e E M C D o c u m e n t u m D 2 D 2 F S A P I J a v a D o c c o n t a i n s f u r t h e r i n f o r m a t i o n o n g e t C h e c k i n U r l s ( ) a n d i t s r e q u i r e d a t t r i b u t e s .



10/31


11/31

C h a p t e r 3

O v e r v i e w i n g t h e A r c h i t e c t u r e o f D 2


• U n d e r s t a n d i n g t h e D 2 C l i e n t A r c h i t e c t u r e

• U n d e r s t a n d i n g t h e D 2 C o n g A r c h i t e c t u r e

• U n d e r s t a n d i n g D 2 F i l e T r a n s f e r

U n d e r s t a n d i n g t h e D 2 C l i e n t A r c h i t e c t u r e

D 2 C l i e n t i s c o m p r i s e d o f t h r e e l a y e r s :

• T h e B r o w s e r l a y e r d e n o t i n g t h e w e b b r o w s e r s u s e d b y e n d u s e r s i n c o n n e c t i n g t o D 2 .

• T h e w e b a p p l i c a t i o n s e r v e r l a y e r c o r r e s p o n d i n g t o t h e i n s t a l l a t i o n a n d c o n g u r a t i o n o f D 2 . w a r .

• T h e D o c u m e n t u m C o n t e n t S e r v e r l a y e r c o n s i s t i n g o f i n s t a l l e d D A R l e s .

T h e f o l l o w i n g g r a p h i c s h o w s t h e c o m p o s i t i o n a n d r e l a t i o n s h i p o f t h e t h r e e l a y e r s :

E M C D o c u m e n t u m D 2 V e r s i o n 4 . 2 D e v e l o p e r s G u i d e 1 1


12/31


B r o w s e r L a y e r

D 2 C l i e n t i s a w e b 2 . 0 b r o w s e r - b a s e d a p p l i c a t i o n . E n d u s e r s n a v i g a t e t o t h e D 2 C l i e n t w e b a p p l i c a t i o n

U R L a n d l o g i n t o u s e D 2 . D 2 C l i e n t i s :

• G W T / G X T - b a s e d : D 2 C l i e n t u s e s S e n c h a G X T a n d t h e G o o g l e W e b T o o l k i t ( G W T ) t o m a n a g e

J a v a S c r i p t . A s a r e s u l t , t h e D 2 C l i e n t J a v a S c r i p t c o d e i s d e l i v e r e d h i d d e n a n d i n a s i n g l e l a r g e l e . Y o u c a n n o t e x t e n d o r d e b u g D 2 C l i e n t w i t h o u t t h e o r i g i n a l s o u r c e .

T h e S e n c h a w e b s i t e ( h t t p : / / w w w . s e n c h a . c o m / p r o d u c t s / g x t ) c o n t a i n s f u r t h e r i n f o r m a t i o n o n G X T .

• L o a d e d o n t o a s i n g l e H T M L p a g e : D 2 C l i e n t i n t e r p r e t s a n d l o a d s a l l J a v a S c r i p t i n t o b r o w s e r

m e m o r y a t t h e s t a r t . A s a r e s u l t , D 2 m a n i p u l a t e s t h e H T M L D O M t o r e m o v e a n d r e p l a c e i n t e r f a c e

p o r t i o n s r a t h e r t h a n s w i t c h i n g H T M L p a g e s u p o n u s e r n a v i g a t i o n .

• G W T R P C - b a s e d : D 2 u s e s s t a n d a r d H T T P r e q u e s t s f o r a l l c o m m u n i c a t i o n b e t w e e n t h e b r o w s e r

c l i e n t a n d t h e D 2 w e b a p p l i c a t i o n . F o r r e q u e s t s f o r s t a t i c r e s o u r c e s , s u c h a s i m a g e s , D 2 u s e s G W T

R P C c a l l s b a c k e d b y t h e D 2 F S s e r v i c e s l a y e r t o r e t r i e v e d y n a m i c d a t a .

T h e G o o g l e d e v e l o p e r s i t e ( h t t p s : / / d e v e l o p e r s . g o o g l e . c o m / ) h a s m o r e i n f o r m a t i o n o n G W T R P C .

A p p l i c a t i o n S e r v e r L a y e r ( D 2 . w a r )

D 2 C l i e n t i s p a c k a g e d a s a . w a r l e t h a t c a n b e d e p l o y e d o n m o s t J 2 E E a p p l i c a t i o n s e r v e r s . T h e

w e b a p p l i c a t i o n s e r v e r i s c o m p r i s e d o f :

• T h e D 2 w e b a p p l i c a t i o n : I n c l u d e s m o s t o f t h e p r e s e n t a t i o n l o g i c , i n c l u d i n g t h e G W T a n d G X T

l i b r a r i e s , c u s t o m i n t e r f a c e c o n t r o l s , s t a t i c w e b r e s o u r c e s , a n d p a s s - t h r o u g h s e r v i c e s t o a l l o w w e b

b r o w s e r s t o i n v o k e D 2 F S s e r v i c e s . T h e l a y e r d o e s n o t l i n k t o t h e D o c u m e n t u m F o u n d a t i o n C l a s s e s

( D F C ) o r D o c u m e n t u m F o u n d a t i o n S e r v i c e s ( D F S ) c l i e n t l i b r a r i e s , b e c a u s e a l l c o m m u n i c a t i o n

b e t w e e n t h e D 2 w e b a p p l i c a t i o n a n d t h e D o c u m e n t u m r e p o s i t o r y p a s s e s t h r o u g h t h e D 2 F S i n t e r f a c e .

• T h e D 2 F S l i b r a r y : C o n t a i n s a l l D 2 b u s i n e s s l o g i c , i n c l u d i n g t h e c o m m u n i c a t i o n b e t w e e n t h e D o c u m e n t u m C o n t e n t S e r v e r t h r o u g h D F C a n d D F S , t h e l o g i c f o r i n t e r p r e t i n g a n d a p p l y i n g D 2

c o n g u r a t i o n s t o s e r v i c e r e q u e s t s , a n d a s e t o f S O A P s e r v i c e s .

T h e a p p l i c a t i o n s e r v e r l a y e r u s e s t h e D 2 F S J a v a A P I w h i l e a l l o w i n g e x t e r n a l c l i e n t s t o u s e t h e

S O A P i n t e r f a c e b e c a u s e D 2 F S m e r g e d w i t h D 2 . P l u g - i n s t o D 2 e x i s t i n t h e D 2 F S l a y e r a n d c a n

i n t e r c e p t e x i s t i n g c a l l s t o t h e D 2 F S i n t e r f a c e t o c h a n g e o r e n h a n c e D 2 b e h a v i o r s .

C o n t e n t S e r v e r L a y e r

T h e D 2 i n s t a l l a t i o n i n c l u d e s t h r e e D A R l e s :

• D 2 – D A R . d a r : I n c l u d e s m o s t o f t h e D o c u m e n t u m t y p e s n e c e s s a r y f o r s t o r i n g c o n g u r a t i o n o b j e c t s i n t h e r e p o s i t o r y . C o n g u r a t i o n o b j e c t s a r e s u b t y p e s o f d 2 _ m o d u l e _ c o n f i g o r

d 2 _ m o d u l e d o c _ c o n f i g d e p e n d i n g o n w h e t h e r t h e c o n g u r a t i o n i s s t o r e d a s o b j e c t m e t a d a t a o r a s X M L c o n t e n t . D 2 f a v o r s X M L f o r r e p r e s e n t i n g f o r m s , d i a l o g b o x e s , m a i l t e m p l a t e s , a n d o t h e r

s t r u c t u r e d c o n t e n t , w h e r e a s e t o f r e p e a t i n g a t t r i b u t e s i s i n s u f c i e n t f o r r e p r e s e n t i n g a c o n g u r a t i o n .

T h e D 2 D A R i n c l u d e s j o b s a n d m e t h o d s u s e d b y D 2 f o r i m p l e m e n t i n g s o m e D 2 c o n g u r a t i o n s .

T h e s e m e t h o d s c a n b e i n v o k e d b y a s c h e d u l e d j o b f o r c o m p l e t i n g b a c k g r o u n d t a s k s , o r i n v o k e d

b y t h e D 2 w e b a p p l i c a t i o n i n r e s p o n s e t o e v e n t s . T h e E M C D o c u m e n t u m D 2 A d m i n i s t r a t o r G u i d e

c o n t a i n s f u r t h e r i n f o r m a t i o n a b o u t D 2 j o b s a n d m e t h o d s .

1 2 E M C D o c u m e n t u m D 2 V e r s i o n 4 . 2 D e v e l o p e r s G u i d e


13/31


• D 2 – W i d g e t - D A R . d a r : I n c l u d e s c o n g u r a t i o n t y p e s r e l a t e d t o t h e D 2 4 . x i n t e r f a c e , s u c h a s

w i d g e t s , w o r k s p a c e l a y o u t s , a n d t h e m e s .

• C o l l a b o r a t i o n _ S e r v i c e s . d a r : I n c l u d e s t y p e s a n d D o c u m e n t u m B u s i n e s s O b j e c t

F r a m e w o r k m o d u l e s f o r D o c u m e n t u m c o l l a b o r a t i o n c a p a b i l i t i e s . D 2 r e q u i r e s t h i s D A R l e t o

e n a b l e c o m m e n t i n g w i t h i n D 2 C l i e n t .

U n d e r s t a n d i n g t h e D 2 C o n g A r c h i t e c t u r e

D 2 C o n g i s c o m p r i s e d o f t h r e e l a y e r s :

• T h e B r o w s e r l a y e r d e n o t i n g t h e w e b b r o w s e r s u s e d b y e n d u s e r s i n c o n n e c t i n g t o D 2 C o n g .

• T h e w e b a p p l i c a t i o n s e r v e r l a y e r c o r r e s p o n d i n g t o t h e i n s t a l l a t i o n a n d c o n g u r a t i o n o f

D 2 – C o n f i g . w a r a n d t h e D 2 - W i d g e t p l u g - i n .

• T h e D o c u m e n t u m C o n t e n t S e r v e r l a y e r .

T h e f o l l o w i n g g r a p h i c s h o w s t h e c o m p o s i t i o n a n d r e l a t i o n s h i p o f t h e t h r e e l a y e r s :

B r o w s e r L a y e r

D 2 C o n g i s a w e b 2 . 0 b r o w s e r - b a s e d a p p l i c a t i o n . E n d u s e r s n a v i g a t e t o t h e D 2 C o n g w e b

a p p l i c a t i o n U R L a n d l o g i n t o u s e D 2 . D 2 C o n g i s :

• A c t i v e X c o n t r o l - b a s e d : D 2 C o n g u s e s A c t i v e X c o n t r o l l i k e t h e o l d D 2 3 . x a r c h i t e c t u r e a n d c a n

o n l y b e a c c e s s e d u s i n g M i c r o s o f t I n t e r n e t E x p l o r e r b r o w s e r s .



14/31


• X M L - b a s e d : D 2 C o n g u s e s t h e o l d D 2 3 . x a r c h i t e c t u r e f o r D 2 a n d d e l i v e r s t h e i n t e r f a c e t o t h e

w e b b r o w s e r i n X M L r e p r e s e n t a t i o n .

A p p l i c a t i o n S e r v e r L a y e r ( D 2 - C o n f g . w a r )

D 2 C o n g i s p a c k a g e d a s a . w a r l e t h a t c a n b e d e p l o y e d o n m o s t J 2 E E a p p l i c a t i o n s e r v e r s . T h e w e b a p p l i c a t i o n s e r v e r i s c o m p r i s e d o f :

• T h e D 2 C o n g w e b a p p l i c a t i o n : I n c l u d e s m o s t o f t h e p r e s e n t a t i o n l o g i c , i n c l u d i n g t h e A c t i v e X

c o n t r o l s . T h e l a y e r i n c l u d e s t h e D o c u m e n t u m F o u n d a t i o n C l a s s e s ( D F C ) o r D o c u m e n t u m

F o u n d a t i o n S e r v i c e s ( D F S ) c l i e n t l i b r a r i e s , a s t h e l a y e r c o n t r o l s c o m m u n i c a t i o n b e t w e e n t h e D 2

C o n g w e b a p p l i c a t i o n a n d t h e D o c u m e n t u m r e p o s i t o r y .

• T h e D 2 - W i d g e t p l u g - i n : A d d s c o n g u r a t i o n c o m p o n e n t s f o r D 2 C l i e n t t o D 2 C o n g .

C o n t e n t S e r v e r L a y e r

T h e D 2 i n s t a l l a t i o n i n c l u d e s t h r e e D A R l e s :

• D 2 – D A R . d a r : I n c l u d e s m o s t o f t h e D o c u m e n t u m t y p e s n e c e s s a r y f o r s t o r i n g c o n g u r a t i o n

o b j e c t s i n t h e r e p o s i t o r y . C o n g u r a t i o n o b j e c t s a r e s u b t y p e s o f d 2 _ m o d u l e _ c o n f i g o r

d 2 _ m o d u l e d o c _ c o n f i g d e p e n d i n g o n w h e t h e r t h e c o n g u r a t i o n i s s t o r e d a s o b j e c t m e t a d a t a o r a s X M L c o n t e n t . D 2 u s e s X M L f o r r e p r e s e n t i n g f o r m s , d i a l o g b o x e s , m a i l t e m p l a t e s , a n d o t h e r

s t r u c t u r e d c o n t e n t , w h e r e a s e t o f r e p e a t i n g a t t r i b u t e s i s i n s u f c i e n t f o r r e p r e s e n t i n g a c o n g u r a t i o n .

T h e D 2 D A R i n c l u d e s j o b s a n d m e t h o d s s e d b y D 2 f o r i m p l e m e n t i n g s o m e D 2 c o n g u r a t i o n s .

T h e s e m e t h o d s c a n b e i n v o k e d b y a s c h e d u l e d j o b f o r c o m p l e t i n g b a c k g r o u n d t a s k s , o r i n v o k e d

b y t h e D 2 w e b a p p l i c a t i o n i n r e s p o n s e t o e v e n t s . T h e E M C D o c u m e n t u m D 2 A d m i n i s t r a t o r G u i d e

c o n t a i n s f u r t h e r i n f o r m a t i o n a b o u t D 2 j o b s a n d m e t h o d s .

• D 2 – W i d g e t - D A R . d a r : I n c l u d e s c o n g u r a t i o n t y p e s r e l a t e d t o t h e D 2 4 . x i n t e r f a c e , s u c h a s w i d g e t s , w o r k s p a c e l a y o u t s , a n d t h e m e s .

• C o l l a b o r a t i o n _ S e r v i c e s . d a r : I n c l u d e s t y p e s a n d D o c u m e n t u m B u s i n e s s O b j e c t F r a m e w o r k m o d u l e s f o r D o c u m e n t u m c o l l a b o r a t i o n c a p a b i l i t i e s . D 2 r e q u i r e s t h i s D A R l e t o

e n a b l e c o m m e n t i n g w i t h i n D 2 C l i e n t .

U n d e r s t a n d i n g D 2 F i l e T r a n s f e r

D 2 u s e s e i t h e r t h e D 2 J a v a a p p l e t o r H T M L 5 ( t h i n c l i e n t m o d e ) t o p e r f o r m c o n t e n t t r a n s f e r , g i v i n g i t

s e v e r a l a d v a n t a g e s o v e r t h e s t a n d a r d H T M L 4 < l e i n p u t > f o r m c o n t r o l :

• M u l t i p l e - l e u p l o a d .

• U p l o a d o f e n t i r e f o l d e r s t r u c t u r e s .

• D r a g - a n d - d r o p o f l e s f r o m t h e d e s k t o p f o r u p l o a d .

• C l i e n t - s i d e c o m p r e s s i o n o f c o n t e n t b e f o r e t h e u p l o a d .

B r o w s e r s t h a t s u p p o r t H T M L 5 c a n r u n D 2 w i t h o u t t h e J a v a a p p l e t i n t h i n c l i e n t m o d e b u t d o s o w i t h

l i m i t e d f u n c t i o n a l i t y . T h e E M C D o c u m e n t u m D 2 I n s t a l l a t i o n G u i d e c o n t a i n s i n f o r m a t i o n a b o u t t h e

f u n c t i o n a l i t y r e s t r i c t e d b y t h i n c l i e n t m o d e a n d i n s t r u c t i o n s f o r s e t t i n g t h e l e t r a n s f e r m o d e .



15/31


T h e f o l l o w i n g g r a p h i c s h o w s t h e d a t a o w o f c o n t e n t t r a n s f e r b e t w e e n t h e D o c u m e n t u m C o n t e n t

S e r v e r a n d D 2 w e b a p p l i c a t i o n s :

I n b a s i c i n s t a l l a t i o n s w i t h m o s t u s e r s i n c l o s e g e o g r a p h i c p r o x i m i t y , t h e D 2 a p p l e t u s e s a s t a n d a r d

H T T P c o n n e c t i o n t o c o n n e c t d i r e c t l y b a c k t o t h e D 2 w e b a p p l i c a t i o n .

U s e t h e D o c u m e n t u m B r a n c h O f c e C a c h i n g S e r v i c e s ( B O C S ) c a c h e t o s p e e d u p t r a n s f e r o f l a r g e

l e s t o u s e r s i n r e m o t e l o c a t i o n s . D 2 r e q u i r e s t h e D 2 - B O C S p l u g - i n t o b e i n s t a l l e d o n t o t h e s a m e

s e r v e r a s t h e B O C S c a c h e t o :

• F a c i l i t a t e c o m m u n i c a t i o n b e t w e e n t h e D 2 a p p l e t a n d t h e B O C S c a c h e .

• A l l o w D 2 t o m a n i p u l a t e c o n t e n t i n a n d o u t o f t h e r e p o s i t o r y . F o r e x a m p l e , t h e C 2 p l u g - i n c a n b e

u s e d t o i n s e r t c o n g u r a t i o n - b a s e d w a t e r m a r k s .

D 2 - B O C S m u s t a p p l y c o n g u r a t i o n r u l e s t o c o m p l e t e C 2 a n d O 2 c o n t e n t o p e r a t i o n s . A s a r e s u l t ,

D 2 - B O C S o p e n s a D F C s e s s i o n w i t h t h e r e p o s i t o r y , w h i c h m a k e s D o c u m e n t u m R P C c a l l s t o t h e

r e p o s i t o r y t o r e t r i e v e c o n g u r a t i o n o b j e c t s a n d c o n t e n t m e t a d a t a . D u e t o t h e r e l a t i v e l y h i g h l a t e n c y o f

t h e c o n n e c t i o n b e t w e e n t h e B O C S c a c h e a n d t h e C o n t e n t S e r v e r , a d m i n i s t r a t o r s a n d e n d u s e r s s h o u l d

t r y t o l i m i t t h e n u m b e r o f a p p l i c a b l e O 2 a n d C 2 c o n g u r a t i o n s . C o n g u r e D 2 s o t h a t o n l y l a r g e l e s

c a n b e t r a n s f e r r e d u s i n g t h e B O C S c a c h e t o r e d u c e l o a d o n t h e c o n n e c t i o n a n d t o c o n n e c t d i r e c t l y t o

t h e D 2 a p p l i c a t i o n f o r t h e t r a n s f e r o f s m a l l e r l e s .



16/31


17/31

C h a p t e r 4

B u i l d i n g I n t e g r a t i o n s U s i n g D 2 F S


• U s i n g S O A P t o A l l o w E x t e r n a l A p p l i c a t i o n s t o A f f e c t D 2 P r o c e s s e s a n d D a t a

• G e n e r a t i n g J a v a S t u b L i b r a r i e s t o C a l l D 2 F S U s i n g S O A P

• D 2 F S E x a m p l e s

• S e t t i n g U p t h e D 2 F S E x a m p l e s

U s i n g S O A P t o A l l o w E x t e r n a l A p p l i c a t i o n s t o A f f e c t D 2 P r o c e s s e s a n d D a t a

T h e D 2 F S A P I i s e x p o s e d f r o m t h e D 2 w e b a p p l i c a t i o n a s a s e t o f S O A P s e r v i c e s . G e n e r a t i n g J a v a

S t u b L i b r a r i e s t o C a l l D 2 F S V i a S O A P , p a g e 1 7 c o n t a i n s i n s t r u c t i o n s f o r g e n e r a t i n g t h e J a v a s t u b

l i b r a r i e s r e q u i r e d f o r i n v o k i n g D 2 F S u s i n g S O A P s e r v i c e s .

T h e D 2 S D K p a c k a g e c o n t a i n s s a m p l e J a v a c l a s s e s t h a t u s e t h e J a v a s t u b l i b r a r i e s t o i n v o k e a n d

m o d i f y D 2 p r o c e s s e s a n d d a t a . T h e E M C D o c u m e n t u m D 2 D 2 F S A P I J a v a D o c c o n t a i n s f u r t h e r i n f o r m a t i o n o n t h e a v a i l a b l e D 2 F S

s e r v i c e s .

G e n e r a t i n g J a v a S t u b L i b r a r i e s t o C a l l D 2 F S U s i n g S O A P

1 . D e p l o y D 2 t o a l o c a l a p p l i c a t i o n s e r v e r .

2 . U s i n g t h e f o l l o w i n g c o m m a n d , g e n e r a t e t h e J a v a s o u r c e l e s f o r t h e s t u b l i b r a r i e s n e e d e d t o

c o n n e c t t o D 2 :

w s i m p o r t — k e e p h t t p : / / l o c a l h o s t : 8 0 8 0 / D 2 / w s / d 2 f s . w s d l

T h e - k e e p p a r a m e t e r s a v e s t h e l e s s o t h a t y o u c a n c o p y t h e m t o y o u r p r o j e c t .

3 . I f y o u g e n e r a t e d s t u b s u s i n g a d i f f e r e n t D 2 s e r v e r t h a n t h e o n e y o u u s e d t o c a l l D 2 F S , m o d i f y t h e U R L b y o p e n i n g M o d e l P o r t S e r v i c e . j a v a a n d e d i t i n g t h e f o l l o w i n g l i n e :

s t a t i c { u r l = n e w U R L ( " h t t p : / / < D 2 s e r v e r a d d r e s s a n d

p o r t > / D 2 / w s / d 2 f s . w s d l " ) ; }



18/31

B u i l d i n g I n t e g r a t i o n s U s i n g D 2 F S

D 2 F S E x a m p l e s

N a v i g a t e t o t h e D 2 F S / J a v a / D 2 F S E x a m p l e s / s r c / c o m / e m c / d 2 / d 2 f s / e x a m p l e s f o l d e r

i n t h e D 2 S D K p a c k a g e f o r t h e f o l l o w i n g e x a m p l e J a v a c l a s s e s :

C l a s s D e s c r i p t i o n

C o n t e x t A n d L o g i n E x a m p l e . j a v a D e m o n s t r a t e s h o w t o e s t a b l i s h a D 2 F S l o g i n c o n t e x t

w i t h t h e D 2 s e r v e r .

I m p o r t A n d U p l o a d D o c u m e n t E x a m p l e . j a v a D e m o n s t r a t e s h o w t o u s e c r e a t e p r o p e r t i e s ( )

t o i m p o r t a n d u p l o a d c o n t e n t .

D e s t r o y E x a m p l e . j a v a D e m o n s t r a t e s h o w t o d e s t r o y c o n t e n t .

S a v e P r o p e r t i e s E x a m p l e . j a v a D e m o n s t r a t e s h o w t o s e t c o n t e n t a t t r i b u t e s .

S e a r c h Q u i c k E x a m p l e . j a v a D e m o n s t r a t e s h o w t o r u n a q u i c k s e a r c h .

S e a r c h A d v a n c e d E x a m p l e . j a v a D e m o n s t r a t e s h o w t o :

• U s e S e a r c h S e r v i c e a n d C o n t e n t S e r v i c e t o s e a r c h

t h e r e p o s i t o r y . • S a v e o r r u n a n a d v a n c e d s e a r c h .

• L i s t s a v e d s e a r c h e s .

• R u n a s a v e d s e a r c h .

C h e c k i n C o n t e n t E x a m p l e . j a v a D e m o n s t r a t e s h o w t o u s e g e t C h e c k i n U r l s ( ) t o :

• C h e c k o u t c o n t e n t .

• R e q u e s t a c h e c k i n U R L .

• P o s t n e w c o n t e n t w i t h c h e c k i n p a r a m e t e r s .

T a x o n o m y E n u m A n d E x p o r t U r l E x a m p l e . j a v a D e m o n s t r a t e s h o w t o u s e C o n t e n t S e r v i c e t o :

• E n u m e r a t e t a x o n o m y o b j e c t s .

• D o w n l o a d a n d s a v e t h e e x p o r t e d t a x o n o m y .

S e t t i n g U p t h e D 2 F S E x a m p l e s , p a g e 1 8 c o n t a i n s i n s t r u c t i o n s f o r s e t t i n g u p t h e D 2 F S e x a m p l e s

a f t e r g e n e r a t i n g t h e J a v a s t u b l i b r a r i e s .

S e t t i n g U p t h e D 2 F S E x a m p l e s

1 . U s i n g E c l i p s e , c r e a t e a n e w w o r k s p a c e a n d i m p o r t e x i s t i n g p r o j e c t s i n t o t h e w o r k s p a c e f r o m t h e D 2 F S / J a v a / D 2 F S E x a m p l e s f o l d e r .

2 . D e l e t e t h e c o m . e m c . d 2 f s . * a n d o r g . w 3 . * p a c k a g e s i f t h e y a r e a l r e a d y c o n t a i n e d b y t h e p r o j e c t .

3 . C o p y t h e g e n e r a t e d c o m a n d o r g f o l d e r s t o y o u r p r o j e c t .

Y o u c a n p a s t e t h e f o l d e r s d i r e c t l y f r o m t h e l o c a l l e d i r e c t o r y t o t h e s r c / f o l d e r o f y o u r I D E .

4 . U p d a t e L o g i n I n f o . j a v a t o s p e c i f y y o u r r e p o s i t o r y , l o g i n , p a s s w o r d , a n d t h e U R L o f t h e w e b a p p l i c a t i o n .

5 . C h e c k t h e s e t u p c o m m e n t s a t t h e t o p o f t h e e x a m p l e t o c o n r m t h e r e q u i r e d i n p u t s .



19/31

C h a p t e r 5 U s i n g O p e n A j a x H u b ( O A H ) t o C r e a t e a n d C o n g u r e a S a m p l e E x t e r n a l

W i d g e t T h i s c h a p t e r c o n t a i n s t h e f o l l o w i n g t o p i c s :

• U n d e r s t a n d i n g O p e n A j a x H u b ( O A H ) a n d E x t e r n a l W i d g e t s

• S e t t i n g U p t h e S a m p l e E x t e r n a l W i d g e t

• W a l k i n g T h r o u g h t h e S a m p l e E x t e r n a l W i d g e t

U n d e r s t a n d i n g O p e n A j a x H u b ( O A H ) a n d E x t e r n a l W i d g e t s

O p e n A j a x H u b ( O A H ) i s a s t a n d a r d J a v a S c r i p t l i b r a r y f o r p u b l i s h i n g a n d s u b s c r i b i n g t o w e b

a p p l i c a t i o n s t h a t i s d e n e d b y t h e O p e n A j a x A l l i a n c e t o a d d r e s s i n t e r o p e r a b i l i t y a n d s e c u r i t y i s s u e s

t h a t a r i s e w h e n m u l t i p l e A j a x l i b r a r i e s a n d c o m p o n e n t s a r e u s e d i n t h e s a m e w e b p a g e . Y o u c a n

u s e O A H t o :

• P u b l i s h t o a c h a n n e l t o s e n d a m e s s a g e .

• S u b s c r i b e t o a c h a n n e l t o l i s t e n f o r a m e s s a g e .

A D 2 e x t e r n a l w i d g e t i s a w e b a p p l i c a t i o n U R L h o s t e d i n a n i f r a m e w i t h i n t h e D 2 C l i e n t a p p l i c a t i o n .

D 2 u s e s O A H t o c o m m u n i c a t e b e t w e e n w i d g e t s a n d t o b r o a d c a s t e v e n t s a n d a c t i o n s s u c h a s c o n t e n t s e l e c t i o n , o b j e c t l o c a t i o n , a n d c o n t e n t v i e w .

• E v e n t s n o t i f y l i s t e n e r s a b o u t t h e D 2 a p p l i c a t i o n a n d w i d g e t - s p e c i c a t t r i b u t e s .

• A c t i o n s c a u s e D 2 o r w i d g e t s t o p e r f o r m a s p e c i e d o p e r a t i o n .

T h e D 2 i m p l e m e n t a t i o n o f O A H , c a l l e d D 2 - O A H . j s , p r o v i d e s t h e b i n d i n g b e t w e e n a w e b p a g e a n d t h e

s u r r o u n d i n g D 2 a p p l i c a t i o n . D 2 C o n g r e f e r s t o t h e s e w e b p a g e s a s e x t e r n a l w i d g e t s , w h i c h a r e h o s t e d

i n a n i f r a m e w i t h i n t h e D 2 C l i e n t w e b a p p l i c a t i o n .

T h e X 3 P u b S u b E v e n t s s e c t i o n o f t h e E M C D o c u m e n t u m D 2 O p e n A j a x H u b ( O A H ) E v e n t a n d

A c t i o n s J a v a D o c c o n t a i n s a c o m p l e t e r e f e r e n c e o f t h e O A H m e s s a g e o b j e c t s , t h e D 2 - O A H A P I , a n d

t h e l i s t o f a v a i l a b l e a c t i o n s a n d e v e n t s .

S e t t i n g U p t h e S a m p l e E x t e r n a l W i d g e t

1 . E x t r a c t U p d a t e D o c L i s t f o l d e r f r o m D 2 4 . 2 S D K . z i p t o a t e m p o r a r y l o c a t i o n .

2 . S t o p y o u r w e b a p p l i c a t i o n s e r v e r .

3 . C o p y t h e X 3 – E x t - U p d a t e D o c l i s t f o l d e r t o t h e < w e b a p p l i c a t i o n s e r v e r > / w e b a p p s / f o l d e r .



20/31

U s i n g O p e n A j a x H u b ( O A H ) t o C r e a t e a n d C o n g u r e a S a m p l e E x t e r n a l W i d g e t

4 . S t a r t y o u r w e b a p p l i c a t i o n s e r v e r .

5 . L o g i n t o D 2 C o n g :

a . N a v i g a t e t o F i l e > I m p o r t c o n g u r a t i o n f r o m t h e m e n u b a r .

b . I m p o r t X 3 – E x t - U p d a t e D o c l i s t — C o n f i g . z i p

T h e E M C D o c u m e n t u m D 2 A d m i n i s t r a t i o n G u i d e c o n t a i n s f u r t h e r i n s t r u c t i o n s o n i m p o r t i n g c o n g u r a t i o n s .

c . N a v i g a t e t o W i d g e t v i e w > W i d g e t f r o m t h e m e n u b a r .

d . S e l e c t t h e W G E X T U p d a t e D o c l i s t w i d g e t .

e . M o d i f y t h e W i d g e t u r l e l d t o m a t c h t h e l o c a t i o n o f y o u r d e p l o y e d w e b a p p l i c a t i o n s e r v e r . F o r e x a m p l e :

h t t p : / / m y s e r v e r : 8 0 8 0 / X 3 – E x t - U p d a t e D o c l i s t

T h e s a m p l e e x t e r n a l w i d g e t a l s o c o n t a i n s a s e c o n d U R L t h a t d i s p l a y s a n O p e n A j a x H u b

p u b l i s h a n d s u b s c r i b e a p p l i c a t i o n :

h t t p : / / m y s e r v e r : 8 0 8 0 / X 3 – E x t - U p d a t e D o c l i s t / d e v i n d e x . h t m l

6 . L o g i n t o D 2 C l i e n t a n d a d d t h e n e w w i d g e t t o y o u r w o r k s p a c e .

W a l k i n g T h r o u g h t h e S a m p l e E x t e r n a l W i d g e t

T h e X 3 – E x t - U p d a t e D o c l i s t e x t e r n a l w i d g e t s h o w s h o w t o :

• C r e a t e a D 2 O p e n A j a x H u b o b j e c t t o c o n n e c t t h e e x t e r n a l w i d g e t t o D 2 .

• U s e t h e O p e n A j a x M e s s a g e H u b t o e x e c u t e a q u e r y f o r m a n d u p d a t e t h e d o c l i s t w i d g e t .

• U s e t h e O p e n A j a x H u b t o s u b s c r i b e t o D 2 e v e n t s a n d r e c e i v e m e s s a g e s .

O p e n X 3 – E x t - U p d a t e D o c l i s t / i n d e x . h t m l i n a t e x t e d i t o r t o v i e w t h e s a m p l e c o d e .

T h e X 3 P u b S u b E v e n t s s e c t i o n o f t h e E M C D o c u m e n t u m D 2 O p e n A j a x H u b ( O A H ) E v e n t a n d

A c t i o n s J a v a D o c c o n t a i n s a c o m p l e t e r e f e r e n c e t o t h e O p e n A j a x H u b ( O A H ) c l a s s e s a n d m e t h o d s a s

w e l l a s a c o m p l e t e l i s t o f D 2 e v e n t s , a c t i o n s , a n d t h e i r c o r r e s p o n d i n g a t t r i b u t e s .

I m p o r t i n g O A H S c r i p t s

Y o u m u s t i m p o r t t h e f o l l o w i n g t w o J a v a s c r i p t s c r i p t s :

• U s e o n e o f t h e f o l l o w i n g :

– h t t p : / / Y o u r S e r v e r : 8 0 8 0 / D 2 / c o n t a i n e r / O p e n A j a x M a n a g e d H u b - a l l - o b f . j s

– h t t p : / / Y o u r S e r v e r : 8 0 8 0 / D 2 / c o n t a i n e r / e x t e r n a l - a p i / O p e n A j a x M a n a g e d H u b - a l l .

O p e n A j a x M a n a g e d H u b - a l l - o b f . j s i s t h e s m a l l e r v e r s i o n u s e d b y D 2 f o r p r o d u c t i o n

p u r p o s e s a n d O p e n A j a x M a n a g e d H u b - a l l . j s i s t h e f u l l v e r s i o n f o r d e v e l o p m e n t p u r p o s e s .

• h t t p : / / Y o u r S e r v e r : 8 0 8 0 / D 2 / c o n t a i n e r / e x t e r n a l - a p i / D 2 - O A H . j s



21/31


C r e a t i n g a n d C o n n e c t i n g a n O p e n A j a x H u b

C r e a t e a n d c o n n e c t a D 2 O p e n A j a x H u b ( ) o b j e c t . T h e s a m p l e c o d e u s e s t h e f o l l o w i n g c o d e :

v a r d 2 O p e n A j a x H u b = n e w D 2 O p e n A j a x H u b ( ) ;

/ / c o n n e c t h u b p r o v i d i n g c a l l b a c k f u n c t i o n s .

d 2 O p e n A j a x H u b . c o n n e c t H u b ( c o n n e c t C o m p l e t e d , o n I n i t W i d g e t , o n A c t i v e W i d g e t ) ; Y o u c a n t h e n s e t a c a l l b a c k f o r a s u c c e s s f u l c o n n e c t i o n t o t h e h u b t o p e r f o r m i n i t i a l i z a t i o n t a s k s . F o r

e x a m p l e , t h e s a m p l e w a i t s f o r t h e h u b c l i e n t t o c o n n e c t a n d t h e n i n i t i a t e s s u b s c r i b i n g t o e v e n t s .

f u n c t i o n c o n n e c t C o m p l e t e d ( h u b C l i e n t , s u c c e s s , e r r o r ) {

i f ( s u c c e s s ) {

l o g i t ( " H u b c l i e n t c o n n e c t e d " ) ;

/ / s u b s c r i b e t o e v e n t s

s u b s c r i b e E v e n t s ( ) ;

} e l s e l o g i t ( " H u b c l i e n t N O T c o n n e c t e d - p l e a s e c h e c k c o n s o l e " ) ;

}

T h e s a m p l e w i d g e t a l w a y s s u b s c r i b e s t o e v e n t s e v e n i f y o u d o n o t r e q u e s t t h a t t h e w i d g e t t r a c k a n d

d i s p l a y o b j e c t s o f t h e s e l e c t e d t y p e .

S u b s c r i b i n g t o E v e n t s

Y o u c a n i n t e r a c t w i t h t h e e x t e r n a l w i d g e t t o s e t o r c h a n g e s u b s c r i p t i o n s t o D 2 e v e n t s . Y o u c a n t h e n

u s e t h e s u b s c r i p t i o n t o l i s t e n t o m e s s a g e s a n d e x t r a c t i n f o r m a t i o n . S e l e c t T r a c k s e l e c t e d t y p e t o

t r a c k c o n t e n t s e l e c t e d b y u s e r s i n D 2 C l i e n t , r e c e i v e d n o t i c a t i o n s , a n d v i e w t h e d o c u m e n t t y p e

i n t h e e x t e r n a l w i d g e t f o r m . C a l l t h e s u b s c r i b e T o C h a n n e l ( ) m e t h o d t o u s e t h i s f e a t u r e o f O p e n A j a x H u b a s s h o w n i n

t h e s a m p l e c o d e :

f u n c t i o n s u b s c r i b e E v e n t s ( ) {

l o g i t ( " s u b s c r i b e t o e v e n t s . . . " ) ;

d 2 O p e n A j a x H u b . s u b s c r i b e T o C h a n n e l ( " D 2 _ E V E N T _ S E L E C T _ O B J E C T " ,

s e l e c t O b j e c t C a l l b a c k , t r u e ) ;

}

T h e s e l e c t O b j e c t C a l l b a c k m e t h o d i s a n e x a m p l e m e t h o d i n t h e s a m p l e t h a t d i c t a t e s h o w t h e

w i d g e t u s e s t h e m e s s a g e r e c e i v e d t h r o u g h t h i s e v e n t .

S e n d i n g M e s s a g e s Y o u c a n i n t e r a c t w i t h t h e e x t e r n a l w i d g e t b o t h a s a w i d g e t i n a D 2 C l i e n t w o r k s p a c e o r b y a c c e s s i n g

t h e U R L d i r e c t l y t h r o u g h a w e b b r o w s e r . T h e s a m p l e w e b a p p l i c a t i o n c o n t a i n s a n H T M L f o r m t h a t

c o n t a i n s t h e s a m e e l d s a s t h e Q F H R a _ s t a t u s q u e r y f o r m t h a t i s i m p o r t e d w h e n t h e e x t e r n a l

w i d g e t i s i n s t a l l e d . T y p e a d o c u m e n t t y p e , s e l e c t a d o c u m e n t s t a t u s , a n d c l i c k t h e U p d a t e D o c l i s t

b u t t o n . T h e e x t e r n a l w i d g e t s e n d s a n O p e n A j a x M e s s a g e t o D 2 t o e x e c u t e t h e Q F H R a _ s t a t u s q u e r y f o r m s e a r c h . T h e q u e r y f o r m t h e n f u n c t i o n s a s a D o c l i s t w i d g e t l t e r b e c a u s e i t u p d a t e s t h e

D o c l i s t w i d g e t w i t h t h e s e a r c h r e s u l t s .



22/31


C a l l t h e s e n d M e s s a g e ( ) m e t h o d t o u s e t h i s f e a t u r e o f O p e n A j a x H u b a s s h o w n i n t h e s a m p l e c o d e :

f u n c t i o n u p d a t e D o c l i s t ( ) {

/ / Q u e r y f o r m c o n f i g u r a t i o n n a m e i s d e f i n e d b e l o w

v a r q u e r y F o r m C o n f i g N a m e = " Q F H R a _ s t a t u s " ;

/ / T o u p d a t e t h e d o c l i s t a n e w O p e n A j a x m e s s a g e w i l l b e b u i l d t o b e p o s t e d / / i n t h e H u b u s i n g t h e D 2 - O A H A P I

v a r m e s s a g e T o S e n d = n e w O p e n A j a x M e s s a g e ( ) ;

/ / S p e c i f y a n o n - n u l l I D ( t o p a s s r e q u e s t v a l i d a t i o n )

m e s s a g e T o S e n d . p u t ( " o a m _ i d " , " " ) ;

/ / I n t h e m e s s a g e , w e n e e d t o d e f i n e w h a t p r o p e r t i e s w i l l b e s e n t .

/ / H e r e a _ s t a t u s a n d r _ o b j e c t _ t y p e

m e s s a g e T o S e n d . p u t ( " l i s t " , " a _ s t a t u s ¬ r _ o b j e c t _ t y p e " ) ;

/ / W e s e t t h e a _ s t a t u s v a l u e

m e s s a g e T o S e n d . p u t ( " a _ s t a t u s " , a _ s t a t u s . v a l u e ) ;

/ / W e s e t t h e r _ o b j e c t _ t y p e v a l u e

m e s s a g e T o S e n d . p u t ( " r _ o b j e c t _ t y p e " , r _ o b j e c t _ t y p e . v a l u e ) ;

/ / s e t t h e q u e r y f o r m c o n f i g n a m e w h i c h w i l l b e u s e d t o u p d a t e t h e d o c l i s t

m e s s a g e T o S e n d . p u t ( " c o n f i g " , q u e r y F o r m C o n f i g N a m e ) ;

/ / T h e n w e d e f i n e w h a t s e r v i c e a n d w h a t m e t h o d i n t h e s e r v i c e w i l l b e c a l l e d .

/ / W e c a l l t h e S e a r c h s e r v i c e a n d t h e r u n Q u e r y F o r m S e a r c h m e t h o d .

/ / C a l l i n g t h i s s e r v i c e w i l l u p d a t e t h e u s e r ’ s l a s t s e a r c h o b j e c t

m e s s a g e T o S e n d . p u t ( " e S e r v i c e " , " S e a r c h " ) ;

m e s s a g e T o S e n d . p u t ( " e M e t h o d " , " r u n Q u e r y F o r m S e a r c h " ) ;

/ / W h e n t h e s e r v i c e c a l l c o m p l e t e s , w e c a n d e f i n e a n a c t i o n t o b e e x e c u t e d . / / H e r e , a n e v e n t w i l l b e p o s t e d .

m e s s a g e T o S e n d . p u t ( " r T y p e " , " E V E N T " ) ;

/ / A s t h e l a s t s e a r c h h a s b e e n u p d a t e d b y t h e w e b s e r v i c e c a l l , w e w i l l p o s t

/ / t h e D 2 _ A C T I O N _ S E A R C H _ D O C U M E N T e v e n t t o d i s p l a y t h e s e a r c h r e s u l t s

m e s s a g e T o S e n d . p u t ( " r A c t i o n " , " D 2 _ A C T I O N _ S E A R C H _ D O C U M E N T : : o a m _ i d = = n o d e _ l a s t _ s e a r c h

/ / T h e m e s s a g e i s n o w r e a d y , i t c a n b e p o s t e d i n t h e H u b

d 2 O p e n A j a x H u b . s e n d M e s s a g e ( " D 2 _ A C T I O N _ E X E C U T E " , m e s s a g e T o S e n d ) ;

}



23/31

C h a p t e r 6

C r e a t i n g a n d C o n g u r i n g a C u s t o m

P l u g - i n


• U n d e r s t a n d i n g C u s t o m P l u g - i n s

• O v e r v i e w o f t h e T e m p l a t e P l u g - i n E x a m p l e s

• D o w n l o a d i n g a n d S e t t i n g U p t h e T e m p l a t e P l u g - i n

• B u i l d i n g , I n s t a l l i n g , a n d V e r i f y i n g t h e T e m p l e P l u g - i n

• C o n g u r i n g a M e n u I t e m f o r t h e T e m p l a t e P l u g - i n

• C r e a t i n g a N e w P l u g - i n U s i n g t h e T e m p l a t e

• C o n g u r i n g a C u s t o m A c t i o n

• U n d e r s t a n d i n g S e r v i c e I n t e r f a c e O v e r r i d e s

• S e t t i n g U p D 2 S e r v i c e O v e r r i d e s

• D e p l o y i n g D 2 P l u g - i n s

U n d e r s t a n d i n g C u s t o m P l u g - i n s

Y o u c a n c r e a t e a n d c o n g u r e c u s t o m p l u g - i n s u s i n g t h e J a v a c l a s s e s a n d r e s o u r c e s p a c k a g e d w i t h

t h e D 2 A P I f r a m e w o r k t o :

• A d d f e a t u r e s a s c u s t o m a c t i o n s .

C o n g u r i n g a C u s t o m A c t i o n , p a g e 2 7 c o n t a i n s i n s t r u c t i o n s f o r c r e a t i n g a n d c o n g u r i n g a c u s t o m

a c t i o n .

• M o d i f y e x i s t i n g f e a t u r e s b y c h a n g i n g p r e - p r o c e s s i n g , p o s t - p r o c e s s i n g , a n d o v e r r i d i n g D 2 s e r v i c e s .

S e t t i n g U p D 2 S e r v i c e O v e r r i d e s , p a g e 3 0 c o n t a i n s i n s t r u c t i o n s f o r m o d i f y i n g t h e D 2 s e r v i c e s

a n d U n d e r s t a n d i n g S e r v i c e O v e r r i d e s , p a g e 2 8 c o n t a i n s i n f o r m a t i o n a b o u t t h e v a r i o u s o v e r r i d e s

y o u c a n u s e .

T h e E M C D o c u m e n t u m D 2 D 2 F S A P I J a v a D o c c o n t a i n s m o r e i n f o r m a t i o n o n t h e a v a i l a b l e s e r v i c e s

a n d a c t i o n s .

O v e r v i e w o f t h e T e m p l a t e P l u g - i n E x a m p l e s

T h e t e m p l a t e p l u g - i n l o c a t e d i n t h e P l u g i n s f o l d e r o f t h e D 2 4 . 2 S D K . z i p a r c h i v e c o n t a i n s

t h e f o l l o w i n g t h r e e e x a m p l e s :



24/31

C r e a t i n g a n d C o n g u r i n g a C u s t o m P l u g - i n

C u s t o m i z i n g C o n t e n t E x p o r t

T h i s e x a m p l e f o r c u s t o m i z i n g c o n t e n t e x p o r t s h o w s h o w t o u s e c o n d i t i o n s e r v i c e o v e r r i d e , h o w

t o a d d a c u s t o m s e r v i c e ( I P l u g i n A c t i o n ) , a n d h o w t o c o n g u r e e r r o r r e p o r t i n g . T h e r e s u l t i n g

p l u g - i n a l l o w s e n d u s e r s t o u s e a m e n u i t e m i n D 2 C l i e n t t o d o w n l o a d d y n a m i c a l l y - g e n e r a t e d c u s t o m

c o n t e n t u s i n g t h e D 2 w e b s e r v i c e . T o d o t h i s , t h e p l u g - i n u s e s t h e D 2 O p e n A j a x H u b t o p o s t a n e v e n t

n a m e d D 2 _ A C T I O N _ E X P O R T _ F R O M _ U R L t o t r i g g e r c o n t e n t d o w n l o a d f r o m t h e U R L c o n t a i n e d

i n a p a r a m e t e r .

T h e p l u g - i n c o n s i s t s o f t h e f o l l o w i n g c l a s s e s :

• D 2 C u s t o m S e r v i c e i m p l e m e n t s t h e I P l u g i n A c t i o n i n t e r f a c e t o a l l o w b e i n g c a l l e d a s a

s t a n d a r d D 2 w e b s e r v i c e . T h e c l a s s c o n t a i n s t h e g e t C u s t o m D o w n l o a d U R L m e t h o d t h a t r e t u r n s a

U R L w i t h d y n a m i c I D s t o t h e E x p o r t C o n t e n t s e r v l e t .

• D 2 E x p o r t S e r v i c e P l u g i n i n t e r c e p t s t h e s t a n d a r d D 2 E x p o r t S e r v i c e w e b s e r v i c e t h a t i s

c a l l e d b y t h e E x p o r t C o n t e n t s e r v l e t . T h e c l a s s o v e r r i d e s t h e e x p o r t T o m e t h o d t o s e n d

c u s t o m c o n t e n t t o D 2 .

• D 2 u s e s D 2 P l u g i n T e m p l a t e V e r s i o n a n d D 2 P l u g i n V e r s i o n f o r p l u g - i n d e t e c t i o n .

A f t e r c o n g u r i n g a m e n u i t e m u s i n g D 2 C o n g , a n e n d u s e r c a n c l i c k t h e m e n u i t e m i n D 2 C l i e n t t o

t r i g g e r t h e f o l l o w i n g c h a i n o f e v e n t s :

1 . T h e p l u g - i n c a l l s t h e g e t C u s t o m D o w n l o a d U R L m e t h o d i n t h e D 2 C u s t o m S e r v i c e s e r v i c e .

2 . T h e m e t h o d r e t u r n s a U R L t o t h e E x p o r t C o n t e n t s e r v l e t i n a n o a m _ v a l u e a t t r i b u t e .

3 . T h e s e r v l e t p o s t s t h e U R L a s a p a r a m e t e r o f t h e D 2 _ A C T I O N _ E X P O R T _ F R O M _ U R L e v e n t .

4 . T h e D 2 a p p l e t d e t e c t s t h e e v e n t a n d t r i g g e r s a d o w n l o a d u s i n g t h e E x p o r t C o n t e n t s e r v l e t .

5 . T h e E x p o r t C o n t e n t s e r v l e t r e t r i v e s c o n t e n t f r o m t h e D 2 E x p o r t S e r v i c e s e r v i c e .

6 . T h e D 2 E x p o r t S e r v i c e P l u g i n i n t e r c e p t s t h e c a l l a n d s e n d s t h e c u s t o m c o n t e n t .

O v e r r i d i n g a S e r v i c e w i t h P o s t - P r o c e s s i n g

T h i s e x a m p l e p e r f o r m s a D 2 S e r v i c e b u t a d d s p o s t - p r o c e s s i n g t o m a k e o b j e c t _ n a m e v a l u e s u p p e r

c a s e .

T h e p l u g - i n c o n s i s t s o f t h e D 2 C o n t e n S e r v i c e P l u g i n c l a s s .

O v e r r i d i n g a S e r v i c e w i t h P r e - P r o c e s s i n g

T h i s e x a m p l e p e r f o r m s a D 2 S e r v i c e b u t a d d s p r e - p r o c e s s i n g t o a d d a t i m e s t a m p s u f x t o t h e t i t l e

a t t r i b u t e .

T h e p l u g - i n c o n s i s s o f t h e D 2 C r e a t i o n S e r v i c e P l u g i n c l a s s .

D o w n l o a d i n g a n d S e t t i n g U p t h e T e m p l a t e P l u g - i n

1 . D o w n l o a d D 2 4 . 2 S D K . z i p t o a t e m p o r a r y l o c a t i o n .

2 4 E M C D o c u m e n t u m D 2 V e r s i o n 4 . 2 D e v e l o

Documentum D2 4.2 Developers Guide

Documents

Transcript of Documentum D2 4.2 Developers Guide