Difference between revisions of "OMR scripting"

From OpenKM Documentation
Jump to: navigation, search
 
(5 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
* '''omId''' value is the '''template id'''.
 
* '''omId''' value is the '''template id'''.
  
 +
'''Code:'''
 
<source lang="java">
 
<source lang="java">
 
import com.openkm.bean.Document;
 
import com.openkm.bean.Document;
Line 14: Line 15:
 
String docPath = OKMRepository.getInstance().getNodePath(systemToken, uuid);
 
String docPath = OKMRepository.getInstance().getNodePath(systemToken, uuid);
 
Document doc = OKMDocument.getInstance().getProperties(systemToken, docPath);
 
Document doc = OKMDocument.getInstance().getProperties(systemToken, docPath);
 +
 
if (OMRHelper.isValid(doc)) {
 
if (OMRHelper.isValid(doc)) {
 
     OMRHelper.processAndStoreMetadata(omId, uuid);
 
     OMRHelper.processAndStoreMetadata(omId, uuid);
Line 28: Line 30:
 
[[File:Okm_user_guide_436.png|center]]
 
[[File:Okm_user_guide_436.png|center]]
  
The script value is:
+
The '''script value''' is:
  
 
[[File:Okm_user_guide_437.png|center]]
 
[[File:Okm_user_guide_437.png|center]]
  
Where '''omId value is template id''';
+
Where '''omId value''' is '''template id''';
 +
 
 +
[[File:Okm_user_guide_439.png|center|900px]]
  
[[File:Okm_user_guide_439.png|center]]
 
  
Each time document is uploaded to folder path ( or subfolders ) the image is processed by OMR.
+
Each time document is uploaded into folder path ( or subfolders ) the image is processed by OMR engine.
  
 
[[File:Okm_user_guide_438.png|center]]
 
[[File:Okm_user_guide_438.png|center]]
  
 
[[Category: Utilities]]
 
[[Category: Utilities]]

Latest revision as of 13:34, 2 May 2013

The script process an image with OMR engine from Automation scripting feature, each time new document is uploaded. With minimal changes can be used in conjuntion with crontab.

  • omId value is the template id.

Code:

import com.openkm.bean.Document;
import com.openkm.module.db.stuff.DbSessionManager;
import com.openkm.api.OKMDocument;
import com.openkm.api.OKMRepository;
import com.openkm.omr.OMRHelper;

long omId= 4;
String systemToken = DbSessionManager.getInstance().getSystemToken();
String docPath = OKMRepository.getInstance().getNodePath(systemToken, uuid);
Document doc = OKMDocument.getInstance().getProperties(systemToken, docPath);

if (OMRHelper.isValid(doc)) {
    OMRHelper.processAndStoreMetadata(omId, uuid);	
}

Example

Create a automation task based on event document creation and post execution.

Okm user guide 435.png

With one validation based on folder path and one scripting action.

Okm user guide 436.png

The script value is:

Okm user guide 437.png

Where omId value is template id;

Okm user guide 439.png


Each time document is uploaded into folder path ( or subfolders ) the image is processed by OMR engine.

Okm user guide 438.png