Open Text Enterprise Scan 10 COM API Programming Guide
Open Text Enterprise Scan 10 COM API Programming Guide
Programming Guide
Enterprise Scan Clients
CLES100000-PGD-EN
9/05/2011
2 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
Open Text Enterprise Scan COM API
Programming Guide
Enterprise Scan Clients
CLES100000-PG-E!
Open Text Corporation
2&5 'ran( T!#pa Dri)e* +ater,!!* Ontari!* Cana%a* N2L 0A1
Te,- .1-519-///-&111
T!,, 'ree Cana%a/0SA- 1-/00-199-2511 nternati!na,- ./00-1992-5110
'ax- .1-519-///-02&&
E#ai,- s$pp!rt3!pentext4c!#
'TP- 5tp-//5tp4!pentext4c!#
'!r #!re in5!r#ati!n* )isit 6ttp-//7774!pentext4c!#
Cop"rig#t $ %" Open Text Corporation& Open Text Inc'
Open Text C!rp!rati!n is t6e !7ner !5 t6e tra%e#ar(s Open Text* T6e C!ntent Experts* Open Text ECM S$ite* Open Text eDOCS*
eDOCS* Open Text 'irstC,ass* 'irstC,ass* Open Text Excee%* Open Text 8!stExp,!rer* Open Text Excee% OnDe#an%* Open Text Excee%
9D* Open Text Excee% 'ree%!#* Open Text Excee% P!7erS$ite* Open Text Excee% :D;* Open Text N'S S!,!* Open Text N'S C,ient*
Open Text N'S Ser)er* Open Text N'S Gate7a<* Open Text E)er<76ere* Open Text =ea, Ti#e* Open Text E,!>$ent Me%ia Ser)er* Open
Text nte"rate% D!c$#ent Mana"e#ent* Open Text DM* Open Text D!c$Lin(* Li)e,in(* Li)e,in( ECM* Artesia* =e%D!t* =i"6t'ax* =;?@*
DOMEA* A,c6e#<* @i"nette* @iAiB,e* Nstein* Le"a,;E?* Pic%ar* 8$##in"Bir%* :OS* A,is Gist-in-Ti#e* E$r!c!rtex* Ga$ss* Captaris*
Spicer* Geni!* @ista P,$s* C$rntsan%* Ne7 Generati!n C!ns$,tin"* M!#ent$# S<ste#s* DO;$Star* an% =ec!Star a#!n" !t6ers4 T6is ,ist
is n!t ex6a$sti)e4
A,, !t6er pr!%$cts !r c!#pan< na#es are $se% 5!r i%enti5icati!n p$rp!ses !n,<* an% are tra%e#ar(s !5 t6eir respecti)e !7ners4 A,, ri"6ts
reser)e%4
9 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
Contents
1 Introduction
(
) *or+ing ,it# IExportCon-ig inter-ace
.
241 Pr!perties
2
24141 O$tp$t'!r#at pr!pert<
2
24142 C!#pressi!nC!,!r pr!pert<
2
24149 M$,tipa"e pr!pert<
2
24141 Dpe"C!#pressi!n pr!pert<
2
242 Met6!%s
&
24241 C!n5i"$re #et6!%
&
24242 Seria,iAeC!n5i"$rati!n #et6!%
&
24249 Deseria,iAeC!n5i"$rati!n #et6!%
&
/ *or+ing ,it# Enterprise Scan COM inter-ace
0
941 Pr!perties
9
94141 D!cPat6Na#e pr!pert<
9
94142 Err!rD pr!pert<
9
94149 D!cD pr!pert<
9
942 Met6!%s
9
94241 =et$rne%Carc!%e #et6!%
9
1 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
94242 Sen%D!c2DP
10
94249 Sen%D!c2DPC5"
10
94241 Sa)eActi)eD!c
11
94245 Sa)eActi)eD!cC5"
11
94242 Sa)eActi)ePa"e
12
9424& Sa)eActi)ePa"eC5"
12
9424/ GetGr!$pNa#e
12
94249 GetN$#BerO5Pa"es
19
942410 GetN$#BerDe,Pa"es
19
942411 Get'!r#at
11
942412 GetCarc!%e
11
942419 CanCeArc6i)e%
11
942411 Sen%D!c2DPEx
15
942415 Sen%D!c2DPExC5"
15
942412 Sen%D!c2Arc6i)e
12
94241& Se,ectD!c
1&
1 Custom 2egistr" 3e" settings
10
141 :SC2SAP
1/
14141 3DPA C0G
1/
14142 M0LT PAGE 'O=MAT
1/
5 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
14149 SNGLE PAGE 'O=MAT
1/
2 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
1 ntr!%$cti!n
t is p!ssiB,e t! $se Enterprise Scan in !t6er )en%!rEs app,icati!ns $sin" a COM inter5aces 5!r ear,<
arc6i)in"4 T6ese t<pes !5 ear,< arc6i)in" scenari!s are s$pp!rte% B< t6ese inter5aces-
F Arc6i)in" int! a t6ir%-part< arc6i)e
F Arc6i)in" int! Open Text C!ntent Ser)er 5r!# a t6ir%-part< c,ient
!ote4 S$pp!rte% 5!r Enterprise Scan )ersi!n 945 an% 6i"6er4
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
& | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
2 +!r(in" 7it6 Exp!rtC!n5i" inter5ace
+it6 Exp!rtC!n5i" inter5ace <!$ can c!n5i"$re t6e !$tp$t 5!r#at !5 5i,es exp!rte% 5r!# Enterprise
Scan4
T6e inter5ace is i#p,e#ente% in #!%$,e ScanExp!rt4%,,4
T6e Pr!"D !5 t6e i#p,e#entati!n is x!s4Scan4Exp!rt4Exp!rtC!n5i"4
T6e CLSD is C/11/C2&-'2A1-9D2D-AA92-AA&'CD1C0C224
241 Pr!perties
24141 O$tp$t'!r#at pr!pert<
T6e O$tp$t'!r#at pr!pert< "ets !r sets t6e 5!r#at !5 !$tp$t 5i,es4 A)ai,aB,e )a,$es are-
0 K T'' 5!r %!c$#ents 7it6 a,, 1-Bit pa"es* DPEG 5!r !t6er %!c$#ents
1 K T'' 5!r a,, %!c$#ents
2 K DPEG2000 5!r a,, %!c$#ents
int Output5ormat
24142 C!#pressi!nC!,!r pr!pert<
T6e C!#pressi!nC!,!r pr!pert< "ets !r sets >$a,it< !5 c!#pressi!n 5!r c!,!r i#a"es4 T6e a,,!7e%
)a,$es are 5r!# 0 HBest >$a,it<I t! 100 HBest c!#pressi!nI4
int CompressionColor
24149 M$,tipa"e pr!pert<
T6e M$,tipa"e pr!pert< "ets !r sets i5 sa)e% T'' 5i,es 7i,, Be #$,tipa"e4
6OOL Multipage
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
/ | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
24141 Dpe"C!#pressi!n pr!pert<
T6e Dpe"C!#pressi!n pr!pert< "ets !r sets t6e C!#pressi!n t<pe4 A)ai,aB,e )a,$es are-
9 K C!#pressi!n t<pe 'ax91
1 K C!#pressi!n t<pe 'ax92
5 K C!#pressi!n t<pe 'ax1
9 K C!#pressi!n t<pe Dpe"2
10 K C!#pressi!n t<pe Dpe"&
int 7pegCompression
242 Met6!%s
24241 C!n5i"$re #et6!%
T6e C!n5i"$re #et6!% s6!7s a c!n5i"$rati!n %ia,!"4 A5ter pressin" O;* t6e )a,$es in t6e !BLect 7i,, Be
$p%ate% acc!r%in" t! t6e se,ecte% )a,$es4
S"stem'*indo,s'5orms'ialog2esult Con-igure89
24242 Seria,iAeC!n5i"$rati!n #et6!%
T6e Seria,iAeC!n5i"$rati!n 5i,,s t6e s$pp,ie% C!n5i"N!%e 7it6 )a,$es 5r!# t6e Exp!rtC!n5i" !BLect4
'!r 5$rt6er in5!r#ati!n aB!$t C!n5i"N!%e* see t6e Enterprise Scan TecD!c4
:oid Seriali;eCon-iguration8Ixos'Clients'Con-igManager'ICon-ig!ode con-ig!ode9<
24249 Deseria,iAeC!n5i"$rati!n #et6!%
T6e Deseria,iAeC!n5i"$rati!n #et6!% 5i,,s t6e Exp!rtC!n5i" !BLect 7it6 )a,$es 5r!# t6e s$pp,ie%
C!n5i"N!%e4 '!r 5$rt6er in5!r#ati!n aB!$t C!n5i"N!%e* see t6e Enterprise Scan TecD!c4
)!i% Deseria,iAeC!n5i"$rati!nHx!s4C,ients4C!n5i"Mana"er4C!n5i"N!%e c!n5i"N!%eIM
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
9 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
9 +!r(in" 7it6 Enterprise Scan COM inter5ace
T6e SC2SAP !BLect is i#p,e#ente% in #!%$,e ScanExtensi!nSC2SAPPr!x<4%,, an% is i%enti5ie% B<
na#e x!s4i:Scan4SC2SAP4
T6e CLSD is 51'9E'&9-DC09-11C'-/C91-0020A''2&0C94
SC2SAP !BLect exp!rts %ispatc6 inter5ace O,eSC2SAP i%enti5ie% B< i% 51'9E'&5-DC09-11C'-/C91-
0020A''2&0C94
T6e taB,e Be,!7 s6!7s inter5ace #et6!%s an% pr!perties4
5unction !ame Id T"pe
D!cPat6Na#e 1 Pr!pert<
Err!rD 2 Pr!pert<
D!cD 9 Pr!pert<
=et$rne%Carc!%e & Pr!pert<
Sen%D!c2DP 1 Met6!%
Sa)eActi)eD!c 5 Met6!%
Sa)eActi)ePa"e 2 Met6!%
GetGr!$pNa#e / Met6!%
GetN$#BerO5Pa"es 9 Met6!%
GetN$#BerDe,Pa"es 10 Met6!%
Get'!r#at 11 Met6!%
GetCarc!%e 12 Met6!%
CanCeArc6i)e% 19 Met6!%
Sen%D!c2DPEx 11 Met6!%
Sen%D!c2DPC5" 15 Met6!%
Sen%D!c2DPExC5" 12 Met6!%
Sa)eActi)eD!cC5" 1& Met6!%
Sa)eActi)ePa"eC5" 1/ Met6!%
Sen%D!c2Arc6i)e 19 Met6!%
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
10 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
Se,ectD!c 20 Met6!%
941 Pr!perties
94141 D!cPat6Na#e pr!pert<
T6e D!cPat6Na#e pr!pert< retrie)es t6e %irect!r< pat6 76ere t6e arc6i)e% %!c$#ent 7as sa)e%4
6ST2 ocPat#!ame
94142 Err!rD pr!pert<
T6e Err!rD pr!pert< retrie)es t6e ,ast err!r c!%e4
6ST2 ErrorI
A)ai,aB,e )a,$es are-
N0N N! err!r - %!c$#ents !r pa"es 7ere s$ccess5$,,< sa)e%
N900N +r!n" para#eters 7ere sent
N920N Pr!cess c!##$nicati!n err!r
N921N An err!r !cc$rs %$rin" arc6i)in"
N9/0N D!c$#ent stac( is e#pt<
N990N Err!r %$rin" %!c$#ent se,ecti!n
94149 D!cD pr!pert<
T6e D!cD pr!pert< retrie)es %!c$#ent i%enti5icati!n4 D!c% is $se% ,ater 5!r %!c$#ent retrie)in"4
6ST2 ocI
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
11 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
942 Met6!%s
94241 =et$rne%Carc!%e #et6!%
T6e =et$rne%Carc!%e pr!pert< retrie)es t6e %!c$#ent Barc!%e4
6ST2 2eturned6arcode
94242 Sen%D!c2DP
T6e Sen%D!cDP 5$ncti!n arc6i)es a %!c$#ent 5r!# Enterprise Scan int! C!ntent Ser)er an% 5i,,s
D!cD an% Err!rD pr!pert<4 N!te t6at Enterprise Scan %e5ines a,"!rit6# 6!7 t! %eci%e 76ic6
%!c$#ent !5 t6e %!c$#ent stac( s6!$,% Be arc6i)e% Hc$rrent )ersi!n !5 Enterprise Scan s$pp!rts
arc6i)in" !5 t6e 5irst %!c$#ent !r arc6i)in" !5 t6e se,ecte% %!c$#entI4
)!i% Sen%D!c2DPH
CST= ,psAArc6i)eD // arc6i)e D
CST= ,psAN!te // n!te
IM
Parameters4
,psAArc6i)eD- L!"ica, arc6i)e i%enti5icati!n
,psAN!te- t is p!ssiB,e t! arc6i)e a n!te 5!r e)er< %!c$#ent4 T6is para#eter c!ntains text !5 an
arc6i)e% n!te4
2eturn :alues4
N!ne4 C6ec( Err!rD pr!pert< 5!r ret$rn )a,$e4
94249 Sen%D!c2DPC5"
T6e Sen%D!cDPC5" 5$ncti!n arc6i)es a %!c$#ent $sin" t6e speci5ie% !$tp$t 5!r#at c!n5i"$rati!n
5r!# Enterprise Scan int! C!ntent Ser)er an% 5i,,s D!cD an% Err!rD pr!pert<4 N!te t6at Enterprise
Scan %e5ines a,"!rit6# 6!7 t! %eci%e 76ic6 %!c$#ent !5 t6e %!c$#ent stac( s6!$,% Be arc6i)e%
Hc$rrent )ersi!n !5 Enterprise Scan s$pp!rts arc6i)in" !5 t6e 5irst %!c$#ent !r arc6i)in" !5 t6e
se,ecte% %!c$#entI4
)!i% Sen%D!c2DPC5"H
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
12 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
CST= ,psAArc6i)eD // arc6i)e D
CST= ,psAN!te // n!te
Dispatc6O aPC!n5i" // !$tp$t c!n5i"$rati!n
IM
Parameters4
,psAArc6i)eD- L!"ica, arc6i)e i%enti5icati!n
,psAN!te- t is p!ssiB,e t! arc6i)e a n!te 5!r e)er< %!c$#ent4 T6is para#eter c!ntains text !5 an
arc6i)e% n!te4
aPC!n5i"- Exp!rtC!n5i" i#p,e#entati!n
2eturn :alues4
N!ne4 C6ec( Err!rD pr!pert< 5!r ret$rn )a,$e4
94241 Sa)eActi)eD!c
T6e Sa)eActi)eD!c 5$ncti!n sa)es t6e acti)e %!c$#ent 5r!# Enterprise Scan Ha %!c$#ent 7it6 t6e
5!c$sI int! t6e 5i,e s<ste# an% 5i,,s D!cPat6Na#e an% Err!rD pr!pert<4 D!c$#ent is sa)e% t! t6e
%irect!r< QTEMPQRscSa)e4
)!i% Sa)eActi)eD!cH
COOL B=e#!)e // re#!)e %!c$#ent
IM
Parameters4
B=e#!)e- Speci5ies i5 sa)e% %!c$#ent 6as t! Be re#!)e% 5r!# Enterprise Scan4
2eturn :alues4
N!ne4 C6ec( Err!rD pr!pert< 5!r ret$rn )a,$e4
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
19 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
94245 Sa)eActi)eD!cC5"
T6e Sa)eActi)eD!cC5" 5$ncti!n sa)es t6e acti)e %!c$#ent 5r!# Enterprise Scan Ha %!c$#ent 7it6
t6e 5!c$sI int! t6e 5i,e s<ste# $sin" t6e speci5ie% !$tp$t 5!r#at c!n5i"$rati!n an% 5i,,s D!cPat6Na#e
an% Err!rD pr!pert<4 D!c$#ent is sa)e% t! t6e %irect!r< QTEMPQRscSa)e4
)!i% Sa)eActi)eD!cH
COOL B=e#!)e // re#!)e %!c$#ent
Dispatc6O aPC!n5i" // !$tp$t c!n5i"$rati!n
IM
Parameters4
B=e#!)e- Speci5ies i5 sa)e% %!c$#ent 6as t! Be re#!)e% 5r!# Enterprise Scan4
aPC!n5i"- Exp!rtC!n5i" i#p,e#entati!n
2eturn :alues4
N!ne4 C6ec( Err!rD pr!pert< 5!r ret$rn )a,$e4
94242 Sa)eActi)ePa"e
T6e Sa)eActi)ePa"e 5$ncti!n sa)es t6e acti)e pa"e 5r!# Enterprise Scan Ha pa"e 7it6 t6e 5!c$sI int!
t6e 5i,e s<ste# an% 5i,,s D!cPat6Na#e an% Err!rD pr!pert<4 Pa"e is sa)e% t! t6e %irect!r< QTEMP
QRscSa)e4
)!i% Sa)eActi)ePa"eH
COOL C=e#!)e // re#!)e pa"e
IM
Parameters4
C=e#!)e- Speci5ies i5 sa)e% pa"e 6as t! Be re#!)e% 5r!# Enterprise Scan4 5 ,ast pa"e !5 %!c$#ent
is re#!)e% t6en t6e 76!,e %!c$#ent is re#!)e% t!!4
2eturn :alues4
N!ne4 C6ec( Err!rD pr!pert< 5!r ret$rn )a,$e4
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
11 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
9424& Sa)eActi)ePa"eC5"
T6e Sa)eActi)ePa"eC5" 5$ncti!n sa)es t6e acti)e pa"e 5r!# Enterprise Scan Ha pa"e 7it6 t6e 5!c$sI
int! t6e 5i,e s<ste# $sin" t6e speci5ie% !$tp$t 5!r#at c!n5i"$rati!n an% 5i,,s D!cPat6Na#e an% Err!rD
pr!pert<4 Pa"e is sa)e% t! t6e %irect!r< QTEMPQRscSa)e4
)!i% Sa)eActi)ePa"eH
COOL B=e#!)e // re#!)e pa"e
Dispatc6O aPC!n5i" // !$tp$t c!n5i"$rati!n
IM
Parameters4
B=e#!)e- Speci5ies i5 sa)e% pa"e 6as t! Be re#!)e% 5r!# Enterprise Scan4 5 ,ast pa"e !5 %!c$#ent
is re#!)e% t6en t6e 76!,e %!c$#ent is re#!)e% t!!4
aPC!n5i"- Exp!rtC!n5i" i#p,e#entati!n4
2eturn :alues4
N!ne4 C6ec( Err!rD pr!pert< 5!r ret$rn )a,$e4
9424/ GetGr!$pNa#e
'$ncti!n ret$rns t6e "r!$p na#e !5 t6e %!c$#ent4
CST= GetGr!$pNa#e H
0LONG $,n%ex // in%ex !5 %!c$#ent
IM
Parameters4
$,n%ex- n%ex !5 %!c$#ent
2eturn :alues4
CST= na#e !5 %!c$#ent "r!$p
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
15 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
94249 GetN$#BerO5Pa"es
'$ncti!n ret$rns n$#Ber !5 pa"es in t6e %!c$#ent4
D+O=D GetN$#BerO5Pa"es H
0LONG $,n%ex // in%ex !5 %!c$#ent
IM
Parameters4
$,n%ex- n%ex !5 %!c$#ent
2eturn :alues4
D+O=D n$#Ber !5 pa"es in %!c$#ent
942410 GetN$#BerDe,Pa"es
'$ncti!n ret$rns n$#Ber !5 pa"es in t6e %!c$#ent t6at are #ar(e% 5!r %e,eti!n H%e,ete #ar(erI4
D+O=D GetN$#BerDe,Pa"es H
0LONG $,n%ex // in%ex !5 %!c$#ent
IM
Parameters4
$,n%ex- n%ex !5 %!c$#ent
2eturn :alues4
D+O=D n$#Ber !5 %e,ete% pa"es in %!c$#ent
942411 Get'!r#at
'$ncti!n ret$rns t6e 5!r#at !5 %!c$#ent HT''* DOC an% s! !nI4
CST= Get'!r#at H
0LONG $,n%ex // in%ex !5 %!c$#ent
IM
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
12 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
Parameters4
$,n%ex- n%ex !5 %!c$#ent4
2eturn :alues4
CST= strin" c!ntains t6e 5!r#at !5 t6e %!c$#ent
942412 GetCarc!%e
'$ncti!n ret$rns t6e Barc!%e !5 t6e %!c$#ent4
CST= GetCarc!%e H
0LONG $,n%ex // in%ex !5 %!c$#ent
IM
Parameters4
$,n%ex- n%ex !5 %!c$#ent
2eturn :alues4
CST= strin" c!ntains t6e Barc!%e
942419 CanCeArc6i)e%
'$ncti!n ret$rns tr$e i5 t6e %!c$#ent can Be arc6i)e% Ht6at #eans it %!es n!t c!ntain pa"es 7it6
%i55erent c!,!r %ept6I4
COOL CanCeArc6i)e% H
0LONG 0,n%ex // in%ex !5 %!c$#ent
IM
Parameters4
0,n%ex- n%ex !5 %!c$#ent
2eturn :alues4
COOL tr$e i5 %!c$#ent can Be arc6i)e%* 5a,se i5 n!t4
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
1& | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
942411 Sen%D!c2DPEx
T6e Sen%D!cDPEx 5$ncti!n arc6i)es a %!c$#ent 5r!# Enterprise Scan int! C!ntent Ser)er an% 5i,,s
D!cD an% Err!rD pr!pert<4 N!te t6at Enterprise Scan %e5ines a,"!rit6# 6!7 t! %eci%e 76ic6
%!c$#ent !5 t6e %!c$#ent stac( s6!$,% Be arc6i)e% Hc$rrent )ersi!n !5 Enterprise Scan s$pp!rts
arc6i)in" !5 t6e 5irst %!c$#ent !r arc6i)in" !5 t6e se,ecte% %!c$#entI4 T6e a%%iti!na, c!n%iti!ns a,,!7
$ser t! set t6is para#eters !$tsi%e 5r!# Enterprise Scan4
)!i% Sen%D!c2DPExH
CST= ,psAArc6i)eD // arc6i)e D
CST= ,psAN!te // n!te
B!!,ean B=etn%ex // ret$rn in%ex 2 =/9
B!!,ean BArc6i)eAs-M$,tipa"e // arc6i)e C/+ pa"es as #$,tipa"e T''
B!!,ean B=e#!)eDe,-Pa"es //re#!)e %e,ete% pa"es Be5!re arc6i)in"
IM
Parameters4
,psAArc6i)eD- L!"ica, arc6i)e i%enti5icati!n4
,psAN!te- t is p!ssiB,e t! arc6i)e a n!te 5!r e)er< %!c$#ent4 T6is para#eter c!ntains text !5 arc6i)e%
n!te4
2eturn :alues4
N!ne4 C6ec( Err!rD pr!pert< 5!r ret$rn )a,$e4
942415 Sen%D!c2DPExC5"
T6e Sen%D!cDPExC5" 5$ncti!n arc6i)es a %!c$#ent s<ste# $sin" t6e speci5ie% !$tp$t 5!r#at
c!n5i"$rati!n 5r!# Enterprise Scan int! C!ntent Ser)er an% 5i,,s D!cD an% Err!rD pr!pert<4 N!te t6at
Enterprise Scan %e5ines a,"!rit6# 6!7 t! %eci%e 76ic6 %!c$#ent !5 t6e %!c$#ent stac( s6!$,% Be
arc6i)e% Hc$rrent )ersi!n !5 Enterprise Scan s$pp!rts arc6i)in" !5 t6e 5irst %!c$#ent !r arc6i)in" !5
t6e se,ecte% %!c$#entI4 T6e a%%iti!na, c!n%iti!ns a,,!7 $ser t! set t6is para#eters !$tsi%e 5r!#
Enterprise Scan4
)!i% Sen%D!c2DPExH
CST= ,psAArc6i)eD // arc6i)e D
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
1/ | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
CST= ,psAN!te // n!te
B!!,ean B=etn%ex // ret$rn in%ex 2 =/9
B!!,ean BArc6i)eAs-M$,tipa"e // arc6i)e C/+ pa"es as #$,tipa"e T''
B!!,ean B=e#!)eDe,-Pa"es //re#!)e %e,ete% pa"es Be5!re arc6i)in"
Dispatc6O aPC!n5i" // !$tp$t c!n5i"$rati!n
IM
Parameters4
,psAArc6i)eD- L!"ica, arc6i)e i%enti5icati!n
,psAN!te- t is p!ssiB,e t! arc6i)e a n!te 5!r e)er< %!c$#ent4 T6is para#eter c!ntains text !5 arc6i)e%
n!te4
aPC!n5i"- Exp!rtC!n5i" i#p,e#entati!n
2eturn :alues4
N!ne4 C6ec( Err!rD pr!pert< 5!r ret$rn )a,$e4
942412 Sen%D!c2Arc6i)e
T6e Sen%D!cArc6i)e 5$ncti!n arc6i)es a %!c$#ent 5r!# Enterprise Scan int! EC= Ser)er an% 5i,,s
D!cD an% Err!rD pr!pert<4 N!te t6at Enterprise Scan %e5ines a,"!rit6# 6!7 t! %eci%e 76ic6
%!c$#ent !5 t6e %!c$#ent stac( s6!$,% Be arc6i)e% Hc$rrent )ersi!n !5 Enterprise Scan s$pp!rts
arc6i)in" !5 t6e 5irst %!c$#ent !r arc6i)in" !5 t6e se,ecte% %!c$#entI4
)!i% Sen%D!c2DPH
CST= ,psAArc6i)eD // arc6i)e D
CST= ,psA=eser)e% // reser)e% 5!r 5$t$re $se
CST= ,psA0=L // Arc6i)eLin( 0=L
CST= ,psAN!te // n!te
IM
Parameters4
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
19 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
,psAArc6i)eD- L!"ica, arc6i)e i%enti5icati!n4 5 ,psA0=L is e#pt<* t6is para#eter #$st Be speci5ie%4
,psAN!te- t is p!ssiB,e t! arc6i)e a n!te 5!r e)er< %!c$#ent4 T6is para#eter c!ntains text !5 arc6i)e%
n!te4
,psA0=L- 0=L !5 t6e %!c$#ent t! Be arc6i)e%4 T6is para#eter* i5 speci5ie%* ta(es prece%ence !)er t6e
,psAArc6i)eD para#eter4 5 ,psAArc6i)eD is e#pt<* t6is para#eter #$st Be speci5ie%4
N!te- T6is app,ies !n,< 5!r +in%!7s @ie7er4 n Enterprise Scan* t6is para#eter is i"n!re%4
=et$rn )a,$es-
N!ne4 C6ec( Err!rD pr!pert< 5!r ret$rn )a,$e4
94241& Se,ectD!c
T6e Se,ectD!c 5$ncti!n se,ects a %!c$#ent !5 Enterprise Scan %!c$#ent stac( an% a,s! sets 5!c$s t!
it4
)!i% Se,ectD!cH
0LONG $,D!cn%ex // in%ex !5 %!c$#ent
0LONG $,Pa"en%ex // pa"e in%ex
IM
Parameters4
$,D!cn%ex- n%ex !5 %!c$#ent t! Be se,ecte%
$,Pa"en%ex - Pa"e in%ex t! Be se,ecte%
2eturn :alues4
N!ne4 C6ec( Err!rD pr!pert< 5!r ret$rn )a,$e4
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
20 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
1 C$st!# =e"istr< ;e< settin"s
0sin" 5!,,!7in" re"istr< (e<s* certain para#eters re,ate% 7it6 Enterprise Scan COM inter5aces can Be
c!n5i"$re%4
141 :SC2SAP
8;E?PC0==ENTP0SE=RS!5t7areR:OSR:OSPA=C8@ERScanRi:Sc2SAP
14141 3DPA C0G
T<pe- =EGPD+O=D
De5a$,t- 0 HB$" s6!$,% n!t Be repaire%I
SAPG0 )ersi!n @940C c!ntains a B$" 5!r 3DPA )ariaB,e in OLE inter5ace4 T6e B$" ca$ses t6at t6e
5irst 5 c6aracters !5 DPA )ariaB,e are re#!)e%4 5 t6e )a,$e is set t! 1 t6en 3DPA )ariaB,e is prece%e%
B< 5 spaces s! it c!$,% 7!r(4
14142 M0LT PAGE 'O=MAT
T<pe- =EGPSS
De5a$,t- 5axQ%p
'i,e na#e !5 t6e pa"e4 t is p!ssiB,e t! sa)e t6e %!c$#ents t! t6e 5i,e s<ste# $sin" t6e COM inter5ace
exp!rte% B< EnterpriseScan4 T6e )a,$e is $se% 5!r #$,ti pa"e %!c$#ents !n,<4 t %e5ines t6e 5i,e na#e
76ic6 is $se% 5!r t6e pa"es4%d is rep,ace% B< pa"e !r%er4
14149 SNGLE PAGE 'O=MAT
T<pe- =EGPSS
De5a$,t- %!(5ax
'i,e na#e !5 t6e pa"e4 t is p!ssiB,e t! sa)e t6e %!c$#ents t! t6e 5i,e s<ste# $sin" t6e COM inter5ace
exp!rte% B< EnterpriseScan4 T6e )a,$e is $se% 5!r sin",e pa"e %!c$#ents !n,< an% %e5ines t6e 5i,e
na#e 76ic6 is $se% 5!r pa"e sa)in"4
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4
21 | Open Text Ent erpri se Scan COM AP Pr!"ra##i n" G$i %e
7774 opent ext 4 c!#
'!r #!re in5!r#ati!n aB!$t Open Text pr!%$cts an% ser)ices* )isit 7774!pentext4c!#4 Open Text is a p$B,ic,< tra%e% c!#pan< !n B!t6 NASDAG HOTE:I an% t6e TS: HOTCI4
C!p<ri"6t J 2010 B< Open Text C!rp!rati!n4 Open Text an% T6e C!ntent Experts are tra%e#ar(s !r re"istere% tra%e#ar(s !5 Open Text C!rp!rati!n4 T6is ,ist is n!t ex6a$sti)e4 A,, !t6er
tra%e#ar(s !r re"istere% tra%e#ar(s are t6e pr!pert< !5 t6eir respecti)e !7ners4 A,, ri"6ts reser)e%4