|
DocLinks can be used as a non-programming method of implementing functionality into other application by using parameter based URLs. DocuNECT supports the following methods:
1.DocURLs – This is a “direct” URL link to a document.
2.DocSearchURLs – This is a search that can be generated to display the document search results.
3.WorkCenterURLs – Displays Work Center batch lists based on search criteria.
4.DataViewURLs - If you are using the DocuNECT Discovery module, then you can link to specific fields within a document.
DocURLs
This section details the format of the URL, however, the easiest way to generate the link is to select the option in the document actions menu in the search results. You can display the latest version of documents, or a specific version.
.png)
Examples:
http://<servername>/DocuNECTWeb/<instancename>/documents/previewFrames.aspx?documentid=<DocumentID>&version=latest
http://<servername>/DocuNECTWeb/<instancename>/documents/previewFrames.aspx?documentid=<DocumentID>&version=1.0
DocSearchURLs
You can drive a document search by using URL parameters.
Create a DocSearchURL
The best way to create a URL query is to use the search interface (either Basic or Advanced) and then use the Copy Link button function.
.png)
The criteria in the above screenshot generates the following URL and you can use the reference below to adjust the query.
http://<servername>/DocuNECTWeb/<instancename>/retrieve/newQuery.aspx?cabinetid=1&sf=documentid&sd=asc&ps=20&pn=1&advanced=1&or=0&search=1&showthumbs=1&seldocid=0&modified=1&vsi=s24&p1=i1|1|0|101|731&p2=i6|1|0|102|Dell
DocSearchURL Reference
This section details the parameters and usage:
DocSearch Parameters
The following table details the system indexes that can be used in searches.
|
Parameter Name
|
Required Value
|
Default Value
|
Description
|
|
cabinetid
|
Yes
|
N/A
|
The ID of the target cabinet.
|
|
sf
|
No
|
documentid
|
The name of the sorting column.
|
|
sd
|
No
|
asc
|
The direction of the sorting.
|
|
ps
|
No
|
Uses the current user setting.
|
The search results page size.
|
|
pn
|
No
|
1
|
The page number to display.
|
|
advanced
|
No
|
0
|
1 - sets the search in the advanced mode, 0 - sets the search in basic mode.
|
|
showthumbs
|
No
|
Takes the setting against the cabinet.
|
1 - to show document thumbnails, 0 - thumbnails will not be displayed.
|
|
seldocid
|
No
|
0
|
Represents the ID of a document.
The parameter is for display purpose, the page is scrolled in order to make visible the row of the specified document.
|
|
vsi
|
Sometimes
|
0
|
Visible System IndxThe parameter specified the array of system indexes that should be displayed in the visible area, and not in the system indexes dropdown list.
The parameter should be specified in the queries that are using system indexes.
Syntax: s<indexid>[,s<indexid]
i.e. s1,s24 represents the system indexes id=1 and id=24 will be added to the public indexes visible list.
Refer to the table below in the System Indexes Code section.
|
|
p<i>
|
No
|
|
The parameters used to search the documents.
See the Search Parameters section for more information.
|
System Indexes Codes
The following table details the system index codes to be used in conjunction with the vsi parameter.
|
ID
|
Display Name
|
|
1
|
Indexed
|
|
2
|
Document ID
|
|
3
|
Batch ID
|
|
4
|
User
|
|
5
|
Role
|
|
7
|
Checked Out
|
|
8
|
Checked Out By
|
|
9
|
Checked Out Date
|
|
12
|
File Path
|
|
13
|
Version No
|
|
15
|
File Size
|
|
19
|
Indexing Error
|
|
21
|
Originating DocuNECT User
|
|
22
|
Originating Windows User
|
|
23
|
Batch Label
|
|
24
|
Text
|
Search Parameters
The following table details the search parameters:
Syntax to search by a public index: p<num>=<indexType><indexid>|<isAnded>|<isNot>|<formatId>|<value>
Syntax to search by a system index: p<num>=<indexType><indexid>|<isAnded>|<isNot>|<formatId>|<value>
|
ID
|
Display Name
|
|
num
|
This is the parameter number, 1-based.
|
|
indextype
|
i, for a public index
s, for a system index
|
|
indexid
|
The ID of the index. If the index is a system index, see the section System Indexes Code to get the ID.
For the public indexes, use the index id.
|
|
isanded
|
1, if the condition is searched with AND
0, if the condition is searched with OR
|
|
isnot
|
1, if the isNot flag is set
0, if the isNot flag is not set
|
|
formatid
|
This is the ID of the condition format used.
See the Condition Formats section for more information.
|
|
value
|
See the Condition Parameters section for more information.
|
Examples:
1.p1=i1|1|0|101|Batch Record - This searches the documents that have the public index with id=1, containing the text “Batch Record”.
2.p1=i1|1|1|101|Batch Record - This searches the documents that have the public index with id=1, that does NOT contain the text “Batch Record”.
3.p1=s4|1|0|701|cmsadmin - This searches the documents that have the User = “cmsadmin” assigned.
4.s4 = the system index User - The actual search is made by the id of the username entered.
5.p1=s5|1|0|801|administrators- This searches the documents that have the Role = “administrators” assigned. s5 = the system index Role. The actual search is made by the id of the role name entered.
6.p1=s15|1|0|901|100KB - This searches the documents that have the file size 100 KB.
7.s15 = the system index File Size - The actual search is made by the entered file size, transformed into bytes.
8.p1=s9|1|0|304|8/4/2012-8/19/2012 - This searches the documents that have the Checked Out Date between 8/4/2012 and 8/19/2012.
Condition Formats
The following table details the condition formats:
|
No.
|
Index Type
|
Format ID
|
Name
|
Required Parameters
|
Search Type
|
|
1
|
Text
|
101
|
contains
|
1
|
Basic Search and Advanced Search
|
|
2
|
Text
|
102
|
is exactly
|
1
|
Advanced Search
|
|
3
|
Text
|
104
|
is empty
|
0
|
Advanced Search
|
|
4
|
Numeric
|
201
|
equals
|
1
|
Basic Search and Advanced Search
|
|
5
|
Numeric
|
203
|
is at most
|
1
|
Advanced Search
|
|
6
|
Numeric
|
204
|
is at least
|
1
|
Advanced Search
|
|
7
|
Numeric
|
205
|
is more than
|
1
|
Advanced Search
|
|
8
|
Numeric
|
206
|
is less than
|
1
|
Advanced Search
|
|
9
|
Numeric
|
207
|
in between
|
0
|
Advanced Search
|
|
11
|
Date
|
301
|
on
|
1
|
Basic Search and Advanced Search
|
|
12
|
Date
|
302
|
on or after
|
1
|
Advanced Search
|
|
13
|
Date
|
303
|
on or before
|
1
|
Advanced Search
|
|
14
|
Date
|
304
|
between
|
2
|
Advanced Search
|
|
15
|
Date
|
305
|
yesterday
|
0
|
Advanced Search
|
|
16
|
Date
|
306
|
tomorrow
|
0
|
Advanced Search
|
|
17
|
Date
|
307
|
today
|
0
|
Advanced Search
|
|
18
|
Date
|
308
|
in the last 7 days
|
0
|
Advanced Search
|
|
19
|
Date
|
309
|
in the next 7 days
|
0
|
Advanced Search
|
|
20
|
Date
|
310
|
last week
|
0
|
Advanced Search
|
|
21
|
Date
|
311
|
this week
|
0
|
Advanced Search
|
|
22
|
Date
|
312
|
next week
|
0
|
Advanced Search
|
|
23
|
Date
|
313
|
last month
|
0
|
Advanced Search
|
|
24
|
Date
|
314
|
this month
|
0
|
Advanced Search
|
|
25
|
Date
|
315
|
next month
|
0
|
Advanced Search
|
|
26
|
Date
|
316
|
exists
|
0
|
Advanced Search
|
|
27
|
Flag
|
501
|
equals
|
1
|
Basic Search and Advanced Search
|
|
28
|
User
|
701
|
equals
|
1
|
Basic Search and Advanced Search
|
|
29
|
User
|
702
|
contains
|
1
|
Advanced Search
|
|
30
|
User
|
703
|
starts with
|
1
|
Advanced Search
|
|
31
|
User
|
704
|
end with
|
1
|
Advanced Search
|
|
32
|
User
|
705
|
is null
|
0
|
Advanced Search
|
|
33
|
Role
|
801
|
equals
|
1
|
Basic Search and Advanced Search
|
|
34
|
Role
|
802
|
contains
|
1
|
Advanced Search
|
|
35
|
Role
|
803
|
starts with
|
1
|
Advanced Search
|
|
36
|
Role
|
804
|
ends with
|
1
|
Advanced Search
|
|
37
|
Role
|
805
|
is null
|
0
|
Advanced Search
|
|
38
|
File Size
|
901
|
equals
|
1
|
Basic Search and Advanced Search
|
|
39
|
File Size
|
903
|
is at most
|
1
|
Advanced Search
|
|
40
|
File Size
|
904
|
is at least
|
1
|
Advanced Search
|
|
41
|
File Size
|
905
|
is more than
|
1
|
Advanced Search
|
|
42
|
File Size
|
906
|
is less than
|
1
|
Advanced Search
|
|
42
|
File Size
|
907
|
is between
|
2
|
Advanced Search
|
Using Condition Parameters
The following details the condition parameters:
|
Type
|
Usage
|
|
Flag
|
One of the values:
(any)
Yes
No
|
|
Number
|
Example: 1343
|
|
Date
|
Date in format: mm/dd/yyyy
|
|
Text
|
Text to search.
|
|
User
|
The user's name.
|
|
Role
|
The role name.
|
|
File Size
|
The file size in one of the following formats:
123 B
12.3 KB
12.3 MB
12.3 GB
12.3 TB
This parameter is finally transformed into bytes, and the search is made by the value in bytes.
|
WorkCenterURLs
You can link any module in the system by cut and pasting the URL. The Work Center batch list is a dynamically created URL and contains the search parameters defined on the web page. Search for the batches you want to display and then press the Copy Link button and this will copy the URL to the clipboard:
.png)
Examples:
http://<servername>/DocuNECTWeb/<instancename>/Work/batches.aspx?captureid=<CaptureID>3&bsf=createdate&bsd=desc&bps=20&bpn=1&batchstatus=0&assignedto=-1&lockedby=-1
DataViewURLs
If you have implemented the DocuNECT Discovery module, you can generate Data View links that display where a specific fields have been extracted. To generate the link, click on the highlighted link next to the field in the indexing module:
.png)
Or you can generate the URL in the following format. Note, the links are only available for fields that have the DocInfo properties and have gone auto data extraction.
An example URL:
http://<servername>/DocuNECTWeb/<instancename>/documents/dataview/frames.aspx?documentid=<documentid>&indexid=<indexno>
On accessing the link, the document will be displayed in Data View.
|