Remote Launches are HTTP URL requests made to the Insight
Browser server. In the following section we will provide several examples of
remote launch strings and break them down to identify the individual
components. These strings can be static or dynamically generated depending on
your needs.
The first section is the “Base Request URL”
http://library.Dalton.edu:8080/BrowserInsight/BrowserInsight/?cmd=start
This is the base of all requests made to the Insight Browser
server. It is composed of the following.
The section following “?cmd=start” are parameters separated by the “&”, these parameter will vary depending on the type of request being made. The following section will help clarify how these requests can be made.
The “cid” referred to as the “collection unique id”. This number is used to specify a unique instance of the Insight Browser. This is set in the BrowserInsight.conf file.
The “iia” “insight initial activity”
0= Open Group Window
1= Open Image Workspace
2= Open Both Group Window and Image Workspace
http://library.Dalton.edu:8080/BrowserInsight/BrowserInsight/?cmd=start&cid=5&iia=0&ig=The%20Dalton%20Library&isl=0&gwisp=0|Period|Period|1|Ming|1&gwia=3&gc=0
cid=5&iia=0
This example would use the cid (collection unique id) information contained in the BrowserInsight.conf file for instance 5 and open the Group window (iia=0).
ig=The%20Dalton%20Library
The next parameter is “ig” identifies which media group to open. The %20 values are the hex value for a space character. If the ig parameter is not included the default group contained in the collection configuration will be used.
isl=0
The isl parameter indicates if the user of the remote launch has the right to create remote launch strings in Browser Insight. 0=NO 1=YES
gwisp=0|Period|Period|1| Neolithic|1
This is where the search request is contained. They are formed as follows:
Bool|Fieldname|FieldDisplayName|FieldType|FieldValue|Relation"
0|Period|Period|1| Neolithic|1
A Boolean operator of 0 refers to an OR
A Boolean operator of 1 refers to an AND
FieldName is the database column name that is searched.
FieldDisplayName is the name that will be displayed in the data window.
FieldType 1 is for text
FieldType 2 is for number
FieldValue is the value you are searching for.
Relation refers to how the value will be searched.
1= EQUALS
2= CONTAINS
3= BEGINS
4= ENDS
5= GREATER
6= LESS
9= DOES NOT CONTAIN
To do a complex Boolean search you concatenate the requests
into one string.
In the example below you are searching the SubjectType field
for Painting AND the EarlyDate (numeric) Field where the value is GREATER than
1900
gwisp=0|SubjectType|Category|1|Painting|1|1|EarlyDate|Early%20Date|2|1900|5
gwia=3
Group Window Initial Activity (gwia) has three options
0 = Do nothing
1 = Show search menu
3 = Custom search
For your search to be preformed you must have this parameter
and it needs to be set to 3.
&gc=0
This parameter controls paging. 0 represents the first image
on the page if you enter 20 this will set you on the 2nd page of
your search result. Each number represent an image starting at 0.
The two requests detailed below are based on ImageID and
ObjectID. These are internal numbers that identify a specific Image and the
relating descriptive information for that image. Together they form a unique
call for a referenced record.
The first portion of these strings are consistent with what
has been described earlier in this section so we will just focus on the
portions that are different.
http://library.Dalton.edu:8080/BrowserInsight/BrowserInsight/?cmd=start&cid=5&iia=0&ig=The%20Dalton%20Library&isl=0&gwisp=0|ImageID|ImageID|2|101854:3013|1|0|ImageID|ImageID|2|101842:301|1|0|ImageID|ImageID|2|101843:302|1&gwia=3&gc=-1
The main difference in this string has to do with the gwisp
parameter. Notice that there is a special keyword ImageID used for the Fieldname and FieldDisplayName sections. It is
also identified as a numeric field. The FieldValue section there is 101854:3013 this is the ObjectID:ImageID
reference for the record
http://library.Dalton.edu:8080/BrowserInsight/BrowserInsight/?cmd=start&cid=5&iia=1&ig=The%20Dalton%20Library&isl=0&ir=3013+301+302&id=101854+101842+101843&iwas=2
When requesting images to open in the Image Workspace there
are a couple of different parameter.
ir=3013+301+302
The ir refers to the ImageIDs being referenced separated by
a plus sign.
id=101854+101842+101843
The id refers to the ObjectIDs being referenced separated by
a plus sign.
These two references need to be in the correct relation to
each other to get the correct result.
iwas=2
The iwas is the requested image size from Size 1 – max size
in collection Size 8
Size 0 .
up to 96 pixels on the long side
Size 1 .
up to 192 pixels on the long side
Size 2 . up
to 384 pixels on the long side
Size 3 .
up to 768 pixels on the long side
Size 4 .
up to 1536 pixels on the long side
Size 5 .
up to 3072 pixels on the long side
Size 6 .
up to 6144 pixels on the long side
Size 7 .
up to 12288 pixels on the long side
Size 8 . up to 24576 pixels on the long side
NOTE: Two
new parameters have been added to version 4 of Insight browser. “un” and “pw”
this will allow an auto login into the Browser Insight collection. You may
combine this with the “cid” to directly open a specific collection.
un=MyUsername
pw=MyPassword
Additional Insight JVA
Launch String Parameters
With the addition of the Deploy
Director server and the Insight Launch Manager you are now able to launch the
Insight JVA client using the same launch strings used for Insight Browser.
There are however a couple additional parameter that are allowed when making a
request to the Insight JVA client. Use the “c=” parameter to specify the
collection you would like to open. Use the “u=” to specify the User Manager
that will authenticate your access.
c=The+Dalton+Collection
u=insightusermanager.dalton.org