DCTM : DFC

See also the page : http://www.javablog.fr/documentum-dfc-standalone-sample-program-all-basic-functionalities-of-documentum.html

---

——————— CONFIG ————————–

---

• Display the JVM properties

view source
print?
01
try {
02
    System.out.println("########################################################");
03
    System.out.println("JVM properties");
04
    System.out.println("########################################################");
05
    java.util.Properties properties = System.getProperties();
06
    java.util.Set<Object> set = properties.keySet();
07
    for (Object object : set) {
08
        Object object2 = properties.get(object);
09
        System.out.println(object + "=" + object2);
10
    }
11
} catch (Exception e) {
12
    System.out.println(com.documentum.fc.common.impl.MessageHelper.getStackTraceAsString(e));
13
}

…outputs:

view source
print?
01
########################################################
02
JVM properties
03
########################################################
04
java.runtime.name=Java(TM) SE Runtime Environment
05
sun.boot.library.path=C:\java\jdk1.6.0_27\jre\bin
06
java.vm.version=20.2-b06
07
java.vm.vendor=Sun Microsystems Inc.
08
java.vendor.url=http://java.sun.com/
09
path.separator=;
10
java.vm.name=Java HotSpot(TM) Client VM
11
file.encoding.pkg=sun.io
12
sun.java.launcher=SUN_STANDARD
13
user.country=GB
14
sun.os.patch.level=Service Pack 1
15
java.vm.specification.name=Java Virtual Machine Specification
16
user.dir=C:\Workspaces\TestDCTMHUO
17
java.runtime.version=1.6.0_27-rev-b21
18
java.awt.graphicsenv=sun.awt.Win32GraphicsEnvironment
19
java.endorsed.dirs=C:\java\jdk1.6.0_27\jre\lib\endorsed
20
os.arch=x86
21
java.io.tmpdir=C:\Users\HUSEYI~1\AppData\Local\Temp\
22
line.separator=
23
 
24
 
25
java.vm.specification.vendor=Sun Microsystems Inc.
26
user.variant=
27
os.name=Windows 7
28
sun.jnu.encoding=Cp1252
29
java.library.path=C:\java\jdk1.6.0_27\jre\bin;C:\WINDOWS\Sun\Java\bin;C:\WINDOWS\system32; C:\WINDOWS; C:/APP/Composer/jre/bin/../jre/bin/client;C:/APP/Composer/jre/bin/../jre/bin; C:\Program Files (x86)\EMC IRM\Common\;... ;C:\Users\hozveren\.dnx\bin;C:\Program Files\Microsoft DNX\Dnvm\.....; C:\Program Files (x86)\Windows Kits\8.1\Windows Performance Toolkit\;.
30
java.specification.name=Java Platform API Specification
31
java.class.version=50.0
32
sun.management.compiler=HotSpot Client Compiler
33
os.version=6.1
34
user.home=C:\Users\hozveren
35
user.timezone=
36
java.awt.printerjob=sun.awt.windows.WPrinterJob
37
file.encoding=Cp1252
38
java.specification.version=1.6
39
java.class.path=C:\Workspaces\DocumentumCoreProject\bin;C:\Workspaces\TestDCTMHUO\Web Services\bin\classes;C:\Workspaces\TestDCTMHUO\bin;....; C:\Workspaces\DocumentumCoreProject\dfs6.7\emc-dfs-sdk-6.7\lib\java\utils\xws-security.jar
40
user.name=hozveren
41
java.vm.specification.version=1.0
42
sun.java.command=com.huo.test.ecm.test3.ShowClientConfig
43
java.home=C:\SDK\jdk1.6.0_27\jre
44
sun.arch.data.model=32
45
user.language=en
46
java.vm.info=mixed mode
47
java.version=1.6.0_27-rev
48
java.ext.dirs=C:\SDK\jdk1.6.0_27\jre\lib\ext;C:\WINDOWS\Sun\Java\lib\ext
49
sun.boot.class.path=C:\SDK\jdk1.6.0_27\jre\lib\resources.jar;...; C:\SDK\jdk1.6.0_27\jre\classes
50
java.vendor=Sun Microsystems Inc.
51
file.separator=\
52
java.specification.vendor=Sun Microsystems Inc.
53
awt.toolkit=sun.awt.windows.WToolkit
54
...

• Display the JVM environment

view source
print?
01
try {
02
    System.out.println("########################################################");
03
    System.out.println("JVM env");
04
    System.out.println("########################################################");
05
    java.util.Map<String, String> map = System.getenv();
06
    java.util.Set<String> set = map.keySet();
07
    for (String object : set) {
08
        String object2 = map.get(object);
09
        System.out.println(object + "=" + object2);
10
    }
11
} catch (Exception e) {
12
    System.out.println(com.documentum.fc.common.impl.MessageHelper.getStackTraceAsString(e));
13
}

…outputs:

view source
print?
01
########################################################
02
JVM env
03
########################################################
04
USERPROFILE=C:\Users\hozveren
05
ProgramData=C:\ProgramData
06
PATHEXT=.COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC
07
windows_tracing_logfile=C:\BVTBin\Tests\installpackage\csilogfile.log
08
ProgramFiles(x86)=C:\Program Files (x86)
09
windows_tracing_flags=3
10
TEMP=C:\Users\HOZVER~1\AppData\Local\Temp
11
SystemDrive=C:
12
ProgramFiles=C:\Program Files (x86)
13
Path=C:/TOOLS/Composer/jre/bin/../jre/bin/client;C:/TOOLS/Composer/jre/bin/../jre/bin;...; C:\Program Files (x86)\Windows Kits\8.1\Windows Performance Toolkit\
14
PROCESSOR_REVISION=3c03
15
TNS_ADMIN=C:\SDK\TNS
16
VSTO_SUPPRESSDISPLAYALERTS=0
17
USERDOMAIN=LU
18
SESSIONNAME=Console
19
TMP=C:\Users\HOZVER~1\AppData\Local\Temp
20
HOMEPATH=\Users\hozveren
21
COMPUTERNAME=MYPCHUO
22
windir=C:\WINDOWS
23
SystemRoot=C:\WINDOWS
24
NUMBER_OF_PROCESSORS=8
25
USERNAME=hozveren
26
PUBLIC=C:\Users\Public
27
ComSpec=C:\WINDOWS\system32\cmd.exe
28
APPDATA=C:\Users\hozveren\AppData\Roaming
29
...

• Display the DFC properties

view source
print?
01
try {
02
    System.out.println("########################################################");
03
    System.out.println("dfc.properties");
04
    System.out.println("########################################################");
05
    com.documentum.fc.client.IDfClient dfClient = com.documentum.fc.client.DfClient.getLocalClientEx();
06
    com.documentum.fc.client.IDfTypedObject dfTypedObject = dfClient.getClientConfig();
07
    for (int i = 0; i < dfTypedObject.getAttrCount(); i++) {
08
        com.documentum.fc.common.IDfAttr dfAttr = dfTypedObject.getAttr(i);
09
        if (dfAttr.isRepeating()) {
10
            for (int j = 0; j < dfTypedObject.getValueCount(dfAttr.getName()); j++) {
11
                StringBuilder sb = new StringBuilder();
12
                sb.append(dfAttr.getName()).append("[").append(j).append("]=");
13
                sb.append(dfTypedObject.getRepeatingValue(dfAttr.getName(), j));
14
                System.out.println(sb.toString());
15
            }//end-for
16
        } else {
17
            StringBuilder sb = new StringBuilder();
18
            sb.append(dfAttr.getName()).append("=").append(dfTypedObject.getValue(dfAttr.getName()));
19
            System.out.println(sb.toString());
20
        }//end-if
21
    }//end-for
22
} catch (Exception e) {
23
    System.out.println(com.documentum.fc.common.impl.MessageHelper.getStackTraceAsString(e));
24
}

…outputs:

view source
print?
01
########################################################
02
dfc.properties
03
########################################################
04
dfc.name=dfc
05
dfc.config.dir=C:\Documentum\DEV\config
06
dfc.config.file=file:/C:/Documentum/DEV/config/dfc.properties
07
dfc.data.dir=C:\Documentum\DEV
08
dfc.data.user_dir=C:\Documentum\DEV
09
dfc.data.checkout_dir=C:\Documentum\DEV\checkout
10
dfc.data.export_dir=C:\Documentum\DEV\export
11
dfc.data.local_diskfull_limit=0
12
dfc.data.local_diskfull_check_interval=1
13
dfc.data.local_clean_on_init=T
14
dfc.data.local_purge_on_diskfull=T
15
dfc.registry.mode=file
16
dfc.permit.grant.write.user_default_folder=T
17
dfc.registry.file=C:\Documentum\DEV\documentum.ini
18
dfc.config.check_interval=30
19
dfc.batch_hint_size=50
20
dfc.search.batch_hint_size=0
21
dfc.codepage=windows-1252
22
dfc.date_format=dd/MM/yyyy HH:mm:ss
23
dfc.locale=en
24
dfc.time_zone=Europe/Paris
25
dfc.version=6.7.2000.0038
26
dfc.verify_registration=T
27
dfc.acs.avail.refresh_interval=360
28
dfc.bocs.avail.refresh_interval=120
29
dfc.acs.check_availability=T
30
dfc.acs.config.refresh_interval=120
31
dfc.acs.gr.refresh_interval=120
32
dfc.acs.request.expiration_interval=360
33
dfc.admin.ldif_file_charset=UTF-8
34
dfc.appledouble.resource_file_ext=adp
35
dfc.bocs.check.keep_number=10
36
dfc.bocs.check.http_method=GET
37
dfc.bof.cache.append_name=T
38
dfc.bof.cache.currency_check_interval=60
39
dfc.bof.cache.cleanup_interval=7
40
dfc.bof.cache.enable_preload=T
41
dfc.bof.classloader.enable_extension_loader_first=T
42
dfc.cache.dir=C:\Documentum\DEV\cache
43
dfc.cache.enable_persistence=T
44
dfc.cache.write_interval=3600
45
dfc.cache.ddinfo.size=500
46
dfc.cache.object.size=1000
47
dfc.cache.query.size=500
48
dfc.cache.type.size=500
49
dfc.cache.format.currency_check_interval=300
50
dfc.cache.store.currency_check_interval=300
51
dfc.cache.type.currency_check_interval=300
52
dfc.cache.currency_scoping.enable=T
53
dfc.cache.currency_scoping.query_result_max_count=5
54
dfc.compatibility.truncate_long_values=F
55
dfc.compatibility.return_null_when_no_values=T
56
dfc.compatibility.preserve_session_info_messages=T
57
...

---

——————— CONTENT ————————–

---

• Set current content file exemple for anonymization need:

view source
print?
01
int countCurrent = 0;
02
for (String documentId : documentIds) {
03
    try {
04
        LOGGER.info(documentId + " : update content (" + countCurrent + ")... ");
05
        IDfDocument document = (IDfDocument) session.getObject(new DfId(documentId));
06
        boolean isImmutable = document.isImmutable();
07
        if (isImmutable) {
08
            document.setBoolean("r_immutable_flag", false);
09
            document.save();
10
        }
11
 
12
 
13
        document.setSubject("anonymized");
14
        document.setContentType("pdf");
15
        document.setFile(docFolder + File.separator + canal + "-encrypted.pdf");
16
        document.save();
17
 
18
        if (isImmutable) {
19
            document.setBoolean("r_immutable_flag", true);
20
            document.save();
21
        }
22
        LOGGER.info(documentId + " : [OK]");
23
    } catch(Exception e) {
24
        LOGGER.error(documentId + " : [KO: error to update content]", e);
25
    }
26
    countCurrent++;
27
}

 
• Get current content file
SOLUTION 1 : The “standard” way to get content from a document stored via the methods getFile OR getFileEx OR getFileEx2
=> The server will create a temporary file on a filesystem accessible to the user, and return the file name.
=> The server copies the file from the Documentum server to the local drive (current working directory):

view source
print?
1
doc.getFile(doc.getObjectName());

SOLUTION 2 : Copies this object’s content from the Documentum server into a ByteArrayInputStream object via the methods getContent OR getContentEx OR getContentEx2 OR getContentEx3

view source
print?
1
long contentSize = docPJ.getContentSize();

view source
print?
01
private String getContentOfDocument(IDfSysObject doc) throws Throwable{
02
    String originalContent = null;
03
    ByteArrayInputStream originalContentBais = doc.getContent();
04
    if (originalContentBais.available() > 0){
05
        int n = originalContentBais.available();
06
        byte[] bytes = new byte[n];
07
        originalContentBais.read(bytes, 0, n);
08
        originalContent = new String(bytes, "UTF-8");
09
    }
10
 
11
    return originalContent;
12
}

 
• Get rendition content file

view source
print?
01
private String getXmlRenditionOfDocument(IDfSysObject doc) throws Throwable{
02
    String renditionXmlContent = null;
03
 
04
    // RENDITION XML
05
    //long renditionXmlContentSize = doc.getContentSize(0, "xml", null);
06
    ByteArrayInputStream renditionXmlContentBais = doc.getContentEx2("xml", 0, null);
07
    if (renditionXmlContentBais!=null && renditionXmlContentBais.available() > 0){
08
        int n = renditionXmlContentBais.available();
09
        byte[] bytes = new byte[n];
10
        renditionXmlContentBais.read(bytes, 0, n);
11
        renditionXmlContent = new String(bytes, "UTF-8");
12
    }
13
 
14
    return renditionXmlContent;
15
}

 
• Extract data from content file with resolution of CHARSET and OS characters encoding problems:

view source
print?
001
public static final String UN_ENCODED_VALUE = "?";
002
public static final String DATIME_SEPARATOR_VALUE = "-";
003
 
004
//They are "\n" (Linux and MacOS X), "\r" (MacOS 9 and older) and "\r\n" (Windows)
005
public static final String WINDOWS_NEW_LINE_SEPARATOR = "\r\n"; // System.getProperty("line.separator");
006
public static final String LINUX_NEW_LINE_SEPARATOR = "\n";
007
public static final String MAC_NEW_LINE_SEPARATOR = "\r";
008
public static final String NOTES_NEW_LINE_SEPARATOR = "
";
009
public static final char NO_BREAK_SPACE_CHARACTER = '\u00A0';
010
 
011
public enum MetaDataFieldTypes {
012
    STRING,
013
    DATE,
014
    REPEATING,
015
    INTEGER,
016
    ;
017
    private MetaDataFieldTypes(){ }
018
}
019
 
020
/**
021
 * Do the extraction of data from TEXTUAL content
022
 */
023
public Map<String, Object> doExtraction(String content, MetaDataFieldTypes fieldType, String metaDataKey, String startTAG, String stopTAG) throws Throwable{
024
    Map<String, Object> extractedData = new LinkedHashMap<String, Object>();
025
 
026
    // Replace the newline (line feed) chars and the carriage-return chars by space " "
027
    content = content.replaceAll(WINDOWS_NEW_LINE_SEPARATOR, "");
028
    content = content.replaceAll(LINUX_NEW_LINE_SEPARATOR, "");
029
    content = content.replaceAll(MAC_NEW_LINE_SEPARATOR, "");
030
 
031
    // See http://stackoverflow.com/questions/13992934/how-to-fix-utf-encoding-for-whitespaces
032
    // Replace all NO-BREAK-SPACE character '\u00A0' by a space character
033
    content = content.replace(NO_BREAK_SPACE_CHARACTER, ' ');
034
 
035
    if(currContentMetaDataFieldSplitter!=null){
036
        String metaDataValue = getValueBetweenTAGs(content, startTAG, stopTAG);
037
 
038
        if(fieldType == MetaDataFieldTypes.DATE){
039
            Date metaDataValueDate = null;
040
            if(metaDataValue!=null && !"".equals(metaDataValue)){
041
                metaDataValue = new String(metaDataValue.getBytes(), ENCODING_CHARSET);
042
                // "Dec?04?2014" -> "Dec-04-2014"
043
                metaDataValue = metaDataValue.replace(UN_ENCODED_VALUE, DATIME_SEPARATOR_VALUE);
044
                metaDataValueDate = currContentMetaDataFieldSplitter.getDateFormat().parse(metaDataValue);
045
            }
046
 
047
            extractedData.put(metaDataKey, metaDataValueDate);
048
 
049
        } else if(fieldType == MetaDataFieldTypes.REPEATING) {
050
            String[] metaDataValuesArray = null;
051
            if(metaDataValue!=null && !"".equals(metaDataValue)){
052
                metaDataValuesArray = metaDataValue.split((String) currContentMetaDataFieldSplitter.getValuesSeparator());
053
                // Trim white space from all elements in array
054
                for (int i = 0; i < metaDataValuesArray.length; i++){
055
                    metaDataValuesArray[i] = metaDataValuesArray[i].trim();
056
                }
057
            }
058
            extractedData.put(metaDataKey, metaDataValuesArray);
059
 
060
        } else if(fieldType == MetaDataFieldTypes.INTEGER) {
061
            if(metaDataValue!=null && !"".equals(metaDataValue)){
062
                metaDataValue = metaDataValue.trim();
063
                // "FIELD VALUE   #:           154564 test huo javablog.fr
"
064
                if(metaDataValue.indexOf(" ")>0){metaDataValue = metaDataValue.substring(0, metaDataValue.indexOf(" "));}
065
                try{int tmpInt = Integer.parseInt(metaDataValue); metaDataValue=""+tmpInt;}catch(Throwable IgnoreTh){}
066
                extractedData.put(metaDataKey, metaDataValue);
067
            }
068
 
069
        } else /**if(fieldType == MetaDataFieldTypes.STRING)*/ {
070
            extractedData.put(metaDataKey, metaDataValue);
071
        }
072
    }
073
    return extractedData;
074
}
075
 
076
private String getValueBetweenTAGs(String content, String startTAG, String stopTAG){
077
    String metaDataValue = null;
078
    int indexStartTAG = content.indexOf(startTAG);
079
    if(indexStartTAG>=0){
080
        int indexStopTAG = content.indexOf(stopTAG, indexStartTAG+startTAG.length());
081
        if(indexStopTAG>0){
082
            metaDataValue = content.substring(indexStartTAG+startTAG.length(), indexStopTAG);
083
            //
084
            if(metaDataValue!=null){
085
                metaDataValue = metaDataValue.trim();
086
                //
087
                //1. FIRST TEXT XML RENDITION : Replace the NOTES newline (line feed) chars "
" by ""
088
                metaDataValue = metaDataValue.replaceAll(NOTES_NEW_LINE_SEPARATOR, "");
089
                //2. SECOND Replace the HTML chars to unicode chars ex:   -> " "
090
                metaDataValue = org.apache.commons.lang.StringEscapeUtils.unescapeHtml(metaDataValue);
091
                //
092
                // See http://stackoverflow.com/questions/13992934/how-to-fix-utf-encoding-for-whitespaces
093
                // Replace all NO-BREAK-SPACE character '\u00A0' by a space character
094
                metaDataValue = metaDataValue.replace(NO_BREAK_SPACE_CHARACTER, ' ').trim();
095
            }
096
        }
097
    }
098
 
099
    return metaDataValue;
100
}

---

——————— SESSION ————————–

---

• To get Documentum session object

view source
print?
01
public IDfSession getDfSession(String user, String passwd, String docbase) throws Exception {
02
    IDfLoginInfo login = new DfLoginInfo();
03
    login.setUser(user);
04
    login.setPassword(passwd);
05
    IDfClient client = DfClient.getLocalClient(); //new DfClient();
06
    IDfSessionManager sessMgr = client.newSessionManager();
07
    sessMgr.setIdentity(docbase, login);
08
    IDfSession idfSession = sessMgr.getSession(docbase);
09
 
10
 
11
    if (idfSession != null)
12
        System.out.println("Session created successfully");
13
 
14
    return idfSession;
15
}

• To get user of Documentum session object

view source
print?
01
// Same value
02
String technicalUser = getCurrentUser();
03
technicalUser= dfSession.getLoginInfo().getUser();
04
technicalUser = dfSession.getLoginUserName();
05
 
06
private String getCurrentUser(){
07
        String userName = null;
08
        ContextFactory contextFactory = ContextFactory.getInstance();
09
    IServiceContext serviceContext = contextFactory.getContext();
10
    for (Iterator<?> iter = serviceContext.getIdentities(); iter.hasNext();) {
11
        Object identity = iter.next();
12
        if (identity instanceof BasicIdentity) {
13
            BasicIdentity basicIdentity = (BasicIdentity) identity;
14
            userName = basicIdentity.getUserName();
15
        }//end-if
16
    }//end-for
17
    return userName;
18
}

• To release a Documentum session object with Session Manager

view source
print?
1
public void releaseSession(IDfSessionManager sessMgr, IDfSession idfSession) throws Exception {
2
    sessMgr.release(idfSession);
3
}

• To create a Session with the credentials sent through Web Context (like Web service):

view source
print?
01
package com.java.lu.service.ecm.utils.context;
02
 
03
import java.text.MessageFormat;
04
import java.util.Iterator;
05
import java.util.UUID;
06
 
07
import com.documentum.fc.client.DfAuthenticationException;
08
import com.documentum.fc.client.IDfSession;
09
import com.emc.documentum.fs.datamodel.core.context.BasicIdentity;
10
import com.emc.documentum.fs.rt.context.ContextFactory;
11
import com.emc.documentum.fs.rt.context.IServiceContext;
12
import com.emc.documentum.fs.rt.impl.DfsLogger;
13
import com.emc.documentum.fs.rt.impl.IDfsLogger;
14
 
15
public class SessionUtils {
16
 
17
    private static final IDfsLogger logger = DfsLogger.getLogger(SessionUtils.class);
18
 
19
    private static IDfSession getMySession(String repositoryName, boolean newSession) throws Throwable{
20
        UUID uuid = UUID.randomUUID();
21
        if (logger.isTraceEnabled()) {
22
            logger.trace(MessageFormat.format("{1} - getMySession(repositoryName={0})", repositoryName, uuid));
23
        }
24
        IDfSession dfSession = null;
25
        ContextFactory contextFactory = ContextFactory.getInstance();
26
        IServiceContext serviceContext = contextFactory.getContext();
27
        for (Iterator<?> iter = serviceContext.getIdentities(); iter.hasNext() && dfSession == null;) {
28
            Object identity = iter.next();
29
            if (identity instanceof BasicIdentity) {
30
                BasicIdentity basicIdentity = (BasicIdentity) identity;
31
                String password = basicIdentity.getPassword();
32
                String userName = basicIdentity.getUserName();
33
                if (!newSession) {
34
                    if (logger.isDebugEnabled()) {
35
                        logger.debug(MessageFormat.format("{0} - Retrieving session for user {1} and repository {2}", uuid, userName, repositoryName));
36
                    }
37
                    try {
38
                        dfSession = ContextCaching.getSessionManager(repositoryName, userName).getSession(repositoryName);
39
                        if (logger.isDebugEnabled()) {
40
                            logger.debug(MessageFormat.format("{0} - Retrieving session for user {1} and repository {2} - success !", uuid, userName, repositoryName));
41
                        }
42
                    } catch (DfAuthenticationException e) {
43
                        if (logger.isDebugEnabled()) {
44
                            logger.debug(MessageFormat.format("{0} - Retrieving session for user {1} and repository {2} - failure : {3}", uuid, userName, repositoryName, e.getMessage()));
45
                        }
46
                        ContextCaching.clearContext(repositoryName, userName);
47
                        if (logger.isDebugEnabled()) {
48
                            logger.debug(MessageFormat.format("{0} - Trying a second time to retrieve session for user {1} and repository {2}", uuid, userName, repositoryName));
49
                        }
50
                        dfSession = ContextCaching.getSessionManager(repositoryName, userName).getSession(repositoryName);
51
                        if (logger.isDebugEnabled()) {
52
                            logger.debug(MessageFormat.format("{0} - Second time retrieving session for user {1} and repository {2} - success !", uuid, userName, repositoryName));
53
                        }
54
                    }
55
                } else {
56
                    if (logger.isDebugEnabled()) {
57
                        logger.debug(MessageFormat.format("{0} - Creating a new session for user {1} and repository {2}", uuid, userName, repositoryName));
58
                    }
59
                    try {
60
                        dfSession = ContextCaching.getSessionManager(repositoryName, userName).newSession(repositoryName);
61
                        if (logger.isDebugEnabled()) {
62
                            logger.debug(MessageFormat.format("{0} - Creating session for user {1} and repository {2} - success !", uuid, userName, repositoryName));
63
                        }
64
                    } catch (DfAuthenticationException e) {
65
                        if (logger.isDebugEnabled()) {
66
                            logger.debug(MessageFormat.format("{0} - Creating session for user {1} and repository {2} - failure : {3}", uuid, userName, repositoryName, e.getMessage()));
67
                        }
68
                        ContextCaching.clearContext(repositoryName, userName);
69
                        if (logger.isDebugEnabled()) {
70
                            logger.debug(MessageFormat.format("{0} - Trying a second time to create a session for user {1} and repository {2}", uuid, userName, repositoryName));
71
                        }
72
                        dfSession = ContextCaching.getSessionManager(repositoryName, userName).newSession(repositoryName);
73
                        if (logger.isDebugEnabled()) {
74
                            logger.debug(MessageFormat.format("{0} - Second time creating session for user {1} and repository {2} - success !", uuid, userName, repositoryName));
75
                        }
76
                    }
77
 
78
                }
79
            }
80
 
81
        }
82
        if (logger.isTraceEnabled()) {
83
            logger.trace(MessageFormat.format("{1} - getMySession(repositoryName={0}) - END", repositoryName, uuid));
84
        }
85
        return dfSession;
86
    }
87
}

---

——————— LOG ————————–

---

• To print the error in Console/Logging file

view source
print?
1
public void displayError(com.documentum.operations.IDfOperation operation, boolean flag) throws Exception {
2
    if (!flag) {
3
        IDfList errlist = operation.getErrors();
4
        for (int i = 0; i < errlist.getCount(); i++) {
5
            IDfOperationError errOperation = (IDfOperationError) errlist.get(i);
6
            System.out.println("Error MSG " + errOperation.getMessage());
7
        }
8
    }
9
}

---

——————— DOCBASE ————————–

---

• To get a list of available docbase

view source
print?
1
public void getAllDocbases() throws Exception {
2
    IDfClient client = DfClient.getLocalClient();
3
    IDfDocbaseMap docbaseMap = client.getDocbaseMap();
4
    for (int i = 0; i < docbaseMap.getDocbaseCount(); i++) {
5
        System.out.println("Docbase Name : " + docbaseMap.getDocbaseName(i));
6
        System.out.println("Docbase Desc : " + docbaseMap.getDocbaseDescription(i));
7
    }
8
}

…outputs:

view source
print?
01
Session created successfully
02
Docbase Name : MY_DOCBASE1_DEV
03
Docbase Desc : My docbase 1
04
Docbase Name : MY_DOCBASE2_DEV
05
Docbase Desc : My docbase 2
06
Docbase Name : GLOBALR
07
Docbase Desc : Global Registry Repository
08
Docbase Name : MY_DOCBASE3_DEV
09
Docbase Desc : My docbase 3
10
Docbase Name : MY_DOCBASE4_DEV
11
Docbase Desc : My docbase 4

---

——————— CABINET / FOLDER ————————–

---

• To create a cabinet (dm_cabinet) in docbase

view source
print?
1
public void createCabinet() throws Exception {
2
    IDfFolder cabinet = (IDfFolder) idfSession.newObject("dm_cabinet");
3
    if (cabinet != null) {
4
        cabinet.setObjectName("Training Cabinet XXX");
5
        cabinet.save();
6
    }
7
}

• To create a folder (dm_folder object) in docbase

view source
print?
1
public void createFolder() throws Exception {
2
    IDfFolder folder = (IDfFolder) idfSession.newObject("dm_folder");
3
    if (folder != null) {
4
        folder.setObjectName("Folder Level 2");
5
        folder.link("/Training Cabinet XXX");
6
        folder.save();
7
    }
8
}

---

——————— DOCUMENT / TYPE ————————–

---

• To create a document (dm_document object) in docbase

view source
print?
01
public IDfDocument createDocument() throws Exception {
02
    IDfDocument document = (IDfDocument) idfSession.newObject("dm_document");
03
    if (document != null) {
04
        document.setObjectName("Test-Document");
05
        document.setContentType("crtext");
06
        document.setFile("C:\\Documentum\\config\\dfc.properties");
07
        document.link("/Training Cabinet XXX/Folder Level 1");
08
        document.save();
09
    }
10
    return document;
11
}

• To import a document into docbase

view source
print?
01
public void importDocument() throws Exception {
02
    IDfSysObject sysObject = (IDfFolder) idfSession.getObjectByPath("/Training Cabinet XXX/Folder Level 2");
03
    System.out.println("Object ID " + sysObject.getObjectId());
04
 
05
    IDfClientX clientx = new DfClientX();
06
    com.documentum.operations.IDfImportOperation importOper = clientx.getImportOperation();
07
    importOper.setSession(idfSession);
08
 
09
    if (importOper == null)
10
        System.out.println("operation object is null");
11
 
12
    importOper.setDestinationFolderId(sysObject.getObjectId());
13
    importOper.setVersionLabels("imported using operation");
14
 
15
    com.documentum.operations.IDfImportNode node = (com.documentum.operations.IDfImportNode) importOper.add("C:\\Documentum\\config\\log4j.properties");
16
    node.setFormat("pdf");
17
 
18
    boolean flag = importOper.execute();
19
    displayError(importOper, flag);
20
}

• To delete a document from docbase

view source
print?
1
public void deleteDoc() throws Exception {
2
    IDfSysObject sysObject = (IDfSysObject) idfSession.getObjectByPath("/Training Cabinet XXX/Folder Level 1/Test-Document");
3
    if (sysObject != null) {
4
        sysObject.destroyAllVersions(); // delete all versions
5
        System.out.println("object destroyed…..");
6
    }
7
}

• To update document’s in docbase

view source
print?
1
public void updateAttributes() throws Exception {
2
    IDfSysObject sysObject = (IDfSysObject) idfSession.getObjectByPath("/Training Cabinet XXX/Folder Level 1/New Document");
3
    sysObject.setString("object_name", "New Document");
4
    sysObject.setString("authors", "Prasad");
5
    sysObject.setRepeatingString("authors", 1, "RamKumar");
6
    sysObject.save();
7
}

• To retrieve document’s attributes from docbase

view source
print?
01
public void getAttributes() throws Exception {
02
    IDfSysObject sysObject = (IDfSysObject) idfSession.getObjectByPath("/Training Cabinet XXX/Folder Level 1/New Document");
03
    if (sysObject != null) {
04
        System.out.println("objectName " + sysObject.getString("object_name"));
05
        // System.out.println("authors " + sysObject.getString("authors"));
06
        String authors = sysObject.getAllRepeatingStrings("authors", ",");
07
 
08
        List list = new java.util.ArrayList();
09
        java.util.StringTokenizer st = new java.util.StringTokenizer(authors, ",");
10
        System.out.println("length of st " + st.countTokens());
11
        while (st.hasMoreTokens()) {
12
            list.add(st.nextElement());
13
        }
14
        System.out.println("length " + list.size());
15
 
16
        for (int i = 0; i < list.size(); i++) {
17
            System.out.println("Author[" + i + "] " + list.get(i));
18
        }
19
    }
20
}

• To get the attributes of a specific type

view source
print?
01
public void getTypeAttributes() throws Exception {
02
    IDfType type = (IDfType) idfSession.newObject("dm_document");
03
    for (int i = 0; i < type.getAttrCount(); i++) {
04
        IDfAttr attr = type.getAttr(i);
05
        System.out.println("Name " + attr.getName());
06
        System.out.println("Datatype " + attr.getDataType());
07
        System.out.println("Length " + attr.getLength());
08
        System.out.println("IS Repeating Attr " + attr.isRepeating());
09
    }
10
}

• To retrieve document from document using IDQL

view source
print?
01
public void collection() throws Exception {
02
    IDfQuery query = new DfQuery();
03
    query.setDQL("select * from dm_document where object_name='New Document' and any r_version_label like 'CURRENT%'");
04
    IDfCollection coll = query.execute(idfSession, 0);
05
 
06
    while (coll.next()) {
07
        IDfTypedObject typeObject = (IDfTypedObject) coll.getTypedObject();
08
        System.out.println("Object Name " + typeObject.getString("r_object_id"));
09
        System.out.println("creation date " + typeObject.getString("r_creation_date"));
10
    }
11
 
12
    if (coll != null)
13
        coll.close();
14
}

---

——————— CHECKIN / CHECKOUT ————————–

---

• To check out a document from docbase using com.documentum.operations.IDfOperations

view source
print?
01
public void checkoutDocument() throws Exception {
02
    IDfClientX clientx = new DfClientX();
03
    com.documentum.operations.IDfCheckoutOperation checkoutOper = clientx.getCheckoutOperation();
04
 
05
 
06
    System.out.println("Checkout Dir "+ checkoutOper.getDefaultDestinationDirectory());
07
    checkoutOper.setDestinationDirectory(checkoutOper.getDefaultDestinationDirectory());
08
 
09
    sysObject = (IDfSysObject) idfSession.getObjectByPath("/Training Cabinet XXX/Folder Level 2/log4j.properties");
10
 
11
    com.documentum.operations.IDfCheckoutNode node = (com.documentum.operations.IDfCheckoutNode) checkoutOper.add(sysObject);
12
    boolean flag = checkoutOper.execute();
13
    displayError(checkoutOper, flag);
14
}

• To check in a document to docbase using com.documentum.operations.IDfOperations

view source
print?
01
public void checkinDocument() throws Exception {
02
    IDfClientX clientx = new DfClientX();
03
    com.documentum.operations.IDfCheckinOperation checkinOper = clientx.getCheckinOperation();
04
 
05
    com.documentum.operations.IDfCheckinNode node = (com.documentum.operations.IDfCheckinNode) checkinOper.add(sysObject);
06
    // NEXT_MINOR
07
    {
08
        // Set CURRENT version label is implicit
09
        //node.setCheckinVersion(IDfCheckinOperation.NEXT_MINOR);
10
    }
11
    // NEXT_MAJOR
12
    {
13
        node.setCheckinVersion(IDfCheckinOperation.NEXT_MAJOR);
14
        if(StringUtils.isEmpty(checkinOper.getVersionLabels())){
15
            checkinOper.setVersionLabels("CURRENT");
16
        }else{
17
            checkinOper.setVersionLabels(checkinOper.getVersionLabels() + "," + "CURRENT");
18
        }
19
    }
20
    System.out.println("Flag —->" + checkinOper.execute());
21
}

• To cancel checkout a document into docbase

view source
print?
1
public void cancelCheckoutDocument() throws Exception {
2
    IDfClientX clientx = new DfClientX();
3
    com.documentum.operations.IDfCancelCheckoutOperation cancelcheckoutOper = clientx.getCancelCheckoutOperation();
4
    sysObject = (IDfSysObject) idfSession.getObjectByPath("/Training Cabinet XXX/Folder Level 2/log4j.properties");
5
 
6
    com.documentum.operations.IDfCancelCheckoutNode node = (com.documentum.operations.IDfCancelCheckoutNode) cancelcheckoutOper.add(sysObject);
7
    boolean flag = cancelcheckoutOper.execute();
8
    displayError(cancelcheckoutOper, flag);
9
}

view source
print?
01
String qualification = "my_document WHERE i_chronicle_id = ID('090xxxxxxxxxxx')";
02
IDfDocument dfDocument = (IDfDocument) session.getObjectByQualification(qualification);
03
 
04
if (dfDocument == null) {
05
    throw new DfException("Unable to find object with qualification : " + qualification );
06
}
07
 
08
if (dfDocument.isCheckedOut()) {
09
    //Canceling checkout of document
10
    dfDocument.cancelCheckout();
11
}

• To check out a document from docbase

view source
print?
1
public void checkoutDoc() throws Exception {
2
    IDfSysObject sysObject = (IDfSysObject) idfSession.getObjectByPath("/Training Cabinet XXX/Folder Level 1/");
3
    if (!sysObject.isCheckedOut()) // if it is not checked out
4
        sysObject.checkout();
5
    System.out.println("is Check out " + sysObject.isCheckedOut());
6
}

• To check in a document to docbase

view source
print?
1
public void checkinDoc() throws Exception {
2
    IDfSysObject sysObject = (IDfSysObject) idfSession.getObjectByPath("/Training Cabinet XXX/Folder Level 1/Test-Document");
3
 
4
    if (sysObject.isCheckedOut()) { // if it is checked out
5
        sysObject.checkin(false, "CURRENT");
6
    }
7
}

---

——————— API ————————–

---

• To use of IAPI methods

view source
print?
01
public void dmclAPI() throws Exception {
02
    System.out.println("Starting...");
03
    IDfSysObject sysObj = (IDfSysObject) idfSession.getObjectByQualification("dm_document where object_name='Test-Document'");
04
    String rObjectId = sysObj.getObjectId().getId();
05
 
06
 
07
    String name = (String) idfSession.apiGet("get", rObjectId+ ",object_name");
08
    System.out.println("Name : " + name);
09
    // idfSession.apiSet("set",rObjectId+",title","sample-doc");
10
    idfSession.apiExec("link",rObjectId+",/Training Cabinet XXX/Folder Level 2");
11
    System.out.println("Linked " + idfSession.apiExec("save", rObjectId));
12
}

---

——————— VIRTUAL DOCUMENT ————————–

---

• To create a virtual document in docbase

view source
print?
01
public void createVirtualDocument() throws Exception {
02
    IDfSysObject pSys = (IDfSysObject) idfSession.getObjectByPath("/Training Cabinet XXX/Folder Level 2/log4j.properties");
03
    IDfSysObject cSys = (IDfSysObject) idfSession.getObjectByPath("/Training Cabinet XXX/Folder Level 1/trace.log");
04
 
05
 
06
    pSys.setIsVirtualDocument(true);
07
    pSys.save();
08
 
09
    IDfVirtualDocument vDoc = pSys.asVirtualDocument("CURRENT", false);
10
    IDfVirtualDocumentNode pNode = vDoc.getRootNode();
11
    pSys.checkout();
12
 
13
    IDfVirtualDocumentNode nodeChild1 = vDoc.addNode(pNode, null, cSys.getChronicleId(), "CURRENT", false, false);
14
    pSys.checkin(false, "CURRENT");
15
}

• To export a virtual document from docbase

view source
print?
01
public void exportVirtualDocument() throws Exception {
02
    System.out.println("exporting virtual document");
03
 
04
    IDfClientX clientx = new DfClientX();
05
    com.documentum.operations.IDfExportOperation expOperation = clientx.getExportOperation();
06
 
07
    IDfSysObject sysObject = (IDfSysObject) idfSession.getObjectByPath("/Training Cabinet XXX/Folder Level 2/log4j.properties");
08
    if (sysObject.isVirtualDocument()) {
09
        IDfVirtualDocument Vdoc = sysObject.asVirtualDocument("CURRENT", false);
10
        com.documentum.operations.IDfExportNode expNode = (com.documentum.operations.IDfExportNode) expOperation.add(sysObject);
11
        expOperation.setDestinationDirectory(expOperation.getDefaultDestinationDirectory());
12
        boolean flag = expOperation.execute();
13
        displayError(expOperation, flag);
14
    }
15
}

• To view virtual document from docbase

view source
print?
01
public void viewVirtualDocument() throws Exception {
02
    IDfSysObject pSys = (IDfSysObject) idfSession.getObjectByPath("/Training Cabinet XXX/Folder Level 2/log4j.properties");
03
    if (pSys.isVirtualDocument()) {
04
        System.out.println("virtual document –> true");
05
        IDfVirtualDocument vDoc = pSys.asVirtualDocument("CURRENT", false);
06
        IDfVirtualDocumentNode pNode = vDoc.getRootNode();
07
 
08
        System.out.println("Iterating thru the lis to get the child nodes");
09
        for (int i = 0; i < pNode.getChildCount(); i++) {
10
            IDfVirtualDocumentNode cNode = pNode.getChild(i);
11
            System.out.println("Child Name " + cNode.getSelectedObject().getObjectName());
12
        }
13
    }
14
}

---

——————— LIFECYCLE ————————–

---

• To attach a lifeCycle to a document in docbase

view source
print?
1
public void attachLC() throws Exception {
2
    IDfSysObject mDocs = (IDfSysObject) idfSession.getObjectByQualification("dm_document where object_name='UniqueDoc' ");
3
 
4
 
5
    IDfSysObject procObj = (IDfSysObject) idfSession.getObjectByQualification("dm_policy where object_name='Training_LC' ");
6
    mDocs.attachPolicy(procObj.getObjectId(), "Author", "");
7
}

• To promote a lifeCycle state of a document

view source
print?
1
public void promoteLC(String State) throws Exception {
2
    IDfSysObject mDocs = (IDfSysObject) idfSession.getObjectByQualification("dm_document where object_name='UniqueDoc' ");
3
    mDocs.promote(State, false, false);
4
}

• To demote a lifeCycle state of a document

view source
print?
1
public void demoteLC(String State) throws Exception {
2
    IDfSysObject mDocs = (IDfSysObject) idfSession.getObjectByQualification("dm_document where object_name='UniqueDoc' ");
3
    mDocs.demote(State, false);
4
}

• To expire a lifeCycle state of a document

view source
print?
1
public void expireLC(String State) throws Exception {
2
    IDfSysObject mDocs = (IDfSysObject) idfSession.getObjectByQualification("dm_document where object_name='UniqueDoc' ");
3
    mDocs.suspend(State, false, false);
4
}

• To resume a lifeCycle state of a document

view source
print?
1
public void resumeLC(String State) throws Exception {
2
    IDfSysObject mDocs = (IDfSysObject) idfSession.getObjectByQualification("dm_document where object_name='UniqueDoc' ");
3
    mDocs.resume(State, false, false, false);
4
}

---

——————— DOCUMENT PROPERTIES ————————–

---

• To modify a repeating properties (attributes) list
In some cases your client may need to make a specific change to a list of repeating properties (also called repeating attributes), such as appending values to the end of the list, inserting an item into the list, or removing an item from the list. To accomplish this you can add one or more ValueAction instances to the ArrayProperty. A ValueAction list is synchronized with the ArrayProperty that contains it, such that an item in position p in the ValueAction list corresponds to a value stored at position p of the ArrayProperty. In this example the first item in the ValueAction list (INSERT, 0) corresonds to the first item in the ArrayProperty (snakes). The index value (0) specifies a position in the repeating property of the repository object. Note that if you insert or delete items in a repeated properties list, the positions of items to the right of the alteration will be offset by 1 or -1. This will affect subsequent processing of the ValueAction list, which is processed from beginning to end. You must account for this effect when coding a ValueAction list, such as by ensuring that the repeating properties list is processed from right to left.

view source
print?
01
public DataPackage updateRepeatProperty(ObjectIdentity objectIdentity)
02
throws ServiceException
03
{
04
    PropertyProfile propertyProfile = new PropertyProfile();
05
    // Setting the filter to ALL can cause errors if the DataObject
06
    // passed to the operation contains system properties, so to be safe
07
    // set the filter to ALL_NON_SYSTEM unless you explicitly want to update
08
    // a system property
09
    propertyProfile.setFilterMode(PropertyFilterMode.ALL_NON_SYSTEM);
10
    serviceContext.setProfile(propertyProfile);
11
    DataObject dataObject = new DataObject(objectIdentity);
12
 
13
 
14
    String[] moreDangers = { "snakes", "sharks" };
15
    ArrayProperty keywordProperty = new StringArrayProperty("keywords", moreDangers);
16
 
17
    ValueAction insertAction = new ValueAction(ValueActionType.INSERT, 0);
18
    ValueAction appendAction = new ValueAction(ValueActionType.APPEND, 1);
19
    keywordProperty.setValueActions(insertAction, appendAction);
20
 
21
    PropertySet properties = new PropertySet();
22
    properties.set(keywordProperty);
23
    dataObject.setProperties(properties);
24
 
25
    OperationOptions operationOptions = null;
26
    return objectService.update(new DataPackage(dataObject), operationOptions);
27
}

---

——————— WORKFLOW / TASK ————————–

---

Some concepts about Workflows:

• Workflows may be likened to “programs” that treat collections of documents as data. Workflows describe business processes that dictate when (under what circumstances) information (represented by documents) is sent to whom (users and groups), and how documents of interest change state (represented by lifecycles) as they progress through a workflow.
• Package: A package is a collection of related documents, treated as a unit of information. A package is just a fancy way of talking about the document that is being routed around from person to person. It’s called a package because it can contain multiple documents instead of just a single document.
• Activity: A step that is performed as part of a workflow. A workflow will typically have multiple activities. Workflows have one or more start activities, one or more step activities and one end activity.
• Aliases: A named set of names that map onto defined users and groups. An alias is a user-friendly name representing users and groups.
• Ports: A port is logical point of information exchange in an activity. Ports exchange information via packages. A port may be an Input port (one that accepts packages for processing), an Output port (one that sends packages from this activity to the next), or a Revert port (one that accepts a package that is returned by the next activity).

• To create and start workflow

view source
print?
01
public void startWorkflow() throws Exception {
02
    // to get the attachment document
03
    IDfSysObject sysObj = (IDfSysObject) idfSession.getObjectByQualification("dm_document where object_name='DFCtest'");
04
 
05
    System.out.println(("Starting workflow for document: "+document.getObjectId().getId());
06
 
07
    // to get the Workflow Template
08
    IDfProcess process = (IDfProcess) idfSession.getObjectByQualification("dm_process where object_name like '%INDIA_TIMES%'");
09
 
10
    System.out.println("Process ID: "+process.getObjectId().getId());
11
 
12
    // to create a Workflo Builder to start a workflow
13
    IDfWorkflowBuilder builder = idfSession.newWorkflowBuilder(process.getObjectId());
14
    IDfId wfId = builder.initWorkflow(); // IDfId wfId = builder.runWorkflow();
15
 
16
    System.out.println(("Workflow ID: "+ wfId.getId());
17
 
18
    // get the First Activity
19
    IDfList startActivityNames = builder.getStartActivityNames();
20
    IDfList startActivities = builder.getStartActivityIds();
21
    String activityName = startActivityNames.getString(0);
22
    IDfId activityID = (IDfId) startActivities.get(0);
23
    IDfActivity activity = (IDfActivity) idfSession.getObject(activityID);
24
 
25
    // to get the Package Name , Port and Package DocType
26
    int nPorts = activity.getPortCount();
27
    String InputPortName = null;
28
    String PkgType = null;
29
    String PkgName = null;
30
 
31
    for (int j = 0; j < nPorts; j++) {
32
        System.out.println("Port Name: " + activity.getPortName(j) + ", " + "Port Type = " + activity.getPortType(j));
33
        if (activity.getPortType(j).equals("INPUT")) {
34
            InputPortName = activity.getPortName(j);
35
            PkgType = activity.getPackageType(j);
36
            PkgName = activity.getPackageName(j);
37
        }
38
    }
39
 
40
    // to Add the attachment document to List
41
    IDfList dfList = new DfList();
42
    dfList.append(sysObj.getObjectId());
43
 
44
    IDfId wfId2 = builder.runWorkflow();
45
    // Add a Package to Workflow Builder
46
    IDfId packageId = builder.addPackage(activityName, InputPortName, PkgName, PkgType, null, false, dfList);
47
 
48
    System.out.println("Package ID: "+packageId.getId());
49
}

• Getting a List of All the Installed Workflows.
->Workflow template must be “installed”, which means that all of its associated activities are all valid and installed.

view source
print?
01
// Get a list of all installed workflows!
02
System.out.println( "The following workflows are ready to run:-" );
03
IDfCollection Workflows = session.getRunnableProcesses("");
04
while ( Workflows.next() )
05
{
06
    IDfTypedObject Next = Workflows.getTypedObject();
07
 
08
    // The following chunk of code has to de with
09
    // obtaining the attributes of the
10
    // IDfTypedObject we got back!
11
 
12
    java.util.Enumeration e = Next.enumAttrs();
13
 
14
    while ( e.hasMoreElements() )
15
    {
16
        IDfAttr NextAttr = (IDfAttr)e.nextElement();
17
 
18
        System.out.print( NextAttr.getName() + " = " );
19
 
20
        int AttrCount = 0;
21
        if ( NextAttr.isRepeating() )
22
            AttrCount = Next.getValueCount
23
                             ( NextAttr.getName() );
24
        else
25
            AttrCount = 1;
26
 
27
        for (int i=0; i<AttrCount; i++)
28
        {
29
            // Get the next value!
30
            IDfValue NextAttrValue = Next.getRepeatingValue
31
                           ( NextAttr.getName(), i );
32
            System.out.print( NextAttrValue );
33
            System.out.print( ", " );
34
        }
35
    }
36
    System.out.println();
37
}

• To start a new instance of workflow via session object

view source
print?
01
private void startWorkflow(IDfSession session, IDfDocument document) throws DfException {
02
    logger.debug("Starting workflow for document: "+document.getObjectId().getId());
03
 
04
    IDfProcess process = (IDfProcess) session.getObjectByQualification("dm_process WHERE object_name = '"+ configGed.getDctmWkfName() +"'");
05
    logger.debug("Process ID: "+process.getObjectId().getId());
06
    IDfWorkflowBuilder builder = session.newWorkflowBuilder(process.getObjectId());
07
    builder.initWorkflow();
08
    IDfId workflowId = builder.runWorkflow();
09
    logger.debug("Workflow ID: "+workflowId.getId());
10
 
11
    //...
12
}

• To create a workflow instance via Workflow Builder object

view source
print?
01
IDfWorkflowBuilder  workflowBuilder = session.newWorkflowBuilder ( new DfId( "4b0f475b80002164" ) );
02
// Init the workflow!
03
IDfId NewWorkflowId = workflowBuilder.initWorkflow();
04
System.out.println( "Workflow initted! Id: " + NewWorkflowId );
05
 
06
// Start the workflow running!
07
IDfId NewWorkflowId2 = workflowBuilder.runWorkflow();
08
System.out.println( "Workflow started! Id: " + NewWorkflowId2 );
09
 
10
// You would add your package here if necessary
11
 
12
// Get the workflow object we created
13
IDfWorkflow workflow = workflowBuilder.getWorkflow();
14
 
15
/**
16
Most useful methods of IDfWorkflowBuilder:
17
- isRunnable() : Returns true if the dm_process is in the installed state
18
- getStartStatus() : Returns 0 if the user has permission to start the workflow
19
- initWorkflow() : This method actually does the work of creating a workflow from the business process
20
- runWorkflow() : This method starts a workflow
21
- getStartActivityNames() : Returns a list of the names of every start activity in the workflow
22
- addPackage() : This method adds a package to the start activity of the workflow
23
- getWorkflow() : Returns the run-time workflow object created by initWorkflow()
24
-   
25
 
26
Using the IDfWorkflowBuilder object to create and start a workflow is a multi-step process.
27
- You must first call the initWorkflow() method to create a dm_workflow object.
28
- You then call the runWorkflow() method to start the workflow. If the workflow is designed with a start activity that has no input ports, the activity will become active and appear in the recipient’s inbox. If the workflow is designed with a start activity that dows have an input port, the start activity will not become active until you attach a package to its input port. To do this, use the addPackage().
29
If you don’t know the name of the start activity or want to give the user a list of all the valid start activities to choose from, you can use the getStartActivityNames() method.
30
*/

• To version to a document via a workflow method :
Params
[0] = “METHOD”
[1] = “SAVE_RESULT”
[2] = “ARGUMENTS”

Types
[0] = “S”
[1] = “B”
[2] = “S”

Values
[0] = “VersioningMethod”
[1] = “F”
[2] = ‘-docbase_name MY_DOCBASE -method_trace_level 10 -orig_id ID_ORIG_XXXX -doc_id ID_VERSION_YYYYY’

view source
print?
01
private void addVersionToOriginal(IDfSession session, IDfDocument original, IDfDocument document) throws DfException {
02
        IDfCollection collection = null;
03
        try {
04
            IDfList params = new DfList();
05
            params.append("METHOD");
06
            params.append("SAVE_RESULT");
07
            params.append("ARGUMENTS");
08
 
09
            IDfList types = new DfList();
10
            types.append("S");
11
            types.append("B");
12
            types.append("S");
13
 
14
            StringBuilder sb = new StringBuilder(0);
15
            sb.append("'-docbase_name ").append(session.getDocbaseName());
16
            if (logger.isDebugEnabled()) {
17
                sb.append(" -method_trace_level 10");
18
            } else {
19
                sb.append(" -method_trace_level 0");
20
            }
21
 
22
            sb.append(" -orig_id ").append(original.getObjectId().getId());
23
            sb.append(" -doc_id ").append(document.getObjectId().getId());
24
            sb.append("'");
25
 
26
            System.out.println(sb.toString());
27
 
28
            IDfList values = new DfList();
29
            values.append("VersioningMethod");
30
            values.append("F");
31
            values.append(sb.toString());
32
 
33
            IDfAuditTrailManager mgr = session.getAuditTrailManager();
34
            mgr.createAudit(original.getObjectId(), "Calling VersioningMethod", null, null);
35
            collection = session.apply(null, "DO_METHOD", params, types, values);
36
            while (collection.next()) {
37
                if (collection.getBoolean("launch_failed")) {
38
                    throw new MyException("L'ajout de la version au document original a échoué!");
39
                }
40
            }
41
        } finally {
42
            if (collection != null){
43
                try{collection.close();}catch(Exception ex){logger.error(ex);}
44
            }
45
        }
46
    }

Packages and Activities
A workflow is made up of one or more activities – the tasks that are to be performed. Activities are assigned to certain users or groups and only become active when a package is delivered to one of the activity’s input ports. In a normal workflow, a user completes an activity and starts the next one by taking a package from the current activity’s output port and routing it to the next activity’s input port. This deactivates the current activity and activates the next one. The process of routing packages from one activity to the next is performed by the server.
An activity receives packages through its input port and sends packages through its output port. The input and output ports of different activities are linked together to create the workflow. To send a document from one person to another, you need two activities, A and B. The output port of A should be connected to the input port of B. This indicates who is sending the document and who is receiving it.
Once a package is attached to an activity, it does not need to be manually attached to all the subsequent activities. It will simply flow from one activity to the next without intervention. Any additional packages will have to be manually attached, but again, once they are attached they will flow as designed in the business process.
When you start a workflow, you must take the package being routed and manually attach it to the workflow’s start activity. A start activity is the entry point that allows us to “kick off” a workflow. Even though a workflow is started, its start activity won’t become active until you give it a package. A workflow can have multiple start activities, but often has only one. In the most common case, we will be routing a single document through the entire workflow. In this case, we’ll want to take a document attach it as a package to the workflow’s start activity.
The Workflow Builder’s addPackage() method. This method takes the following arguments:
– startActivityName: Name of the start activity to which you are attaching this package
– inputPortName : Name of the start activity’s input port
– packageName : Name of the package. Specify your own or use the name of the document you are attaching
– packageType : The object type of the components in the package
– noteText : A text message to attach to the package for the recipient
– notePersistent : A boolean indicating whether or not to show the note to all recipients of the package, anywhere in the workflow, or just the first recipient of the package.
– componentIds : A list of all the objects you are including in this package

-> When the attachment is accepted by the activity, the activity will become active and place a work item in the user’s inbox.
 

• To attach a package to a workflow after it is has been started via WorkflowBuilder object
The steps shown are:
– Get the Names and IDs of the workflow’s start activities
– Select the first start activity and determine the name of its first input port (in a real application, you would probably ask the user which start activity to use)
– Attach a package to the activity using a hard-coded object ID (in a real application you would probably ask the user what document to attach)

view source
print?
01
// Get lists of the start activity Names and IDs
02
IDfList StartActivityNames = workflowBuilder.getStartActivityNames();
03
IDfList StartActivities = workflowBuilder.getStartActivityIds();
04
 
05
// Get the first start activity's Name
06
String ActivityName = StartActivityNames.getString(i);
07
 
08
// Get the first start activity ID
09
IDfId ActivityId = (IDfId)StartActivities.get(i);
10
// Construct an IDfActivity from the start activity ID
11
IDfActivity TheActivity = (IDfActivity)session.getObject( ActivityId );
12
 
13
// Get the number of ports and loop through them until you find an input port
14
int nPorts = TheActivity.getPortCount();
15
 
16
String InputPortName = null;
17
for (int j=0; j<nPorts; j++){
18
    System.out.println( "Port Name: " + TheActivity.getPortName(j) + ", " + "Port Type = " + TheActivity.getPortType(j) );
19
    if ( TheActivity.getPortType(j).equals( "INPUT" ) )
20
        InputPortName = TheActivity.getPortName(j);
21
}
22
 
23
// With AnActivity and InputPort, we can now attach a package
24
// First create a list of components (even though we only have one component)
25
 
26
DfList List = new DfList();
27
List.append( new DfId( "090f475b80000140" ) );
28
 
29
IDfId PackageId = w.addPackage(
30
        AnActivityName,
31
        InputPort,
32
        "Package Name",
33
        "dm_document",
34
        "This is a message to the first recipient",
35
        false,
36
        List );
37
 
38
System.out.println( "The id of the newly created package is: " +PackageId );
39
 
40
// Now that we have "delivered" a package to a start activity
41
// of the workflow, this activity will be started

• To attach a package to a workflow after it is has been started via session object

view source
print?
01
logger.debug("Starting workflow for document: "+document.getObjectId().getId());
02
 
03
IDfProcess process = (IDfProcess) session.getObjectByQualification("dm_process WHERE object_name = '"+ configGed.getDctmWkfName() +"'");
04
logger.debug("Process ID: "+process.getObjectId().getId());
05
IDfWorkflowBuilder builder = session.newWorkflowBuilder(process.getObjectId());
06
builder.initWorkflow();
07
IDfId workflowId = builder.runWorkflow();
08
logger.debug("Workflow ID: "+workflowId.getId());
09
 
10
String activityName = builder.getStartActivityNames().getString(0);
11
IDfList list = new DfList();
12
list.append(document.getObjectId());
13
IDfId packageId = builder.addPackage(activityName, "Input:0", "Attachment", DCTM_TYPE_DOC, null, false, list);
14
logger.debug("Package ID: "+packageId.getId());

Inbox Processing
When an activity becomes active, it usually results in a work item being queued up in someone’s inbox. This inbox is a Documentum-specific inbox, not your email inbox. The inbox contains a list of work items that have been forwarded to the user as well as a list of event notifications. Work items are generally workflow-related while event notifications are simply information messages generated by the server.

A user’s inbox is really just a list of the dmi_queue_item objects that are associated with that user. Documentum has created a view that you can query against that makes it easy to see what items are in a particular user’s inbox.

The difference between dmi_queue_item and dm_queue is simple:

• dmi_queue_item is the object instance associated with a task assigned to a user/person
• dm_queue is a view in multiple tables associated with task

 
DFC provides some methods that are useful for manipulating your inbox.
– IDfSession.getEvents() : Returns a collection of unread items in the current user’s inbox. This isn’t as useful as it sounds since most users will want to see all the items in their inbox, not just the unread ones. It’s best to call IDfSession.getEvents() to get a list of all the items in a user’s inbox.
– IDfSession.hasEvents() : Returns true if there are any new items in the user’s inbox since the last time you called hasEvents().
– IDfSession.getTasks() : Returns a collection of all the items in a user’s inbox. Use the DF_TASKS filter to get only workflow-related tasks. The getTasks() method only retrieves these attributes: sent_by, date_sent, task_name, due_date, priority, task_state, r_object_id, item_id. The item_id is the r_object_id of dm_sysobject/dm_document. If you want to get other attributes such as the name of the document, you must specify them in the additionalAttributes argument.
– IDfWorkItem.acquire() : Acquires the task/work item. Acquiring a work item indicates that you intend to work on it. If the task was routed to a group, acquiring the task will cause it to disappear from the other group members’ inboxes.
– IDfWorkItem.complete() : Tells the server that you are finished working on the work item. This will cause the task to be forwareded to the next person in the workflow.
– IDfWorkItem.delegateTask() : Delegates the work item to someone else.
In a production application, processing an inbox would probably be a manual process. A user would view the contents of his inbox and select an item to work on. He would acquire the work item to show that he was working on it and would probably need to view or checkout the document attached to the work item. When he finished modifying the document, he would mark the work item as completed and it would be removed from his inbox. If he refreshed his inbox, he would see that the work item was no longer there.
 

• Create a item / task in inbox

view source
print?
1
public IDfId createQueueItem(IDfSysObject dfSysObject) throws DfException {
2
    try {
3
        // dfSysObject.queue(getUserName(), getEventName(), getPriority(), isSendMail(), getDueDate(), getMessage());
4
        return dfSysObject.queue("myitemname", "myeventname", 0, false, new DfTime(GregorianCalendar.getInstance().getTime()), "my message");
5
    } catch (DfException e) {
6
        logger.log(Level.WARNING, MessageFormat.format("Unable to create dmi_queue_item for item {0} : {1}", dfSysObject.getObjectId(), e.getMessage()), e);
7
    }
8
    return DfId.DF_NULLID;
9
}

• To view task in inbox – example 1

view source
print?
01
public void getInbox() throws Exception {
02
    IDfCollection tasks = idfSession.getTasks("temp", IDfSession.DF_TASKS, "name, date_sent, message ", "task_name");
03
    try {
04
        while (tasks.next()) {
05
            IDfWorkitem wi = (IDfWorkitem) idfSession.getObject(tasks.getId("item_id"));
06
            IDfId queueItemId = wi.getQueueItemId();
07
            IDfQueueItem qi = (IDfQueueItem) idfSession.getObject(queueItemId);
08
            System.out.println(tasks.getString("sent_by") + "   "
09
                + tasks.getString("task_name") + "   "
10
                + tasks.getString("date_sent") + "   "
11
                + tasks.getString("message") + "   "
12
                + qi.getItemName());
13
 
14
            IDfActivity dfActivity = wi.getActivity();
15
            System.out.println("\tActivity Information : " + dfActivity.getString("object_name"));
16
            IDfCollection packColl = null;
17
            try {
18
                packColl = wi.getPackages("");
19
                while (packColl.next()) {
20
                    IDfSysObject sysObj = (IDfSysObject) idfSession.getObject(packColl.getId("r_component_id"));
21
                    System.out.println("\t Package Information: " + sysObj.getString("object_name"));
22
                }
23
            } finally {
24
                if (packColl != null)
25
                    packColl.close();
26
            }
27
            // to finish a Task or Workitem
28
            // finishTask(wi);
29
        }
30
    } finally {
31
        if (tasks != null)
32
            tasks.close();
33
    }
34
}
35
 
36
public void finishTask(IDfWorkitem wi) throws Exception {
37
    if (wi.getRuntimeState() == IDfWorkflow.DF_WF_STATE_DORMANT) {
38
        wi.acquire();
39
    }
40
    wi.complete();
41
}

• To view task in inbox – example 2
The following example shows how to query the docbase for the contents of the current user’s inbox. It will print the name of the document, the r_object_id of the document (needed if the user is going to view or check out the document), the person who sent the document and that date/time it was sent, the work item’s ID (needed for the user to aquire and complete the work item), the name of the task, the due date requested by the sender, and the message sent by the sender.

view source
print?
01
// Use getTasks to get all the tasks in the user's inbox
02
// Use the DF_TASKS filter so that we don't get any event notifications
03
// Specify these addtionalAttributes: item_name, due_date, message
04
// Order the results by the date_sent
05
IDfCollection Tasks = d.getTasks( "/articles/dmin", IDfSession.DF_TASKS,  "item_name, due_date, message", "date_sent" );
06
    while ( Tasks.next() )
07
    {
08
        IDfTypedObject Next = Tasks.getTypedObject();
09
 
10
        java.util.Enumeration e = Next.enumAttrs();
11
 
12
        while ( e.hasMoreElements() )
13
        {
14
            IDfAttr NextAttr = (IDfAttr)e.nextElement();
15
 
16
            System.out.print( NextAttr.getName() + " = " );
17
 
18
            int AttrCount = 0;
19
            if ( NextAttr.isRepeating() )
20
                AttrCount = Next.getValueCount(
21
                    NextAttr.getName() );
22
            else
23
                AttrCount = 1;
24
 
25
            for (int i=0; i<AttrCount; i++)
26
            {
27
                // Get the next value!
28
                IDfValue NextAttrValue = Next.getRepeatingValue( NextAttr.getName(), i );
29
                System.out.print( NextAttrValue );
30
                System.out.print( ", " );
31
            }
32
        }
33
        System.out.println();
34
    }
35
}

• To get the TASK linked to a document
The following example shows how to query the docbase for the contents of the current user’s inbox. It will print the name of the document, the r_object_id of the document (needed if the user is going to view or check out the document), the person who sent the document and that date/time it was sent, the work item’s ID (needed for the user to aquire and complete the work item), the name of the task, the due date requested by the sender, and the message sent by the sender.

view source
print?
1
private IDfWorkitem getTask(IDfSession session, String documentId) throws DfException {
2
    StringBuilder sb = new StringBuilder(0);
3
    sb.append("dmi_workitem WHERE ")
4
        .append("r_queue_item_id IN (SELECT r_object_id FROM dmi_queue_item WHERE delete_flag = FALSE) AND ")
5
        .append("r_workflow_id IN (SELECT DISTINCT r_workflow_id FROM dmi_package WHERE ")
6
        .append("ANY r_component_chron_id = '").append(documentId).append("')");
7
    logger.debug("Workitem query: "+sb.toString());
8
    return (IDfWorkitem) session.getObjectByQualification(sb.toString());
9
}

• To acquire work items
This example assumes that you know the r_object_id of the work item (which you would have retrieved from the previous example). It shows how to acquire the work item.

view source
print?
01
IDfPersistentObject pObj = sess.getObjectByQualification("dmi_queue_item where r_object_id='" + TaskId.toString() + "'");
02
 
03
// Make sure the task(s) for this user are associated with the workflow
04
if (pObj.getId("router_id").toString().equals( wfId.getId() ))
05
{
06
    IDfWorkitem wi = (IDfWorkitem)d.getObject(tasks.getId("item_id"));
07
    wi.acquire();
08
    // Do some processing on the work item here
09
    // ...
10
}

• To accept a task

view source
print?
1
private void lockTask(IDfWorkitem wi) throws DfException {
2
    if (wi.getRuntimeState() == IDfWorkitem.DF_WI_STATE_DORMANT) {
3
        wi.acquire();
4
        logger.debug("Acquiring task: "+wi.getObjectId().getId());
5
    }
6
}

• To complete work items – example 1
This example assumes that you know the r_object_id of the work item (which you would have retrieved from the previous example). It shows how to complete the work item, which will remove it from the users inbox and forward it to the next user in the workflow.

view source
print?
1
IDfPersistentObject pObj = sess.getObjectByQualification("dmi_queue_item where r_object_id='" + TaskId.toString() + "'");
2
// Make sure the task(s) for this user are associated with the workflow
3
if (pObj.getId("router_id").toString().equals( wfId.getId() ))
4
{
5
    IDfWorkitem wi = (IDfWorkitem)d.getObject(tasks.getId("item_id"));
6
    // Acquire the work item here.
7
    // Done some processing on the work item: ready to complete
8
    wi.complete();
9
}

• To complete work items – example 2

view source
print?
01
private void completeTask(IDfWorkitem wi, String activityName) throws DfException {
02
    if (wi.getRuntimeState() == IDfWorkitem.DF_WI_STATE_DORMANT)
03
        lockTask(wi);
04
 
05
    IDfList activities = wi.getForwardActivities();
06
    int count = activities.getCount();
07
    if (count > 1) {
08
        IDfList list = new DfList();
09
        for (int i = 0; i < count; i++) {
10
            IDfActivity activity = (IDfActivity) activities.get(i);
11
            if (activity.getObjectName().equals(activityName)) {
12
                list.append(activity);
13
                break;
14
            }
15
        }
16
        wi.setOutputByActivities(list);
17
    }
18
    wi.complete();
19
    logger.debug("Completing task: "+wi.getObjectId().getId());
20
}

• To reject a task
The following example shows how to query the docbase for the contents of the current user’s inbox. It will print the name of the document, the r_object_id of the document (needed if the user is going to view or check out the document), the person who sent the document and that date/time it was sent, the work item’s ID (needed for the user to aquire and complete the work item), the name of the task, the due date requested by the sender, and the message sent by the sender.

view source
print?
01
private void rejectTask(IDfWorkitem wi) throws DfException {
02
    if (wi.getRuntimeState() == IDfWorkitem.DF_WI_STATE_DORMANT)
03
        lockTask(wi);
04
 
05
    IDfList activities = wi.getRejectActivities();
06
    IDfList list = new DfList();
07
    list.append(activities.get(0));
08
    wi.setOutputByActivities(list);
09
    wi.complete();
10
    logger.debug("Rejecting task: "+wi.getObjectId().getId());
11
}

• To forward the workflow via method server

view source
print?
01
IDfWorkitem wi = getWorkitem();
02
IDfDocument document = getDocument();
03
 
04
//...
05
 
06
String activity = (String) wi.getNextActivityNames().get(0);
07
IDfList performers = new DfList();
08
String performer = getGroupForService(document.getInt(ATTR_DESTINATION_SERVICE));
09
performers.append(performer);
10
IDfWorkflow workflow = (IDfWorkflow) getSession().getObject(wi.getWorkflowId());
11
workflow.setPerformers(activity, performers);
12
IDfAuditTrailManager mgr = getSession().getAuditTrailManager();
13
mgr.createAudit(document.getObjectId(), "Executing WorkflowMethod", null, null);

• To give access without use of ACL (read right to sender and write right to recipient)

view source
print?
01
IDfDocument document = ...;
02
String sender = getGroupForService(document.getInt(ATTR_SEND_SERVICE));
03
printLogDctmServerMethodServer("Sending service: "+sender+" for document: "+document.getObjectId().getId()+" ("+document.getString(ATTR_REFERENCE)+","+document.getString(ATTR_VERSION_LABEL)+") ");
04
if (sender != null) {
05
    document.revoke(sender, null);
06
    document.grant(sender, IDfACL.DF_PERMIT_READ, null);
07
    printLogDctmServerMethodServer("Revoke permission and add read permission to service: "+sender+" for document: "+document.getObjectId().getId()+" ("+document.getString(ATTR_REFERENCE)+","+document.getString(ATTR_VERSION_LABEL)+") ");
08
}
09
 
10
String performer = getGroupForService(document.getInt(ATTR_DESTINATION_SERVICE));
11
printLogDctmServerMethodServer("Grant write permit to Destination service: "+performer+" for document: "+document.getObjectId().getId()+" ("+document.getString(ATTR_REFERENCE)+","+document.getString(ATTR_VERSION_LABEL)+") ");
12
document.grant(performer, IDfACL.DF_PERMIT_WRITE, null);

---

——————— LINKING ————————–

---

• For all others versions of a document in argument, this method :
– Removes all links
– Adds the same links than the document in argument.
If a version has already the same links, no change is applied.

view source
print?
01
private void linkOtherVersionsToSameLinks(IDfDocument document) throws DfException {
02
    IDfSession session = document.getSession();
03
 
04
 
05
    // Get all links from the document
06
    Set<String> links = new HashSet<String>();
07
    int count = document.getFolderIdCount();
08
    for (int i = 0; i < count; i++) {
09
        links.add(document.getFolderId(i).getId());
10
    }
11
 
12
    // Get other versions document
13
    StringBuilder sb = new StringBuilder();
14
    String documentId = document.getObjectId().getId();
15
    String chronicleId = document.getChronicleId().getId();
16
    sb.append("SELECT r_object_id FROM my_custom_document (all) WHERE i_chronicle_id = '")
17
        .append(chronicleId).append("' and r_object_id != '").append(documentId).append("'");
18
    IDfCollection coll = null;
19
    List<String> otherVersionsIds = new ArrayList<String>();
20
    try {
21
        IDfQuery query = new DfQuery(sb.toString());
22
        coll = query.execute(session, DfQuery.DF_QUERY);
23
        while (coll.next()) {
24
            String objectId = coll.getString("r_object_id");
25
            otherVersionsIds.add(objectId);
26
        }
27
    } finally {
28
        if (null != coll) {
29
            try {
30
                coll.close();
31
            } catch(DfException e) {
32
                LOGGER.warn("Warning, can't close the DfCollection", e);
33
            }
34
        }
35
    }
36
 
37
    for (String otherVersionId : otherVersionsIds) {
38
        IDfDocument otherVersionDocument = (IDfDocument) session.getObject(new DfId(otherVersionId));
39
 
40
        // Get all links from the other version
41
        Set<String> linksOtherVersion = new HashSet<String>();
42
        int otherVersionCount = otherVersionDocument.getFolderIdCount();
43
        for (int i = 0; i < otherVersionCount; i++) {
44
            linksOtherVersion.add(otherVersionDocument.getFolderId(i).getId());
45
        }
46
 
47
        // Check if the other versions need to be updated with the links
48
        if (links.size() == linksOtherVersion.size() && links.containsAll(linksOtherVersion)) {
49
            continue;
50
        }
51
 
52
        // Unlink other links
53
        for (String link : linksOtherVersion) {
54
            otherVersionDocument.unlink(link);
55
        }
56
 
57
        // Link to new links
58
        for (String link : links) {
59
            otherVersionDocument.link(link);
60
        }
61
 
62
        otherVersionDocument.save();
63
    }
64
}

---

——————— ACL ————————–

---

• Creation of ACL

view source
print?
001
package com.huo.test.ecm.test3;
002
 
003
 
004
import java.text.MessageFormat;
005
 
006
import com.documentum.fc.client.DfClient;
007
import com.documentum.fc.client.IDfACL;
008
import com.documentum.fc.client.IDfClient;
009
import com.documentum.fc.client.IDfPermit;
010
import com.documentum.fc.client.IDfPermitType;
011
import com.documentum.fc.client.IDfSession;
012
import com.documentum.fc.client.IDfSessionManager;
013
import com.documentum.fc.client.IDfSysObject;
014
import com.documentum.fc.common.DfLoginInfo;
015
import com.documentum.fc.common.IDfList;
016
import com.documentum.fc.common.IDfLoginInfo;
017
 
018
/**
019
 Documentum DFC - ACL
020
 */
021
public class DfcCreationUpdateACLTest {
022
    IDfSysObject sysObject = null;
023
    IDfSession idfSession = null;
024
    IDfSessionManager sessMgr = null;
025
 
026
    public DfcCreationUpdateACLTest(String user, String passwd, String docbase) throws Exception {
027
        getDfSession(user, passwd, docbase);
028
    }
029
 
030
    public IDfSession getDfSession(String args1, String args2, String args3) throws Exception {
031
        IDfLoginInfo login = new DfLoginInfo();
032
        login.setUser(args1);
033
        login.setPassword(args2);
034
        IDfClient client = DfClient.getLocalClient(); // new DfClient();
035
        sessMgr = client.newSessionManager();
036
        sessMgr.setIdentity(args3, login);
037
        idfSession = sessMgr.getSession(args3);
038
 
039
        if (idfSession != null)
040
            System.out.println("Session created successfully");
041
 
042
        return idfSession;
043
    }
044
 
045
    public void releaseSession() throws Exception {
046
        sessMgr.release(idfSession);
047
    }
048
 
049
    public static void main(String[] args) throws Exception {
050
        long startTime = 0;
051
        long stopTime = 0;
052
 
053
        String user = "mysuperuser";
054
        String passwd = "pwd4superuser";
055
        String docbase = "MY_DOCBASE_DEV";
056
        String aclName = "TEST ACL HUO World Write";
057
        String aclDomain = "MYDOCBASEDEV"; // docbase owner : select owner_name from dm_docbase_config;
058
        DfcCreationUpdateACLTest object = new DfcCreationUpdateACLTest(user, passwd, docbase);
059
 
060
        boolean isTransactionalSession = false;
061
        boolean noErrorWithCurrentDocument = false;
062
        try {
063
            if (!object.idfSession.isTransactionActive()) {
064
                object.idfSession.beginTrans();
065
                isTransactionalSession = true;
066
            }
067
 
068
            startTime = System.currentTimeMillis();
069
 
070
            IDfACL dfACL = object.idfSession.getACL(aclDomain, aclName);
071
            if (dfACL == null) {
072
                dfACL = (IDfACL) object.idfSession.newObject("dm_acl");
073
                dfACL.setObjectName(aclName);
074
                dfACL.setDomain(aclDomain);
075
                dfACL.setACLClass(0); // User ACL
076
                dfACL.setDescription("ACL test created via DFC");
077
                dfACL.save();
078
            }
079
 
080
            String message = MessageFormat.format("acl({0}, {1}) was successfully ", aclDomain, aclName) + ((dfACL.isNew()) ? "created." : "modified.");
081
            System.out.println(message);
082
 
083
            stopTime = System.currentTimeMillis();
084
 
085
            noErrorWithCurrentDocument = true;
086
 
087
        } finally {
088
            if(object!=null){
089
                if (isTransactionalSession) {
090
                    if (noErrorWithCurrentDocument) {
091
                        object.idfSession.commitTrans();
092
                    } else {
093
                        object.idfSession.abortTrans();
094
                    }
095
                }
096
 
097
                // to release a docbase session
098
                object.releaseSession();
099
 
100
                long elapsedTime = stopTime - startTime;
101
                System.out.println(MessageFormat.format("Execute() total execution time : {0} ms ", elapsedTime));
102
            }
103
        }
104
    }
105
}
106
 
107
/**
108
... the created ACL will be the following accessors:
109
r_accessor_name
110
[0]: dm_world
111
[1]: dm_owner
112
 
113
r_accessor_permit
114
[0]: 1 (for None)
115
[1]: 1 (for None)
116
 
117
r_accessor_xpermit
118
[0]: 0 (for execute_proc, change_location)
119
[1]: 0 (for execute_proc, change_location)
120
 
121
r_permit_type
122
[0]: 0 (for ACCESS_PERMIT)
123
[1]: 0 (for ACCESS_PERMIT)
124
*/

• Add new accessors to previous ACL

view source
print?
01
IDfACL dfACL = object.idfSession.getACL(aclDomain, aclName);
02
dfACL.grantPermit(new IDfPermit() {
03
    @Override
04
    public String getAccessorName() { return "mysuperuser"; }
05
    @Override
06
    public int getPermitType() { return IDfPermitType.ACCESS_PERMIT; }
07
    @Override
08
    public int getPermitValueInt() { return IDfACL.DF_PERMIT_DELETE; }
09
    @Override
10
    public String getPermitValueString() { return IDfACL.DF_PERMIT_DELETE_STR; }
11
    @Override
12
    public void setAccessorName(String arg0) { throw new RuntimeException("Not implemented"); }
13
    @Override
14
    public void setPermitType(int arg0) { throw new RuntimeException("Not implemented"); }
15
    @Override
16
    public void setPermitTypeString(String arg0) { throw new RuntimeException("Not implemented"); }
17
    @Override
18
    public void setPermitValue(String arg0) { throw new RuntimeException("Not implemented");}
19
});
20
dfACL.grantPermit(new IDfPermit() {
21
    @Override
22
    public String getAccessorName() { return "myuser001"; }
23
    @Override
24
    public int getPermitType() { return IDfPermitType.ACCESS_RESTRICTION; }
25
    @Override
26
    public int getPermitValueInt() { return IDfACL.DF_PERMIT_VERSION; }
27
    @Override
28
    public String getPermitValueString() { return IDfACL.DF_PERMIT_VERSION_STR; }
29
    @Override
30
    public void setAccessorName(String arg0) { throw new RuntimeException("Not implemented"); }
31
    @Override
32
    public void setPermitType(int arg0) { throw new RuntimeException("Not implemented"); }
33
    @Override
34
    public void setPermitTypeString(String arg0) { throw new RuntimeException("Not implemented"); }
35
    @Override
36
    public void setPermitValue(String arg0) { throw new RuntimeException("Not implemented");}
37
});
38
 
39
dfACL.save();
40
 
41
/**
42
... so, the ACL will be modified like:
43
r_accessor_name
44
[0]: dm_world
45
[1]: dm_owner
46
[2]: mysuperuser --- inserted ---
47
[3]: myuser001  --- inserted ---
48
 
49
r_accessor_permit
50
[0]: 1 (for None)
51
[1]: 1 (for None)
52
[2]: 7 (for Delete) --- inserted ---
53
[3]: 5 (for Version) --- inserted ---
54
 
55
r_accessor_xpermit
56
[0]: 0 (for execute_proc, change_location)
57
[1]: 0 (for execute_proc, change_location)
58
[2]: 0 (for execute_proc, change_location) --- inserted ---
59
[3]: 0 (for execute_proc, change_location) --- inserted ---
60
 
61
r_permit_type
62
[0]: 0 (for ACCESS_PERMIT)
63
[1]: 0 (for ACCESS_PERMIT)
64
[2]: 0 (for ACCESS_PERMIT) --- inserted ---
65
[3]: 3 (for ACCESS_RESTRICTION) --- inserted ---
66
*/

• Rewoke all current permits/xpermits to previous ACL via DFC
Warning : the “dm_world” and “dm_owner” accessors can not be removed totally => so, these accessors have always entries even if without permissions and extended permissions.

view source
print?
01
IDfACL dfACL = object.idfSession.getACL(aclDomain, aclName);
02
IDfList list;
03
while (0 < (list = dfACL.getPermissions()).getCount()) {
04
    dfACL.revokePermit((IDfPermit) list.get(0));
05
}
06
dfACL.save();
07
 
08
/**
09
... so, the ACL will be modified like:
10
r_accessor_name
11
[0]: dm_world
12
[1]: dm_owner
13
 
14
r_accessor_permit
15
[0]: 0 (for NULL) --- modified ---
16
[1]: 0 (for NULL) --- modified ---
17
 
18
r_accessor_xpermit
19
[0]: 3 (for None) --- modified ---
20
[1]: 3 (for None) --- modified ---
21
 
22
r_permit_type
23
[0]: 0 (for ACCESS_PERMIT)
24
[1]: 0 (for ACCESS_PERMIT)
25
*/

• To assign a ACL to a document

view source
print?
1
public void assignACL() throws Exception {
2
    IDfSysObject mDocs = (IDfSysObject) idfSession.getObjectByQualification("dm_document where object_name='UniqueDoc' ");
3
    IDfACL dfACL = (IDfACL) idfSession.getObjectByQualification("dm_acl where object_name='TrainingACL' ");
4
    mDocs.setACL(dfACL);
5
    mDocs.save();
6
}

---

——————— ALIAS SET / TEMPLATE ACL (PERMISSION SET TEMPLATE) ————————–

---

• Creation of Alias Set (dm_alias_set)

view source
print?
01
private boolean setAliasSetValue(IDfAliasSet aliasSet, String aliasName, String aliasValue, int aliasCategory, String aliasDescription) throws DfException {
02
    int index;
03
    if ((index = aliasSet.findAliasIndex(aliasName)) >= 0) {
04
        if (!aliasValue.equals(aliasSet.getAliasValue(index))) {
05
            System.out.println("Alias set " + aliasSet.getObjectName() + " : modified " + aliasName + " '" + aliasSet.getAliasValue(index) + "' => '" + aliasValue + "'");
06
            aliasSet.setAliasValue(index, aliasValue);
07
            System.out.println("Alias set " + aliasSet.getObjectName() + " : modified " + aliasDescription + " '" + aliasSet.getAliasDescription(index) + "' => '" + aliasDescription + "'");
08
            aliasSet.setAliasDescription(index, aliasDescription);
09
            return true;
10
        }
11
    } else {
12
        aliasSet.appendAlias(aliasName, aliasValue, aliasCategory, -1, aliasDescription);
13
        System.out.println("Alias set " + aliasSet.getObjectName() + " : added '" + aliasName + "', '" + aliasValue + "', '" + aliasDescription + "'");
14
        return true;
15
    }
16
    return false;
17
}
18
 
19
 
20
String aliasSetName = "TEST AS HUO Simple";
21
IDfAliasSet aliasSet = (IDfAliasSet) object.idfSession.getObjectByQualification("dm_alias_set where object_name ='" + aliasSetName + "'");
22
if (aliasSet == null) {
23
    aliasSet = (IDfAliasSet) object.idfSession.newObject("dm_alias_set");
24
    aliasSet.setObjectName(aliasSetName);
25
    aliasSet.setOwnerName("dm_dbo");
26
    aliasSet.setObjectDescription("Desc 4 TEST AS HUO Simple");
27
 
28
    //# ALIAS 1 : GROUP
29
    object.setAliasSetValue(aliasSet, "AS4MyGroup", "huo_grp_all_users", 2, "Entry for a group alias (huo_grp_all_users)");
30
 
31
    //# ALIAS 2 : USER
32
    object.setAliasSetValue(aliasSet, "AS4SuperUser", "myuser001", 1, "Entry for a user alias (myuser001)");
33
 
34
    aliasSet.save();
35
}
36
 
37
/**
38
USER ATTRIBUTES
39
    owner_name                 : dm_dbo
40
    object_name                : TEST AS HUO Simple
41
    object_description         : Desc 4 TEST AS HUO Simple
42
    alias_name              [0]: AS4MyGroup
43
                [1]: AS4SuperUser
44
    alias_value             [0]: huo_grp_all_users
45
                [1]: myuser001
46
    alias_category          [0]: 2
47
                [1]: 1
48
    alias_usr_category      [0]: -1
49
                [1]: -1
50
    alias_description       [0]: Entry for a group alias (huo_grp_all_users)
51
                [1]: Entry for a user alias (myuser001)
52
SYSTEM ATTRIBUTES
53
    r_object_id                : 660xxxxxxx90c
54
*/

Concerning the the category (alias_category ) for the alias in the specified index position in the alias set. This value is set by the creator of the alias object and used by Documentum client applications. The server does not verify the category value against the alias value to ensure that alias value is in the specified category.
Currently, only the following values are allowed:

• 0 (Unknown)
• 1 (User, alias_value is a user)
• 2 (Group, alias_value is a group)
• 3 (User or Group, alias_value is either a user or a group)
• 4 (Cabinet Path, alias_value is a cabinet path)
• 5 (Folder Path, alias_value is a folder path)
• 6 (ACL Name, alias_value is an ACL name)

• Creation of Template ACLs or Permission Set Template (acl_class=1)

view source
print?
001
String aclTemplateName = "TEST PST HUO Simple";
002
String aclTemplateDomain = "MYDOCBASEDEV"; // docbase owner : select owner_name from dm_docbase_config;
003
IDfACL dfTemplateACL = object.idfSession.getACL(aclTemplateDomain, aclTemplateName);
004
if (dfTemplateACL == null) {
005
    dfTemplateACL = (IDfACL) object.idfSession.newObject("dm_acl");
006
    dfTemplateACL.setObjectName(aclTemplateName);
007
    dfTemplateACL.setDomain(aclTemplateDomain);
008
    dfTemplateACL.setACLClass(1); // PST
009
        dfTemplateACL.setDescription("Desc 4 TEST PST HUO Simple");
010
 
011
    // grant,c,l,dm_world,AccessPermit,,3
012
    dfTemplateACL.grantPermit(new IDfPermit() {
013
        @Override
014
        public String getAccessorName() { return "dm_world"; }
015
        @Override
016
        public int getPermitType() { return IDfPermitType.ACCESS_PERMIT; }
017
        @Override
018
        public int getPermitValueInt() { return IDfACL.DF_PERMIT_READ; }
019
        @Override
020
        public String getPermitValueString() { return IDfACL.DF_PERMIT_READ_STR; }
021
        @Override
022
        public void setAccessorName(String arg0) { throw new RuntimeException("Not implemented"); }
023
        @Override
024
        public void setPermitType(int arg0) { throw new RuntimeException("Not implemented"); }
025
        @Override
026
        public void setPermitTypeString(String arg0) { throw new RuntimeException("Not implemented"); }
027
        @Override
028
        public void setPermitValue(String arg0) { throw new RuntimeException("Not implemented");}
029
    });
030
 
031
    // grant,c,l,dm_owner,AccessPermit,,3
032
    dfTemplateACL.grantPermit(new IDfPermit() {
033
        @Override
034
        public String getAccessorName() { return "dm_owner"; }
035
        @Override
036
        public int getPermitType() { return IDfPermitType.ACCESS_PERMIT; }
037
        @Override
038
        public int getPermitValueInt() { return IDfACL.DF_PERMIT_READ; }
039
        @Override
040
        public String getPermitValueString() { return IDfACL.DF_PERMIT_READ_STR; }
041
        @Override
042
        public void setAccessorName(String arg0) { throw new RuntimeException("Not implemented"); }
043
        @Override
044
        public void setPermitType(int arg0) { throw new RuntimeException("Not implemented"); }
045
        @Override
046
        public void setPermitTypeString(String arg0) { throw new RuntimeException("Not implemented"); }
047
        @Override
048
        public void setPermitValue(String arg0) { throw new RuntimeException("Not implemented");}
049
    });
050
 
051
    // grant,c,l,%AS4MyGroup,AccessPermit,,6
052
    dfTemplateACL.grantPermit(new IDfPermit() {
053
        @Override
054
        public String getAccessorName() { return "%AS4MyGroup"; }
055
        @Override
056
        public int getPermitType() { return IDfPermitType.ACCESS_PERMIT; }
057
        @Override
058
        public int getPermitValueInt() { return IDfACL.DF_PERMIT_WRITE; }
059
        @Override
060
        public String getPermitValueString() { return IDfACL.DF_PERMIT_WRITE_STR; }
061
        @Override
062
        public void setAccessorName(String arg0) { throw new RuntimeException("Not implemented"); }
063
        @Override
064
        public void setPermitType(int arg0) { throw new RuntimeException("Not implemented"); }
065
        @Override
066
        public void setPermitTypeString(String arg0) { throw new RuntimeException("Not implemented"); }
067
        @Override
068
        public void setPermitValue(String arg0) { throw new RuntimeException("Not implemented");}
069
    });
070
 
071
    // grant,c,l,%AS4SuperUser,AccessPermit,,7
072
    dfTemplateACL.grantPermit(new IDfPermit() {
073
        @Override
074
        public String getAccessorName() { return "%AS4SuperUser"; }
075
        @Override
076
        public int getPermitType() { return IDfPermitType.ACCESS_PERMIT; }
077
        @Override
078
        public int getPermitValueInt() { return IDfACL.DF_PERMIT_DELETE; }
079
        @Override
080
        public String getPermitValueString() { return IDfACL.DF_PERMIT_DELETE_STR; }
081
        @Override
082
        public void setAccessorName(String arg0) { throw new RuntimeException("Not implemented"); }
083
        @Override
084
        public void setPermitType(int arg0) { throw new RuntimeException("Not implemented"); }
085
        @Override
086
        public void setPermitTypeString(String arg0) { throw new RuntimeException("Not implemented"); }
087
        @Override
088
        public void setPermitValue(String arg0) { throw new RuntimeException("Not implemented");}
089
    });
090
 
091
    dfTemplateACL.save();
092
}
093
 
094
/**
095
USER ATTRIBUTES
096
    object_name                : TEST PST HUO Simple
097
    description                : Desc 4 TEST PST HUO Simple
098
    owner_name                 : MYDOCBASEDEV
099
    globally_managed           : F
100
    acl_class                  : 1
101
 
102
SYSTEM ATTRIBUTES
103
    r_object_id                : 450xxxxxx151
104
    r_is_internal              : F
105
    r_accessor_name         [0]: dm_world
106
                [1]: dm_owner
107
                [2]: %AS4MyGroup
108
                [3]: %AS4SuperUser
109
    r_accessor_permit       [0]: 3
110
                [1]: 3
111
                [2]: 6
112
                [3]: 7
113
    r_accessor_xpermit      [0]: 0
114
                [1]: 0
115
                [2]: 0
116
                [3]: 0
117
    r_is_group              [0]: F
118
                [1]: F
119
                [2]: F
120
                [3]: F
121
    r_has_events               : F
122
    r_permit_type           [0]: 0
123
                            [1]: 0
124
                [2]: 0
125
                [3]: 0
126
    r_application_permit    [0]:
127
                [1]:
128
                [2]:
129
                [3]:
130
    r_template_id              : 0000000000000000
131
    r_alias_set_id             : 0000000000000000
132
*/

• Creation of Instance of Template ACL using the PST previous and AS (acl_class=2).
An instance of an ACL template is created when an AliasSet and PST are associated to a document. It is not possible to create directly manually an instance of PST.
The error DM_ACL_E_CANT_CHANGE_INSTANCE occurs if the user tries to modify a instance of PST (acl_class=2). To modify the instances of PST, it is necessary to modify the PST or PST/AliasSet associated to theses instances.

view source
print?
01
String documentName ="Test DOC HUO WITH AS AND PST";
02
IDfDocument document = (IDfDocument) object.idfSession.getObjectByQualification("dm_document where object_name ='" + documentName + "'");
03
if (document == null) {
04
    document = (IDfDocument) object.idfSession.newObject("dm_document");
05
    document.setObjectName(documentName);
06
    document.setContentType("pdf");
07
    document.setFile("C:/temp/test.pdf");
08
    document.link("/"+user);
09
    // ALIAS SET
10
    document.setString("r_alias_set_id", aliasSet.getObjectId().toString());
11
    // PST
12
    document.setACLName(dfTemplateACL.getObjectName());
13
    document.setACLDomain(dfTemplateACL.getDomain());
14
    document.save();
15
 
16
    /**
17
    USER ATTRIBUTES
18
      object_name                : Test DOC HUO WITH AS AND PST
19
      acl_domain                 : MYDOCBASEDEV
20
      acl_name                   : dm_450xxxxxx151_xxxxx90c
21
 
22
    SYSTEM ATTRIBUTES
23
      r_object_id                : 09xxxxx87
24
      r_object_type              : dm_document
25
     */
26
}//end-if

So, the association between document, AliasSet and Templace ACL generates an instance of Templace ACL (acl_class=2) with name like dm_450xxxxxxx94_xxxxd3e. This instance is created only if its is not already exist.

view source
print?
01
// Reload document
02
document = (IDfDocument) object.idfSession.getObjectByQualification("dm_document where object_name ='" + documentName + "'");
03
IDfACL dfInstanceACL = object.idfSession.getACL(document.getACLDomain(), document.getACLName());
04
if (dfInstanceACL != null) {
05
    System.out.println("Document '"+documentName+"' associated with instance of Template ACL '"+document.getACLName()+"' / '"+document.getACLDomain()+"'");
06
    System.out.println("The instance of Template ACL '"+document.getACLName()+"' / '"+document.getACLDomain()+"' => "+dfInstanceACL.getString("r_object_id"));
07
    System.out.println("    o Alias Set = '"+dfInstanceACL.getString("r_alias_set_id")+"'");
08
    System.out.println("    o Template ACL (PST) = '"+dfInstanceACL.getString("r_template_id")+"'");
09
 
10
    /**
11
    Document 'Test DOC HUO WITH AS AND PST' associated with instance of Template ACL 'dm_450xxxxxx151_xxxxx90c' / 'MYDOCBASEDEV'
12
 
13
    The instance of Template ACL 'dm_450xxxxxx151_xxxxx90c' / 'MYDOCBASEDEV' => 45xxxxxx94e
14
        o Alias Set = '660xxxxxxx90c'
15
        o Template ACL (PST) = '450xxxxxx151'
16
 
17
    USER ATTRIBUTES
18
      object_name                : dm_450xxxxxx151_xxxxx90c
19
      description                : dm_450xxxxxx151_xxxxx90c
20
      owner_name                 : MYDOCBASEDEV
21
      globally_managed           : F
22
      acl_class                  : 2
23
 
24
    SYSTEM ATTRIBUTES
25
      r_object_id                : 45xxxxxx94e
26
      r_is_internal              : T
27
      r_accessor_name         [0]: dm_world
28
                              [1]: dm_owner
29
                              [2]: AS4MyGroup
30
                              [3]: AS4SuperUser
31
      r_accessor_permit       [0]: 3
32
                              [1]: 3
33
                              [2]: 6
34
                              [3]: 7
35
      r_accessor_xpermit      [0]: 0
36
                              [1]: 0
37
                              [2]: 0
38
                              [3]: 0
39
      r_is_group              [0]: F
40
                              [1]: F
41
                              [2]: T
42
                              [3]: F
43
      r_has_events               : F
44
      r_permit_type           [0]: 0
45
                              [1]: 0
46
                              [2]: 0
47
                              [3]: 0
48
      r_application_permit    [0]:
49
                              [1]:
50
                              [2]:
51
                              [3]:
52
      r_template_id              : 450xxxxxx151
53
      r_alias_set_id             : 660xxxxxxx90c
54
 
55
    APPLICATION ATTRIBUTES
56
 
57
    INTERNAL ATTRIBUTES
58
      i_has_required_groups      : F
59
      i_has_required_group_set   : F
60
      i_has_access_restrictions  : F
61
      i_partition                : 0
62
      i_is_replica               : F
63
      i_vstamp                   : 0
64
 */
65
}

---

——————— DOCUMENT SECURITY ————————–

---

• To check the user’s permission level on a document. The “getPermit()” method returns an integer number that corresponds to the access permission level that the current user has for the object: DF_PERMIT_NONE = 1 / DF_PERMIT_BROWSE = 2 / DF_PERMIT_READ = 3 / DF_PERMIT_RELATE = 4 / DF_PERMIT_VERSION = 5 / DF_PERMIT_WRITE = 6 / DF_PERMIT_DELETE = 7

view source
print?
01
String qualification = "my_document WHERE i_chronicle_id = ID(''090xxxxxxxxxxx'')";
02
IDfDocument dfDocument = (IDfDocument) session.getObjectByQualification(qualification);
03
 
04
if (dfDocument == null) {
05
    throw new DfException("Unable to find object with qualification : " + qualification );
06
}
07
 
08
if (dfDocument.getPermit() < IDfACL.DF_PERMIT_DELETE && dfDocument.getXPermitNames(null).indexOf(IDfACL.DF_XPERMIT_DELETE_OBJECT_STR) != -1) {
09
    throw new DfException(MessageFormat.format("{0} does not have sufficient permissions to delete object {1}", session.getUser(null).getUserName(), dfDocument.getObjectId().getId()));
10
}

view source
print?
1
int userPermit = document.getPermit();
2
if(userPermit < IDfACL.DF_PERMIT_WRITE){
3
    throw new RuntimeException("Current user has is not authorized to upload a document ");
4
}

---

——————— METHOD ————————–

---

…