Cabinet Retriever 3/1/2010

Transcription

1 2010 Cabinet Retriever 3/1/2010

2 Purpose... 4 Overview... 5 Installation... 5 Things to know before configuring Retriever... 6 Setting up your first connection... 7 Step 1 Run the Retriever... 7 Setup... 7 Items removed or resized from earlier version (6.5 and below)... 8 Step 2 Enter a new setup/edit an Existing setup... 9 Step 3 Select the application to connect Retriever to Step 4 Selecting the positioning of the Retriever button New function: Look for string in window title Step 5 Setting up the various options Global Auto Open Use Capture Use Matching Use Search Step 6 Save the setup Miscellaneous Information Running Retriever Step 1 Start an Application Retriever is connected to Step 2 Login Step 3 Focus the connected application Search for a non-active item Load Appendix A Microsoft SQL Server Management Studio Appendix B - Known Regular Expression Setups Application - Laser App Application - Aria Application Access App - will not work with all Access Apps Retriever Page 2

3 Application NextGen EMR Application Gorilla Bill Good Marketing Notes Retriever Page 3

4 Purpose Retriever is used to connect SAFE to an external business application. The objective is to provide access to documents stored in SAFE based on information retrieved from the external business application. Retriever Page 4

5 Overview Retriever is used to connect business database applications (like ACT!, Goldmine, QuickBooks, Junxure, Gorilla, ) to Cabinet SAFE document management software. After the connection to the business application is made, Retriever keeps up with what record the business application is on and finds the folder in SAFE associated with that record. This allows the user to access relevant documents with a simple button click rather than switching applications to find relevant documents. NorthWind Access Database and cabinet below folder indexes are imported into the folder indexes using synchronizer. (See the Synchronizer documentation) Retriever Page 5

6 Installation Run the Retriever.msi installation program. Retriever is client specific and required the SAFE client to be installed on the same machine. Install the program with the default settings provided. Alternative settings should only be used when directed by Cabinet NG technical support staff. Go to helpdesk.cabinetng.com, log in and under Technical Resources>CNG Install Files select Retriever, save to your desktop. Things to know before configuring Retriever 1. Application Information (Things your IT person should know). a. Which application are you connecting with? b. Is there a Cabinet setup that matches this database? c. If not, see the Synchronizer documentation 2. Location of SAFE data. a. Which Repository/Cabinet will be mapped? b. Which folder index value in the Cabinet contains the same data from the business application being connected to? c. Do you have access rights to the Cabinet in SAFE? 3. Application Matching is done by matching a database field to a folder index. a. For each needed field in the database table/query, you need a corresponding field in the SAFE folder indexes. Retriever Page 6

7 Setting up your first connection Step 1 Run the Retriever By default the Retriever is installed in C:\Program Files\CNG\ SAFE. The executable name is CNG.Retriever.exe. Double click the executable to run the Retriever. A shortcut is also installed on the All Programs toolbar when you click on the Windows Start button. Setup Access to setup is now via the following methods: 1. Right Click on the Retriever Icon on the System Tray and select Setup or 2. CTRL + = Setup. Press CTRL and click on the button with CNG Logo in the application. If yes, the administrator below opens. 3. Access requires the Administrator password. (Except if there are no records in setup). Retriever Page 7

8 Items removed or resized from earlier version (6.5 and below) 1. Removed the dedicated Setup button Provision made to access via CTRL Removed the dedicated Exit button Provision made to access via ALT Cabinet and Index Drop down boxes were removed, as they are irrelevant to the end user. 4. Removed the Reload button as it is not required anymore. 5. Resized the CNG button. Retriever Page 8

9 Step 2 Enter a new setup/edit an Existing setup The Retriever can be used to connect to many different databases and cabinets. A setup name is required for each connection. The Retriever connects a field in another software application to a SAFE repository/cabinet/fol der index. Data is pulled from the other software application and matched against the data in the given folder index. If there is a match then the folder information is retrieved and the document list is made available to the user. Retriever Page 9

10 Step 3 Select the application to connect Retriever to Retriever connects to another application based on the application executable name. In general these files are stored in the C:\Program Files\<appname> (i.e. c:\program files\act). It may take some detective work to determine which executable file is the correct one to connect to. Step 4 Selecting the positioning of the Retriever button. Retriever attaches a small button to the application selected in Step 3. This button can be placed in one of three locations. This is dependent on where in the connected application is the best place to display the CNG icon. New function: Look for string in window title There are applications that have multiple windows but the folder value to lookup in SAFE may be only from a specific window. For this, the display of Retriever is unnecessary and obstructive in other windows. This new feature targets only the specified window. In the setup, a constant value (if available) from the specific window title can be set to Look for string in window title. The default value is blank with no constraints applied. The Retriever will display full screen only if the active window contains the specified value or else it will stay minimized. Retriever Page 10

11 Step 5 Setting up the various options Retriever has a number of options that control how each setup functions. This section goes through each one of the options and explains how it affects the Retriever application. Global This option allows the user to set this setup as available to other users using the same repository/cabinet AND the same application. If this is unchecked, the setup is only available to this user/computer. If the global option is set, the setup becomes available to all other users of Retriever. Auto Open When Retriever finds the folder that matches the data in the connected application, it can automatically open the document list if this option is checked. If it is not checked, the user will have to click the Show Document List button to see the list of documents. Use Capture Use capture is the option that connects the folder index data to data from the screen of the connected application. Simply follow the directions on the Select Capture Field screen. When you click on Get Connected Data the Select Capture Field opens. Retriever Page 11

12 Use Matching Use matching is one of the more interesting technical parts of Retriever. It is used to take data from the screen and run it through a regular expression parser to extract a piece of data that can be used to match the folder index. An example would be if an EMR software package could only extract a piece of data like Patient John Ferry where is the patient number. If is in a folder index in SAFE then this data could be extracted from the string by using a regular expression. See for more information on regular expressions. For the above string the regular expression to extract from Patient John Ferry would be [0-9]+$. The $ matches the end of the string and the [0-9]+ extracts the client number. Unless there is a technical person on staff, it s best to call Support to get help with the regular expressions. Alternatively the above website had a set of tutorials on using regular expressions. A list of known regular expressions and the applications they work with are displayed in Appendix A. Use Search For future use not currently functional. Retriever Page 12

13 Step 6 Save the setup Save the current setup displayed by clicking on the save settings button. After saving click the exit button to exit setup mode. Miscellaneous Information Retriever can be connected to more than one application. For instance it could be setup to connect to ACT! for contact management and MAS-90 for the accounting function, to Junxure, Gorilla, Goldmine, Quickbooks (those are just a few of the applications). As you move back and forth between the two applications, Retriever will follow the application that has the mouse focus. So if you click on ACT!, Retriever will move to the ACT! setup and attach itself to ACT!. If you click on MAS-90, Retriever will move to the MAS-90 setup and attach itself to MAS-90; same for Junxure and Gorilla. Retriever Page 13

14 Running Retriever After following the steps to setup Retriever, running it is quite simple. Step 1 Start an Application Retriever is connected to After following the instructions to setup Retriever, start an application connected with in Step 3 above. Step 2 Login In order to use Retriever, a user must log in using the Retriever Login: The login will open the first time you click on the Retriever Icon. The next time you go into Retriever, click on the Retriever Icon, Retriever will automatically open to the application you have running. Enter username and password. database and click on Login. Connect to the correct Retriever Page 14

15 Step 3 Focus the connected application Give the connected application (NorthWind Employees for this example) by clicking on it and click on the Retriever Logo in the task bar. The CNG logo will be displayed in the right corner of the application below. Retriever can be opened at any time by clicking on the application, the Logo will open on the right side of the application. The Retriever can be expanded to show the Cabinet/Folder in the right side of the window. Several things can be done at this point. 1. Click on the Retriever Logo to open in the application. 2. Clicking on the Logo will open the cabinet/folders. 3. Clicking the Logo again will shrink Retriever back to just the logo button. 4. Setup mode can be opened again by holding the control key and clicking on the Retriever Logo on the right side of the application below. 5. Can exit the Retriever by holding the alt key and clicking on the Retriever Logo on the right side of the application below. 6. To show all tabs click on Tabs. Retriever Page 15

16 Clicking on the Retriever Logo will show the cabinet/folders click on find to view the clients and show to open the tabs and folders. All tabs are viewable in the shot below if tabs is selected. Retriever Page 16

17 After Retriever is displayed the document list can be displayed by clicking the Show Document List button. At this point, anything normally done with the document list in SAFE can be done in Retriever. If Auto Open was selected for this setup, the document list is automatically displayed whenever a new record is displayed in the connected application. To hide the document list, simply click the Hide Document List button which is a toggle button with show. Tabs is not checked below, therefore the tabs are scrolled across and cannot all be viewed at the Retriever Page 17

18 To open the document highlighted, double click, the document will open in the appropriate application, this is a PDF. Client may view, edit, scan, new, tools, print, search, delete and refresh by selecting the appropriate toolbar button. If you right click on the document title may do the same functions as in SAFE Retriever Page 18

19 Search for a non-active item 1. Click the Manual checkbox. 2. Enter search value and click Find. 3. The maximum limit to items returned is The Drop Down is displayed for manual search only. 5. Uncheck Manual for the active value to be displayed again. Load 1. Folders are not preloaded on startup. 2. Search on real time data. 3. Reload is not required. 4. Improved performance. Retriever Page 19

20 Appendix A Microsoft SQL Server Management Studio Microsoft SQL Server Management Studio Set up for Retriever Retriever Page 20

21 Retriever Page 21

22 Appendix B - Known Regular Expression Setups Application - Laser App String being matched: Laser App Enterprise DE [Ben Franklin] - [SAMPLE FORM : Sample Form] Regular expression: (?<=\[)\w+ \w+(?=\]) Data Extracted: Ben Franklin Application - Aria String being matched: Notes-Davis, Jesse J Regular expression: (\w+, \w+ \w?) Data Extracted: Davis, Jesse J Application Access App - will not work with all Access Apps. String being matched: Contact Log Version WX ALBERTA SMITH Regular expression: (?<=- )[a-za-z0-9]+ Data Extracted: WX Application NextGen EMR String being matched: NextGen EMR: Jones, Fred - [09/05/ :04 AM:"eyemaster im"] Regular expression: (?<=\: )[a-za-z0-9 /,]+(?= -) Data Extracted: Jones, Fred Application Gorilla Bill Good Marketing String being matched: NextGen Gorilla 3.0 [Playground] [Info Sheet: Ferry, John] Regular expression: (?<=: )[a-za-z0-9, ]+(?=]) Data Extracted: Ferry, John Retriever Page 22

23 Notes Retriever Page 23