Access Collections and Objects

Collections, Objects or Elements can be opened directly from an external web application or document. The external application composes the URL that contains all the information needed by InterPlay to open a Collection Editor, an Object Editor or an Element Editor.

The URL contains:

  • InterPlay root URL
  • A filter to find the collection
  • A filter to find the object (optional for a collection)
  • Filters to find the element and sub-element (optional for a collection or an object)
  • User name (optional)

To find the target Collection, Object or Element, InterPlay applies the filters from collection level to sub-element level. At each level, if the type is not given, the search is performed on each type and the first item that matches the filter is chosen. If no object is found, InterPlay displays the collection list.

The format of the URL is:

InterPlayURL#filters OR InterPlayURL#userName@filters, where:

Element Description
InterPlayURL

InterPlay root URL. In a regular installation, the URL is:

http://bdiserver.companydomain/interplay-web/interplay-client/index.html

or

http://bdiserver.companydomain/interplay-web/interplay-client/

userName Login user name that, when specified, is entered automatically in the Username field of the login screen.
filters

List of filters that must be URL-encoded when appended to the URL. The list of filters is separated by forward slashes (‘/’).

Each filter is an expression composed of at least a relational operation (property RelationalOperator ”value”) or more relational operations linked with the logical conjunction operator (“AND”). The value is enclosed in quotes or apostrophes.

RelationalOperator can be: =, >, <, >=, <=, <>, != (this is an equivalent for <>).

The property can be a business property, a type or a version, where:

  • The property type represents the collection type name for the first filter, the Object Type name for the second filter and the relative element path for the next filters.
  • The property version represents the collection type version for the first filter and the Object Type version for the second filter.
Note   The URL encoding is described in http://www.ietf.org/rfc/rfc1738.txt and http://www.ietf.org/rfc/rfc2396.txt. Each language has functions (build-in or as 3rd party library) that perform this kind of encoding, for example:
  • JavaScript: encodeURIComponent(uri) function
  • Java: java.net.URLEncoder class
  • PHP: string urlencode ( string $str )
  • Python: urllib.urlencode(query[, doseq])

Testing the URL generation

If you want to generate a typical external URL and test the links to the objects:

  1. Go to http://bdiserver.companydomain/interplay-web/interplay-client/objectURL.html
  2. If you have a different InterPlay root URL, add objectURL.html at the end of your InterPlay root URL.
  3. Fill in the filters.
  4. Click Generate.
  5. The URL to directly access the object is computed and set in the text area below. A direct link is generated at the bottom.
  6. Click the link to open the InterPlay object.

Examples

For the InterPlay URL http://bdi:8080/interplay-web/interplay-client/:

Object to access Non-encoded filter URL-encoded filter

Collection:

  • Type: ACCDOCSET
  • property FILE_NAME: file1
type="ACCDOCSET" and FILE_NAME="file1" type%3D%22ACCDOCSET%22%20and%20FILE_NAME%3D%22file1%22%2Ftype%3D%22ACCDOC%22%20and%20ACCDOC_NAME%3D%22doc1%22%20and%20BATCH_NAME%3D%22b1%22

Object:

  • Type: ACCDOC

where:

  • ACCDOC_NAME=”doc1”
  • BATCH_NAME=”b1”
type="ACCDOCSET" and FILE_NAME="file1"/type="ACCDOC" and ACCDOC_NAME="doc1" and BATCH_NAME="b1" type%3D%22ACCDOCSET%22%20and%20FILE_NAME%3D%22file1%22%2Ftype%3D%22ACCDOC%22%20and%20ACCDOC_NAME%3D%22doc1%22%20and%20BATCH_NAME%3D%22b1%22

Sub-element:

Relative path: "LINE"

LINE_NUMBER="2"

type="ACCDOCSET" and FILE_NAME="file1"/type="ACCDOC" and ACCDOC_NAME="doc1" and BATCH_NAME="b1"/type="LINE" and LINE_NUMBER="2" type%3D%22ACCDOCSET%22%20and%20FILE_NAME%3D%22file1%22%2Ftype%3D%22ACCDOC%22%20and%20ACCDOC_NAME%3D%22doc1%22%20and%20BATCH_NAME%3D%22b1%22

Related Links