# BeginSession

The BeginSession object is submitted as part of the BeginSession request message (input).

Parameter | Type | Description
--- | --- | ---
accountId | string | A string identifying the format of the document to return. Options include: PDF, Raw XML, TRF, Tagged PDF.
txn | string | This is the transaction data in a specific XML format. This should include any data points mapped from the application’s system that DocViewer will change.
docs | ArrayOfDocument | This is a list of documents that you want DocViewer to display. You can specify this list of documents if you wish to bypass autoselection rules. DocViewer will run the instancing rules in the documents and display all the matching document instances. The Id specified of each document can be shorthand (PKGD.SampleDocument) or longhand (expere://ORG.CustomOrg/PKGD.SampleDocument). If the shorthand is used, DocViewer will use the default org, so specifying the full URI may be necessary.
packages | ArrayOfPackage | If this argument is passed in, the docs argument will be ignored. Either this argument or docs must be passed in. This is the list of packages that will be used to run autoselection against. The package Ids, like document Ids, can be shorthand (PKG.SamplePackage) or longhand (expere://ORG.CustomOrg/ PKG.SamplePackage). If the shorthand is used, DocViewer will use the default org, so specifying the full URI may be necessary.
supplementalREQs | ArrayOfSupplementalReqFile | An integer indicating the number of days to keep the document available in the system.
redirectOnCompletionUrl | string | This is the URL that DocViewer Interface should navigate to when the user completes the DocViewer interaction. The URL used should also include a query string in the format ?SessionId=<SESSION_ID>. DocViewer will replace <SESSION_ID> with the actual ID of the session so that your URL can take action on it.
options | configuration | This argument is used to specify a variety of UI configuration options. UI customization items include, but are not limited to, the visibility of certain elements and the coloring of certain elements. In addition to UI customization, the option to specify a pre-selected package is available as well as the option to specify a list of xpaths.
dictInfo | OverlayDictionaryInfo | This argument is used to specify an overlay dictionary to use during the DocViewer Interface session. This object contains the file name (with or without extension) and the precedence level (organization) it can be found at. This overlay dictionary must be present within that organization in the repository. If not found, DocViewer Interface will return an error and the session will not begin.
docOrder | ArrayOfstring | Pass in a list of document names to specify the order you wish to see documents appear in the Doc Options document dropbox and in the Document Drawer. These IDs should be provided without any prefixes. For instance, if the longhand ID of a document is expere://ORG.CustomOrg/ PKGD.DocumentName, you should use DocumentName in this parameter. This list does not have to contain all the documents. The documents listed will be moved in that order in front of all of the other documents. Documents provided, but not autoselected will be ignored in the ordering.