Examples of org.openntf.domino.helpers.DocumentSyncHelper

org.openntf.domino.helpers.DocumentSyncHelper

DocumentSyncHelper class This class provides a quick and easy way to sync fields or formulas from a DocumentCollection to related documents, e.g. from Companies to Contacts for those companies, or States to Contacts for those states.

Create a map of updates to make to related documents
- Key is Item to pull from source document or formula to be processed against source document
- Value is Item name to wrote to on target documents
Create a new instance of DocumentSyncHelper
Either in constructor or separately, define the strategy to apply when updating target documents
Either in constructor or separately, load in the map
Either in constructor or separately, define target server
Either in constructor or separately, define target database
Either in constructor or separately, define target view name
Either in constructor or separately, define field in source to use as a key for target view
Get a DocumentCollection of source document(s)
Pass to DocumentSyncHelper.process method

Example:

 Database currDb = XSPUtil.getCurrentDatabase(); java.util.Map syncMap = new java.util.HashMap(); syncMap.put("Key", "State"); syncMap.put("Name", "StateName"); syncMap.put("@Now", "LastSync"); DocumentSyncHelper helper = new DocumentSyncHelper(DocumentSyncHelper.Strategy.CREATE_AND_REPLACE, syncMap, currDb.getServer(), currDb.getFilePath(), "AllContactsByState", "Key"); View states = currDb.getView("AllStates"); DocumentCollection sourceCollection = states.getAllDocuments(); helper.process(sourceCollection);

Alternatively, sync settings can be held in a control document. Use a Map to map DocumentSyncHelper properties to Item names on the control document, e.g. Map has key Controls.TARGET_SERVER=ServerName will look for an Item called ServerName on the control document to retrieve the server name to use in the DocumentSyncHelper

    Utils.addAllListeners(currDb);
    java.util.Map<Object, String> syncMap = new java.util.HashMap<Object, String>();
    syncMap.put("Key", "State");
    syncMap.put("Name", "StateName");
    syncMap.put("@Now", "LastSync");
    DocumentSyncHelper helper = new DocumentSyncHelper(DocumentSyncHelper.Strategy.CREATE_AND_REPLACE, syncMap,
        currDb.getServer(), currDb.getFilePath(), "AllContactsByState", "Key");
    View states = currDb.getView("AllStates");
    DocumentCollection sourceCollection = states.getAllDocuments();
    helper.process(sourceCollection);
    ExtLibUtil.getViewScope().put("javaTest", "Done");
  }

    syncMap.put("Address", "CompanyAddress");
    syncMap.put("City", "CompanyCity");
    syncMap.put("State", "CompanyState");
    syncMap.put("ZIP", "CompanyZIP");
    syncMap.put("@Now", "LastSync");
    DocumentSyncHelper helper = new DocumentSyncHelper(DocumentSyncHelper.Strategy.CREATE_AND_REPLACE, syncMap);
    helper.setTargetServer(targetDb.getServer());
    helper.setTargetFilepath(targetDb.getFilePath());
    helper.setTargetLookupView("byCompanyID");
    helper.setTargetDatabase(targetDb, "byCompanyID");


    helper.setSourceKeyFormula("CompID");
    java.util.Date sinceDate = new java.util.Date(0);
    org.openntf.domino.DateTime dt = sourceDb.getAncestorSession().createDateTime(sinceDate);
    org.openntf.domino.DocumentCollection sourceCollection = sourceDb.getModifiedDocuments(dt);
    helper.process(sourceCollection);
    helper.setTransactionRule(DocumentSyncHelper.TransactionRule.COMMIT_EVERY_SOURCE);
    helper.processSince(sourceDb, sinceDate);
  }

Examples of org.openntf.domino.helpers.DocumentSyncHelper

Related Classes of org.openntf.domino.helpers.DocumentSyncHelper