OnBase Connector: Adding a new connection

Setting nameDescriptionExample
Connection nameThe name of the connectionOnBase Connection



Setting nameDescriptionExample
OnBase Service UrlAddress url of OnBase servicehttp://localhost/appserver/service.asmx
UsernameOnBase usernameManager
PasswordOnBase user passwordpassword
Data SourceOnBase data source nameOnBase
Local Server Url

Address url of local server

(Can be found in Ayfie\Locator\OnBase\Via.OnBase.Server.exe.config file)

http://localhost:9955
License TypType of client licenseDefault
Active Directory IntegrationDefines if OnBase is integrated with Active Directory



Setting nameDescriptionExample
Document Types to indexDocument types and metadata to index
Structure to indexDocuments structure, more information: Documents StructureDefault Rendition
Index documents noteDefines if documents notes should be indexed
Unity client in useDefines if unity client is used by the customer, used for OpenLink
DocPop UrlUrl used to open documentshttp://localhost/AppNet/docpop/docpop.aspx



Setting nameDescription
File Type to index

Select file types Only the most common file types are included by default.

The file extension to index. The options are:

  • Index all file types (default)
    • This one will by default index ALL files, regardless of the file format
    • For file types associated with the built-in DocFilter content filter, all text content available will be indexed
    • For other file types, only available metadata (like file name and path) will be indexed
  • Index selected file types only
    • Will only index the file types listed in the dialog
  • Exclude selected file types
    • Will index everything - except the file types defined in the list


Documents Structure

In OnBase, a single document is broken down into three separate layers of structure. This structure allows for information to be stored and changed at individual levels based on what needs to be done to the document. These layers are more formally thought of as the Document, Revisions and the Renditions. The tree below shows the relationship between the structures. As you can see, the document is really the parent object containing one or many revisions. A single revision can then contain one or many renditions.

The Document and its Revisions and Renditions layers are defined as follows:


Document

A document is a piece of information that your organization has chosen to store electronically in the system. Letters, contracts, scanned images of contracts, photographs, and e-mail messages are all examples of documents.

Revision

A revision is a container for the contents of a document. When a Document Type is configured to "allow multiple revisions," a new revision of the document is stored in OnBase each time a document is changed. If a Document Type is not configured to allow multiple revisions, only one revision exists for a document.

Rendition

A rendition is a version of an original document that is saved in a different File Format. For example, a searchable text document version of an image document is a rendition.


Connector allows to specify which structure should be indexed.

Default Rendition option, will fetch document and it's default rendition. By default document has one revision and one default rendition.

 


All Revisions and Default Rendition option, will fetch all document's revisions and their default rendition.(assuming that for revision 2 default rendition is text rendition and image rendition for revision 3.)


All Revisions and all renditions, will fetch all document's revisions and all their renditions




ayfie