see also Q: What is DocIntegrate?

DocIntegrate 4 Settings (Since DocIntegrate 4.1.0)

To disable notifications please add this file to the data folder of DocIntegrate 4 %USER_HOME%/.doc-integrate4

settings

DI3.0 version and newer

Install DocIntegrate on Windows

• Choose and download the DocIntegrate installer package for your OS from: https://edmsdoc.pace-ip.com/display/DMS/EDMS+Downloads
• Double click the installer file and follow the wizards to finish installation. (If old one is running, then quit it and uninstall it first). Don't change default settings in the installation wizards.

Install DocIntegrate on Mac

• Download from (Mac OS 10.11+): https://www.pace-ip.com/edms/downloads/components/DocIntegrate/
• Double click the DMS file and drag and drop the app filet to /Applications folder (override if old one exists)
• Go to /Applications folder, and double click: "DocIntegrate.app"

Installation for All Users beforehand (DI3.0 version and newer)

1. Make sure, that all previous DocIntegrate versions are uninstalled and removed. Remove any old occurrence of [HKEY_CURRENT_USER\SOFTWARE\Classes\pinuxeo] or similar keys in HKLM.
2. Install the DocIntegrate as Admin User.
   

3. To set the registry key copy contents below and save file as key.reg and run it to add these registry keys to the system.

   Replace "cbUrl"="http://dmshost:9080/casebrowser" value to correct DMS URL of your environment. Modify value of [HKEY_LOCAL_MACHINE\Software\DocIntegrate\Protocols\pinuxeo\shell\open\command] in below code block to correct path for DocIntegrate.exe in your environment

   Windows Registry Editor Version 5.00   [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\pinuxeo] "EditFlags"=dword:00000002 @=URL:pinuxeo Protocol "URL Protocol"="" [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\pinuxeo\shell] [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\pinuxeo\shell\open] [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\pinuxeo\shell\open\command] @=hex(2):22,00,43,00,3a,00,5c,00,50,00,72,00,6f,00,67,00,72,00,61,00,6d,00,20,\ 00,46,00,69,00,6c,00,65,00,73,00,20,00,28,00,78,00,38,00,36,00,29,00,5c,00,\ 44,00,6f,00,63,00,49,00,6e,00,74,00,65,00,67,00,72,00,61,00,74,00,65,00,5c,\ 00,44,00,6f,00,63,00,49,00,6e,00,74,00,65,00,67,00,72,00,61,00,74,00,65,00,\ 2e,00,65,00,78,00,65,00,22,00,20,00,22,00,25,00,31,00,22,00,00,00 [HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Run] "DocIntegrate"="C:\\Program Files (x86)\\DocIntegrate\\DocIntegrate.exe" [HKEY_LOCAL_MACHINE\Software\DocIntegrate\Settings] "cbUrl"="http://dmshost:9080/casebrowser"

Please note that after installation no permanent icon appears anymore and that there is no need to start the utility explicitly. The utility is started when needed and finished shortly after.

Test DocIntegrate from Case Browser

• Open case browser: http://[casebroser_host]:[casebrowser_port]/casebrowser
• Login if needed
• Go to case, e.g. TM10002CA00
• Select a file in case browser, e.g. D503.rtf, and click 'View/Edit' button
• It will open the file immediately or show a message if it is not downloaded yet

DEPRECATED - Map Nuxeo Webdav on Mac

• Open Finder
• Select menu 'Go' -> 'Connect to Server…' (or use shortcut CMD+K)
• In the 'Connect to Server' dialog, input http://[nuxeohost]:[nuxeoport]/nuxeo/site/dav
• Click 'Connect' button
• Input username and password

Troubleshooting

In case of URL handler is not successfully integrated, please contact patricia-support@serviva.com, and we will assist you in addressing any configuration issues.

Functional description

The DI has both a temp and a cache folder.

They are used for different purposes:

temp is the local storage point for non-editable (read only) documents.

temp is cleared on startup of DI as it contains only read-only docs.

• This includes any documents that are opened via DocIntegrate, and are read only/non-editable,
• docs that are set as final in Patricia,
• docs that are opened despite another user editing (if system is set so),
• docs for which no entry is found in <editableFileTypes> in the settings.xml in nuxeo.
  these will not be uploaded again should any changes have been made (though office respects a locked flag set by DI on the document and will inform the user that it’s a read-only doc).

cache is the local storage point for editable docs, ie. for doc formats that are set in the <editableFileTypes> in the settings.xml and no other reason for keeping them read only applies.

 When a "save" action is called in your editing Application (Word, Excel, Acrobat Professional, Libre Office or any Application that handles your Documents) that Save happens towards your cache folder.
Only when you close the Document, DI recognizes the release of the "Lock" for this file and uploads the Document to the eDMS. So DI monitors the Document while it being edited.
This is also the reason why you need to disable "autosave" a.k.a "background save" (depending on your MS office Version) functionality in your Office Application: these functionalities rename the document back and forth in their own manner. This causes DI to lose the connection with the document.
So DI cannot upload a new version anymore, since it is not notified of any changes.

When a document has been uploaded by DI to the eDMS , the document is cleared from the cache folder.

The temp folder´s content will simply stay on until next restart of DI.

DI2 version and older

Install DocIntegrate on Windows

• Choose and download the DocIntegrate installer package for your OS from: https://edmsdoc.pace-ip.com/display/DMS/EDMS+Downloads
• Double click the installer file and follow the wizards to finish installation. (If old one is running, then quit it and uninstall it first). Don't change default settings in the installation wizards.
• Double click the 'DocIntegrate' shortcut on your Desktop to launch the app. It may disappear quickly, which is ok. This step is important for a complete and correct installation of DocIntegrate.

Install DocIntegrate on Mac

• Download from (Mac OS 10.11+): https://www.pace-ip.com/edms/downloads/components/DocIntegrate/
• Double click the DMS file and drag and drop the app filet to /Applications folder (override if old one exists)
• Go to /Applications folder, and double click: "DocIntegrate.app"

Installation for All Users beforehand (old version)

1. Install the DocIntegrate as Admin User.
   
   

2. To set the registry key copy contents below and save file as key.reg and run it to add these registry keys to the system.

   Replace "cbUrl"="http://dmshost:9080/casebrowser" value to correct DMS URL of your environment. Modify value of [HKEY_LOCAL_MACHINE\Software\DocIntegrate\Protocols\pinuxeo\shell\open\command] in below code block to correct path for DocIntegrate.exe in your environment

   Windows Registry Editor Version 5.00 [HKEY_LOCAL_MACHINE\Software\DocIntegrate] @="DocIntegrate" [HKEY_LOCAL_MACHINE\Software\DocIntegrate\Protocols] [HKEY_LOCAL_MACHINE\Software\DocIntegrate\Protocols\pinuxeo] "URL Protocol"="" [HKEY_LOCAL_MACHINE\Software\DocIntegrate\Protocols\pinuxeo\shell] [HKEY_LOCAL_MACHINE\Software\DocIntegrate\Protocols\pinuxeo\shell\open] [HKEY_LOCAL_MACHINE\Software\DocIntegrate\Protocols\pinuxeo\shell\open\command] @="\"C:\\Program Files (x86)\\DocIntegrate\\appdata\\DocIntegrate-2.0.11.win32\\DocIntegrate.exe\" \"%1\"" [HKEY_LOCAL_MACHINE\Software\DocIntegrate\Settings] "cbUrl"="http://dmshost:9080/casebrowser"

   On first login by a user, DocIntegrate must be started from the shortcut on the user's desktop to complete the installation.

Test DocIntegrate from Case Browser

• Open case browser: http://[casebroser_host]:[casebrowser_port]/casebrowser
• Login if needed
• Go to case, e.g. TM10002CA00
• Select a file in case browser, e.g. D503.rtf, and click 'View/Edit' button
• It will open the file immediately or show a message if it is not downloaded yet

DEPRECATED - Map Nuxeo Webdav on Mac

• Open Finder
• Select menu 'Go' -> 'Connect to Server…' (or use shortcut CMD+K)
• In the 'Connect to Server' dialog, input http://[nuxeohost]:[nuxeoport]/nuxeo/site/dav
• Click 'Connect' button
• Input username and password

Troubleshooting

In case of URL handler is not successfully integrated, please contact patricia-support@serviva.com, and we will assist you in addressing any configuration issues.

Functional description

The DI has both a temp and a cache folder.

They are used for different purposes:

temp is the local storage point for non-editable (read only) documents.

temp is cleared on startup of DI as it contains only read-only docs.

• This includes any documents that are opened via DocIntegrate, and are read only/non-editable,
• docs that are set as final in Patricia,
• docs that are opened despite another user editing (if system is set so),
• docs for which no entry is found in <editableFileTypes> in the settings.xml in nuxeo.
  these will not be uploaded again should any changes have been made (though office respects a locked flag set by DI on the document and will inform the user that it’s a read-only doc).

cache is the local storage point for editable docs, ie. for doc formats that are set in the <editableFileTypes> in the settings.xml and no other reason for keeping them read only applies.

 When a "save" action is called in your editing Application (Word, Excel, Acrobat Professional, Libre Office or any Application that handles your Documents) that Save happens towards your cache folder.
Only when you close the Document, DI recognizes the release of the "Lock" for this file and uploads the Document to the eDMS. So DI monitors the Document while it being edited.
This is also the reason why you need to disable "autosave" a.k.a "background save" (depending on your MS office Version) functionality in your Office Application: these functionalities rename the document back and forth in their own manner. This causes DI to lose the connection with the document.
So DI cannot upload a  new version anymore, since it is not notified of any changes.

When a document has been uploaded by DI to the eDMS , the document is cleared from the cache folder.

The temp folder´s content will simply stay on until next restart of DI.