115
PegaRULES Process Commander ECM Connector Framework For: IBM FileNet P8 Image Manager & IBM FileNet P8 Content Manager

TriTek ECM Connector Framework

  • Upload
    sivamma

  • View
    67

  • Download
    2

Embed Size (px)

Citation preview

Page 1: TriTek ECM Connector Framework

PegaRULES Process Commander ECM Connector Framework

For:

IBM FileNet P8 Image Manager & IBM FileNet P8 Content Manager

Page 2: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 2 of 115

Table of Contents

 

1.  Introduction ............................................................................................................ 9 2.  Functional Capabilities ........................................................................................ 11 3.  Technical Design .................................................................................................. 13 

3.1.  PRPC Class Structure ............................................................................................................... 13 3.1.1.  Work Objects ..................................................................................................................... 13 3.1.2.  Document Properties Data Class .................................................................................... 63 3.1.3.  Integration Data Class ...................................................................................................... 65 3.1.4.  Document Indexing Data Class ....................................................................................... 67 3.1.5.  IS Integration Class ........................................................................................................... 72 3.1.6.  CE Integration Class ......................................................................................................... 87 

3.2.  Custom Java Classes ............................................................................................................. 103 3.2.1.  com.triteksol.content.j2is.J2ISPegaWrapper ............................................................... 104 3.2.2.  com.triteksol.content.isqueue.QueueWrapper ............................................................ 106 3.2.3.  com.triteksol.content.p8.P8PegaWrapper .................................................................... 107 

4.  Installation .......................................................................................................... 109 4.1.  General System Information .................................................................................................. 109 4.2.  Installation instructions .......................................................................................................... 109 

5.  Configuration ...................................................................................................... 112 5.1.  IS/CE Prerequisites ................................................................................................................. 112 5.2.  PRPC Rules .............................................................................................................................. 113 

5.2.1.  Properties ......................................................................................................................... 113 5.2.2.  Model ................................................................................................................................ 113 5.2.3.  Connectors – Integration-Mapping ................................................................................ 114 5.2.4.  Activities .......................................................................................................................... 114 5.2.5.  Flow .................................................................................................................................. 114 5.2.6.  Decision Table ................................................................................................................. 115 5.2.7.  Section ............................................................................................................................. 115 5.2.8.  Agents .............................................................................................................................. 115 

Page 3: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 3 of 115

Table of Figures

Table 1 - AccountNumber Property Rule Properties ............................................................................................. 14 Table 2 - docid Property Rule Properties ................................................................................................................ 14 Table 3 - DocType Property Rule Properties .......................................................................................................... 14 Table 4 - DocumentTitle Property Rule Properties ................................................................................................ 14 Table 5 - ECMDocProperties Property Rule Properties ........................................................................................ 15 Table 6 - GUID Property Rule Properties ............................................................................................................... 15 Table 7 - ISDocIds Property Rule Properties .......................................................................................................... 15 Table 8 - pagelistCounter Property Rule Properties .............................................................................................. 16 Table 9 - WorkbasketChoices Property Rule Properties ....................................................................................... 16 Table 10 - WorkbasketName Property Rule Properties ........................................................................................ 16 Table 11 - WorkType Property Rule Properties ..................................................................................................... 16 Table 12 - PickOneFromValueListWithActivity HTML Tab ............................................................................... 17 Table 13 - PickOneFromValueListWithActivity HTML Property Parameters .................................................. 18 Table 14 - DisplayCEPropertiesMain Flow Rule Properties ................................................................................. 18 Table 15 - WorkBasketDecision Decision Table Rule Table Tab .......................................................................... 19 Table 16 - WorkBasketDecision Decision Table Rule Pages & Classes Tab ........................................................ 20 Table 17 - DocumentIDNotNull When Rule Conditions Tab ................................................................................ 20 Table 18 - DocumentIDNotNull When Rule Page & Classes Tab ......................................................................... 20 Table 19 – GUIDNotNull When Rule Conditions Tab ........................................................................................... 20 Table 20 - GUIDNotNull When Rule Pages & Classes Tab ................................................................................... 20 Table 21 - CEProperties Flow Action Rule Properties ........................................................................................... 21 Table 22 - TransferToWorkBasketModified Flow Action Rule Properties ......................................................... 22 Table 23 - ISPropertiesFullSection Section Rule Properties .................................................................................. 23 Table 24 - ReIndexStatus Section Rule Properties ................................................................................................. 24 Table 25 - WorkbasketDropDown Section Rule Properties .................................................................................. 24 Table 26 - TriTekFWRepoConnectorWork.NewWork.CreateNewWork Service HTTP Rule Properties ....... 25 Table 27 - CallReIndexMultiple Activity Rule Step 1.0 Properties ....................................................................... 26 Table 28 - CallReIndexMultiple Activity Rule Step 1.1 Properties ....................................................................... 26 Table 29 - CallReIndexMultiple Activity Rule Pages & Classes Tab Properties ................................................. 27 Table 30 - CallReIndexMultiple Activity Rule Security Tab Properties .............................................................. 27 Table 31 - CallReIndexMultipleMain Activity Rule Step 1 Properties ................................................................. 27 Table 32 - CallReIndexMultipleMain Activity Rule Step 2 Properties ................................................................. 28 Table 33 - CallReIndexMultipleMain Activity Rule Step 3.0 Properties .............................................................. 28 Table 34 - CallReIndexMultipleMain Activity Rule Step 3.1 Properties .............................................................. 28 Table 35 - CallReIndexMultipleMain Activity Rule Step 3.2 Properties .............................................................. 29 Table 36 - CallReIndexMultipleMain Activity Rule Step 3.3 Properties .............................................................. 29 Table 37 - CallReIndexMultipleMain Activity Rule Step 4 Properties ................................................................. 29 Table 38 - CallReIndexMultipleMain Activity Rule Step 5 Properties ................................................................. 30 Table 39 - CallReIndexMultipleMain Activity Rule Parameters Tab Properties ................................................ 30 Table 40 - CallReIndexMultipleMain Activity Rule Pages & Classes Tab Properties ........................................ 30 Table 41 - CallReIndexMultipleMain Activity Rule Security Tab Properties ..................................................... 30 Table 42 - CallURL Activity Rule Step 1 Properties .............................................................................................. 31 Table 43 - CallURL Activity Rule Step 2 Properties .............................................................................................. 31 Table 44 - CallURL Activity Rule Step 3 Properties .............................................................................................. 31 Table 45 - CallURL Activity Rule Parameters Tab Properties ............................................................................. 32 Table 46 - ConnectAndGetPropertiesMultiple Activity Rule Step 1 Properties .................................................. 32 

Page 4: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 4 of 115

Table 47 - ConnectAndGetPropertiesMultiple Activity Rule Step 2 Properties .................................................. 32 Table 48 - ConnectAndGetPropertiesMultiple Activity Rule Step 3.0 Properties ............................................... 33 Table 49 - ConnectAndGetPropertiesMultiple Activity Rule Step 3.1 Properties ............................................... 33 Table 50 - ConnectAndGetPropertiesMultiple Activity Rule Step 3.2 Properties ............................................... 33 Table 51 - ConnectAndGetPropertiesMultiple Activity Rule Step 3.3 Properties ............................................... 34 Table 52 - ConnectAndGetPropertiesMultiple Activity Rule Step 3.4 Properties ............................................... 34 Table 53 - ConnectAndGetPropertiesMultiple Activity Rule Step 4 Properties .................................................. 34 Table 54 - ConnectAndGetPropertiesMultiple Activity Rule Step 5 Properties .................................................. 35 Table 55 - ConnectAndGetPropertiesMultiple Activity Rule Parameters Tab Properties ................................. 35 Table 56 - ConnectAndGetPropertiesMultiple Activity Rule Pages & Classes Tab Properties ......................... 35 Table 57 - ConnectAndGetPropertiesMultiple Activity Rule Security Tab Properties ...................................... 35 Table 58 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 1 Properties ......................................... 35 Table 59 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 2 Properties ......................................... 36 Table 60 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 3 Properties ......................................... 36 Table 61 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.0 Properties ...................................... 36 Table 62 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.1 Properties ...................................... 37 Table 63 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.2 Properties ...................................... 37 Table 64 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.3 Properties ...................................... 37 Table 65 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.4 Properties ...................................... 38 Table 66 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.5 Properties ...................................... 38 Table 67 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.6 Properties ...................................... 39 Table 68 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.7 Properties ...................................... 39 Table 69 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4 Properties ......................................... 39 Table 70 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 5 Properties ......................................... 39 Table 71 - ConnectAndGetPropertiesMultipleMain Activity Rule Parameters Tab Properties ........................ 40 Table 72 - ConnectAndGetPropertiesMultipleMain Activity Rule Pages & Classes Tab Properties ................ 40 Table 73 - ConnectAndGetPropertiesMultipleMain Activity Rule Security Tab Properties ............................. 40 Table 74 - MapCorrespondingProperties Activity Rule Step 1 Properties .......................................................... 41 Table 75 - MapCorrespondingProperties Activity Rule Step 2 Properties .......................................................... 41 Table 76 - MapCorrespondingProperties Activity Rule Step 3 Properties .......................................................... 41 Table 77 - MapCorrespondingProperties Activity Rule Parameters Tab Properties ......................................... 42 Table 78 - MapCorrespondingProperties Activity Rule Pages & Classes Tab Properties .................................. 42 Table 79 - MapCorrespondingProperties Activity Rule Security Tab Properties ............................................... 42 Table 80 - MapCorrespondingPropertiesMain Activity Rule Step 1 Properties ................................................. 42 Table 81 - MapCorrespondingPropertiesMain Activity Rule Step 2 Properties ................................................. 43 Table 82 - MapCorrespondingPropertiesMain Activity Rule Step 3 Properties ................................................. 43 Table 83 - MapCorrespondingPropertiesMain Activity Rule Step 4 Properties ................................................. 43 Table 84 - MapCorrespondingPropertiesMain Activity Rule Parameters Tab Properties ................................ 44 Table 85 - MapCorrespondingPropertiesMain Activity Rule Pages & Classes Tab Properties ......................... 44 Table 86 - MapCorrespondingPropertiesMain Activity Rule Security Tab Properties ...................................... 44 Table 87 - SavePegaProperties Activity Rule Step 1 Properties ........................................................................... 45 Table 88 - SavePegaProperties Activity Rule Step 2 Properties ............................................................................ 45 Table 89 - SavePegaProperties Activity Rule Step 3 Properties ............................................................................ 45 Table 90 - SavePegaProperties Activity Rule Parameters Tab Properties ........................................................... 46 Table 91- SavePegaProperties Activity Rule Pages & Classes Tab Properties .................................................... 46 Table 92 - SavePegaProperties Activity Rule Security Tab Properties ................................................................ 46 Table 93 - SavePegaPropertiesCE Activity Rule Step 1 Properties ...................................................................... 46 Table 94 - SavePegaPropertiesCE Activity Rule Step 2 Properties ...................................................................... 47 

Page 5: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 5 of 115

Table 95 - SavePegaPropertiesCE Activity Rule Step 3 Properties ...................................................................... 47 Table 96 - SavePegaPropertiesCE Activity Rule Parameters Tab Properties ..................................................... 48 Table 97 - SavePegaPropertiesCE Activity Rule Pages & Classes Tab Properties .............................................. 48 Table 98 - SavePegaPropertiesCE Activity Rule Security Tab Properties ........................................................... 48 Table 99 - ToWorkbasketWithDecision Activity Rule Step 1 Properties ............................................................. 48 Table 100 - ToWorkbasketWithDecision Activity Rule Step 2 Properties ........................................................... 49 Table 101- ToWorkbasketWithDecision Activity Rule Parameters Tab Properties ........................................... 49 Table 102 - ToWorkbasketWithDecision Activity Rule Pages & Classes Tab Properties .................................. 49 Table 103 - ToWorkbasketWithDecision Activity Rule Security Tab Properties ................................................ 50 Table 104 - UseToRefreshWOB Activity Rule Step 1 Properties .......................................................................... 50 Table 105 - UseToRefreshWOB Activity Rule Parameters Tab Properties ......................................................... 50 Table 106 - UseToRefreshWOB Activity Rule Security Tab Properties .............................................................. 50 Table 107 - FNCELibrary getDocPropsFunction Parameters Tab....................................................................... 51 Table 108 - FNCELibrary getDocPropsFunction Java Tab .................................................................................. 51 Table 109 - FNCELibrary reIndexFunction Parameters Tab ............................................................................... 52 Table 110 - FNCELibrary reIndexFunction Java Tab ........................................................................................... 52 Table 111 - J2ISLibrary getDocPropsFunction Parameters Tab .......................................................................... 53 Table 112 - J2ISLibrary getDocPropsFunction Java Tab ..................................................................................... 53 Table 113 - J2ISLibrary reIndexFunction Parameters Tab .................................................................................. 54 Table 114 - J2ISLibrary reIndexFunction Java Tab .............................................................................................. 54 Table 115 - QueueLibrary deleteFunction Parameters Tab .................................................................................. 55 Table 116 - QueueLibrary deleteFunction Java Tab .............................................................................................. 55 Table 117 - QueueLibrary getDateStringFunction Parameters Tab .................................................................... 56 Table 118 - QueueLibrary getDateStringFunction Java Tab ................................................................................ 56 Table 119 - QueueLibrary getEntryFunction Parameters Tab ............................................................................. 56 Table 120 - QueueLibrary getEntryFunction Java Tab ......................................................................................... 57 Table 121 - QueueLibrary getStringFunction Parameters Tab ............................................................................ 57 Table 122 - QueueLibrary getStringFunction Java Tab ........................................................................................ 58 Table 123 - QueueLibrary logoffFunction Parameters Tab .................................................................................. 58 Table 124 - QueueLibrary logoffFunction Java Tab .............................................................................................. 58 Table 125 - QueueLibrary logonFunction Parameters Tab ................................................................................... 59 Table 126 - QueueLibrary logonFunction Java Tab .............................................................................................. 59 Table 127 - FNCELibrary Packages Tab ................................................................................................................ 60 Table 128 - J2ISLibrary Packages Tab ................................................................................................................... 60 Table 129 - QueueLibrary Packages Tab ................................................................................................................ 60 Table 130 - TriTek-FW-RepoConnector-Work Class properties ......................................................................... 62 Table 131 - TriTek Agent Rule Schedule Tab Properties ...................................................................................... 62 Table 132 - AccountNumber Property Rule Properties ......................................................................................... 63 Table 133 - DocType Property Rule Properties ...................................................................................................... 63 Table 134 - DocumentID Property Rule Properties ............................................................................................... 64 Table 135 – DocumentTitle Property Rule Properties ........................................................................................... 64 Table 136 - GUID Property Rule Properties ........................................................................................................... 64 Table 137 - TriTek-FW-RepoConnector-Data-ECMDocumentProperties Class Properties ............................. 64 Table 138 - ClassName Property Rule Properties .................................................................................................. 65 Table 139 - JNDI Property Rule Properties ............................................................................................................ 65 Table 140 - MaxRetries Property Rule Properties ................................................................................................. 65 Table 141 - Password Property Rule Properties ..................................................................................................... 66 Table 142 - PollingInterval Property Rule Properties ............................................................................................ 66 

Page 6: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 6 of 115

Table 143 - QueueName Property Rule Properties ................................................................................................ 66 Table 144 - UserName Property Rule Properties ................................................................................................... 66 Table 145 - Workspace Property Rule Properties .................................................................................................. 66 Table 146 - EnvProperties Model Rule Properties ................................................................................................. 67 Table 147 - reIndex_return Property Rule Properties ........................................................................................... 68 Table 148 - getDocumentPropertiesXML Activity Rule Step 1 Properties .......................................................... 69 Table 149 - getDocumentPropertiesXML Activity Rule Step 2 Properties .......................................................... 69 Table 150 - getDocumentPropertiesXML Activity Rule Step 3 Properties .......................................................... 69 Table 151 - getDocumentPropertiesXML Activity Rule Step 4 Properties .......................................................... 69 Table 152 - getDocumentPropertiesXML Activity Rule Parameters Tab Properties ......................................... 70 Table 153 - getDocumentPropertiesXML Activity Rule Pages & Classes Tab Properties ................................. 70 Table 154 - getDocumentPropertiesXML Activity Rule Security Tab Properties ............................................... 70 Table 155 - reIndex Activity Rule Step 1 Properties .............................................................................................. 70 Table 156 - reIndex Activity Rule Step 2 Properties .............................................................................................. 70 Table 157 - reIndex Activity Rule Step 3 Properties .............................................................................................. 71 Table 158 - reIndex Activity Rule Step 5 Properties .............................................................................................. 71 Table 159 - reIndex Activity Rule Security Tab Properties ................................................................................... 71 Table 160 - J2ISWrapper Class General Tab Properties ...................................................................................... 72 Table 161 - checkdocid Property Rule Properties .................................................................................................. 72 Table 162 - docidIsNull When Rule Advanced Tab................................................................................................ 72 Table 163 - createWorkObjectF Activity Rule Step 1 Properties ......................................................................... 73 Table 164 - createWorkObjectF Activity Rule Step 2 Properties ......................................................................... 74 Table 165 - createWorkObjectF Activity Rule Step 3 Properties ......................................................................... 74 Table 166 - createWorkObjectF Activity Rule Step 4 Properties ......................................................................... 74 Table 167 - createWorkObjectF Activity Rule Step 5 Properties ......................................................................... 75 Table 168 - createWorkObjectF Activity Rule Step 6 Properties ......................................................................... 75 Table 169 - createWorkObjectF Activity Rule Step 6 Properties ......................................................................... 76 Table 170 - createWorkObjectF Activity Rule Step 8 Properties ......................................................................... 76 Table 171 - createWorkObjectF Activity Rule Step 9 Properties ......................................................................... 76 Table 172 - createWorkObjectF Activity Rule Step 10 Properties ....................................................................... 76 Table 173 - createWorkObjectF Activity Rule Step 11 Properties ....................................................................... 77 Table 174 - createWorkObjectF Activity Rule Step 12 Properties ....................................................................... 77 Table 175 - createWorkObject Activity Rule Parameters Tab Properties ........................................................... 77 Table 176 - createWorkObject Activity Rule Pages & Classes Tab Properties ................................................... 77 Table 177 - createWorkObject Activity Rule Security Tab Properties ................................................................ 77 Table 178 - getDistQueueProperties Activity Rule Step 1 Properties ................................................................... 78 Table 179 - getDistQueueProperties Activity Rule Step 2 Properties ................................................................... 78 Table 180 - getDistQueueProperties Activity Rule Step 3 Properties ................................................................... 78 Table 181 - getDistQueueProperties Activity Rule Pages & Classes Tab Properties .......................................... 78 Table 182 - getDistQueueProperties Activity Rule Security Tab Properties ........................................................ 78 Table 183 - getISEntry Activity Rule Step 1 Properties ......................................................................................... 79 Table 184 - getISEntry Activity Rule Step 2 Properties ......................................................................................... 79 Table 185 - getISEntryF Activity Rule Step 3 Properties ...................................................................................... 79 Table 186 - getISEntryF Activity Rule Step 4 Properties ...................................................................................... 80 Table 187 - getISEntryF Activity Rule Step 5 Properties ...................................................................................... 80 Table 188 - getISEntry Activity Rule Step 6 Properties ......................................................................................... 80 Table 189 - getISEntry Activity Rule Step 7 Properties ......................................................................................... 80 Table 190 - getISEntry Activity Rule Security Tab Properties ............................................................................. 80 

Page 7: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 7 of 115

Table 191 - MapMultipleDocIds Activity Rule Step 1 Properties ......................................................................... 81 Table 192 - MapMultipleDocIds Activity Rule Step 2 Properties ......................................................................... 81 Table 193 - MapMultipleDocIds Activity Rule Parameters Tab Properties ........................................................ 81 Table 194 - MapMultipleDocIds Activity Rule Pages & Classes Properties ........................................................ 81 Table 195 - MapMultipleDocIds Activity Rule Security Tab Properties .............................................................. 81 Table 196 - SearchForAccountNumber Activity Rule Step 1 Properties ............................................................. 82 Table 197 - SearchForAccountNumber Activity Rule Step 2 Properties ............................................................. 82 Table 198 - SearchForAccountNumber Activity Rule Step 3 Properties ............................................................. 83 Table 199 - SearchForAccountNumber Activity Rule Step 4 Properties ............................................................. 83 Table 200 - SearchForAccountNumber Activity Rule Step 5 Properties ............................................................. 83 Table 201 - SearchForAccountNumber Activity Rule Step 6 Properties ............................................................. 84 Table 202 - SearchForAccountNumber Activity Rule Step 7 Properties ............................................................. 84 Table 203 - SearchForAccountNumber Activity Rule Parameters Tab Properties ............................................ 84 Table 204 - SearchForAccountNumber Activity Rule Pages & Classes Properties ............................................. 84 Table 205 - SearchForAccountNumber Activity Rule Security Tab Properties .................................................. 85 Table 206 - startISProcessF Activity Rule Step 1 Properties ................................................................................. 85 Table 207 - startISProcessF Activity Rule Step 2 Properties ................................................................................. 85 Table 208 - startISProcessF Activity Rule Step 3 Properties ................................................................................. 86 Table 209 - startISProcessF Activity Rule Step 4 Properties ................................................................................. 86 Table 210 - startISProcessF Activity Rule Step 5 Properties ................................................................................. 86 Table 211 - startISProcessF Parameters Tab .......................................................................................................... 86 Table 212 - startISProcessF Activity Rule Security Tab Properties ..................................................................... 86 Table 213 - QueueWrapper Class Properties .......................................................................................................... 87 Table 214 - http_request Property Rule Properties ................................................................................................ 87 Table 215 - http_response Property Rule Properties ............................................................................................. 87 Table 216 - UserName Property Rule Properties ................................................................................................... 88 Table 217 - Password Property Rule Properties ..................................................................................................... 88 Table 218 - ObjectStore Property Rule Properties ................................................................................................. 88 Table 219 - AppId Property Rule Properties .......................................................................................................... 88 Table 220 - basePath Property Rule Properties ...................................................................................................... 88 Table 221 - ClassName Property Rule Properties .................................................................................................. 89 Table 222 - UseVirtualFolders Property Rule Properties ...................................................................................... 89 Table 223 - WcmApiConfig Property Rule Properties ........................................................................................... 89 Table 224 - reIndex_arg1 Property Rule Properties .............................................................................................. 89 Table 225 - reIndex_return Property Rule Properties ........................................................................................... 90 Table 226 - createWorkObject Activity Rule Step 1 Properties ............................................................................ 91 Table 227 - createWorkObject Activity Rule Step 2 Properties ............................................................................ 91 Table 228 - createWorkObject Activity Rule Step 3 Properties ............................................................................ 91 Table 229 - createWorkObject Activity Rule Step 4 Properties ............................................................................ 91 Table 230 - createWorkObject Activity Rule Step 5 Properties ............................................................................ 92 Table 231 - createWorkObject Activity Rule Step 6 Properties ............................................................................ 92 Table 232 - createWorkObject Activity Rule Step 7 Properties ............................................................................ 92 Table 233 - createWorkObject Activity Rule Step 8 Properties ............................................................................ 93 Table 234 - createWorkObject Activity Rule Step 9 Properties ............................................................................ 93 Table 235 - createWorkObject Activity Rule Step 10 Properties .......................................................................... 94 Table 236 - createWorkObject Activity Rule Step 11 Properties .......................................................................... 94 Table 237 - createWorkObject Activity Rule Step 12 Properties .......................................................................... 94 Table 238 - createWorkObject Activity Rule Step 13 Properties .......................................................................... 94 

Page 8: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 8 of 115

Table 239 - createWorkObject Activity Rule Step 14 Properties .......................................................................... 95 Table 240 - createWorkObject Activity Rule Step 15 Properties .......................................................................... 95 Table 241 - createWorkObject Activity Rule Step 16 Properties .......................................................................... 95 Table 242 - createWorkObject Activity Rule Step 17 Properties .......................................................................... 95 Table 243 - createWorkObject Activity Rule Parameters Tab Properties ........................................................... 95 Table 244 - createWorkObject Activity Rule Pages & Classes Tab Properties ................................................... 96 Table 245 - createWorkObject Activity Rule Security Tab Properties ................................................................ 96 Table 246 - getDocumentPropertiesXMLF Activity Rule Step 1 Properties ........................................................ 96 Table 247 - getDocumentPropertiesXMLF Activity Rule Step 2 Properties ........................................................ 96 Table 248 - getDocumentPropertiesXMLF Activity Rule Step 3 Properties ........................................................ 97 Table 249 - getDocumentPropertiesXMLF Activity Rule Step 4 Properties ........................................................ 97 Table 250 - getDocumentPropertiesXMLF Activity Rule Parameters Tab ......................................................... 97 Table 251 - reIndexF Activity Rule Step 1 Properties ............................................................................................ 98 Table 252 - reIndexF Activity Rule Step 2 Properties ............................................................................................ 98 Table 253 - reIndexF Activity Rule Step 3 Properties ............................................................................................ 98 Table 254 - reIndexF Activity Rule Step 4 Properties ............................................................................................ 98 Table 255 - reIndexF Activity Rule Parameters Tab .............................................................................................. 99 Table 256 - MapMultipleDocIds Activity Rule Step 1 Properties ......................................................................... 99 Table 257 - createWorkObject Activity Rule Step 2 Properties ............................................................................ 99 Table 258 - createWorkObject Activity Rule Parameters Tab Properties ........................................................... 99 Table 259 - createWorkObject Activity Rule Pages & Classes Tab Properties ................................................... 99 Table 260 - createWorkObject Activity Rule Security Tab Properties .............................................................. 100 Table 261 - SearchForAccountNumber Activity Rule Step 1 Properties ........................................................... 100 Table 262 - SearchForAccountNumber Activity Rule Step 2 Properties ........................................................... 100 Table 263 - SearchForAccountNumber Activity Rule Step 3 Properties ........................................................... 101 Table 264 - SearchForAccountNumber Activity Rule Step 4 Properties ........................................................... 101 Table 265 - SearchForAccountNumber Activity Rule Step 5 Properties ........................................................... 101 Table 266 - SearchForAccountNumber Activity Rule Step 6 Properties ........................................................... 102 Table 267 - SearchForAccountNumber Activity Rule Step 7 Properties ........................................................... 102 Table 268 - SearchForAccountNumber Activity Rule Parameters Tab Properties .......................................... 102 Table 269 - SearchForAccountNumber Activity Rule Pages & Classes Tab Properties ................................... 103 Table 270 - SearchForAccountNumber Activity Rule Security Tab Properties ................................................ 103 Table 271- CEEnvProperties Definition Tab ........................................................................................................ 103 Table 272 - J2ISPegaWrapper Method Parameters ............................................................................................. 104 Table 273 - logon Method Parameters ................................................................................................................... 104 Table 274 - getDocumentProperties Method Parameters .................................................................................... 104 Table 275 - launchURL Method Parameters ........................................................................................................ 105 Table 276 - getDocumentPropertiesXML Method Parameters ........................................................................... 105 Table 277 - reIndex Method Parameters ............................................................................................................... 105 Table 278 - logon Method Parameters ................................................................................................................... 106 Table 279 - QueueWrapper Method Parameters ................................................................................................. 106 Table 280 - getISQueueEntry Method Parameters .............................................................................................. 106 Table 281 - getString Method Parameters ............................................................................................................. 107 Table 282 - getDateString Method Parameters ..................................................................................................... 107 Table 283 - P8PegaWrapper constructor Parameters .......................................................................................... 107 Table 284 - logon method Parameters ................................................................................................................... 108 

Page 9: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 9 of 115

1. Introduction

Pegasystems’s SmartBPM software, PegaRULES Process Commander (PRPC), focuses on closing execution gaps by eliminating manual software coding. Applications built using PRPC seek to integrate the business process with the business practice. This allows users to manage the work lifecycle from inception to completion. PRPC provides powerful tools which enable an enterprise to develop BPM solutions. Its strength lies in the ease of creating business process flows and accompanying user interfaces. However, Pegasystems’s flow-based philosophy for BPM incorporates very limited functionality for capturing and viewing content. Within the customer service sector, Pegasystems’s traditional focus, workflows are not content-driven, so integrating content within the workflow is unnecessary. On the other hand, the vast majority of BPM workflows in the insurance and financial sectors are content-driven. Developing a viable content-driven PRPC application would require additional functionality:

Launching a workflow once a document was ingested into the system Attaching documents to the workflow once launched Storing documents within a content management system Viewing documents attached to the work item in a true document viewer. Adding documents from the in-flight work item, whether documents already stored in the

content repository, or documents yet to be added to the repository Removing documents from the in-flight work item Viewing and reindexing document properties from the in-flight work item

IBM/FileNet (FileNet) offers enterprise content management systems which provide the aforementioned functionality required for a content-driven PRPC application. Thus, integrating PRPC with IBM/FileNet ECM systems will result in a more fully-featured application, able to leverage both PRPC’s strength in BPM and workflow, as well as FileNet’s strength in content management. Integrating PRPC with IBM/FileNet will require the following steps:

Creating a PRPC work object and launching an associated flow when a document is committed to an ECM repository

Developing custom PRPC harnesses and sections to display ECM documents associated with the PRPC work object

Leveraging the Daeja document viewer to allow users to view the document from a PRPC work object

Section 2 - Functional Capabilities describes the functional capabilities of the PRPC/FileNet integration.

Page 10: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 10 of 115

Section 3 – Technical Design describes the design of the integration, specifically the rules created in PRPC and the custom code written to support the integration. Section 4 – Installation describes general information about installing the connector framework in an environment. Section 5 – Configurati describes necessary configuration post-installation to enable full connector framework functionality.

Page 11: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 11 of 115

2. Functional Capabilities

The Pega/FileNet connector will integrate Pega RULES Process Commander (PRPC) with an IBM FileNet Image Services content repository. Once integrated, documents committed to the IS content repository will be associated with PRPC work objects. Multiple documents associated with a single case, such as supporting documentation for an insurance claim or policy application, may all be associated with a single work object. Users may manipulate the documents without exiting PRPC, i.e. viewing document content, viewing and reindexing document index values. PRPC will automatically authenticate against the IS instance at specified time intervals to query for all documents of a single document class within a specific distribution queue. For each document found, PRPC will query the database for an existing PRPC work object that matches on a defined key, such as document ID. If no such match is found, PRPC will create a work object and map single-value document property values from the IS document to the configured work object fields, including but not limited to document ID. The work object can be created in a specific workbasket, depending on the document type value. If a match is found, PRPC will associate the document ID with the work object document ID value list property. Once processed, PRPC will remove the document from the distribution queue and save the PRPC work object to the database. PRPC will iterate through each document in the distribution queue, following the same process, until no documents remain within the distribution queue. Once a document is committed to CE as an instance of a specific document class, CE will pass the document’s index property information to PRPC. Once PRPC receives that document index information, PRPC will search for an existing PRPC work object that matches on a defined key, such as document ID. If no such match is found, PRPC will create a work object and map the single-value document property values from the CE document to corresponding work object fields, including but not limited to document ID. The work object can be created in a specific workbasket, depending on the document type value. PRPC will then save the work object to the database. If a match is found, PRPC will associate the document ID with a work object document ID value list property. PRPC will then save the work object to the database. Once the work objects have been created, users may login to PRPC and use either the WorkUser or WorkManager portals to view and process these work objects. When selected, the work object will display within the harness values populated from the FileNet document, as well as all document ID values associated with the work object. If only one document ID is associated with a work object, that document’s index values will be displayed within the work object. If multiple document IDs are associated with a work object, the user may select each document ID. This will refresh the harness, updating the work object properties to display the selected document ID’s property values. Users may view a document’s content by selecting the document ID and clicking a View Image button. This will open a new browser pop-up which will display the document within the FileNet Daeja viewer. All extant Daeja viewer functionality will be available to the user.

Page 12: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 12 of 115

Users may also reindex a document’s index values. The user may change the populated values on the work object and click a Reindex button. PRPC will authenticate against the FileNet content repository, query for the matching document, and reindex the document’s property values within the FileNet content repository. The user may process the work object as normal, and either reassign the work object to another workbasket or process the work object.

Page 13: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 13 of 115

3. Technical Design

Integrating PRPC with IS requires defining a PRPC work class with a page list property to store the document property values, as well as sections with custom buttons that allow displaying the document content in a document viewer servlet and reindexing the document within the IS content repository. Integration also requires custom Java classes to be called by PRPC in order to connect to the IS instance to retrieve the document index information and reindex the IS documents. Integrating PRPC with CE requires defining a PRPC work class with a page list property to store the document property values, as well as section rules with custom buttons that allow displaying the document content in a document viewer servlet and reindexing the document within the CE content repository. Integration also requires custom Java classes to be called by PRPC to reindex the IS documents. 3.1. PRPC Class Structure

TriTek-FW-RepoConnector-Work (Section 3.1.1 - Work Objects) defines the Work class and work objects created for the FileNet integration. TriTek-FW-RepoConnector-Int (Section 3.1.3 -Integration Data Class) is the parent class to all the classes responsible for the actual integration between PRPC and FileNet. TriTek-FW-RepoConnector-Int-QueueWrapper (Section 3.1.5 - IS Integration Class) is responsible for querying IS for documents and creating work objects based on the new documents. TriTek-FW-RepoConnector-Int-CEWrapper (Section 3.1.6 - CE Integration Class) is responsible for creating work objects based on document index information passed from CE. TriTek-FW-RepoConnector-Int-J2ISWrapper (Section 3.1.4 - Document Indexing Data Class) is responsible for retrieving document properties from the FileNet content repository, and writing new document index properties back to the content repository. 3.1.1. Work Objects

TriTek-FW-RepoConnector-Work defines the Work class. Work objects will be derived from this class. This class contains all the rules necessary to support processing a work object, including properties, flows, sections and various activities which will call additional activities related to displaying and reindexing documents from within PRPC.1 3.1.1.1. Pega Properties

The following are the required property rules.

1 The activity rules responsible for retrieving and reindexing document properties are located in TriTek-FW-RepoConnector-Int-J2ISWrapper. Calling those activities allows for iterating through a list of documents attached to a work object.

Page 14: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 14 of 115

3.1.1.1.1. AccountNumber

The AccountNumber property rule holds the AccountNumber associated with a CE/IS document. Since the implementation groups documents into Work Objects by AccountNumber this is a required field.

Table 1 - AccountNumber Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Decimal n/a None

3.1.1.1.2. Docid

The docid property rule contains the IS document ID value. Will be displayed to the user within a section rule. Selecting this document ID value and clicking View Document will allow the user to view the document in the Daeja viewer. Table 2 - docid Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.1.1.3. DocType

The DocType property rule contains the IS document type value. Will be displayed to the user within a section rule. Table 3 - DocType Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.1.1.4. DocumentTitle

The DocumentTitle property rule contains the document title associated with a CE document. For CE documents, this Document Title will appear to an end user as opposed to the GUID and is displayed in the UI.

Table 4 - DocumentTitle Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None

Page 15: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 15 of 115

3.1.1.1.5. ECMDocProperties

The ECMDocProperties page list property contains the document index values for FileNet documents associated with the PRPC work object. See section 3.1.2 - Document Properties Data Class. Table 5 - ECMDocProperties Property Rule Properties

General Tab Property Mode

Page Class: Validate embedded page

Java Page Lightweight On Change Activity:

Page List TriTek-FW-RepoConnector-Data-ECMDocument Properties

true false false n/a

3.1.1.1.6. GUID

The GUID holds the unique identifier for a CE document. It is the CE counterpart to the docid in its usage for retrieving and reindexing documents.

Table 6 - GUID Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.1.1.7. ISDocIds

The ISDocIds value list property will store all document ids associated with a work object. The user will be able to review these document ids and reindex the document property values from the work object. Table 7 - ISDocIds Property Rule Properties

General Tab Property Mode Property Type: HTML Property: Table Type: Value List Text n/a None 3.1.1.1.8. pagelistCounter

The pagelistCounter property is used to map the correct document ID value to the proper element in the ISDocIds value list property.

Page 16: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 16 of 115

Table 8 - pagelistCounter Property Rule Properties

General Tab Property Mode Property Type: HTML Property: Table Type: Single Value Integer n/a None 3.1.1.1.9. WorkbasketChoices

The WorkbasketChoices property rule will reference a workbasket name. This value will be leveraged to route the work object to the specified workbasket when selected in the assignment flow action. The workbasket names are stored in a local list table. Table 9 - WorkbasketChoices Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a Local List Table 1 2 NIGO 3 Supervisor 4 Pend 3.1.1.1.10. WorkbasketName

The WorkbasketName property stores the name of the workbasket the work object is currently located in. This value will be used to determine work object routing. Table 10 - WorkbasketName Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.1.1.11. WorkType

The WorkType property displays the work type value to the user. Table 11 - WorkType Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None

Page 17: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 17 of 115

3.1.1.2. HTML Properties

The following is the required HTML property rule.

3.1.1.2.1. PickOneFromValueListWithActivity

The PickOneFromValueListWithActivity HTML property rule is referenced by the docid field in order to select a document ID stored in the field, and subsequently call the MapCorrespondingProperties activity. The parameters are defined from the docid field configuration, as defined in the ISPropertiesFullSection. Table 12 - PickOneFromValueListWithActivity HTML Tab

HTML Source <% String size = tools.getParamValue("size"); if(size.length() == 0) size = "6"; String handle =tools.getActive().getEntryHandle(true); String propRef = tools.getParamValue("propertyUsedFor"); String propToDisplay = tools.getProperty(propRef).getStringValue(); %> <pega:save name="currentValue" value='<pega:reference name="$this-value"/>'/> <input type=hidden name='<pega:reference name="$this-name"/>' value = '<pega:reference name="$this-value"/>'/> <SELECT onclick="pickOneFromValueListSelected(event.srcElement); handleClientEvent('SERVER', '<pega:reference name="param.activityToBeCalled"/>','', '-1')" handle="<%=handle%>" size="<%=size%>" style="width:100%" <pega:choose><pega:when test='$mode-input'></pega:when><pega:otherwise>disabled</pega:otherwise></pega:choose>> <% String cv = tools.getSaveValue("currentValue").trim(); //get list elements String listRef = tools.getParamValue("valueListReference").trim(); if(listRef.length() > 0){ ClipboardProperty cppList = tools.getStepPage().getProperty(listRef); for (int i = 1; i <= cppList.size(); i++) { String field_selected = ""; String v = cppList.getPropertyValue(i).getStringValue().trim(); if(v.equals(propToDisplay)) field_selected = " selected='selected' "; tools.appendString("<OPTION value='" + v + "'" + field_selected + " >" + v + "</OPTION>"); } }

Page 18: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 18 of 115

String noSelection = ""; if (cv.length() == 0) noSelection = " selected='true' "; %> </SELECT> <script> function pickOneFromValueListSelected(srcElement) { var field = document.getElementById(srcElement.handle); field.value = srcElement.value; } </script> Table 13 - PickOneFromValueListWithActivity HTML Property Parameters

Parameter Value valueListReference ISDocIds activityToBeCalled MapCorrespondingProperties propertyUsedFor “pyWorkPage.docid”

3.1.1.3. Flow

The following is the required flow rule.

3.1.1.3.1. DisplayCEPropertiesMain

This sample flow rule demonstrates the Pega-CE/IS integration. Work objects created by either implementation will start the DisplayCEPropertiesMain flow. At the QA Process assignment smartshape, work objects will be routed to the appropriate workbasket, where a user may access the work objects through the WorkUser or WorkManager portal. To integrate Pega and CE/IS, the assignment smartshape requires a router smartshape attached. The assignment smartshape will reference the WorkBasket rule, and one of the Local Actions will be the TransferToWorkBasketModified flow action rule. The router will reference the ToWorkbasketWithDecision activity rule. Table 14 - DisplayCEPropertiesMain Flow Rule Properties

Assignment Name QA Process

Page 19: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 19 of 115

Rule WorkBasket Instructions n/a StatusWork n/a StatusAssign n/a ConfirmationNote n/a HarnessPurpose Perform UseCurOperIfBasketNotFound false Service Level n/a Local Actions TransferToWorkBasketModified Effort Cost n/a Notify n/a Router n/a Entry Point? true Only Going Back? false Post Action on Click Away? true Router Name To DocType WB Rule ToWorkbasketWithDecision Workbasket TriTekWB Connector Flow Action CEProperties Application ISCon WorkType Work Use Case n/a Likelihood 100 Properties n/a Audit Note n/a

3.1.1.4. Decision Table

3.1.1.4.1. WorkBasketDecision

WorkBasketDecision will return the name of a Work Basket based on the DocType property of the Work Object.

Table 15 - WorkBasketDecision Decision Table Rule Table Tab

Conditions Actions

tempDocTypePage.DocType Return if “NEWBUSINESS” NewBusiness else if “ACCOUNTSERVICES” AccountServices else if “DEPOSITS” Deposits

Page 20: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 20 of 115

else if “TRANSFERS” Transfers else if “COMPLIANCE” Compliance otherwise TriTekWB

Table 16 - WorkBasketDecision Decision Table Rule Pages & Classes Tab

Page Name Class tempDocTypePage TriTek-FW-RepoConnector-Work

3.1.1.5. When

3.1.1.5.1. DocumentIDNotNull

Used to detect if docid has a value.

Table 17 - DocumentIDNotNull When Rule Conditions Tab

When docid has a value

Table 18 - DocumentIDNotNull When Rule Page & Classes Tab

Page Name Class pyWorkPage TriTek-FW-RepoConnector-Work

3.1.1.5.2. GUIDNotNull

The GUIDNotNull When Rule is used to determine if the property GUID exists and has a value in the work class. This is used primarily to determine if the current document being viewed is from IS or CE (as IS documents do not have an associated GUID) and is necessary when reindexing or mapping properties to the ECMDocumentProperties tab.

Table 19 – GUIDNotNull When Rule Conditions Tab

When Property “pyWorkPage.GUID” exists and has a value

Table 20 - GUIDNotNull When Rule Pages & Classes Tab

Page Name Class pyWorkPage TriTek-FW-RepoConnector-Work 3.1.1.6. Flow Actions

Page 21: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 21 of 115

The following are the required flow action rules.

3.1.1.6.1. CEProperties

The CEProperties connector flow action is outgoing from the QA Process assignment smartshape in the DisplayCEPropertiesMain flow rule. This flow action is called when the work object is initially opened. Before the flow action executes, the ConnectAndGetPropertiesMultipleMain activity is run. The flow action displays the ISPropertiesFullSection section. After the flow action executes, the CallReIndexMultipleMain activity is run. The Action tab lists flow action properties. Table 21 - CEProperties Flow Action Rule Properties

Action Tab BEFORE THIS ACTION… Run Activity ConnectAndGetPropertiesMultipleMain No Parameters Available VALIDATE Validation Rule n/a AFTER THIS ACTION… Apply Cost n/a Run Activity CallReIndexMultipleMain No Parameters Available Look for an assignment to perform? true If not found, look in other flows on this work object?

false

If not found, look in flows on the cover object? false For each also consider assignments in workbaskets?

false

If an assignment is not being performed Show Harness, Confirm INDICATOR Used As Local and Connector Disqualify this action from bulk processing? false The Security tab lists security information. Security Tab Privilege Class Privilege Name When Name Audit Use? TriTek-FW-RepoConnector-Work

n/a n/a false

The HTML tab lists information about the HTML generation. HTML GENERATION

Section Reference Enable Client Side Validation?

Enable Expression Calculation?

Page 22: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 22 of 115

Reference Section ISPropertiesFullSection true false 3.1.1.6.2. TransferToWorkBasketModified

The TransferToWorkBasketModified flow action is a local flow action that will run the CallReIndexMultiplMain activity to reindex documents, then display a list of workbaskets to which the work object may be forwarded. The flow action will display the WorkBasketDropDown section. After the flow action is run, it will run the ReassignToWorkBasket activity to transfer the work object to a selected Workbasket. Table 22 - TransferToWorkBasketModified Flow Action Rule Properties

Action Tab BEFORE THIS ACTION… Run Activity CallReIndexMultipleMain No Parameters Available VALIDATE Validation Rule n/a AFTER THIS ACTION… Apply Cost n/a Run Activity ReassignToWorkBasket Parameter Value ReassignWorkbasket Primary.WorkbasketChoices InstructionNote Transferred Note n/a Look for an assignment to perform? true If not found, look in other flows on this work object?

false

If not found, look in flows on the cover object? false For each also consider assignments in workbaskets?

false

If an assignment is not being performed Show Harness, Confirm INDICATOR Used As Local and Connector Disqualify this action from bulk processing? false The Security tab lists security information. Privilege Class Privilege Name When Name Audit Use? n/a ActionTransferToWorkBasket n/a false n/a AllFlowActions n/a n/a The HTML tab lists information about the HTML generation. HTML Section Reference Enable Client Side Enable Expression

Page 23: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 23 of 115

GENERATION Validation? Calculation? Reference Section WorkbasketDropDown false false 3.1.1.7. Section

The following are the required section rules.

3.1.1.7.1. ISPropertiesFullSection

The ISPropertiesFullSection rule contains read only information about the IS/CE document. Allows user to view document and manually reindex values. The following are required: A cell must be defined to display all values contained within the docid property. Table 23 - ISPropertiesFullSection Section Rule Properties

Cell Properties Property .docid Display As PickOneFromValueListWithActivity Behavior n/a General Tab Visible Always Required false Wrap Text false Read Only false A cell must be defined with a button to allow the user to open a viewer in the Daeja Viewer servlet. Cell Properties Type CUSTOM Caption &View Image Tooltip n/a General Tab Do Action CallURL Target Pop-up window Window Width 60 Window Height 85 Visible Always Wrap Text false Disabled false

Page 24: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 24 of 115

Cells must be defined that display the document index values. These are dependent on the specific FileNet implementation. 3.1.1.7.2. ReIndexStatus

The ReIndexStatus section rule is called once a manual reindex has been performed to display the status of the document reindexing. The following is required: A cell that displays the status of the document reindexing. Table 24 - ReIndexStatus Section Rule Properties

Cell Properties Property J2ISPegaWrapperPage.reIndex_return Display As Default Behavior n/a General Tab Visible Always Required false Wrap Text false Read Only true Read Only Condition Always 3.1.1.7.3. WorkbasketDropDown

The WorkbasketDropDown section allows users to select a destination workbasket for work object routing. The following is required: A cell that displays the possible workbasket choices in a drop-down. Table 25 - WorkbasketDropDown Section Rule Properties

Cell Properties Property .WorkbasketChoices Display As PromptSelect Behavior ONCHANGE General Tab Visible Always Required true

Page 25: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 25 of 115

Wrap Text false Read Only false 3.1.1.8. Service HTTP

The following describes the required Service HTTP rules.

3.1.1.8.1. TriTekFWRepoConnectorWork.NewWork.CreateNewWork

The TriTekFWRepoConnectorWork service HTTP rule allows FileNet CE as the client to send a request to PRPC as the server. Here, CE will pass document properties when a document is committed to the CE repository to PRPC. PRPC will call the createWorkObject activity, and return a success or failure message to CE. The Service tab details information about the service, including the activity called. Table 26 - TriTekFWRepoConnectorWork.NewWork.CreateNewWork Service HTTP Rule Properties

PRIMARY PAGE Page Class TriTek-FW-RepoConnector-Int-CEWrapper Page Model n/a Page Name MyServicePage SERVICE ACTIVITY Activity Name createWorkObject PROCESSING OPTIONS End requestor when done false Method is read-only false Execution Mode Execute synchronously Request Processor n/a The Request tab details information about the request received. HEADER FIELDS none MESSAGE DATA Description Urgency added by user Map To Clipboard Map To Key .http_request The Response tab details information about the response returned. RESPONSE CONDITION

Condition When Name Content Type Status Code Default n/a text/xml 200 HEADER FIELDS n/a

Page 26: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 26 of 115

MESSAGE DATA Description work process info Map To Clipboard Map To Key .http_response 3.1.1.9. Activity

The following describes the required activity rules.

3.1.1.9.1. CallReIndexMultiple

(DEPRECATED. REPLACED BY CallReIndexMultipleMain) The CallReIndexMultiple activity rule will take document property values from each document associated with the work object and reindex each within the IS repository. The Property-Set method will set various work object properties equal to the IS document index values. This method has an iteration that will repeat for each document associated with the work object within the ECMDocProperties page list property rule. Table 27 - CallReIndexMultiple Activity Rule Step 1.0 Properties

Iteration For Each Embedded Page Label Description Step Page Method 1.0 pyWorkPage.ECMDocProperties Property-Set PropertiesName PropertiesValue pyWorkPage.AccountNumber pyWorkPage.ECMDocProperties(<CURRENT>)

.AccountNumber pyWorkPage.DocType pyWorkPage.ECMDocProperties(<CURRENT>).DocType pyWorkPage.docid pyWorkPage.ECMDocProperties(<CURRENT>)

.DocumentID pyWorkPage.LastName pyWorkPage.ECMDocProperties(<CURRENT>).LastName pyWorkPage.receivedDate pyWorkPage.ECMDocProperties(<CURRENT>)

.ReceivedDate The call reIndex method will call the reIndex activity rule. The reIndex activity will reindex the IS document index values. This is the first and only iterative step tied to step 1.0 - Property-Set. Table 28 - CallReIndexMultiple Activity Rule Step 1.1 Properties

Label Description Step Page Method 1.1 Call the reindex

activity in J2ISPegaWrapper

J2ISPegaWrapperPage call reIndex

Page 27: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 27 of 115

Pass current parameter page? false The Page-Remove method will remove the step page from the Clipboard (and server memory) to free up resources no longer required. Label Description Step Page Method 2. Delete our step

page Page-Remove

The Pages & Classes tab lists the required pages. Table 29 - CallReIndexMultiple Activity Rule Pages & Classes Tab Properties

Page Name Class Mode J2ISPegaWrapperPage TriTek-FW-RepoConnector-

Int-J2ISWrapper n/a

pyWorkPage TriTek-FW-RepoConnector-Work

n/a

ecmDocPropsPage TriTek-FW-RepoConnector-Data-ECMDocumentProperties

n/a

The Security tab lists the security settings. Table 30 - CallReIndexMultiple Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name true false Activity TriTek-FW-

RepoConnector-Work

n/a

3.1.1.9.2. CallReIndexMultipleMain

The CallReIndexMultipleMain activity rule will take document property values from each document associated with the work object and reindex each within both the CE and IS repositories by using conditional logic (CE documents will have an associated GUID, as IS documents will not). The Page-New methods will create new pages on the clipboard for each of the desired Integration classes. Table 31 - CallReIndexMultipleMain Activity Rule Step 1 Properties

Label Description Step Page Method 1 Create new page CEPegaWrapperPage Page-New

Page 28: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 28 of 115

Table 32 - CallReIndexMultipleMain Activity Rule Step 2 Properties

Label Description Step Page Method 2 Create new page J2ISPegaWrapperPage Page-New The Property-Set method will set various work object properties equal to the CE document index values. This method has an iteration that will repeat for each document associated with the work object within the ECMDocProperties page list property rule. Table 33 - CallReIndexMultipleMain Activity Rule Step 3.0 Properties

Iteration For Each Embedded Page Label Description Step Page Method 3.0 pyWorkPage.ECMDocProperties Property-Set PropertiesName PropertiesValue pyWorkPage.AccountNumber pyWorkPage.ECMDocProperties(<CURRENT>)

.AccountNumber pyWorkPage.DocType pyWorkPage.ECMDocProperties(<CURRENT>).DocType pyWorkPage.docid pyWorkPage.ECMDocProperties(<CURRENT>)

.DocumentID pyWorkPage.LastName pyWorkPage.ECMDocProperties(<CURRENT>).LastName pyWorkPage.receivedDate pyWorkPage.ECMDocProperties(<CURRENT>)

.ReceivedDate pyWorkPage.DocumentTitle pyWorkPage.ECMDocProperties(<CURRENT>).Document

Title pyWorkPage.GUID pyWorkPage.ECMDocProperties(<CURRENT>).GUID Local.isCE false This step uses the When rule GUIDNotNull to determine if the GUID exists and has a value and if so to set our local parameter to true to use reindexF activity in CEWrapper. Table 34 - CallReIndexMultipleMain Activity Rule Step 3.1 Properties

Label Description Step Page Method 3.1 Check guid pyWorkPage Property-Set Precondition: Enabled

When If True If False

GUIDNotNull Continue Whens Skip Step PropertiesName PropertiesValue Local.isCE true

Page 29: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 29 of 115

The call reIndexF method will call the reIndexF activity rule in CEWrapper when the precondition is true. The reIndexF activity will reindex the CE document index values. Table 35 - CallReIndexMultipleMain Activity Rule Step 3.2 Properties

Label Description Step Page Method 3.2 Call the reindex

activity in CEPegaWrapper

CEPegaWrapperPage call reIndexF

Precondition: Enabled

When If True If False

Local.isCE==true Continue Whens Skip Step Pass current parameter page? false The call reIndexF method will call the reIndexF activity rule in J2ISWrapper when the precondition is true. The reIndexF activity will reindex the IS document index values. Table 36 - CallReIndexMultipleMain Activity Rule Step 3.3 Properties

Label Description Step Page Method 3.3 Call the reindex

activity in J2ISPegaWrapper

J2ISPegaWrapperPage call reIndexF

Precondition: Enabled

When If True If False

Local.isCE==false Continue Whens Skip Step Pass current parameter page? false The Page-Remove method will remove the step page from the Clipboard (and server memory) to free up resources no longer required. Table 37 - CallReIndexMultipleMain Activity Rule Step 4 Properties

Label Description Step Page Method 4. Delete our step

page CEPegaWrapperPage Page-Remove

Page 30: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 30 of 115

Table 38 - CallReIndexMultipleMain Activity Rule Step 5 Properties

Label Description Step Page Method 5. Delete our step

page Page-Remove

The Parameters tab lists the local variables Table 39 - CallReIndexMultipleMain Activity Rule Parameters Tab Properties

Name Description Data Type isCE boolean The Pages & Classes tab lists the required pages. Table 40 - CallReIndexMultipleMain Activity Rule Pages & Classes Tab Properties

Page Name Class Mode J2ISPegaWrapperPage TriTek-FW-RepoConnector-

Int-J2ISWrapper n/a

pyWorkPage TriTek-FW-RepoConnector-Work

n/a

ecmDocPropsPage TriTek-FW-RepoConnector-Data-ECMDocumentProperties

n/a

CEPegaWrapperPage TriTek-FW-RepoConnector-Int-CEWrapper

n/a

The Security tab lists the security settings. Table 41 - CallReIndexMultipleMain Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name true false Activity TriTek-FW-

RepoConnector-Work

n/a

3.1.1.9.3. CallURL

The CallURL activity rule is called when the user wants to view an IS or CE document within PRPC. This activity will set the document URL to be displayed in the Daeja viewer. The Property-Set method will set the URL value based on the document ID value, then store that URL value in a local parameter to be displayed in the user’s browser window. Note that the URL itself must be configured to match the environment.

Page 31: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 31 of 115

Table 42 - CallURL Activity Rule Step 1 Properties

Label Description Step Page Method 1. Set the document

URL based on document ID

Property-Set

PropertiesName PropertiesValue local.url http://pega:9080/PegaContentServletProject/displayContent.jsp?docID=

+ .docid local.result “<SCRIPT LANGUAGE=’JAVASCRIPT’>window.location.href=’” +

local.url + “’;</SCRIPT> The Property-Set method will set the URL value based on the document ID value, then store that URL value in a local parameter to be displayed in the user’s browser window. Note that the URL itself must be configured to match the environment. Table 43 - CallURL Activity Rule Step 2 Properties

Label Description Step Page Method 2. Set the document

URL based on document ID

Property-Set

Precondition: Enabled When If True If False GUIDNotNull Continue Whens Skip step PropertiesName PropertiesValue local.url http://pega:9080/PegaCEContentServletProject/displayContent.jsp?docID=

+ .docid local.result “<SCRIPT LANGUAGE=’JAVASCRIPT’>window.location.href=’” +

local.url + “’;</SCRIPT> The Show-Property method will display the URL value in the new browser window. This will display the IS document in the Daeja viewer. Table 44 - CallURL Activity Rule Step 3 Properties

Label Description Step Page Method 3. Display the

document URL in the browser

Show-Property

Page 32: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 32 of 115

window Parameter Value Property local.result Two local parameters are required, one to generate the URL based on a stored URL value plus the document ID, one to store the URL to be displayed in the browser window. Table 45 - CallURL Activity Rule Parameters Tab Properties

Local Variables Name Description Data Type result Holds the URL to be

displayed in the browser window.

String

url Holds the generated URL based on the document ID.

String

3.1.1.9.4. ConnectAndGetPropertiesMultiple

(DEPRECATED. REPLACED BY ConnectAndGetPropertiesMultipleMain) The ConnectAndGetPropertiesMultiple activity rule will retrieve the IS document properties from the IS repository for each document associated with the current work object. The Page-New method will create a step page and initialize it with values from the EnvProperties model. Table 46 - ConnectAndGetPropertiesMultiple Activity Rule Step 1 Properties

Label Description Step Page Method 1. Create a new

temporary page J2ISPegaWrapperPage Page-New

Parameter Value Model EnvProperties PageList n/a NewClass n/a The Property-Set method will set the index parameter equal to 1. This value will be used to determine which document’s index values will be retrieved. Table 47 - ConnectAndGetPropertiesMultiple Activity Rule Step 2 Properties

Label Description Step Page Method 2. initialize counter Property-Set

Page 33: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 33 of 115

PropertiesName PropertiesValue local.index 1 The Property-Set method will set the docid property equal to the value stored in the appropriate element of the ISDocIds property. This method has an iteration that will repeat for each element in the .ISDocIds value list property. Table 48 - ConnectAndGetPropertiesMultiple Activity Rule Step 3.0 Properties

Iteration Property Name For Each Element in Value List .ISDocIds Label Description Step Page Method 3.0 For Each ISDocIds add to .docId pyWorkPage Property-Set PropertiesName PropertiesValue .docid .ISDocIds(local.index) The Call getDocumentPropertiesXML method will call the getDocumentPropertiesXML activity, which will retrieve the document properties in an XML format. This is the first of four steps in the iteration associated with step 2 – Property-Set. Table 49 - ConnectAndGetPropertiesMultiple Activity Rule Step 3.1 Properties

Label Description Step Page Method 3.1. call

getDocument PropertiesXML

J2ISPegaWrapperPage Call getDocumentPropertiesXML

Parameter Value return n/a The Property-Set method sets properties associated with an ECMDocProperties embedded page equal to the values retrieved from the IS instance. This is the second of four steps in the iteration associated with step 2 – Property-Set. Table 50 - ConnectAndGetPropertiesMultiple Activity Rule Step 3.2 Properties

Label Description Step Page Method 3.2 Sets the properties to appropriate

page in pagelist pyWorkPage Property-Set

PropertiesName PropertiesValue .ECMDocProperties(local.index).AccountNumber

.AccountNumber

.ECMDocProperties(local.index) .DocType

Page 34: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 34 of 115

.DocType

.ECMDocProperties(local.index)

.LastName .LastName

.ECMDocProperties(local.index)

.ReceivedDate .receivedDate

The Property-Set method sets the document ID property associated with an ECMDocProperties embedded page equal to the value stored in the corresponding element in the ISDocIds value list property. This is the third of four steps in the iteration associated with step 2 – Property-Set. Table 51 - ConnectAndGetPropertiesMultiple Activity Rule Step 3.3 Properties

Label Description Step Page Method 3.3 map the docid the page list pyWorkPage Property-Set PropertiesName PropertiesValue pyWorkPage.ECMDocProperties(local.index).DocumentID

.ISDocIds(local.index)

The Property-Set method adds 1 to the value of the index property. When the iteration repeats, the next element in the ISDocIds property will be evaluated. This is the fourth of four steps in the iteration associated with step 2 – Property-Set. Table 52 - ConnectAndGetPropertiesMultiple Activity Rule Step 3.4 Properties

Label Description Step Page Method 3.4 Increment index by 1 Property-Set PropertiesName PropertiesValue local.index local.index+1 The Call MapCorrespondingProperties method will call the MapCorrespondingProperties activity. The MapCorrespondingProperties activity will map the document index values to the corresponding work object properties. Table 53 - ConnectAndGetPropertiesMultiple Activity Rule Step 4 Properties

Label Description Step Page Method 4. Map properties of selected

docid to the properties displayed in the section

pyWorkPage Call MapCorrespondingProperties

Pass current parameter page? false The Page-Remove method will remove the step page from the Clipboard, freeing server memory.

Page 35: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 35 of 115

Table 54 - ConnectAndGetPropertiesMultiple Activity Rule Step 5 Properties

Label Description Step Page Method 5. Remove our temporary page J2ISPegaWrapperPage Page-Remove The Parameters tab lists the required parameters. Table 55 - ConnectAndGetPropertiesMultiple Activity Rule Parameters Tab Properties

Local Variables Name Description Data Type index int The Pages & Classes tab lists the required pages. Table 56 - ConnectAndGetPropertiesMultiple Activity Rule Pages & Classes Tab Properties

Page Name Class Mode J2ISPegaWrapperPage TriTek-FW-RepoConnector-

Int-J2ISWrapper n/a

pyWorkPage TriTek-FW-RepoConnector-Work

n/a

The Security tab lists the security settings. Table 57 - ConnectAndGetPropertiesMultiple Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name true false Activity TriTek-FW-

RepoConnector-Int-J2ISWrapper

n/a

3.1.1.9.5. ConnectAndGetPropertiesMultipleMain

The ConnectAndGetPropertiesMultipleMain activity rule will retrieve the CE/IS document properties from the CE/IS repository for each document associated with the current work object. The Page-New method will create a new page of the J2ISWrapper class with the EnvProperties model rule. Table 58 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 1 Properties

Label Description Step Page Method 1. Create a new

temporary page J2ISPegaWrapperPage Page-New

Page 36: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 36 of 115

Parameter Value Model EnvProperties PageList n/a NewClass n/a The Page-New method will create a new page of the CEWrapper class with the CEEnvProperties model rule. Table 59 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 2 Properties

Label Description Step Page Method 2. Create a new

temporary page CEPegaWrapperPage Page-New

Parameter Value Model CEEnvProperties PageList n/a NewClass n/a The Property-Set method will set the index parameter equal to 1. This value will be used to determine which document’s index values will be retrieved. Table 60 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 3 Properties

Label Description Step Page Method 3. initialize counter Property-Set PropertiesName PropertiesValue local.index 1 The Property-Set method will set the docid property equal to the value stored in the appropriate element of the ISDocIds property. This method has an iteration that will repeat for each element in the .ISDocIds value list property. Table 61 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.0 Properties

Iteration Property Name For Each Element in Value List .ISDocIds Label Description Step Page Method 4.0 For Each ISDocIds add to .docId pyWorkPage Property-Set PropertiesName PropertiesValue

Page 37: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 37 of 115

.docid .ISDocIds(local.index) Local.isCE false This step checks to see if the document has a GUID. If so, it is mapped to the .docid property on pyWorkPage and the local boolean isCE is set to true. Table 62 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.1 Properties

Label Description Step Page Method 4.1 For Each ISDocIds add to .docId pyWorkPage Property-Set When If True If False .ECMDocProperties(local.index).GUID!="" Continue Whens Skip step PropertiesName PropertiesValue .docid .ECMDocProperties(local.index).GUID Local.isCE true The Call getDocumentPropertiesXMLF method will call the getDocumentPropertiesXMLF activity in the J2ISWrapper class, which will retrieve the document properties in an XML format if the precondition evaluates to true. Table 63 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.2 Properties

Label Description Step Page Method 4.2. call

getDocument PropertiesXML

J2ISPegaWrapperPage Call getDocumentPropertiesXMLF

When If True If False local.isCE==false Continue Whens Skip step Parameter Value return n/a The Call getDocumentPropertiesXMLF method will call the getDocumentPropertiesXMLF activity in the CEWrapper class, which will retrieve the document properties in an XML format if the precondition evaluates to true. Table 64 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.3 Properties

Label Description Step Page Method 4.3. call CEPegaWrapperPage Call

Page 38: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 38 of 115

getDocument PropertiesXML

getDocumentPropertiesXMLF

When If True If False local.isCE==true Continue Whens Skip step Parameter Value return n/a The Property-Set method sets properties associated with an ECMDocProperties embedded page equal to the values retrieved from the CE/IS instance. Table 65 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.4 Properties

Label Description Step Page Method 4.4 Sets the properties to appropriate

page in pagelist pyWorkPage Property-Set

PropertiesName PropertiesValue .ECMDocProperties(local.index).AccountNumber

.AccountNumber

.ECMDocProperties(local.index)

.DocType .DocType

.ECMDocProperties(local.index)

.LastName .LastName

.ECMDocProperties(local.index)

.ReceivedDate .receivedDate

The Property-Set method sets properties associated with an ECMDocProperties embedded page equal to the values retrieved from the CE instance. Table 66 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.5 Properties

Label Description Step Page Method 4.5 Sets the properties to appropriate

page in pagelist pyWorkPage Property-Set

When If True If False local.isCE==true Continue Whens Skip step PropertiesName PropertiesValue .ECMDocProperties(local.index).DocumentTitle

.DocumentTitle

Page 39: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 39 of 115

The Property-Set method sets the document ID property associated with an ECMDocProperties embedded page equal to the value stored in the corresponding element in the ISDocIds value list property. Table 67 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.6 Properties

Label Description Step Page Method 4.6 map the docid the page list pyWorkPage Property-Set PropertiesName PropertiesValue pyWorkPage.ECMDocProperties(local.index).DocumentID

.ISDocIds(local.index)

The Property-Set method adds 1 to the value of the index property. When the iteration repeats, the next element in the ISDocIds property will be evaluated. This is the fourth of four steps in the iteration associated with step 2 – Property-Set. Table 68 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4.7 Properties

Label Description Step Page Method 4.7 Increment index by 1 Property-Set PropertiesName PropertiesValue local.index local.index+1 The Call MapCorrespondingPropertiesMain method will call the MapCorrespondingPropertiesMain activity. The MapCorrespondingPropertiesMain activity will map the document index values to the corresponding work object properties. Table 69 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 4 Properties

Label Description Step Page Method 5. Map properties of

selected docid to the properties displayed in the section

pyWorkPage Call MapCorrespondingPropertiesMain

Pass current parameter page? false The Page-Remove method will remove the step page from the Clipboard, freeing server memory. Table 70 - ConnectAndGetPropertiesMultipleMain Activity Rule Step 5 Properties

Label Description Step Page Method 6. Remove our temporary page J2ISPegaWrapperPage Page-Remove

Page 40: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 40 of 115

Label Description Step Page Method 7. Remove our temporary page CEPegaWrapperPage Page-Remove The Parameters tab lists the required parameters. Table 71 - ConnectAndGetPropertiesMultipleMain Activity Rule Parameters Tab Properties

Local Variables Name Description Data Type index Int isCE boolean The Pages & Classes tab lists the required pages. Table 72 - ConnectAndGetPropertiesMultipleMain Activity Rule Pages & Classes Tab Properties

Page Name Class Mode J2ISPegaWrapperPage TriTek-FW-RepoConnector-

Int-J2ISWrapper n/a

pyWorkPage TriTek-FW-RepoConnector-Work

n/a

CEPegaWrapperPage TriTek-FW-RepoConnector-Int-CEWrapper

The Security tab lists the security settings. Table 73 - ConnectAndGetPropertiesMultipleMain Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name true false Activity TriTek-FW-

RepoConnector-Int-J2ISWrapper

n/a

3.1.1.9.6. MapCorrespondingProperties

(DEPRECATED. REPLACED BY MapCorrespondingPropertiesMain) The MapCorrespondingProperties activity will map each document ID value to the corresponding PageList of properties. These properties will be displayed in the section when a document ID is selected from the list. The Property-Set method sets the index parameter equal to 1. This value will be used to determine which element in the ISDocIds value list property will be processed.

Page 41: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 41 of 115

Table 74 - MapCorrespondingProperties Activity Rule Step 1 Properties

Label Description Step Page Method 1. Initialize index param to 1 Property-Set PropertiesName PropertiesValue local.index 1 The Property-Set method adds 1 to the index parameter value. This method has an iteration that will process for each element in the ISDocIds value list property. This method also has a precondition that compares the docid property value to an element in the ISDocIds property. If this is true, the step is skipped. If this is false, the activity continues. Table 75 - MapCorrespondingProperties Activity Rule Step 2 Properties

Iteration Property Name For Each Element in Value List pyWorkPage.ISDocIds Precondition enabled? (true) When If True True

Param if False False

Param pyWorkPage.docid== pyWorkPage.ISDocIds(local.index)

Skip step n/a Continue whens

n/a

Label Description Step Page Method 2. Find ISDocIds index of selected

docid pyWorkPage Property-Set

PropertiesName PropertiesValue local.index local.index+1 The Property-Set method maps from the page list property to the corresponding work object properties displayed in the section. Table 76 - MapCorrespondingProperties Activity Rule Step 3 Properties

Label Description Step Page Method 3. Map corresponding properties to

workpage properties pyWorkPage Property-Set

PropertiesName PropertiesValue .LastName .ECMDocProperties(local.index).LastName .AccountNumber .ECMDocProperties(local.index).AccountNumber .receivedDate .ECMDocProperties(local.index).ReceivedDate .DocType .ECMDocProperties(local.index).DocType

Page 42: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 42 of 115

The Parameters tab lists the required parameters. Table 77 - MapCorrespondingProperties Activity Rule Parameters Tab Properties

Local Variables Name Description Data Type index int The Pages & Classes tab lists the required pages. Table 78 - MapCorrespondingProperties Activity Rule Pages & Classes Tab Properties

Page Name Class Mode pyWorkPage TriTek-FW-RepoConnector-

Work n/a

The Security tab lists the security settings. Table 79 - MapCorrespondingProperties Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name true true Activity TriTek-FW-

RepoConnector-Work

n/a

3.1.1.9.7. MapCorrespondingPropertiesMain

The MapCorrespondingPropertiesMain activity will map each document ID value to the corresponding PageList of properties. These properties will be displayed in the section when a document ID is selected from the list. The Property-Set method sets the index parameter equal to 1. This value will be used to determine which element in the ISDocIds value list property will be processed.

Table 80 - MapCorrespondingPropertiesMain Activity Rule Step 1 Properties

Label Description Step Page Method 1. Initialize index param to 1 Property-Set PropertiesName PropertiesValue local.index 1 The Property-Set method adds 1 to the index parameter value. This method has an iteration that will process for each element in the ISDocIds value list property. This method also has a precondition that compares the docid property value to an element in the ISDocIds property. If this is true, the step is skipped. If this is false, the activity continues.

Page 43: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 43 of 115

Table 81 - MapCorrespondingPropertiesMain Activity Rule Step 2 Properties

Iteration Property Name For Each Element in Value List pyWorkPage.ISDocIds Precondition enabled? (true) When If True True

Param if False False

Param pyWorkPage.docid== pyWorkPage.ISDocIds(local.index)

Skip step n/a Continue whens

n/a

Label Description Step Page Method 2. Find ISDocIds index of selected

docid pyWorkPage Property-Set

PropertiesName PropertiesValue local.index local.index+1 The Property-Set method maps from the page list property to the corresponding work object properties displayed in the section. Table 82 - MapCorrespondingPropertiesMain Activity Rule Step 3 Properties

Label Description Step Page Method 3. Map corresponding properties to

workpage properties pyWorkPage Property-Set

PropertiesName PropertiesValue .LastName .ECMDocProperties(local.index).LastName .AccountNumber .ECMDocProperties(local.index).AccountNumber .receivedDate .ECMDocProperties(local.index).ReceivedDate .DocType .ECMDocProperties(local.index).DocType The Property-Set method maps from the page list property to the corresponding work object properties displayed in the section if it is a CE document. Table 83 - MapCorrespondingPropertiesMain Activity Rule Step 4 Properties

Label Description Step Page Method 4. Map corresponding properties to

workpage properties pyWorkPage Property-Set

Precondition enabled? (true) When If True True Param if False False Param GUIDNotNull Skip step n/a Continue n/a

Page 44: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 44 of 115

whens PropertiesName PropertiesValue .DocumentTitle .ECMDocProperties(local.index).LastName .GUID .ECMDocProperties(local.index).AccountNumber The Parameters tab lists the required parameters. Table 84 - MapCorrespondingPropertiesMain Activity Rule Parameters Tab Properties

Local Variables Name Description Data Type index int The Pages & Classes tab lists the required pages. Table 85 - MapCorrespondingPropertiesMain Activity Rule Pages & Classes Tab Properties

Page Name Class Mode pyWorkPage TriTek-FW-RepoConnector-

Work n/a

The Security tab lists the security settings. Table 86 - MapCorrespondingPropertiesMain Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name true true Activity TriTek-FW-

RepoConnector-Work

n/a

3.1.1.9.8. SavePegaProperties

The SavePegaProperties activity maps work object properties displayed in the section to the page list property. This activity is called from the createWorkObject activity when a work object is created to map the properties to the work object. This activity is also called in the ISPropertiesFullSection section. For properties that will be displayed within the section that have corresponding values from the IS document, for on change events, the section will be refreshed and this activity will be called for those fields to update the property values. The Property-Set method sets the index parameter equal to 1. This value will be used to determine which element in the ISDocIds value list property will be processed.

Page 45: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 45 of 115

Table 87 - SavePegaProperties Activity Rule Step 1 Properties

Label Description Step Page Method 1. Initialize index param to 1 Property-Set PropertiesName PropertiesValue param.index 1 The Property-Set method adds 1 to the index parameter value. This method has an iteration that will process for each element in the ISDocIds value list property. This method also has a precondition that compares the docid property value to an element in the ISDocIds property. If this is true, the step is skipped. If this is false, the activity continues. Table 88 - SavePegaProperties Activity Rule Step 2 Properties

Iteration Property Name For Each Element in Value List pyWorkPage.ISDocIds Precondition enabled? (true) When If True True

Param if False False

Param pyWorkPage.docid== pyWorkPage.ISDocIds(local.index)

Skip step n/a Continue whens

n/a

Label Description Step Page Method 2. Find ISDocIds index of selected

docid pyWorkPage Property-Set

PropertiesName PropertiesValue local.index local.index+1 The Property-Set method maps the work object properties displayed in the section to the page list property. Table 89 - SavePegaProperties Activity Rule Step 3 Properties

Label Description Step Page Method 3. Map corresponding properties to

workpage properties pyWorkPage Property-Set

PropertiesName PropertiesValue .ECMDocProperties(local.index).LastName

.LastName

.ECMDocProperties(local.index)

.AccountNumber .AccountNumber

.ECMDocProperties(local.index) .ReceivedDate

Page 46: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 46 of 115

.ReceivedDate

.ECMDocProperties(local.index)

.DocType .DocType

The Parameters tab lists the required parameters. Table 90 - SavePegaProperties Activity Rule Parameters Tab Properties

Parameters Name Description Data Type Required? In/Out Prompt

Default Value

index Integer No n/a n/a The Pages & Classes tab lists the required pages. Table 91- SavePegaProperties Activity Rule Pages & Classes Tab Properties

Page Name Class Mode pyWorkPage TriTek-FW-RepoConnector-

Work n/a

The Security tab lists the security settings. Table 92 - SavePegaProperties Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name true true Activity TriTek-FW-

RepoConnector-Work

n/a

3.1.1.9.9. SavePegaPropertiesCE

The SavePegaPropertiesCE activity maps work object properties displayed in the section to the page list property. This activity is called from the createWorkObject activity in the CEWrapper class when a work object is created to map the properties to the work object. This activity is also called in the ISPropertiesFullSection section. For properties that will be displayed within the section that have corresponding values from the CE document, for on change events, the section will be refreshed and this activity will be called for those fields to update the property values. The Property-Set method sets the index parameter equal to 1. This value will be used to determine which element in the ISDocIds value list property will be processed.

Table 93 - SavePegaPropertiesCE Activity Rule Step 1 Properties

Label Description Step Page Method

Page 47: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 47 of 115

1. Initialize index param to 1 Property-Set PropertiesName PropertiesValue param.index 1 The Property-Set method adds 1 to the index parameter value. This method has an iteration that will process for each element in the ISDocIds value list property. This method also has a precondition that compares the docid property value to an element in the ISDocIds property. If this is true, the step is skipped. If this is false, the activity continues. Table 94 - SavePegaPropertiesCE Activity Rule Step 2 Properties

Iteration Property Name For Each Element in Value List pyWorkPage.ISDocIds Precondition enabled? (true) When If True True

Param if False False

Param pyWorkPage.DocumentTitle== pyWorkPage.ISDocIds(local.index)

Skip step n/a Continue whens

n/a

Label Description Step Page Method 2. Find ISDocIds index of selected

docid pyWorkPage Property-Set

PropertiesName PropertiesValue local.index local.index+1 The Property-Set method maps the work object properties displayed in the section to the page list property. Table 95 - SavePegaPropertiesCE Activity Rule Step 3 Properties

Label Description Step Page Method 3. Map corresponding properties to

workpage properties pyWorkPage Property-Set

PropertiesName PropertiesValue .ECMDocProperties(local.index).LastName

.LastName

.ECMDocProperties(local.index)

.AccountNumber .AccountNumber

.ECMDocProperties(local.index)

.ReceivedDate .ReceivedDate

.ECMDocProperties(local.index)

.DocType .DocType

Page 48: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 48 of 115

.ECMDocProperties(local.index)

.DocumentTitle .DocumentTitle

.ECMDocProperties(local.index)

.GUID .GUID

The Parameters tab lists the required parameters. Table 96 - SavePegaPropertiesCE Activity Rule Parameters Tab Properties

Parameters Name Description Data Type Required? In/Out Prompt

Default Value

index Integer No n/a n/a The Pages & Classes tab lists the required pages. Table 97 - SavePegaPropertiesCE Activity Rule Pages & Classes Tab Properties

Page Name Class Mode pyWorkPage TriTek-FW-RepoConnector-

Work n/a

The Security tab lists the security settings. Table 98 - SavePegaPropertiesCE Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name true true Activity TriTek-FW-

RepoConnector-Work

n/a

3.1.1.9.10. ToWorkbasketWithDecision

The ToWorkbasketWithDecision activity rule is a router activity that will control to which workbasket a work item is routed. The routing is based on the document type value. The Property-Map-DecisionTable method will evaluate the work object document type value against the WorkBasketDecision decision table and return a result value. This value will correspond to the destination workbasket. Table 99 - ToWorkbasketWithDecision Activity Rule Step 1 Properties

Label Description Step Page Method 1. Call decision Property-Map-

Page 49: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 49 of 115

table to check DocType

DecisionTable

Parameter Value PropertyName Primary.WorkbasketName DecisionTableName WorkBasketDecision AllowMissingProperties false The Property-Set method will set the AssignTo field value equal to the workbasket name in order to route the work object. Table 100 - ToWorkbasketWithDecision Activity Rule Step 2 Properties

Label Description Step Page Method 2. Set AssignTo

to workbasket in param

Property-Set

PropertiesName PropertiesValue param.AssignTo Primary.WorkbasketName The Parameters tab will contain the Workbasket parameter, containing the workbasket ID for routing purposes. Table 101- ToWorkbasketWithDecision Activity Rule Parameters Tab Properties

Parameters Name Description Data Type Required? In/Out Prompt

Default Value Workbasket ID of the

workbasket to route the assignment to

String No n/a n/a

The Pages and Classes tab defines two pages. Table 102 - ToWorkbasketWithDecision Activity Rule Pages & Classes Tab Properties

Page Name Class Mode pyWorkPage TriTek-FW-RepoConnector-

Work n/a

tempDocTypePage TriTek-FW-RepoConnector-Work

n/a

The Security tab defines the ToWorkbasketWithDecision activity as a Route type activity.

Page 50: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 50 of 115

Table 103 - ToWorkbasketWithDecision Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name n/a n/a Route n/a n/a 3.1.1.9.11. UseToRefreshWOB

The UseToRefreshWOB activity is called by the WorkType property in order to refresh the section when a work type is selected. See http://pdn.pega.com/DevNet/PRPCv4/KB/14585.asp for more information. The Property-Set method has no purpose; the activity is called to refresh work object values. Table 104 - UseToRefreshWOB Activity Rule Step 1 Properties

Label Description Step Page Method 1. Used in refreshing our

section via WorkType property. Property-Set value is not important.

Property-Set

PropertiesName PropertiesValue param.Purpose “NoPurpose” One parameter is defined for this activity. Table 105 - UseToRefreshWOB Activity Rule Parameters Tab Properties

Name Description Data Type Required? In/Out Prompt Default Value

Purpose String The security tab contains various security settings for this activity. Table 106 - UseToRefreshWOB Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name false true Activity TriTek-FW-

RepoConnector-Work

n/a

3.1.1.10. Function

3.1.1.10.1. FNCELibrary getDocPropsFunction

Page 51: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 51 of 115

The getDocPropsFunction rule calls the P8PegaWrapper java class constructor, login, getDocPropsXML, and logoff methods and returns a String parameter.

Table 107 - FNCELibrary getDocPropsFunction Parameters Tab

Parameter Name Java Data Type Type Page Class

In/Out

docid String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

username String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

password String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

classname String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

wcmapiconfig String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

appId String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

objStore String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

UseVirtualFolders String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

basePath String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

OUTPUT Return Type: String Pega Type: n/a Page Class: n/a

The code in the Java tab is as follows:

Table 108 - FNCELibrary getDocPropsFunction Java Tab

JAVA P8PegaWrapper p8 = new P8PegaWrapper(classname, wcmapiconfig, appId, objStore, UseVirtualFolders, basepath); try{ p8.logon(username, password); return p8.getDocPropsXML(docid); } catch(Exception e){ throw new RuntimeException("Unable to get document properties", e); } finally{ p8.logoff();

Page 52: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 52 of 115

}

3.1.1.10.2. FNCELibrary reIndexFunction

The FNCELibrary reIndexFunction calls the P8PegaWrapper java class constructor, login, reIndex, and logoff methods and returns a String parameter.

Table 109 - FNCELibrary reIndexFunction Parameters Tab

Parameter Name Java Data Type Type Page Class

In/Out

xml String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

username String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

password String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

classname String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

wcmapiconfig String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

appId String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

objStore String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

UseVirtualFolders String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

basePath String Text TriTek-FW-RepoConnector-Int-CEWrapper

In

OUTPUT Return Type: String Pega Type: n/a Page Class: n/a

The Java tab is as follows:

Table 110 - FNCELibrary reIndexFunction Java Tab

JAVA P8PegaWrapper p8 = new P8PegaWrapper(classname, wcmapiconfig, appId, objStore, UseVirtualFolders, basepath); try{ p8.logon(username, password); return p8.reIndex(xml);

Page 53: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 53 of 115

} catch(Exception e){ throw new RuntimeException("Unable to reindex document" + xml, e); } finally{ p8.logoff(); }

3.1.1.10.3. J2ISLibrary getDocPropsFunction

The getDocPropsFunction rule calls the J2ISPegaWrapper java class constructor, login, getDocPropsXML, and logoff methods and returns a String parameter.

Table 111 - J2ISLibrary getDocPropsFunction Parameters Tab

Parameter Name Java Data Type Type Page Class

In/Out

docid String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

username String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

password String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

classname String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

jndi String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

maxretries int Number TriTek-FW-RepoConnector-Int-J2ISWrapper

In

pollinginterval int Number TriTek-FW-RepoConnector-Int-J2ISWrapper

In

OUTPUT Return Type: String Pega Type: n/a Page Class: n/a

The Java tab is as follows:

Table 112 - J2ISLibrary getDocPropsFunction Java Tab

JAVA J2ISPegaWrapper j2is = new J2ISPegaWrapper(classname, jndi, pollinginterval, maxretries); try{ j2is.logon(username, password); return j2is.getDocPropsXML(docid);

Page 54: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 54 of 115

} catch (Exception e){ throw new RuntimeException(e); } finally{ j2is.logoff(); }

3.1.1.10.4. J2ISLibrary reIndexFunction

The J2ISLibrary reIndexFunction calls the P8PegaWrapper java class constructor, login, reIndex, and logoff methods and returns a String parameter.

Table 113 - J2ISLibrary reIndexFunction Parameters Tab

Parameter Name Java Data Type Type Page Class

In/Out

xml String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

username String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

password String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

classname String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

jndi String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

maxretries int Number TriTek-FW-RepoConnector-Int-J2ISWrapper

In

pollinginterval int Number TriTek-FW-RepoConnector-Int-J2ISWrapper

In

OUTPUT Return Type: String Pega Type: n/a Page Class: n/a

The Java tab is as follows:

Table 114 - J2ISLibrary reIndexFunction Java Tab

JAVA J2ISPegaWrapper j2is = new J2ISPegaWrapper(classname, jndi, pollinginterval, maxretries); try{ j2is.logon(username, password); return j2is.reIndex(xml); } catch(Exception e){

Page 55: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 55 of 115

throw new RuntimeException("Unable to reindex document" + xml, e); } finally{ j2is.logoff(); }

3.1.1.10.5. QueueLibrary deleteFunction

The deleteFunction deletes an entry from the IS DistQueue.

Table 115 - QueueLibrary deleteFunction Parameters Tab

OUTPUT Return Type: String Pega Type: n/a Page Class: n/a

The Java tab is as follows:

Table 116 - QueueLibrary deleteFunction Java Tab

JAVA PublicAPI tools = null; PRThread thisThread = (PRThread)ThreadContainer.get(); if (thisThread != null) { tools = thisThread.getPublicAPI(); ClipboardPage cbp = tools.findPage("javaObjectPage"); QueueWrapper qw = (QueueWrapper) cbp.getObject("QueueWrapper"); qw.delete(); cbp.putObject("QueueWrapper", qw); } else{ throw new PRAppRuntimeException("Pega-RULES", 0, "Unable to obtain current thread"); } return "";

3.1.1.10.6. QueueLibrary getDateStringFunction

The QueueLibrary getDateStringFunction calls a specialized method that pulls an IS Property of type Date and reformat it into a String that PRPC will then recognize when cast into a PRPC property of type Date.

Page 56: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 56 of 115

Table 117 - QueueLibrary getDateStringFunction Parameters Tab

Parameter Name Java Data Type Type Page Class

In/Out

searchString String Text TriTek-FW-RepoConnector-Int-QueueWrapper

In

OUTPUT Return Type: String Pega Type: n/a Page Class: n/a

The Java tab is as follows:

Table 118 - QueueLibrary getDateStringFunction Java Tab

JAVA PublicAPI tools = null; PRThread thisThread = (PRThread)ThreadContainer.get(); String returnString = null; if (thisThread != null) { tools = thisThread.getPublicAPI(); ClipboardPage cbp = tools.findPage("javaObjectPage"); QueueWrapper qw = (QueueWrapper) cbp.getObject("QueueWrapper"); returnString = qw.getDateString(searchString); } else{ throw new PRAppRuntimeException("Pega-RULES", 0, "Unable to obtain current thread"); } return returnString;

3.1.1.10.7. QueueLibrary getEntryFunction

Table 119 - QueueLibrary getEntryFunction Parameters Tab

Parameter Name Java Data Type Type Page Class

In/Out

workspace String Text TriTek-FW-RepoConnector-Int-QueueWrapper

In

queuename String Text TriTek-FW-RepoConnector-Int-QueueWrapper

In

colname String Text TriTek-FW-RepoConnector-Int-QueueWrapper

In

Page 57: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 57 of 115

OUTPUT Return Type: String Pega Type: n/a Page Class: n/a

The Java tab is as follows:

Table 120 - QueueLibrary getEntryFunction Java Tab

JAVA PublicAPI tools = null; PRThread thisThread = (PRThread)ThreadContainer.get(); if (thisThread != null) { tools = thisThread.getPublicAPI(); ClipboardPage cbp = tools.findPage("javaObjectPage"); QueueWrapper qw = (QueueWrapper) cbp.getObject("QueueWrapper"); qw.getISQueueEntry(workspace, queuename); if(qw.next()){ cbp.putObject("QueueWrapper", qw); return qw.getString(colname); } else{ cbp.putObject("QueueWrapper", qw); return "null"; } } else{ throw new PRAppRuntimeException("Pega-RULES", 0, "Unable to obtain current thread"); }

3.1.1.10.8. QueueLibrary getStringFunction

Table 121 - QueueLibrary getStringFunction Parameters Tab

Parameter Name Java Data Type Type Page Class

In/Out

searchString String Text TriTek-FW-RepoConnector-Int-QueueWrapper

In

OUTPUT Return Type: String Pega Type: n/a Page Class: n/a

Page 58: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 58 of 115

The Java tab is as follows:

Table 122 - QueueLibrary getStringFunction Java Tab

JAVA PublicAPI tools = null; PRThread thisThread = (PRThread)ThreadContainer.get(); String returnString = null; if (thisThread != null) { tools = thisThread.getPublicAPI(); ClipboardPage cbp = tools.findPage("javaObjectPage"); QueueWrapper qw = (QueueWrapper) cbp.getObject("QueueWrapper"); returnString = qw.getString(searchString); } else{ throw new PRAppRuntimeException("Pega-RULES", 0, "Unable to obtain current thread"); } return returnString;

3.1.1.10.9. QueueLibrary logoffFunction

Table 123 - QueueLibrary logoffFunction Parameters Tab

OUTPUT Return Type: String Pega Type: n/a Page Class: n/a

Table 124 - QueueLibrary logoffFunction Java Tab

JAVA PublicAPI tools = null; PRThread thisThread = (PRThread)ThreadContainer.get(); if (thisThread != null) { tools = thisThread.getPublicAPI(); ClipboardPage cbp = tools.findPage("javaObjectPage"); QueueWrapper qw = (QueueWrapper) cbp.getObject("QueueWrapper"); qw.finalize(); } else{ throw new PRAppRuntimeException("Pega-RULES", 0, "Unable to obtain current thread"); }

Page 59: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 59 of 115

return "";

3.1.1.10.10. QueueLibrary logonFunction

Table 125 - QueueLibrary logonFunction Parameters Tab

Parameter Name Java Data Type Type Page Class

In/Out

classname String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

jndi String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

maxretries int Number TriTek-FW-RepoConnector-Int-J2ISWrapper

In

pollinginterval int Number TriTek-FW-RepoConnector-Int-J2ISWrapper

In

username String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

password String Text TriTek-FW-RepoConnector-Int-J2ISWrapper

In

OUTPUT Return Type: String Pega Type: n/a Page Class: n/a

The Java tab is as follows:

Table 126 - QueueLibrary logonFunction Java Tab

JAVA PublicAPI tools = null; PRThread thisThread = (PRThread)ThreadContainer.get(); QueueWrapper qw = new QueueWrapper(classname, jndi, pollinginterval, maxretries); if (thisThread != null) { tools = thisThread.getPublicAPI(); ClipboardPage cbp = tools.createPage("TriTek-FW-RepoConnector-Int-QueueWrapper", "javaObjectPage"); qw.logon(username, password, jndi); cbp.putObject("QueueWrapper", qw); } else{ throw new PRAppRuntimeException("Pega-RULES", 0, "Unable to obtain current

Page 60: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 60 of 115

thread"); } return "";

3.1.1.11. Library

3.1.1.11.1. FNCELibrary

Library utilized by Rule-Utility-Functions to access Content Engine.

Table 127 - FNCELibrary Packages Tab

Java Packages to Import com.triteksol.content.p8.P8PegaWrapper

3.1.1.11.2. J2ISLibrary

Library utilized by Rule-Utility-Functions to access Image Services.

Table 128 - J2ISLibrary Packages Tab

Java Packages to Import com.triteksol.content.j2is.J2ISPegaWrapper

3.1.1.11.3. QueueLibrary

Library utilized by Rule-Utility-Functions to access IS DistQueue.

Table 129 - QueueLibrary Packages Tab

Java Packages to Import com.triteksol.content.isqueue.QueueWrapper

3.1.1.12. Text File

The following describes the required text file.

3.1.1.12.1. TriTekFWRepoConnectorWork.NewWork.xsd

The TriTekFWRepoConnectorWork text file is an xsd schema created for the service HTTP rule. The following is the schema.

Page 61: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 61 of 115

<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="ProcessInfo"> <xs:complexType> <xs:sequence> <xs:element name="pyAssignmentList" minOccurs="0" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="pyAssignedTo" minOccurs="0" type="xs:string"/> <xs:element name="pyAssignmentClass" minOccurs="0" type="xs:string"/> <xs:element name="pyAssignmentHandle" minOccurs="0" type="xs:string"/> <xs:element name="pyFlowType" minOccurs="0" type="xs:string"/> <xs:element name="pyInstructions" minOccurs="0" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="pyCurrentUserHasOwnership" minOccurs="0" type="xs:boolean"/> <xs:element name="pyErrors" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element name="pyMessages" minOccurs="0" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="pyErrorCount" minOccurs="0" type="xs:int"/> <xs:element name="pyErrorMessage" minOccurs="0" maxOccurs="unbounded" type="xs:string"/> <xs:element name="pyPageName" minOccurs="0" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="pyFlowsToAdd" minOccurs="0" maxOccurs="unbounded" type="xs:string"/> <xs:element name="pyProcessState" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element name="pyAssignActions" minOccurs="0" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="pyActionLabel" minOccurs="0" type="xs:string"/> <xs:element name="pyActionName" minOccurs="0" type="xs:string"/> <xs:element name="pyActionType" minOccurs="0" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="pyAssignmentHandle" minOccurs="0" type="xs:string"/> <xs:element name="pyFlowIdentifier" minOccurs="0" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="pyStatus" minOccurs="0" type="xs:string"/>

Page 62: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 62 of 115

<xs:element name="pyWorkObjectHandle" minOccurs="0" type="xs:string"/> <xs:element name="pyWorkObjectStatus" minOccurs="0" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> 3.1.1.13. Class

The following describes the class definition.

3.1.1.13.1. TriTek-FW-RepoConnector-Work

This class is a class group that inherits directly from Work-. Table 130 - TriTek-FW-RepoConnector-Work Class properties

General Tab Select: Created in

Version: This Class Encrypt BLOB? Class Group

Concrete 01-01-01 is a class group false TriTek-FW-RepoConnector-Work

KEYS Name Caption pyID Work Object ID Find by name first (Pattern)? Parent class (Directed) true Work- 3.1.1.14. Agents

The following describes the required agent.

3.1.1.14.1. TriTek

The TriTek agent runs the startISProcess activity on a regular basis to process IS documents. Settings will need to be customized for the specific PRPC instance. It is configured in Advanced mode to run automatically on a periodic basis, given the unpredictability of documents being committed to the IS content repository. Table 131 - TriTek Agent Rule Schedule Tab Properties

Agent Name Pattern Interval (sec) Mode Enabled? StartISProcess Periodic 30 Advanced no AGENT-WIDE SETTINGS

Page 63: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 63 of 115

Enable this agent true Interval (seconds) 30 3.1.2. Document Properties Data Class

TriTek-FW-RepoConnector-Data-ECMDocumentProperties is the concrete data class that holds the document properties to be displayed within PRPC. This class is referenced by the ECMDocumentProperties page list property rule to display the values on the work object, as well as to allow reindexing an IS document with PRPC user-input values. DocumentID and DocType are required properties. Additional properties may be defined to reflect the IS instance’s document class and document index properties. 3.1.2.1. Pega Properties

The following describes the required properties. These properties will be displayed in the PRPC work object.

3.1.2.1.1. AccountNumber

The AccountNumber property will hold the number by which documents are grouped into work objects.

Table 132 - AccountNumber Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Decimal n/a None

3.1.2.1.2. DocType

The DocType property will store the document type value from the FileNet instance. Table 133 - DocType Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.2.1.3. DocumentID

The DocumentID property will store the document ID from the FileNet instance. This document ID will be used as a key to identify the proper document and retrieve property values from the FileNet instance, as well as write property values to the FileNet instance.

Page 64: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 64 of 115

Table 134 - DocumentID Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None

3.1.2.1.4. DocumentTitle

The DocumentTitle property will hold the title associated with the document.

Table 135 – DocumentTitle Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None

3.1.2.1.5. GUID

The GUID property will store a document ID from the CE instance. This GUID will be used as a key to identify the proper document and retrieve property values from the CE instance, as well as write property values to the CE instance. Table 136 - GUID Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None

3.1.2.2. Class

The following describes the class definition.

3.1.2.2.1. TriTek-FW-RepoConnector-Data-ECMDocumentProperties

This data class will contain various FileNet document property values, to be displayed to the user on the work object. Table 137 - TriTek-FW-RepoConnector-Data-ECMDocumentProperties Class Properties

General Tab Select: Created in Version: This Class: Encrypt BLOB? Concrete 01-01-01 does not belong to a

class group false

Page 65: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 65 of 115

Find by name first (Pattern)? Parent class (Directed): true TriTek-FW-RepoConnector-Data- 3.1.3. Integration Data Class

TriTek-FW-RepoConnector-Int- is an abstract data class that is parent to the various Pega/FileNet integration classes. This class stores a model rule that will contain information necessary to log into the IS instance. 3.1.3.1. Properties

The following describes the required configuration properties. All of these properties must be configured based on the IS instance logon information. 3.1.3.1.1. ClassName

The ClassName property contains the fully qualified class name of the J2ISWrapper class. This class is used to connect to the IS instance. Table 138 - ClassName Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.3.1.2. JNDI

The JNDI property contains the name of the Image Services Resource Adaptor (ISRA). Used to connect to the IS instance. Table 139 - JNDI Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.3.1.3. MaxRetries

The MaxRetries property contains the maximum number of retries of failed logon attempts before stopping. Table 140 - MaxRetries Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None

Page 66: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 66 of 115

3.1.3.1.4. Password

The Password property contains the password used to logon to the IS instance. Table 141 - Password Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.3.1.5. PollingInterval

The PollingInterval property contains the number of seconds between failed logon attempts. Table 142 - PollingInterval Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.3.1.6. QueueName

The QueueName property contains the name of the IS queue which will contain the documents. Table 143 - QueueName Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.3.1.7. UserName

The UserName property contains the user name used to logon to the IS instance. Table 144 - UserName Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.3.1.8. Workspace

The Workspace property contains the name of the IS workspace to connect to. Table 145 - Workspace Property Rule Properties

General Tab

Page 67: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 67 of 115

Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.3.2. Model

The following describes the required model.

3.1.3.2.1. EnvProperties

The EnvProperties model initializes the values used to log into the IS instance. Table 146 - EnvProperties Model Rule Properties

Data Dictionary Property Data Dictionary Value .ClassName fully qualified class name of wrapper class .JNDI Directory name of Image Services Resource

Adaptor; set equal to “ISRA” .MaxRetries maximum number of retries of failed logon

attempts before stopping .PollingInterval number of seconds between failed logon

attempts .UserName user name used to logon to the IS instance.

Note that this username should have administrative rights.

.Password password used to logon to the IS instance.

.Workspace name of the IS workspace to connect to

.QueueName name of the IS queue which will contain the documents

3.1.4. Document Indexing Data Class

TriTek-FW-RepoConnector-Int-J2ISWrapper is an abstract data class responsible for connecting to the IS instance to retrieve document properties to be displayed on a work object, and passing document properties when reindexing the IS documents. The rules in this class are responsible for connecting to the IS instance to retrieve information and reindex properties. 3.1.4.1. Properties

The following describes the required properties. These properties will pass information between PRPC and IS, and will not be directly displayed to the user.

3.1.4.1.1. reIndex_return

Page 68: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 68 of 115

The reIndex_return property contains the status of the reindexing sent from the IS instance to PRPC. The status will either be “Reindex Successful” or “Reindex Unsuccessful” and is displayed to the user in the section rule. Table 147 - reIndex_return Property Rule Properties

General Tab Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.4.2. Parse XML

The following describes the required Parse XML rule. 3.1.4.2.1. DocPropertiesXMLParse.Document

The DocPropertiesXMLParse.Document parse XML rule will map incoming document index values from the IS instance to the appropriate work object properties in PRPC. Note that this will need to be configured for the specific IS instance. 3.1.4.3. XML Stream

The following describes the required XML Stream rule.

3.1.4.3.1. reIndexStream.ReIndex

The reIndexStream.reIndex XML Stream rule will map outgoing document index values from the work object to the document index values in the IS instance. Note that this will need to be configured for the specific IS instance. 3.1.4.4. Activity

The following describes the required activities.

3.1.4.4.1. getDocumentPropertiesXMLF

The getDocumentPropertiesXML activity rule retrieves an IS document’s properties in XML format. The activity logs into the IS instance, passes the document ID, calls the getDocumentPropertiesXML Java connector rule to retrieve the document index properties from the IS instance, maps the values to a field, then applies a Parse XML rule to map the values to work object properties. The Page New method calls the creates a new connector rule.

Page 69: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 69 of 115

Table 148 - getDocumentPropertiesXML Activity Rule Step 1 Properties

Label Description Step Page Method 1. Create a temporary data Page Page-New Parameter Value Model EnvProperties PageList NewClass The Property-Set method calls the J2ISLibrary logonFunction function rule. Table 149 - getDocumentPropertiesXML Activity Rule Step 2 Properties

Label Description Step Page Method 2. Map outbound

clipboard values

Property-Set

PropertiesName PropertiesValue Local.returnxml Lib(TriTek:J2ISLibrary).getDocPropsFunction(pyWorkPage.docid,

Primary.UserName, Primary.Password, Primary.ClassName, Primary.JNDI, Primary.MaxRetries, Primary.PollingInterval)

The Appy-Parse-XML method will parse the String of xml returned from CE and map them to the clipboard. Table 150 - getDocumentPropertiesXML Activity Rule Step 3 Properties

Label Description Step Page Method 3. Use parse rule to map to

Pega Propertiess Apply-Parse-XML

Parameter Value Namespace DocPropertiesXMLParse Element Document SourceProperty Local.returnxml The Page-Remove method will remove the Primary page. Table 151 - getDocumentPropertiesXML Activity Rule Step 4 Properties

Label Description Step Page Method 4. Remove the temporary

data page Page-Remove

Page 70: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 70 of 115

Table 152 - getDocumentPropertiesXML Activity Rule Parameters Tab Properties

LOCAL VARIABLES

Name Description Data Type

returnxml Xml returned String

The Pages & Classes tab defines the required pages. Table 153 - getDocumentPropertiesXML Activity Rule Pages & Classes Tab Properties

Page Name Class Mode pyWorkPage TriTek-FW-RepoConnector-

Work n/a

The Security tab defines the security settings. Table 154 - getDocumentPropertiesXML Activity Rule Security Tab Properties

May Start? Authenticate? Activity Type Privilege Class Privilege Name false true Activity TriTek-FW-

RepoConnector-Int-J2ISWrapper

n/a

3.1.4.4.2. reIndexF

The reIndex activity rule will log into the IS instance, set the document index values to be reindexed, and call the reIndex Java connector rule to execute the document reindexing. The Page-New method creates a new page associated with the J2ISWrapper class. Table 155 - reIndex Activity Rule Step 1 Properties

Label Description Step Page Method 1. Create new

page Page-New

Parameter Value Model EnvProperties The Property-Set-XML method calls the XML Stream rule. Table 156 - reIndex Activity Rule Step 2 Properties

Label Description Step Page Method 2. Set XML Properties Property-Set-XML

Page 71: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 71 of 115

Parameter Value PropertyName Local.reindex_arg1 XMLStream reIndexStream XMLType ReIndex The Property-Set method calls the J2IS reIndexFunction function rule. Table 157 - reIndex Activity Rule Step 3 Properties

Label Description Step Page Method 3. Call reIndex

function Property-Set

PropertiesName PropertiesValue Primary.reIndex_return Lib(TriTek:J2ISLibrary).reindexFunction(local.reindex_arg1,

Primary.UserName, Primary.Password, Primary.ClassName, Primary.JNDI, Primary.MaxRetries, Primary.PollingInterval)

The Page-Remove methods removes the Primary page Table 158 - reIndex Activity Rule Step 5 Properties

Label Description DataType reindex_arg1 String The Parameters tab defines the local variables Name Description Step Page Method 4. Remove page Page-Remove The Security tab defines the security settings. Table 159 - reIndex Activity Rule Security Tab Properties

May Start? Authenticate? Activity Type Privilege Class Privilege Name true true Activity TriTek-FW-

RepoConnector-Int-J2ISWrapper

n/a

3.1.4.5. Class

The following describes the class definition.

3.1.4.5.1. TriTek-FW-RepoConnector-Int-J2ISWrapper

The J2ISWrapper class is an abstract class that inherits directly from TriTek-FW-RepoConnector-Int-.

Page 72: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 72 of 115

Table 160 - J2ISWrapper Class General Tab Properties

Select: Created in Version: Find by name first (Pattern)?

Parent class (Directed):

Abstract 01-01-01 true TriTek-FW-RepoConnector-Int-

3.1.5. IS Integration Class

TriTek-FW-RepoConnector-Int-QueueWrapper is an abstract data class responsible for querying the IS instance for documents within the distribution queue, and attaching document references to either new work objects or existing work objects that match on a given key. 3.1.5.1. Property

The following lists the required properties. These properties will pass information between PRPC and IS, and will not be directly displayed to the user.

3.1.5.1.1. checkdocid

Holds the docid of the next document in the ISDistQueue

Table 161 - checkdocid Property Rule Properties

Property Mode Property Type HTML Property Table Type Single Value Text n/a None 3.1.5.2. When

The following describes the required when rule.

3.1.5.2.1. docidIsNull

The docidIsNull when rule is referenced in the getISEntry activity to evaluate whether or not additional documents must be processed from the configured distribution queue. Conditions Tab When .checkdocid EQUALS “null” The Advanced tab contains the logic used to evaluate the when rule. Table 162 - docidIsNull When Rule Advanced Tab

CHECK CONDITION(S) AND RETURN TRUE OR FALSE

Page 73: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 73 of 115

Label Field Name

Operation Value

A0 true Equal @(Pega-RULES:ExpressionEvaluators).compareTwoStrings(.checkdocid, "EQUALS", "null")

Logic of Table Elements

Logic A0 Backward Chaining

Skip this rule false 3.1.5.3. Activity

The following describes the required activities.

3.1.5.3.1. createWorkObjectF

The createWorkObjectF activity rule will retrieve document index properties for an IS document. The activity first maps the document ID to the AccountNumber property and queries the PegaRULES database for a work object with a matching AccountNumber property value. If a match is found, the activity will open the existing work object. Otherwise, the activity will create a new work object for the IS document, then set the pagelistCounter equal to 0. The activity will associate the IS document ID with the existing work object, populate the work object with document index properties retrieved from the document stored in the IS instance, save the work object, commit the work object to the PegaRULES database, and remove unnecessary pages. The Page-New method will create a new page, pyWorkPage. This page will be initialized by the pyDefault model. Table 163 - createWorkObjectF Activity Rule Step 1 Properties

Label Description Step Page Method 1. pyWorkPage Page-New Parameter Value Model pyDefault PageList n/a NewClass n/a

Page 74: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 74 of 115

The call getDistQueueProperties method will call the getDistQueueProperties activity. This will retrieve certain IS document index values, including the document id. These values will be stored on the tempDocTypePage page. Table 164 - createWorkObjectF Activity Rule Step 2 Properties

Label Description Step Page Method 2. Get the DocType Call

getDistQueueProperties The Call SearchForAccountNumber method will call the SearchForAccountNumber activity. Using the document ID stored on the tempDocTypePage page, the SearchForAccountNumber activity will query the PegaRULES database for a work object with a matching document ID and return a boolean. This boolean will be used to determine whether or not to create a new work object, or open an existing work object. Table 165 - createWorkObjectF Activity Rule Step 3 Properties

Label Description Step Page Method 3. Search for matching

AccountNumbers Call

SearchForAccountNumber Pass current parameter page? true The Call svcAddWorkObject method will create a new work object. A precondition evaluates the CreateNewWob value. If the CreateNewWOB value returned from the SearchForAccountNumber method is equal to true, the step continues execution. If the CreateNewWOB value is false, this step will be skipped. 2 Table 166 - createWorkObjectF Activity Rule Step 4 Properties

Precondition Enabled? (true)

When if True True Param if False False Param param.CreateNewWOB==false Skip step Continue

Whens

2 The svcAddWorkObject method creates the new work object, and starts the associated flow, before committing that work object to the database. It is possible to incorporate the account number matching into a utility activity referenced in the flow. However, this approach would require deleting the newly created work objects if a matching work object was found. These work objects (not yet committed to the database) would have to be stored on a temporary page, and then deleted from the temporary page if the database query resulted in a match. Moving the matching account number query before the new work object creation reduces system overhead, creating new work objects only when necessary.

Page 75: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 75 of 115

Label Description Step Page Method 4. Create new work object pyWorkPage Call

svcAddWorkObject Parameter Value FlowType DisplayPropertiesMain organization “TriTek.com” workPage pyWorkPage The Property-Set method sets the pagelistCounter property equal to 0. A precondition evaluates the CreateNewWOB value. If the CreateNewWOB value is equal to true, the step continues execution. If the CreateNewWOB value is false, this step will be skipped. Table 167 - createWorkObjectF Activity Rule Step 5 Properties

Precondition Enabled? (true)

When if True True Param if False False Param param.CreateNewWOB==false Skip step Label Description Step Page Method 5. Initialize pagelistCounter pyWorkPage Property-Set PropertiesName PropertiesValue .pagelistCounter 0 The Call MapMultipleDocIds method calls the MapMultipleDocIds activity. This activity will map each document ID to the next element in the ISDocIds value list-type property stored on the tempDocTypePage page. Table 168 - createWorkObjectF Activity Rule Step 6 Properties

Label Description Step Page Method 6. Map docid parameter to ISDocIds Call

MapMultipleDocIds Parameter Value docId tempDocTypePage.docid The Property-Set method sets the AccountNumber to the current WOB. This needs to be set at the very least if we are not mapping the other properties at this time. This is to insure that WOBs that have yet to be viewed in a flow action will be searched for when looking for matching Account Numbers

Page 76: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 76 of 115

Table 169 - createWorkObjectF Activity Rule Step 6 Properties

Label Description Step Page Method 7. Set AccountNumber of the WOB pyWorkPage Property-Set PropertiesName PropertiesValue .AccountNumber tempDocTypePage.AccountNumber The Property-Set method will map the first value in the ISDocIds value list property to the docid property. This value will be considered the default document ID value for the work object. Table 170 - createWorkObjectF Activity Rule Step 8 Properties

Label Description Step Page Method 8. Map ISDocIds(1) to docid (default

value) pyWorkPage Property-Set

PropertiesName PropertiesValue .docid .ISDocIds(1) The Obj-Save method marks the work object for a pending save to the PegaRULES database. Table 171 - createWorkObjectF Activity Rule Step 9 Properties

Label Description Step Page Method 9. Save the work page pyWorkPage Obj-Save Parameter Value WriteNow false WithErrors false The Call commitWithErrorHandling method commits the work object to the PegaRULES database. Table 172 - createWorkObjectF Activity Rule Step 10 Properties

Label Description Step Page Method 10. Commit everything pyWorkPage Call

commitWithErrorHandling Parameter Value OnlyCreateOutputPageIfError false OutputPageName n/a OutputPageClass n/a

Page 77: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 77 of 115

The Page-Remove method removes the tempDocTypePage page from the clipboard. Table 173 - createWorkObjectF Activity Rule Step 11 Properties

Label Description Step Page Method 11. tempDocTypePage Page-Remove The Page-Remove method removes the primary page from the clipboard. Table 174 - createWorkObjectF Activity Rule Step 12 Properties

Label Description Step Page Method 12. Remove Primary Page Page-Remove Label Description Step Page Method 13. Exception Exception handling exit activity Exit-Activity The Parameters tab lists the parameters required for the activity. Table 175 - createWorkObject Activity Rule Parameters Tab Properties

Name Description Data Type Required? In/Out Prompt Default Value

docId String Yes In CreateNewWOB Boolean No true AccountNumberToSearch Decimal No The Pages & Classes tab lists the pages required for the activity. Table 176 - createWorkObject Activity Rule Pages & Classes Tab Properties

Page Name Class Mode pyWorkPage TriTek-FW-RepoConnector-

Work n/a

tempDocTypePage TriTek-FW-RepoConnector-Work

n/a

The Security tab lists security settings for the activity. Table 177 - createWorkObject Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name false false Activity n/a n/a 3.1.5.3.2. getDistQueuePropertiesF

Page 78: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 78 of 115

The getDistQueueProperties activity rule will retrieve several document index values from the IS instance and set properties on the tempDocTypePage page equal to these values. The Page-New method creates a new step page, the tempDocTypePage page. Table 178 - getDistQueueProperties Activity Rule Step 1 Properties

Label Description Step Page Method 1. Create new page tempDocTypePage Page-New The Property-Set method calls multiple function rules . Table 179 - getDistQueueProperties Activity Rule Step 2 Properties

Label Description Step Page Method 2. Property-Set PropertiesName PropertiesValue tempDocTypePage.DocType Lib(TriTek:QueueLibrary).getStringFunction("DocType") tempDocTypePage.AccountNumber

Lib(TriTek:QueueLibrary).getStringFunction("AccountNumber")

param.AccountNumberToSearch tempDocTypePage.AccountNumber The Page-Remove method removes the Primary page Table 180 - getDistQueueProperties Activity Rule Step 3 Properties

Label Description Step Page Method 3. Page-Remove The Pages & Classes tab defines the required pages. Table 181 - getDistQueueProperties Activity Rule Pages & Classes Tab Properties

Page Name Class Mode tempDocTypePage TriTek-FW-RepoConnector-

Work n/a

pyWorkPage TriTek-FW-RepoConnector-Work

n/a

The Security tab defines the security settings. Table 182 - getDistQueueProperties Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name false true Activity TriTek-FW- n/a

Page 79: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 79 of 115

RepoConnector-Int-QueueWrapper

3.1.5.3.3. getISEntryF

The getISEntry activity rule will retrieve an entry from the IS queue, retrieve the document ID from the IS instance, call the createWorkObject activity, then remove the document from the IS queue. This will continue until all documents in the IS queue have been processed, at which point processing ends. The Page-New method creates a new Primary page using a model rule. Table 183 - getISEntry Activity Rule Step 1 Properties

Label Description Step Page Method 1. Create new page with EnvProperties Page-New Parameter Value Model EnvProperties PageList NewClass The Property-Set calls QueueLibrary getEntryFunction function rule Table 184 - getISEntry Activity Rule Step 2 Properties

Label Description Step Page Method 2. Call getEntryFunction Property-Set Parameter Value Primary.checkdocid Lib(TriTek:QueueLibrary).getEntryFunction(Primary.Workspace,

Primary.QueueName, "DOCID") The Call createWorkObjectF method calls our activity Table 185 - getISEntryF Activity Rule Step 3 Properties

Precondition Enabled? (true) When if True True Param if False False Param hasNext Exit Activity Continue Whens

Label Description Step Page Method 3. Create new work object if docID

exists call

createWorkObjectF

Page 80: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 80 of 115

The Property-Set method invokes the QueueLibrary deleteFunction function rule. The returned String is mapped to local.deleteString Table 186 - getISEntryF Activity Rule Step 4 Properties

Label Description Step Page Method 4. After round, delete entry from IS Property-Set PropertiesName PropertiesValue local.deleteString Lib(TriTek:QueueLibrary).deleteFunction() The call getISEntryF method invokes our activity. Table 187 - getISEntryF Activity Rule Step 5 Properties

Label Description Step Page Method 5. Get next entry from IS Queue Call getISEntryF The Page-Remove method will remove the Primary page. Table 188 - getISEntry Activity Rule Step 6 Properties

Label Description Step Page Method 6. Remove Primary page Page-Remove Table 189 - getISEntry Activity Rule Step 7 Properties

Label Description Step Page Method 7. Exception handling exit activity Exit-Activity The Security tab lists the security settings. Table 190 - getISEntry Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name false true Activity TriTek-FW-

RepoConnector-Int-QueueWrapper

n/a

3.1.5.3.4. MapMultipleDocIds

The MapMultipleDocIds activity rule will increment the pagelistCounter property value and then add a document ID to the ISDocIds property.

Page 81: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 81 of 115

The Property-Set method adds 1 to pagelistCounter. Table 191 - MapMultipleDocIds Activity Rule Step 1 Properties

Label Description Step Page Method 1. increment pagelistCounter Property-Set PropertiesName PropertiesValue prWorkPage.pagelistCounter pyWorkPage.pagelistCounter+1 The Property-Set method adds the current document ID to the ISDocIds value list. Table 192 - MapMultipleDocIds Activity Rule Step 2 Properties

Label Description Step Page Method 2. Add docid to value list Property-Set PropertiesName PropertiesValue prWorkPage.ISDocIds(pyWorkPage) Param.docId The Parameters tab lists the required parameters. Table 193 - MapMultipleDocIds Activity Rule Parameters Tab Properties

Name Description Data Type Required? In/Out Prompt Default Value

docId String Yes In n/a The Pages & Classes tab lists the required pages. Table 194 - MapMultipleDocIds Activity Rule Pages & Classes Properties

Page Name Class Mode counterPage TriTek-FW-RepoConnector-

Int-QueueWrapper n/a

pyWorkPage TriTek-FW-RepoConnector-Work

n/a

The Security tab lists the security settings. Table 195 - MapMultipleDocIds Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name true true Activity TriTek-FW-

RepoConnector-Int-

n/a

Page 82: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 82 of 115

QueueWrapper 3.1.5.3.5. SearchForAccountNumber

The SearchForAccountNumber activity rule will create a temporary page to store search results, query the PegaRULES database for a work object with a matching document id, and store the match on the temporary page. The CreateNewWOB property is set equal to true. If no match was found, the page is removed. If a match was found, CreateNewWOB is set equal to false, and the matching work item is opened. The Page-New method creates the searchResults step page. The page will be initialized with values from the pyDefault model rule. Table 196 - SearchForAccountNumber Activity Rule Step 1 Properties

Label Description Step Page Method 1. Create a new page to hold the search

results searchResults Page-New

Parameter Value Model pyDefault PageList n/a NewClass n/a The Obj-Browse method queries the PegaRULES database for any AccountNumber value equal to the AccountNumberToSearch value. Table 197 - SearchForAccountNumber Activity Rule Step 2 Properties

Label Description Step Page Method 2. Query the DB using the

AccountNumber param Obj-Browse

Parameter Value PageName searchResults ObjClass TriTek-FW-RepoConnector-Work MaxRecords n/a GetRowKey False RowKey n/a ReadOnly False Logic n/a Label Select Field Condition Value Sort n/a False .AccountNumber Is Equal Param.AccountNumberToSearch No

Sorting

Page 83: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 83 of 115

The Page-Copy method copies the searchResults page to the tempWorkPage page. Table 198 - SearchForAccountNumber Activity Rule Step 3 Properties

Label Description Step Page Method 3. Copy the first entry of pxResult

page list to pyWorkPage(should only be a single entry)

Page-Copy

Parameter Value CopyFrom searchResults.pxResults(1) CopyInto tempWorkPage Model n/a PageList n/a The Property-Set method sets the CreateNewWOB property value equal to true. Table 199 - SearchForAccountNumber Activity Rule Step 4 Properties

Label Description Step Page Method 4. Default CreateWOB to true Property-Set PropertiesName PropertiesValue param.CreateNewWOB true The Property-Set method sets the CreateNewWOB property value equal to false. A precondition will evaluate whether or not the AccountNumber value is equal to the AccountNumberToSearch value. If this is true, the activity continues. If this is false, this step is skipped. Table 200 - SearchForAccountNumber Activity Rule Step 5 Properties

Precondition Enabled? (true)

When if True True Param if False False Param tempWorkPage.AccountNumber== param.AccountNumberToSearch

Continue Whens

Skip Step

Label Description Step Page Method 5. If AccountNumber equals

param.AccountNumber change to false

tempWorkPage Property-Set

PropertiesName PropertiesValue param.CreateNewWOB false

Page 84: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 84 of 115

The Obj-Open-By-Handle method opens the work object that has the same value as the pzInsKey value stored on the tempWorkPage page. Table 201 - SearchForAccountNumber Activity Rule Step 6 Properties

Precondition Enabled? (true)

When if True True Param if False False Param tempWorkPage.AccountNumber== param.AccountNumberToSearch

Skip Step

Label Description Step Page Method 6. pyWorkPage Obj-Open-By-

Handle Parameter Value InstanceHandle tempWorkPage.pzInsKey Lock true ReleaseOnCommit true LockInfoPage n/a The Page-Remove method removes the searchResults page from the Clipboard. Table 202 - SearchForAccountNumber Activity Rule Step 7 Properties

Label Description Step Page Method 7. Remove unneeded page searchResults Page-Remove The Parameters tab lists the required parameters. Table 203 - SearchForAccountNumber Activity Rule Parameters Tab Properties

Name Description Data Type Required? In/Out Prompt Default Value

AccountNumberToSearch Decimal No In n/a CreateNewWOB Boolean No Out n/a The Pages & Classes tab lists the required pages. Table 204 - SearchForAccountNumber Activity Rule Pages & Classes Properties

Page Name Class Mode tempWorkPage TriTek-FW-RepoConnector-

Work n/a

searchResults Code-Pega-List n/a

Page 85: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 85 of 115

tempDocTypePage TriTek-FW-RepoConnector-Work

n/a

The Security tab lists the security settings. Table 205 - SearchForAccountNumber Activity Rule Security Tab Properties

Security Tab May start? Authenticate? Activity Type Privilege Class Privilege Name true true Activity TriTek-FW-

RepoConnector-Int-QueueWrapper

n/a

3.1.5.3.6. startISProcessF

The startISProcess activity rule will create a new page, call the function rule to log into the IS instance, call the getISEntryF activity to process all documents in the IS distribution queue, then log off from the IS instance and remove the page from the Clipboard. The TriTek agent calls this activity on a periodic basis. This activity serves as the starting point to the entire process, as it monitors the IS distribution queue and intakes new documents. The Page-New method will create a new page associated with the QueueWrapper class. This page’s values will be initialized by the EnvProperties model rule. Table 206 - startISProcessF Activity Rule Step 1 Properties

Label Description Step Page Method 1. Create new page Page-New Parameter Value Model EnvProperties PageList n/a NewClass n/a The Property-Set method will call the logonFunction function rule. The logonFunction rule will logon to the IS instance. Table 207 - startISProcessF Activity Rule Step 2 Properties

Label Description Step Page Method 2. Logon Property-Set PropertiesName PropertiesValue local.logonVar Lib(TriTek:QueueLibrary).logonFunction(Primary.ClassName,

Primary.JNDI, Primary.MaxRetries, Primary.PollingInterval,

Page 86: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 86 of 115

Primary.UserName, Primary.Password) The Call getISEntryF method will call the getISEntryF activity rule. The getISEntry activity rule will retrieve a document from the IS distribution queue. Table 208 - startISProcessF Activity Rule Step 3 Properties

Label Description Step Page Method 3. Call get IS queue entry call getISEntryF The Property-Set method calls the logoffFunction function rule which will log off of the IS instance. Table 209 - startISProcessF Activity Rule Step 4 Properties

Label Description Step Page Method 4. Finalize log off IS Library Property-Set PropertiesName PropertiesValue Local.logonVar Lib(TriTek:QueueLibrary).logoffFunction() The Page-Remove method removes the primary page. Table 210 - startISProcessF Activity Rule Step 5 Properties

Label Description Step Page Method 5. Remove primary page Page-Remove The Parameters tab lists the local variables. Table 211 - startISProcessF Parameters Tab

Name Description Data Type logonVar String The Security tab lists the security settings. Table 212 - startISProcessF Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name true false Activity n/a n/a 3.1.5.4. Class

The following describes the class definition.

Page 87: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 87 of 115

3.1.5.4.1. TriTek-FW-RepoConnector-Int-QueueWrapper

The QueueWrapper class is an abstract class that inherits directly from TriTek-FW-RepoConnector-Int-. Table 213 - QueueWrapper Class Properties

General Tab Select: Created in Version: Find by name first

(Pattern)? Parent class (Directed):

Abstract 01-01-01 true TriTek-FW-RepoConnector-Int-

3.1.6. CE Integration Class

TriTek-FW-RepoConnector-Int-CEWrapper is an abstract data class responsible for parsing incoming document properties passed from CE, and based on the information, attaching the document reference either to a new work object or to an existing work object that matches on a given key. 3.1.6.1. Property

The following describes the required properties. These properties will pass values between PRPC and CE, and will not be displayed directly to the user.

3.1.6.1.1. http_request

The http_request property will hold the incoming CE document properties as XML. Table 214 - http_request Property Rule Properties

Property Mode Property Type: HTML Property: Table Type: Single value Text n/a None 3.1.6.1.2. http_response

The http_response property will hold the status of the work item creation (success or failure). Table 215 - http_response Property Rule Properties

Property Mode Property Type: HTML Property: Table Type: Single value Text n/a None 3.1.6.1.3. UserName

The UserName property will hold the user name needed to logon to CE.

Page 88: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 88 of 115

Table 216 - UserName Property Rule Properties

Property Mode Property Type: HTML Property: Table Type: Single value Text n/a None

3.1.6.1.4. Password

The Password property will hold the password needed to logon to CE.

Table 217 - Password Property Rule Properties

Property Mode Property Type: HTML Property: Table Type:

Single value Text n/a None

3.1.6.1.5. ObjectStore

The ObjectStore property will hold the name of the CE Object Store which to connect to.

Table 218 - ObjectStore Property Rule Properties

Property Mode Property Type: HTML Property: Table Type: Single value Text n/a None

3.1.6.1.6. AppId

The AppId property will hold the name of the AppId used in connecting to CE

Table 219 - AppId Property Rule Properties

Property Mode Property Type: HTML Property: Table Type: Single value Text n/a None

3.1.6.1.7. basePath

The basePath property will hold the full path of the directory that contains the WcmApiConfig.properties file.

Table 220 - basePath Property Rule Properties

Property Mode Property Type: HTML Property: Table Type:

Page 89: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 89 of 115

Single value Text n/a None

3.1.6.1.8. ClassName

The Classname property will hold the name of the class which implements ContentSystem for CE (com.triteksol.content.p8.P8ContentEngine)

Table 221 - ClassName Property Rule Properties

Property Mode Property Type: HTML Property: Table Type: Single value Text n/a None

3.1.6.1.9. UseVirtualFolders

The UseVirtualFolders property will hold the String value of “true” or “false” to be used when creating a connection to CE.

Table 222 - UseVirtualFolders Property Rule Properties

Property Mode Property Type: HTML Property: Table Type: Single value Text n/a None

3.1.6.1.10. WcmApiConfig

The WcmApiConfig property will hold the name of the eponymous file.

Table 223 - WcmApiConfig Property Rule Properties

Property Mode Property Type: HTML Property: Table Type: Single value Text n/a None

3.1.6.1.11. reIndex_arg1

The reIndex_arg1 property will hold a string of xml containing the new values.

Table 224 - reIndex_arg1 Property Rule Properties

Property Mode Property Type: HTML Property: Table Type: Single value Text n/a None

3.1.6.1.12. reIndex_return

Page 90: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 90 of 115

The reIndex_return property will hold the value returned from the reIndex function with a “Successful” or “Unsuccessful”

Table 225 - reIndex_return Property Rule Properties

Property Mode Property Type: HTML Property: Table Type: Single value Text n/a None

3.1.6.2. Parse XML

The following describes the required Parse XML rule.

3.1.6.2.1. DocPropertiesXMLParse.Document

The DocPropertiesXMLParse.Document parse XML rule will map incoming document index values from the CE instance to the appropriate work object properties in PRPC. Note that this will need to be configured for the specific CE instance. 3.1.6.3. XML Stream

3.1.6.3.1. reIndexStream ReIndex

The reIndexStream Reindex stream rule will map properties from the workpage into an xml schema similar to that of the Parse XML rule. In the CE instance the GUID (CE’s unique content identifier will take the place of the docid in the DOCID node.

3.1.6.4. Activity

The following describes the required activities.

3.1.6.4.1. createWorkObject

The createWorkObject activity rule will map a document ID to a work object. The activity parses an incoming XML stream, containing CE document properties, and copies the results to a temporary page. It queries the PegaRULES database for a work object with a matching AccountNumber property value. If a match is found, the activity will open the existing work object. Otherwise, the activity will create a new work object for the IS document, then set the pagelistCounter equal to 0. The activity will associate the CE document ID with the work object, populate the work object with document index properties retrieved from the document stored in the IS instance, save the work object, commit the work object to the PegaRULES database, and remove unnecessary pages.

Page 91: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 91 of 115

The Page-New method will create a new page, pyWorkPage. Table 226 - createWorkObject Activity Rule Step 1 Properties

Label Description Step Page Method 1. Create new workpage pyWorkPage Page-New Parameter Value Model n/a PageList n/a NewClass n/a The Page-New method will create a new page, tempDocTypePage. This page will temporarily store document index values. Table 227 - createWorkObject Activity Rule Step 2 Properties

Label Description Step Page Method 2. Create temp page tempDocTypePage Page-New Parameter Value Model n/a PageList n/a NewClass n/a The Apply-Parse-XML method will parse the incoming http request from the CE instance, stored in the http_request property, to retrieve the CE document property values. Table 228 - createWorkObject Activity Rule Step 3 Properties

Label Description Step Page Method 3. Parse the http request Apply-Parse-

XML Parameter Value Namespace DocPropertiesXMLParse ElementName Document SourceProperty .http_request The Page-Copy method will copy the values from the pyWorkPage page to the tempDocTypePage. Table 229 - createWorkObject Activity Rule Step 4 Properties

Label Description Step Page Method 4. copy to temp page Page-Copy

Page 92: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 92 of 115

The Property-Set method will set the AccountNumberToSearch property value equal to the document ID. Table 230 - createWorkObject Activity Rule Step 5 Properties

Label Description Step Page Method 5. map to param Property-Set PropertiesName PropertiesValue param.AccountNumberToSearch tempDocTypePage.AccountNumber The Call SearchForAccountNumber method will call the SearchForAccountNumber activity. Using the document ID stored on the tempDocTypePage page, the SearchForAccountNumber activity will query the PegaRULES database for a work object with a matching document ID and return a boolean. Table 231 - createWorkObject Activity Rule Step 6 Properties

Label Description Step Page Method 6. Search for matching

AccountNumbers Call

SearchForAccountNumber Pass current parameter page? true The Call svcAddWorkObject method will create a new work object. A precondition evaluates the CreateNewWob value. If the CreateNewWOB value returned from the SearchForAccountNumber method is equal to true, the step continues execution. If the CreateNewWOB value is false, this step will be skipped. 3 Table 232 - createWorkObject Activity Rule Step 7 Properties

Precondition Enabled? (true)

When if True True Param if False False Param param.CreateNewWOB==false Skip step Continue

Whens

3 The svcAddWorkObject method creates the new work object, and starts the associated flow, before committing that work object to the database. It is possible to incorporate the account number matching into a utility activity referenced in the flow. However, this approach would require deleting the newly created work objects if a matching work object was found. These work objects (not yet committed to the database) would have to be stored on a temporary page, and then deleted from the temporary page if the database query resulted in a match. Moving the matching account number query before the new work object creation reduces system overhead, creating new work objects only when necessary.

Page 93: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 93 of 115

Label Description Step Page Method 7. Create a newWOB pyWorkPage Call

svcAddWorkObject Parameter Value FlowType DisplayCEPropertiesMain organization “TriTek.com” workPage pyWorkPage The Property-Set method sets the pagelistCounter property equal to 0. A precondition evaluates the CreateNewWOB value. If the CreateNewWOB value is equal to true, the step continues execution. If the CreateNewWOB value is false, this step will be skipped. Table 233 - createWorkObject Activity Rule Step 8 Properties

Precondition Enabled? (true)

When if True True Param if False False Param param.CreateNewWOB==false Skip step Label Description Step Page Method 8. Initialize pagelistCounter pyWorkPage Property-Set PropertiesName PropertiesValue .pagelistCounter 0 The Apply-Parse-XML method will parse the incoming http request from the CE instance, stored in the http_request property, to retrieve the CE document property values. Table 234 - createWorkObject Activity Rule Step 9 Properties

Label Description Step Page Method 9. parse http request (again) to current

workpage Apply-Parse-

XML Parameter Value Namespace DocPropertiesXMLParse ElementName Document SourceProperty .http_request The Property-Set method will add the prefix ‘D’ to the GUID. The ‘D’ stands for document as opposed to a ‘V’ for versioning. This will have to be configured depending on how CE is set up.

Page 94: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 94 of 115

Table 235 - createWorkObject Activity Rule Step 10 Properties

Label Description Step Page Method 10. add 'D' to beginning of GUID pyWorkPage Property-SEt PropertiesName PropertiesValue .GUID “D” +.GUID The Call MapMultipleDocIds method calls the MapMultipleDocIds activity. This activity will map each document ID to the next element in the ISDocIds value list-type property stored on the tempDocTypePage page. Table 236 - createWorkObject Activity Rule Step 11 Properties

Label Description Step Page Method 11. append docid to value list Call

MapMultipleDocIds Parameter Value docId tempDocTypePage.docid The Call SavePegaProperties method calls the SavePegaProperties activity. This activity will map work object properties displayed in the section to the page list property. Table 237 - createWorkObject Activity Rule Step 12 Properties

Label Description Step Page Method 12. append properties to pagelist Call

SavePegaProperties Pass current parameter page? false The Property-Set method will set the http_response property equal a success status, since the activity has reached this point without error. Table 238 - createWorkObject Activity Rule Step 13 Properties

Label Description Step Page Method 13. Set http response (hardcoding it for

now) Property-Set

PropertiesName PropertiesValue .http_response “Success” The Obj-Save method marks the work object for a pending save to the PegaRULES database.

Page 95: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 95 of 115

Table 239 - createWorkObject Activity Rule Step 14 Properties

Label Description Step Page Method 14. Save the WOB pyWorkPage Obj-Save Parameter Value WriteNow false WithErrors false The Call commitWithErrorHandling method commits the work object to the PegaRULES database. Table 240 - createWorkObject Activity Rule Step 15 Properties

Label Description Step Page Method 15. Commit to DB pyWorkPage Call

commitWithErrorHandling Parameter Value OnlyCreateOutputPageIfError false OutputPageName n/a OutputPageClass n/a The Page-Remove method removes the tempDocTypePage page from the clipboard Table 241 - createWorkObject Activity Rule Step 16 Properties

Label Description Step Page Method 16. tempDocTypePage Page-Remove The Page-Remove method removes the Primary page from the clipboard. Table 242 - createWorkObject Activity Rule Step 17 Properties

Label Description Step Page Method 17. tempDocTypePage Page-Remove The Parameters tab lists the parameters required for the activity. Table 243 - createWorkObject Activity Rule Parameters Tab Properties

Name Description Data Type Required? In/Out Prompt Default Value

CreateNewWOB Boolean No true AccountNumberToSearch Integer No

Page 96: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 96 of 115

The Pages & Classes tab lists the pages required for the activity. Table 244 - createWorkObject Activity Rule Pages & Classes Tab Properties

Page Name Class Mode pyWorkPage TriTek-FW-RepoConnector-

Work n/a

tempDocTypePage TriTek-FW-RepoConnector-Work

n/a

The Security tab lists security settings for the activity. Table 245 - createWorkObject Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name true true Activity TriTek-FW-

RepoConnector-Int-CEWrapper

n/a

3.1.6.4.2. getDocumentPropertiesXMLF

The getDocumentPropertiesXMLF activity will call the FNCELibrary getDocPropsFunction and retrieve the xml in the parameter returnxml and pass that to the Parse XML rule. (DocPropertiesXMLParse Document)

The Page-New method initializes a new primary page with the properties set from our model rule.

Table 246 - getDocumentPropertiesXMLF Activity Rule Step 1 Properties

Label Description Step Page Method 1. Create a temporary data page Page-New Parameter Value Model CEEnvProperties PageList n/a NewClass n/a

The function rule getDocPropsFunction is called via a Property-Set.

Table 247 - getDocumentPropertiesXMLF Activity Rule Step 2 Properties

Label Description Step Page Method 2. Call function rule Property-Set PropertiesName PropertiesValue

Page 97: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 97 of 115

Local.returnxml Lib(TriTek:FNCELibrary).getDocPropsFunction(pyWorkPage.GUID, Primary.UserName, Primary.Password, Primary.ClassName, Primary.WcmApiConfig, Primary.AppId, Primary.ObjectStore, Primary.UseVirtualFolders, Primary.basePath)

The Apply-Parse-XML rule calls our Parse XML to parse the returned xml string from the getDocPropsFunction.

Table 248 - getDocumentPropertiesXMLF Activity Rule Step 3 Properties

Label Description Step Page Method 3. Use parse rule to map to Pega

Properties Apply-Parse-

XML Parameter Value Namespace DocPropertiesXMLParse ElementName Document SourceProperty Local.returnxml

The Page-Remove method removes the primary page as it is no longer needed.

Table 249 - getDocumentPropertiesXMLF Activity Rule Step 4 Properties

Label Description Step Page Method 4. Removes the page Page-Remove

The Parameters tab lists the local variables.

Table 250 - getDocumentPropertiesXMLF Activity Rule Parameters Tab

Name Description Data Type returnxml XML returned String

3.1.6.4.3. reIndexF

The reIndexF activity rule will call the Stream XML rule to create a string of xml and then pass that to the Rule-Utility-Function FNCELibrary reIndexFunction.

The Page-New method initializes a new primary page with the properties set from our model rule.

Page 98: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 98 of 115

Table 251 - reIndexF Activity Rule Step 1 Properties

Label Description Step Page Method 1. Create a temporary data page Page-New Parameter Value Model CEEnvProperties PageList n/a NewClass n/a

The Property-Set-XMl methods calls the Stream XML rule

Table 252 - reIndexF Activity Rule Step 2 Properties

Label Description Step Page Method 2. Set XML properties Property-Set-

XML Parameter Value PropertyName Local.reindex_arg1 ElementName reIndexStream SourceProperty ReIndex

The function rule reIndexFunction is called via a Property-Set.

Table 253 - reIndexF Activity Rule Step 3 Properties

Label Description Step Page Method 3. Call reIndex Function Property-Set PropertiesName PropertiesValue Primary.reIndex_return Lib(TriTek:FNCELibrary).reindexFunction(local.reindex_arg1,

Primary.UserName, Primary.Password, Primary.ClassName, Primary.WcmApiConfig, Primary.AppId, Primary.ObjectStore, Primary.UseVirtualFolders, Primary.basePath)

The Page-Remove method removes the primary page as it is no longer needed.

Table 254 - reIndexF Activity Rule Step 4 Properties

Label Description Step Page Method 4. Removes the page Page-Remove

The Parameters tab lists the local variables

Page 99: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 99 of 115

Table 255 - reIndexF Activity Rule Parameters Tab

Name Description Data Type reindex_arg1 Outgoing XML String

3.1.6.4.4. MapMultipleDocIds

The MapMultipleDocIds activity rule will increment the pagelistCounter property value, then add a document ID to the ISDocIds property. The Property-Set method adds 1 to pagelistCounter. Table 256 - MapMultipleDocIds Activity Rule Step 1 Properties

Label Description Step Page Method 1. increment pagelistCounter Property-Set PropertiesName PropertiesValue prWorkPage.pagelistCounter pyWorkPage.pagelistCounter+1 The Property-Set method adds the current document ID to the ISDocIds value list. Table 257 - createWorkObject Activity Rule Step 2 Properties

Label Description Step Page Method 2. Add docid to value list Property-Set PropertiesName PropertiesValue prWorkPage.ISDocIds(pyWorkPage) Param.docId The Parameters tab lists the required parameters. Table 258 - createWorkObject Activity Rule Parameters Tab Properties

Name Description Data Type Required? In/Out Prompt Default Value

docId String Yes In n/a The Pages & Classes tab lists the required pages. Table 259 - createWorkObject Activity Rule Pages & Classes Tab Properties

Page Name Class Mode pyWorkPage TriTek-FW-RepoConnector-

Work n/a

Page 100: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 100 of 115

The Security tab lists the security settings. Table 260 - createWorkObject Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name true true Activity TriTek-FW-

RepoConnector-Int-QueueWrapper

n/a

3.1.6.4.5. SearchForAccountNumber

The SearchForAccountNumber activity rule will create a temporary page to store search results, query the PegaRULES database for a work object with a matching document id, and store the match on the temporary page. The CreateNewWOB property is set equal to true. If no match was found, the page is removed. If a match was found, CreateNewWOB is set equal to false, and the matching work item is opened. The Page-New method creates the searchResults step page. The page will be initialized with values from the pyDefault model rule. Table 261 - SearchForAccountNumber Activity Rule Step 1 Properties

Label Description Step Page Method 1. Create a new page to hold the search

results searchResults Page-New

Parameter Value Model pyDefault PageList n/a NewClass n/a The Obj-Browse method queries the PegaRULES database for any AccountNumber value equal to the AccountNumberToSearch value. Table 262 - SearchForAccountNumber Activity Rule Step 2 Properties

Label Description Step Page Method 2. Query the DB using the

AccountNumber param Obj-Browse

Parameter Value PageName searchResults ObjClass TriTek-FW-RepoConnector-Work

Page 101: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 101 of 115

MaxRecords n/a GetRowKey False RowKey n/a ReadOnly False Logic n/a Label Select Field Condition Value Sort n/a False .AccountNumber Is Equal Param.AccountNumberToSearch No

Sorting The Page-Copy method copies the searchResults page to the tempWorkPage page. Table 263 - SearchForAccountNumber Activity Rule Step 3 Properties

Label Description Step Page Method 3. Copy the first entry of pxResult

page list to pyWorkPage(should only be a single entry)

Page-Copy

Parameter Value CopyFrom searchResults.pxResults(1) CopyInto tempWorkPage Model n/a PageList n/a The Property-Set method sets the CreateNewWOB property value equal to true. Table 264 - SearchForAccountNumber Activity Rule Step 4 Properties

Label Description Step Page Method 4. Default CreateWOB to true Property-Set PropertiesName PropertiesValue param.CreateNewWOB true The Property-Set method sets the CreateNewWOB property value equal to false. A precondition will evaluate whether or not the AccountNumber value is equal to the AccountNumberToSearch value. If this is true, the activity continues. If this is false, this step is skipped. Table 265 - SearchForAccountNumber Activity Rule Step 5 Properties

Precondition Enabled? (true)

When if True True Param if False False Param tempWorkPage.AccountNumber== param.AccountNumberToSearch

Continue Whens

Skip Step

Page 102: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 102 of 115

Label Description Step Page Method 5. If AccountNumber equals

param.AccountNumber change to false

tempWorkPage Property-Set

PropertiesName PropertiesValue param.CreateNewWOB false The Obj-Open-By-Handle method opens the work object that has the same value as the pzInsKey value stored on the tempWorkPage page. Table 266 - SearchForAccountNumber Activity Rule Step 6 Properties

Precondition Enabled? (true)

When if True True Param if False False Param tempWorkPage.AccountNumber== param.AccountNumberToSearch

Skip Step

Label Description Step Page Method 6. pyWorkPage Obj-Open-By-

Handle Parameter Value InstanceHandle tempWorkPage.pzInsKey Lock true ReleaseOnCommit true LockInfoPage n/a The Page-Remove method removes the searchResults page from the Clipboard. Table 267 - SearchForAccountNumber Activity Rule Step 7 Properties

Label Description Step Page Method 7. Remove unneeded page searchResults Page-Remove The Parameters tab lists the required parameters. Table 268 - SearchForAccountNumber Activity Rule Parameters Tab Properties

Name Description Data Type Required? In/Out Prompt Default Value

AccountNumberToSearch Decimal No In n/a CreateNewWOB Boolean No Out n/a

Page 103: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 103 of 115

The Pages & Classes tab lists the required pages. Table 269 - SearchForAccountNumber Activity Rule Pages & Classes Tab Properties

Page Name Class Mode tempWorkPage TriTek-FW-RepoConnector-

Work n/a

searchResults Code-Pega-List n/a tempDocTypePage TriTek-FW-RepoConnector-

Work n/a

The Security tab lists the security settings. Table 270 - SearchForAccountNumber Activity Rule Security Tab Properties

May start? Authenticate? Activity Type Privilege Class Privilege Name true true Activity TriTek-FW-

RepoConnector-Int-QueueWrapper

n/a

3.1.6.5. Model

3.1.6.5.1. CEEnvProperties

Sets the values of properties used to connect and logon to CE

Table 271- CEEnvProperties Definition Tab

Property Value Primary.UserName The username needed to log on to CE Primary.Password The password needed to log on to CE Primary.ClassName “com.triteksol.content.p8.P8ContentEngine”(the

name of the java class which communicates with CE)

Primary.AppId AppId Primary.ObjectStore The name of the object store Primary.UseVirtualFolders A true or false value in the form of a string Primary.WcmApiConfig “$/WcmApiConfig.properties”, The name of the

WcmApiConfig file Primary.basePath The basepath to the WcmApiConfig file.

3.2. Custom Java Classes

Page 104: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 104 of 115

Several Java classes will be used within the ECM connector framework. The J2ISPegaWrapper class will retrieve document properties from the FileNet content repository. The QueueWrapper class will query the IS instance for documents in the distribution queue, in order to create PRPC work objects. The CEWrapper class will generate work objects based on document property information passed from the CE instance. 3.2.1. com.triteksol.content.j2is.J2ISPegaWrapper

The following details the methods in the J2ISPegaWrapper class. 3.2.1.1. J2ISPegaWrapper

Public method that initializes the object with the input parameter values. These values will be used to logon to the IS instance. Table 272 - J2ISPegaWrapper Method Parameters

Input Parameters Name Type Description sClassName String classname used to login sJNDI String JNDI reference to the IS instance iPollingInterval int number of seconds between login attempts iMaxRetries int maximum number of attempts to login before stopping 3.2.1.2. logon

Public method that logs onto the IS instance using the input parameter values and the values initialized when the object was created. Table 273 - logon Method Parameters

Input Parameters Name Type Description sUSer String username used to login sPassword String password used to login 3.2.1.3. getDocumentProperties

Public method that returns a map of document properties based on the input document identifier.

Table 274 - getDocumentProperties Method Parameters

Input Parameters Name Type Description sDocID String document identifier

Page 105: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 105 of 115

Output Parameters

Name Type Description myMap Map map of document index properties and values 3.2.1.4. launchURL

Public method that does one of two things; if Windows is the operating system, opens the document in the Daeja viewer servlet in a browser window. If Windows is not the operating system, returns a system error stating the browser could not be opened. Table 275 - launchURL Method Parameters

Input Parameters Name Type Description URL String URL passed to open document in the Daeja Viewer servlet 3.2.1.5. getDocPropsXML

Public method that calls getDocumentProperties to retrieve the document properties. Table 276 - getDocumentPropertiesXML Method Parameters

Input Parameters Name Type Description sDocID String document identifier Output Parameters

Name Type Description docElement Element contains XML string of document properties 3.2.1.6. reIndex

Public method that parses an XML object containing values to reindex the properties of a specific document. Table 277 - reIndex Method Parameters

Input Parameters Name Type Description xml String XML containing document property values to be parsed 3.2.1.7. logoff

Public method that logs off of the Content System

Page 106: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 106 of 115

3.2.2. com.triteksol.content.isqueue.QueueWrapper

The following details the methods in the QueueWrapper class. 3.2.2.1. logon

Public method that logs onto the IS instance. Table 278 - logon Method Parameters

Input Parameters Name Type Description sUSer String username used to login sPassword String password used to login jndi String JNDI reference used to login 3.2.2.2. QueueWrapper

Public method that initializes the object with the input parameter values. These values will be used to logon to the IS instance. Table 279 - QueueWrapper Method Parameters

Input Parameters Name Type Description sClassName String classname used to login sJNDI String JNDI reference to the IS instance iPollingInterval int number of seconds between login attempts iMaxRetries int maximum number of attempts to login before stopping 3.2.2.3. getISQueueEntry

Public method that retrieves the data from the first row of the specified IS distribution queue. Table 280 - getISQueueEntry Method Parameters

Input Parameters Name Type Description workspace String name of the IS workspace queue String name of the IS distribution queue 3.2.2.4. getString

Public method that does one of two things; if the resultSet is populated, a value from the specified column will be returned. Otherwise, a null value will be returned.

Page 107: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 107 of 115

Table 281 - getString Method Parameters

Input Parameters Name Type Description columnName String property name Output Parameters Name Type Description This.resultSet. getString(columnName) .toString()

String map of document index properties and values

3.2.2.5. getDateString

Public method that retrieves a date property value based on the input property name if there are documents in the IS distribution queue. Table 282 - getDateString Method Parameters

Input Parameters Name Type Description columnName String propertyname Output Parameters

Name Type Description String Date date value df.format(date) DateFormat property value in date format 3.2.3. com.triteksol.content.p8.P8PegaWrapper

The following details the methods in the P8PegaWrapper class.

3.2.3.1. P8PegaWrapper

Public method that initializes the object with the input parameter values. These values will be used to logon to the CE instance. Table 283 - P8PegaWrapper constructor Parameters

Input Parameters Name Type Description sClassName String classname used to login sWcmApiConfig String Name of the config file($/WcmApiConfig.properties) sAppId String Name of the appId sObjStore String Name of the Object Store in CE sUseVirtualFolders String Read as a String but later converted to Boolean (true/false)

Page 108: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 108 of 115

sBasePath String Basepath to the directory containing WcmApiConfig file

3.2.3.2. logon

Public method that logs onto the CE instance. Table 284 - logon method Parameters

Input Parameters Name Type Description sUSer String username used to login sPassword String password used to login jndi String JNDI reference used to login 3.2.3.3. getDocumentProperties

(See Section 3.2.1.3)

3.2.3.4. getDocPropsXML

(See Section 3.2.1.5)

3.2.3.5. reIndex

(See Section 3.2.1.6)

3.2.3.6. logoff

Public method that logs off of the Content System

Page 109: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 109 of 115

4. Installation

The following details the installation instructions for the Pega/FileNet connector.

4.1. General System Information

Version of PRPC used during development - 5.5 Application server name and version that the component was built on - IBM WebSphere

Application Server version 6.1 Version of the java JDK installed at the time of development – 6, standard edition, update

18 Min/Max JVM memory setting for application server - 512 MB/2047 MB Version of Visio used to create any process diagrams - Visio 2007 Any frameworks that the component may rely on (i.e., Retail Banking Industry

Framework (RBIF), Multi-channel Insurance Framework (MCIF), etc.) – no framework dependency

PRPC database and version information - Microsoft SQL Server version 9.00.4035 What JDBC driver was used during development - Microsoft SQL Server 2005 JDBC

Driver

4.2. Installation instructions

Note: The FNImageViewer application must be deployed to the application server.

Deploy the following EAR files to the application server: PegaContentServletEAR.ear, PegaCEContentServletEAR.ear

Copy the following JAR files to the APP-INF\lib\pega directory within the main PRPC

application ear file:

ISQueueWrapper.jar CEJ2ISPega.jar

Logon to PRPC as a user with access to the developer portal.

Go to the import menu from the developer dashboard (File>Import)

Page 110: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 110 of 115

Upload the ECM Connector product rule zip file to PRPC server

Page 111: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 111 of 115

Click the import button. Make sure the “compile libraries” and overwrite existing rules boxes are checked.

Page 112: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 112 of 115

Log off, and log back as username: [email protected] password: admin

See Configuration system below for details regarding modifications to PRPC Rules as well as your Content System

5. Configuration

The following section details requirements and notes for Pega/IS/CE integration. 5.1. IS/CE Prerequisites

The FileNet content repository must be properly configured before integrating the repository with PRPC. Image Services – Once the Image Services instance has been created, configure the document index fields that will be mapped to PRPC. Create a distribution queue that will hold these documents for processing. Assign a username and password rights to access the distribution queue and documents within, add documents and modify the document property values.

Page 113: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 113 of 115

Content Engine – Once the Content Engine instance has been created, configure a document class with the document index fields that will be mapped to PRPC. Set up a workflow subscription tied to a document creation event, and reference the document class. Create a CE event action. Assign a username and password rights to add documents and modify the document index values. The event action should pass a string of XML to the PRPC service rule (http://<servername>:<port>/prweb/PRHTTPService/TriTekFWRepoConnectorWork/NewWork/CreateNewWork). The format of the XML should correspond to the format expected by the PRPC Parse XML rule. For this implementation the following structure was used: Sample XML <Document> <Properties> <DOCID>-1</DOCID> <DocType>DEPOSITS</DocType> <AccountNumber>443380</AccountNumber> <LastName>smith</LastName> <ReceivedDate>20100506T000000.000 EDT</ReceivedDate> <DocumentTitle>sampledocument</DocumentTitle> <GUID>{94BCF7C9-06FF-460C-AAD6-5E7DCB03F37A}</GUID> </Properties> </Document> 5.2. PRPC Rules

The following details the changes required in PRPC to update the configuration. The rules found in the Work class should be configured to the specific implementation while the rules found in the Integration classes should need minimal configuration outside of the model rules.

5.2.1. Properties

Based on the business requirements, create property rules in the ECMDocumentProperties data class to which the FileNet document property values will be mapped. Ensure that the data types correspond and can be mapped between CE/IS and PRPC. In the Work class, when defining the ECMDocProperties property, set the Property Mode to Page List and reference the ECMDocumentProperties data class. 5.2.2. Model

TriTek-FW-RepoConnector-Int.EnvProperties – Set the UserName, Password, Workspace and QueueName to the appropriate values for logging into the IS instance. TriTek-FW-RepoConnector-Int-CEWrapper.CEEnvProperties – Set the UserName, Password, and other appropriate values for logging into the CE instance.

Page 114: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 114 of 115

5.2.3. Connectors – Integration-Mapping

TriTek-FW-RepoConnector-Int-J2ISWrapper.DocPropertiesXMLParse.Document - Change the property value mappings to reflect the incoming FileNet document properties to be mapped to the corresponding PRPC work object properties. TriTek-FW-RepoConnector-Int-J2ISWrapper.reIndexStream.ReIndex - Change the property value mappings to reflect the outgoing PRPC work object properties to be mapped to the corresponding FileNet document index properties. TriTek-FW-RepoConnector-Int-CEWrapper.DocPropertiesXMLParse.Document - Change the property value mappings to reflect the incoming FileNet document properties to be mapped to the corresponding PRPC work object properties. TriTek-FW-RepoConnector-Int-CEWrapper.reIndexStream.ReIndex - Change the property value mappings to reflect the outgoing PRPC work object properties to be mapped to the corresponding FileNet document index properties. 5.2.4. Activities

TriTek-FW-RepoConnector-Work.CallReIndexMultipleMain - At step 4.4, 4.5 – Property-Set, update all PropertiesName and PropertiesValue values to reflect the document properties defined for this instance of PRPC. TriTek-FW-RepoConnector-Work.CallURL - At step 2 – Property-Set and step 3 – Property-Set, update the URL fragments to reflect the location of the Daeja viewer servlet. TriTek-FW-RepoConnector-Work.MapCorrespondingPropertiesMain - At step 3, 4 – Property-Set, update the PropertiesName and PropertiesValue values to reflect the document properties defined for this instance of PRPC. TriTek-FW-RepoConnector-Work.SavePegaProperties - At step 3 – Property-Set, update the PropertiesName and PropertiesValue values to reflect the document properties defined for this instance of PRPC. TriTek-FW-RepoConnector-Work.SavePegaPropertiesCE - At step 3 – Property-Set, update the PropertiesName and PropertiesValue values to reflect the document properties defined for this instance of PRPC. 5.2.5. Flow

Page 115: TriTek ECM Connector Framework

©2010 TriTek Solutions, Inc. 115 of 115

The flow configuration is highly dependent on the specific environment. However, the sample flow (TriTek-FW-RepoConnector-Work.DisplayCEPropertiesMain) may be leveraged to route work items to different workbaskets for processing. 5.2.6. Decision Table

TriTek-FW-RepoConnector-Work.WorkBasketDecision should be updated to specifications of the incoming DocTypes and the names of the workbaskets to use.

5.2.7. Section

TriTek-FW-RepoConnector-Work.ISPropertiesFullSection - Layout 2 (ECM Document) displays the document IDs as well as the document index property values associated with the documents. Update the document index property values to reflect the document properties defined for this PRPC instance. 5.2.8. Agents

The TriTek-FW-RepoConnector-Work.TriTek Agent rule is responsible for calling the startISProcess activity which retrieves document properties from the IS DistQueue. It should be set for the desired interval and enabled.