The Configuration dialog specifies how the Go-Between will connect to the OpenEngagement DMS. Usually, this will be the same as the URL used when connecting to the DMS through a web browser. This configuration must be done on each computer on which the Go-Between will be used.

Note as well: though the Go-Between interacts with only the DMS and the Quick Upload interacts with both the DMS and KMS, the connection parameters will be the same for both the Go-Between and Quick Upload.

The configuration dialog is the first dialog each Go-Between user will use; users will not be able to use the other dialogs until they have properly configured the Go-Between. This is generally a one-time operation, though some firms may change the settings for the OpenEngagement DMS from time to time. Configuration is done by going to Tools | Options | DMS and specifying OpenEngagement CMS as the current CMS, then hitting the Configure button. This launches the configuration dialog where you may specify the settings of the OpenEngagement DMS. For Local Solutions, unless you have changed the settings of the OpenEngagement DMS you should be able to use the default settings of 80 and /CMS for the Port and Path respectively. If the server uses SSL, though (as in the case of Hosted Solutions), the port is most likely 443 and not 80. If the path is blank, this will appear as a slash in the Configuration dialog.

For the server, you should set this to the domain name you use in a web browser, omitting the 'http://' portion. If users do include the http://, it will be stripped out by the Go-Between.

For example, if the URL to connect to the OpenEngagement CMS in a web browser is: http://europa:8080/CMS, then the Go-Between configuration would be:

Server: europa

Port: 8080

Path: /CMS

Once this dialog is filled in and saved you will be able to access the Go-between through the Open from OpenEngagement and Save to OpenEngagement menu items.

Assuming the firm has only one OpenEngagement DMS, everyone will have the same settings in their configuration dialog.

It may be convenient to write the settings down somewhere, as they will be lost if there is a hard-drive crash or a problem of that nature.

It is possible to define multiple server configurations. This is not normally useful, it can be where firms use multiple servers, for example a test server and a production server. To take advantage of this, users can hit the Save/Load button. This launches a dialog that is used to define, delete and select configurations. Each configuration has a name and specifies a server, port, and path.

Users must login before accessing the Load from OpenEngagement or Save to OpenEngagement dialogs. If users have not yet logged in, selecting these menu items will launch the Login dialog before the user proceeds to the corresponding dialog. The user will remain logged in until Working Papers is closed or the user specifically changes user account. The login dialog will not allow users to enter a username/password that is not registered with the OpenEngagement DMS. Users will use the same username and password they normally use to access the DMS through a web browser. When Working Papers is restarted later, the user may be prompted for their username and password again, depending on their selection for the two check-boxes in the Login dialog.

Users have two check-boxes in the Login dialog. The first allows users to save their username and password. The second specifies that they not be prompted again for their username and password. This second checkbox is enabled only if the first checkbox is checked. If the first, but not the second checkbox is checked, users will be prompted for their username & password each time Working Papers is restarted and they access an OpenEngagement dialog, but the Login dialog will default to the values they last entered in the Login dialog. If a user selects both checkboxes, they will not be prompted for their username and password again. However, if a user selects both checkboxes and later changes user account while using the Go-Between, the Go-Between will prompt them for their username and password the next time they start Working Papers, as it is possible the user wishes to save this new user account as their default.

Users are encouraged to check at least the first checkbox, in order that their username and password may be saved, and may be used when the Go-Between is used to open a Working Papers client file launched from a web browser interface to the DMS. This is explained later in this documentation.

The password will be saved in encrypted form on the same computer.

As with the web interface, each user has certain site-wide and local roles and these affect what they can do within the Go-Between. Specifically, it restricts which engagements they may download read-only, which they may download editable copies of, which they may upload to, and which Sections they may create Engagements within.

To download a client file from the OpenEngagement DMS, select File | Load from OpenEngagement. This will launch a dialog where users may navigate to the Engagement they wish to download. Alternatively, users may select My Workspace or Search, to search for the Engagement.

The Load From OpenEngagement dialog will always open showing the root-level DMS Areas. Those Areas with a plus sign next to them may be expanded. Once each item is expanded, the dialog will show all Areas, Entities, Sections, and some Engagements within that item. All users may view the complete DMS navigation tree, and so may see all DMS Areas, Entities and Sections. Users may not necessarily see all Engagements, depending on their permissions. The dialog will not show Files, Pages, Links, Images, or any KMS Areas. It will show Engagements that do not contain CaseWare client files, as users may wish to upload client files to these Engagements. Users cannot, though, download any file type other than Working Papers client files from Engagements using the Go-Between.

When the user clicks on an Engagement, the fields underneath the navigation field will be filled in. This shows the Engagement name, period end, state, and so on. The User Role(s) field will show all roles the current user has on the Engagement, which includes all site-wide, inherited and local roles.

Users may, depending on their permissions and other considerations, download engagements that are editable or read-only. Any user who can see the Engagement in the Go-Between may download a read-only copy of the enclosed file, so long as the contained file is a Working Papers client file.

To download an engagement as editable, the Engagement must be:

1) Either not signed out by anyone, or signed out by the current user;
2) Not set read-only within the DMS;
3) The Engagement must contain a Working Papers client file; and
4) The current user must have role such that they have edit permission on the engagement given its current state

When the user hits the Sign Out button, the client file will be downloaded and opened in Working Papers. If it is not already signed-out by the current user, it will be set as signed-out then as well. This ensures no other use may edit the client file at the same time, other than through the use of Working Papers-level sign-outs or check-outs.

When the user hits the Read-only button, a read-only copy of the client file will be downloaded. The signed out status of the Engagement will not be changed. Users will not be able to later upload this copy, as the OpenEngagement DMS does not accept read-only files.

Users may set the Download Directory. This will always default to the value provided in Tools | Options | DMS. However, users can override this download directory for any given download.

Engagements are shown using one of four icons. The first is the default engagement icon, which represents an engagement that is not signed out and not set read-only. Signed out engagements look similar but also have a red checkmark. Read-only engagements also look similar but have a padlock. Engagements with no enclosed file use an error icon, which is a red circle with a white X. In some cases this may actually not be an error, as it may be the case that another user is simply in the process of uploading a file.

The Load from OpenEngagement and Save to OpenEngagement dialogs both include '[Secure Connection]' in the title bar when connected to sites using SSL.

Users upload client files using the Save to OpenEngagement dialog, which is accessible using the File | Save to OpenEngagement menu item. For this to be enabled, a client file must be open in Working Papers. The menu item will be disabled if the client file is read-only.

Only Engagement Managers, Site Mangers and Managers may create new Engagements. Preparers and Reviewers may save to existing Engagements, but cannot create new Engagements. Users who have permission to create new Engagements may do so by specifying to save a client file to a Section. No user may upload a client file to an existing Engagement unless they have the Engagement signed-out. When creating a new Engagement, there is no concept of it being already signed-out.

Users will not be able to upload to existing Engagements unless the GUIDs match. See the section on GUIDs in this documentation.

When users first open the Save to OpenEngagement dialog, the Go-Between will search the DMS for an Engagement with the same GUID as the client file currently open in Working Papers, and will select this as the default save location if such an Engagement exists. If not, but if the engagement had been downloaded from the DMS before, the Save to OpenEngagement dialog will default to the location from which it had been previously downloaded, if possible. On occasion, the DMS may not be able to choose an appropriate default save location using either technique, and users may then navigate to the Engagement themselves, or may use the Search or My Workspace dialogs to locate the target Engagement.

When uploading, the Go-Between will check the file size and file hash value on both the server and the local copy to ensure they match. This ensures no bits were altered while in transit and that the files are identical. Once this is done, the local copy is deleted, to ensure there are not two copies of the same file.

When client files are uploaded, the OpenEngagement DMS extracts information from them, such as the engagement type and period end, and sets these values in the Engagement, as is done when the file is uploaded through a web browser.

When creating a new Engagement, if no title is specified, the title of the Engagement will default to the client name in the Client Profile if available, or to the name of the compressed CaseWare client file otherwise. When uploading though, to new or existing Engagements, it is possible to specify the title in the Save As field in this dialog.

The Load from OpenEngagement and Save to OpenEngagement dialogs have Expand All, Collapse All and Refresh buttons. These may be used to aid use of the navigation tree.

The Refresh button may be useful where there are other users updating the DMS at the same time. For example, if a user is using the Go-Between, another user may add or delete content, change the state of an Engagement or otherwise change what is currently shown in the Go-Between. When users hit Refresh, the Go-Between will not examine the entire site, but only every object currently expanded in the navigation tree.

The Expand All and Collapse All buttons expand and collapse the navigation tree. On very large sites, the Expand All button may take some time to execute.

The Search and My Workspace dialogs may be used to locate an Engagement, either to save a client file to (when launched from the Save to OpenEngagement dialog(, or to open a client file from (when launched from the Open from OpenEngagement dialog). The user may use these dialogs to query the DMS for a list of Engagements. The results are then shown in a table, which is the same in both dialogs, other than the table in the My Workspace dialog may have an additional column for the role. The results may be sorted by any column in ascending or descending order. Clicking on a column's heading will sort the column in ascending order; clicking again will sort it in descending order. As well, a Sort button is available, which sorts the results first by the left-most column, then by the next left-most and so on.

When accessing the dialogs from the Open From OpenEngagement dialog, they will behave similarly to that dialog; they have Sign Out and Readonly buttons, and allow users to specify the download directory.

When accessing the dialogs from the Save To OpenEngagement dialog, they will behave similarly that dialog; they have a Save button, and allow users to specify the title and if the Engagement should remain signed-out.

In the Search dialog, the Search Text field specifies text to be searched for in the Engagements' titles, keywords and descriptions. The other fields are self explanatory.

The My Workspace dialog has the same purpose in the Go-Between as in the web browser interface. Users will generally use this after completing one engagement in order to find the next engagement they should work on. It lists the engagements they should prepare, review and manage, as well as those they have permission to read. For most users, this will be the most common means to locate Engagements within the DMS.

The Change User dialog may be reached from the Open From OpenEngagement, Save To OpenEngagement, My Workspace and Search Dialogs. Users will be logged on as the user they select in this dialog for as long as Working Papers is kept open, unless they later again specifically change user account, again in this dialog.

The user account changes will take affect even if users cancel out of the dialog from which they launched the Change User dialog. For example, if the user opens the Load From OpenEngagement dialog, selects Change User, enters a new username and password, hits OK, and then cancels out of the Load From OpenEngagement dialog, the user account change will still take affect.

This dialog also shows the name and site-wide roles of the current user, which may be convenient to check from time to time even without actually changing user account. The list of site-wide roles will not include Member, unless this is the current user's only site-wide role.

Working Papers maintains a Most Recently Used list, which may contain some items within the OpenEngagement DMS. These will be identified with the prefix [DMS]. They will also display the Entity and Section names in which the Engagement is located. DMS items will appear in the Most Recently Used list only when they are uploaded to the DMS, not when they are downloaded from the DMS. Where items are downloaded from the DMS, it is assumed there is a local copy and users will prefer to use this until such time as it is uploaded again to the DMS.

When a user selects such an item from the Most Recently Used list, Working Papers will launch the Go-Between, which may require the user to log into the OpenEngagement DMS. If the user last specified in the Login dialog to save the username and password, it will not be necessary to prompt for these when opening client files from the Most Recently Used list. Once logged in, the Go-Between will then download the client file from the Open Engagement. It will sign-out the Engagement and return an editable copy of the client file if possible. Otherwise it will return a read-only copy. Unless it is necessary to prompt the user for their DMS username/password, users will not actually see the Go-Between executing; this will be behind the scenes and the user will simply see the CaseWare client file opened in Working Papers.

Though it is most often simplest to open all CaseWare client files using the Go-Between, it is possible to do this from a web browser as well. When doing this, OpenEngagement will launch Working Papers if it is not already running, and will open the client file within Working Papers.

When users launch Working Papers from a web browser, Working Papers then launches the Go-Between (though this is usually behind the scenes and invisible to the user), which will then perform the downloading of  the client file from the OpenEngagement DMS. To do this, the Go-Between must have a username and password to access the OpenEngagement DMS. If the user has already opened Working Papers and worked with the Go-Between, this will have been taken care of already. As well, if the user has previously specified in the Login dialog to save the username and password, the Go-Between will, in this case, simply use this username and password. Otherwise, it will have to prompt the user, and so the Login dialog may be presented.

The DMS configuration must be saved for the Go-Between before files may be downloaded using a web browser. As the Go-Between connect to the server to download the client file, it must know the server, port and path used to connect. As with the login information, if this information has not already been specified, a dialog will be launched prompting the user.

As when directly using the Go-Between, the Go-Between launched through a web browser will save the client file somewhere on the local computer. The location will be the directory specified in the Tools | Options | CMS dialog, which is the default directory for all downloads. Users will not have an opportunity to override this directory when downloading files from a web browser, as the Open from OpenEngagement dialog will not be launched.

The OpenEngagement Go-Between allows users to save PDF versions of a client file or portions of a client file to the DMS. As with saving the client files themselves, it is possible to save to existing Engagements (so long as the engagement does not already contain a CaseWare client file), and it is possible, if the user has sufficient permissions, to create a new Engagement within a Section.

To save a PDF, the client file must be open in Working Papers. Select the documents to be included in the Document Manager. Control-A may be used to select all documents. Then right-click on the selection and select Sent To in the menu. Then select OpenEngagement. This will bring up the Save to OpenEngagement dialog. The dialog work the same as when saving client files. Specify the desired location and, optionally, the title to be used and select Save.

The Go-Between may optionally create a log file as it runs. This will generally not be useful to users, but will usually be useful when reporting problems to OpenEngagement. Usually, there is no harm in having the Go-Between set to always create log files. However, there are a few possible concerns:

1) The log files may get large. This is very rarely a problem, however, since the log file is deleted and re-created each time Working Papers is restarted.
2) Logging may cause some performance penalty. However, this will be very small compared to the time to upload and download files, and should not be noticeable.
3) The log files may contain user passwords unless the user specifies to not include passwords. If passwords are included, the passwords are in Base64 format, which is quite easy to decode. This may be a concern for some users, though where the log files remain on the computer on which they are created, the username and password are available only to persons with access to this computer.

The log files track three things:
1) Errors
2) Function calls.
3) Communication calls.

The first, errors, are always logged if logging is enabled. The other two must be optionally enabled by the user in order for them to be logged. Users may search the log file themselves for errors by searching for the words FAULT, ERROR and ASSERT. Otherwise, tracking function calls and communication calls will be useful only for sending the log to OpenEngagement for debugging.

The Go-Between uses two internet protocols, HTTP/HTTPS and XMLRPC to communicate with the OpenEngagement DMS. Dumps from these protocols will be included in the log file if logging communication is enabled. In this case, OpenEngagement will also create an HTML file each time the Go-Between uploads an engagement. These HTML files will contain the response to the upload operation.

Logging is enabled by using a file called oe.ver. This file, if it exists, should be in the same directory as the Go-Between dll file, dms.dll. If it does not already exist, users may create one. One will be placed in this directory when the Go-Between is installed.

sample oe.ver file:

logging=1
log_communication=1
log_function_calls=1
hide_passwords=1

Users may also specify log_path, for example: log_path=c://go-between.txt. If log_path is not specified, the log file will be placed in a /log folder within the folder in which Go-Between is installed.

When hide_passwords is set to 1, the log file will list '<password>' or '<username/password>' instead of the actual password.

All releases of the Go-Between will coincide with releases of the DMS. In this way, the two products will always use the same release numbering. The numbers have three parts. For example, the first release of the DMS and Go-Between had the number 2.1.016. The first two parts, 2.1, are the version number. The third number, 016, is the build number. The build number may actually differ between the DMS and Go-Between.

As well as interfacing with only one version of the DMS, each version of the Go-Between is designed to work with only certain versions of Working Papers. The Go-Between, however, will always be able to work with any Working Papers client file that can be loaded in Working Papers, since that client file will, if necessary, be rolled up to that version of Working Papers. 

As the DMS and Go-Between releases are released at the same time, they are designed specifically to work together. Any given version of the Go-Between will work with the corresponding version of the DMS but may or may not work properly with prior or later versions of the DMS. Using mismatched versions, it is possible for, for example, searching to work properly but not navigation, or navigation but not searching. In some cases, neither will work.