For more info:

Transcription

1 IBM FileNet Content Manager 5.0: Java API Programming F143 Course Abstract For more info: Course description This course is for those whose job responsibility includes developing custom applications for an IBM FileNet Content Manager system. You work with a fully functioning IBM FileNet P8 system for using the Content Engine Java API library to develop custom applications that access the IBM FileNet P8 Content Engine. In order to practice these skills, you write code and test content management functions. Duration 5 Days Delivery Method ILT, ILO and SPVC Audience Anyone who needs to know the capabilities of the Content Engine API for Java-based applications Programmers responsible for the design and development of custom Content Manager applications Prerequisites Basic programming experience in Java-based technologies Knowledge in Content management concepts IBM FileNet P8 5.0 Prerequisite Skills using Workplace (F140) Knowledge in IBM FileNet P8 Platform Administration is recommended Course Objectives Acquire the knowledge and skills necessary to create custom applications for an IBM FileNet P8 Content Manager system using the Java API. Topics Content Engine Java API Overview Content Engine Java API concepts FileNet P8 architecture Content Engine and J2EE J2EE architecture Content Engine-supported transport protocols Content Engine Java APIs Application types supported by Content Engine APIs Required Java Archive (JAR) files Commonly used Content Engine Java packages Java Authentication and Authorization Service (JAAS) JAAS configuration files Content Engine objects

2 Folders Interface hierarchy EngineObject and RepositoryObject IndependentObject and DependentObject Base classes and interfaces Core objects of the API Instantiating objects Factory class Collection objects Actions in pending state Working with properties Setting up a thick client development environment Using Eclipse IDE for writing your code Communication with the Content Engine Get a connection to a FileNet P8 domain Connection object Steps to get a connection to a FileNet P8 domain Factory.Connection.getConnection( ) UserContext.createSubject( ) UserContext.get() usercontext.pushsubject( ) Sample code to get a connection to a FileNet P8 domain Retrieve the domain and the object stores Domain object Global Configuration Database and Domain objects Steps to retrieve Domain and ObjectStore objects Factory.Domain.fetchInstance( ) domain.get_objectstores() Sample code to retrieve the Domain object Sample code to retrieve the ObjectStore objects Create and delete Folder objects What is a Folder object? Containment concepts Create a Folder object Steps to create a Folder object (1) Steps to create a Folder object (2) folder.createsubfolder( ) Factory.Folder.createInstance( ) Factory.ObjectStore.fetchInstance( ) objectstore.get_rootfolder() folder.set_parent( ) folder.set_foldername( ) folder.save( ) Sample code to create a folder Deleting folders Steps to delete a Folder object Factory.Folder.fetchInstance( ) folder.delete() Sample code to delete a folder Retrieve objects from a folder Referential containment Steps to retrieve objects from a folder ) folder.get_subfolders() folder.get_containeddocuments() folder.get_containees() referentialcontainmentrelationship.get_name() referentialcontainmentrelationship.get_head() independentobject.getclassname() Sample code to retrieve Folder objects Sample code to retrieve Document objects

3 Sample code to retrieve objects from a folder Documents Create Document objects Document objects Available actions on Document objects Steps to create a document Steps to create a Document object Steps to save the document and file Steps to set content to the Document object Steps to set content reference element Factory.Document.createInstance( ) Factory.ContentElement.createList() Factory.ContentTransfer.createInstance() contenttransfer.setcapturesource( ) contenttransfer.set_contenttype( ) Factory.ContentReference.createInstance() contentreference.set_contentlocation( ) contentreference.set_contenttype( ) document.set_contentelements( ) document.checkin( ) document.getproperties () properties.putvalue( ) document.set_mimetype( ) folder.file( ) independentlypersistableobject.save( ) Sample code to create a Document object (1) Sample code to create a Document object (2) Sample code to set multiple content elements Sample code to set content reference Retrieve a document and its content Steps to retrieve a Document object Steps to retrieve contents of a Document object Factory.Document.fetchInstance( ) document.get_name() document.get_contentelements() contentelement.get_contenttype() document.get_contentelementspresent() contenttransfer.get_retrievalname() contenttransfer.get_contentsize() contenttransfer.accesscontentstream() Sample code to retrieve a document Sample code to retrieve content elements of a document Sample code to retrieve content stream Properties Retrieve property descriptions Properties defined Setting and accessing property values Property cache Property Filters Components of property filters object propertyfilter.addincludeproperty( ) propertyfilter.addexcludeproperty( ) propertyfilter. addincludetype( ) ClassDescription objects PropertyDescription objects Steps to retrieve class descriptions Steps to retrieve property descriptions objectstore.get_classdescriptions() classdescription.get_propertydescriptions()

4 propertydescription.get_symbolicname() propertydescription.get_isreadonly() propertydescription.get_isvaluerequired() propertydescription.get_settability() propertydescription.get_cardinality() propertydescription.get_issystemgenerated() Sample code to retrieve class descriptions Sample code to retrieve a document Sample code to retrieve property descriptions Retrieve a choice list Choice list objects Using choice lists ChoiceList interface Choice objects Steps to retrieve a choice list and choices Steps to retrieve a choice list Steps to retrieve individual choices propertydescription.get_choicelist( ) choicelist.get_choicevalues() choicelist.get_hashierarchy() choice.get_choicetype() choice.get_choiceintegervalue() choice.get_choicestringvalue() Sample code to retrieve a choice list Sample code to retrieve the individual choices Retrieve object properties Steps to retrieve a given property value Steps to retrieve a property description for a property Steps to retrieve a property value propertydescription.get_datatype() property.getstringvalue() property.getstringlistvalue() Sample code to retrieve object properties Sample code to retrieve a property value (1) Sample code to retrieve a property value (2) Sample code to retrieve a property value (3) Custom Objects Create custom objects What are custom objects? Custom objects are unlike Document objects Why use custom objects? Creating a custom object Steps to create a custom object (1) Steps to create a custom object (2) Factory.CustomObject.createInstance( ) customobject.getproperties () properties.putvalue( ) independentlypersistableobject.save( ) folder.file( ) Sample code to create a custom object and set properties Sample code to set a multivalued property of a custom object Sample code to save and file a custom object to a folder Retrieve custom object properties Steps to retrieve custom object properties Factory.CustomObject.fetchInstance( ) properties.getstringvalue( ) properties.getinteger32value( ) properties.getdatetimevalue( ) properties.getstringlistvalue( )

5 Sample code to retrieve a custom object Sample code to retrieve custom object properties Sample code to retrieve a multivalued property Searches Search for objects Overview of searches Components of a query Searches SearchScope class SearchSQL Fetching the result set contents Fetching the result set controls Results sets and paging Steps to search for objects based on the property Steps to search for objects SearchScope.fetchObjects( ) documentset.pageiterator() Sample code to search for documents based on property Sample code to search for documents with paging Additional sample SQL statements for searching objects objectstore.set_defaultquerytimelimit( ) servercacheconfiguration.set_querypagemaxsize( ) servercacheconfiguration.set_querypagedefaultsize( ) servercacheconfiguration.set_nonpagedquerymaxsize( ) Tips for searches Build SQL statements Building SQL statements Steps to build an SQL statement Elements of a basic SQL statement Conventions for SQL query syntax statements SELECT list FROM clause WHERE clause IN operator (IBM FileNet P8 SQL extensions) OBJECT function (IBM FileNet P8 SQL extensions) Class functions (IBM FileNet P8 SQL extensions) Available SearchSQL helper class methods searchsql.setselectlist( ) searchsql.setfromclauseinitialvalue( ) searchsql.setfromclauseadditionaljoin( ) searchsql.setwhereclause ( ) searchsql.setorderbyclause( ) searchsql.setquerystring ( ) searchsql.setmaxrecords( ) Sample code to construct SQL statements Content based retrieval Content based retrieval Content searches Initiating content search Full text joins CONTAINS operator FREETEXT operator Ranking Common stop words Proximity operators (Verity terminology) Autonomy K2 query language Query option Steps to return object properties Steps to retrieve properties of the objects

6 searchscope.fetchrows( ) repositoryrow.getproperties() searchsql.setcontainsrestriction( ) searchsql.setfreetextrestriction( ) Sample code for content-based document searching Sample code for retrieving the properties Additional sample VQL statements for content-based search Security Retrieve object permissions Object-level security Access control objects and properties Permission sources Steps to get object permissions containable.get_permissions() accesspermission.get_granteename() accesspermission.get_granteetype() accesspermission.get_permissionsource() accesspermission.get_accessmask() accesspermission.get_accesstype() Sample code to get object permissions (1) Sample code to get object permissions (2) et object permissions Security inheritance Setting security with a security parent Steps to set permissions on a folder (1) Steps to set permissions on a folder (2) Factory.AccessPermission.createInstance( ) accesspermission.set_granteename() accesspermission.set_accesstype( ) accesspermission.set_inheritabledepth( ) accesspermission.set_accessmask() folder.set_permissions( ) Sample code to set folder permissions Steps to set the security folder to a document document.get_containers() document.set_securityfolder( ) Sample code to set the security folder to a document Apply a security template Security policies and templates Types of security templates Creating a security template Steps to apply a security template Steps to apply a security policy to a document (1) Steps to apply a security policy to a document (2) objectstore.get_securitypolicies() securitypolicy.get_securitytemplates() securitytemplate.get_applystateid() document.applysecuritytemplate( ) Sample code to retrieve a security policy Sample code to apply a security policy to a document (1) Sample code to apply a security policy to a document (2) Sample code to apply a security policy to a document (3) Retrieve security users and groups What is a realm? User and Group objects User and group names FileNet User and Group Interfaces Steps to get user names from the directory service Factory.EntireNetwork.fetchInstance( )

7 entirenetwork.get_myrealm() realm.findusers( ) Sample code to retrieve the realm Sample code to retrieve user names Getting group names from directory service realm.findgroups( ) Sample code to retrieve group names Document Versions Retrieve versionable objects Document versions Three levels of versioning Two-level versioning (1) Two-level versioning (2) Document version states Reservation object Versionable object VersionSeries object Versionable versus VersionSeries object (1) Versionable versus VersionSeries object (2) Document versions example Steps to retrieve versions of a document versionable.get_versions() versionable.get_majorversionnumber() versionable.get_minorversionnumber() versionable.get_versionstatus() Sample code to retrieve versions for a document Steps to retrieve version series for a document versionable.get_versionseries() versionseries.get_releasedversion() versionseries.get_currentversion() Sample code to retrieve a version series (1) Sample code to retrieve a version series (2) Check out and check in a document Steps to check out a document versionable.get_iscurrentversion() document.get_currentversion() versionable.get_isreserved() versionable.checkout( ) Sample code to check out a document Steps to check in a document versionable.get_reservation() document.checkin( ) Sample code to check the version status Sample code to check in a document Steps to cancel a checked-out document versionable.cancelcheckout() Sample code to cancel a checkout of a document Promote and demote a document Steps to promote a version for a document versionable.promoteversion() Sample code to promote a version for a document Steps to demote a version for a document versionable.demoteversion() Sample code to demote a version for a document Document Lifecycle Change a document lifecycle state Document lifecycles Sample document lifecycle state Document lifecycle policy and lifecycle action

8 Setup process for lifecycle policy and action Steps to change a document lifecycle state Promote or demote the document document.get_documentlifecyclepolicy() document.getproperties() properties.getstringvalue( ) documentlifecyclepolicy.get_documentstates() documentstate.get_statename() documentstate.get_canbedemoted() document.changestate( ) Sample code to get document lifecycle states Sample code to get current lifecycle state Sample code to promote or demote a document Create lifecycle actions DocumentLifecycleActionHandler interface Steps to create a lifecycle action documentlifecycleactionhandler.ondocumentpromote( ) documentlifecycleactionhandler.ondocumentdemote( ) document.get_currentstate() EngineRuntimeException raised by the lifecycle handler Error logging and debugging Code modules Update lifecycle action Adding external JAR files to the Content Engine Sample code to use lifecycle action handler (1) Sample code to use lifecycle action handler (2) Sample code to add custom methods Publishing Publish a document Publishing overview Publishing components Publishing actions Publish templates MIME types and publish templates Steps to publish a document Publish options XML Creating the publish options XML string instantiatingscope.fetchobject( ) document.publish( ) publishrequest.get_publishingstatus() Sample code to get the document for publishing Sample code to get the publish template Sample code to publish a document Republish a document Steps to republish a document Creating the publish options XML string Document.get_DestinationDocuments( ) document.republish( ) Sample code to get the publication document Sample code to republish a document Sample code to get the republishing status Sample SQL statement to retrieve publish templates Sample code to retrieve publish templates Compound Documents Create compound documents Compound documents Components of compound documents Features of compound documents Managing and viewing compound documents

9 Compound document chapter book Compound document insurance policy Building a compound document ComponentRelationship class Document class Steps to create a compound document document.set_compounddocumentstate( ) Factory.ComponentRelationship.createInstance( ) componentrelationship.set_childcomponent( ) Setting child version relationships componentrelationship.set_versionbindtype( ) componentrelationship.save( ) Sample code to set compound document state Sample code to retrieve child documents Sample code to set up static component relationship Sample code to set up dynamic component relationship Retrieve compound documents Steps to retrieve component relationships Steps to retrieve the child documents document.get_compounddocumentstate() compounddocumentstate.getvalue() document.get_childrelationships() componentrelationship.get_name() componentrelationship.get_versionbindtype() document.get_childdocuments() Sample code to retrieve the parent document Sample code to retrieve component relationships (1) Sample code to retrieve component relationships (2) Sample code to retrieve child documents Annotations Create Annotation objects Image Viewer Working with annotations in Image Viewer Image Viewer with annotations Annotation objects Annotated objects and annotations Annotated objects and annotations Steps to create an Annotation object Factory.Annotation.createInstance( ) annotation.set_contentelements( ) annotation.set_annotatedobject( ) Sample code to create an Annotation object Retrieve annotations Steps to retrieve annotations document.get_annotations() annotation. get_name() annotation.get_creator() annotation.get_datecreated() Sample code to retrieve annotations Optional: Copy annotations Steps to copy annotations Sample code to copy annotations (1) Sample code to copy annotations (2) Sample code to copy annotations (3) Auditing Retrieve the audit history for existing objects Auditing concepts Enabling and configuring auditing Audit event logs

10 Event object Steps to retrieve audited events containable.get_auditedevents() event.get_initiatinguser() engineobject.getclassname() event.get_datecreated() event.get_eventstatus() updateevent.get_modifiedproperties() updateevent.get_originalobject() updateevent.get_sourceobject() Sample code to retrieve audited events from an object Sample code to retrieve the modified properties Sample code to retrieve the each property value (1) Sample code to retrieve each property value (2) Sample code to retrieve audited events for document versions Retrieve the audit history for deleted objects Using SQL queries to retrieve audit data Steps to retrieve audit events for deleted objects Sample code to retrieve the delete events (1) Sample code to retrieve the delete events (2) Work with custom events Raising and auditing custom events Steps to raise a custom event on a subscribable object Factory.CustomEvent.CreateInstance( ) subscribable.raiseevent( ) Sample code to raise custom event Events and Subscriptions Implement a Java event handler Event-action architecture Subscriptions Subscriptions for classes or instances Steps to create an event action Applying a filter to an event subscription Define subscription filter Event handler requirements Event handler coding guidelines Code modules Update event action with a new code module version Adding external JAR files to the Content Engine eventactionhandler.onevent( ) ObjectChangeEvent objectchangeevent.get_sourceobject() Sample code to implement an event action handler EngineRuntimeException Error logging and debugging Sample messages in P8_server_error.log file Batches Batch update Batch definition Batch class and BatchItemHandle interface Batch updates Steps to execute a batch objectstore.get_domain updatingbatch.createupdatingbatchinstance( ) UpdatingBatch.add( ) updatingbatch.updatebatch() Sample code for batch update (1) Sample code for batch update (2) Sample code for batch update (3)

11 Batch retrieval Batch retrievals Steps to execute a batch Steps to retrieve batch item handles and objects retrievingbatch.createretrievingbatchinstance( ) retrievingbatch.add( ) retrievingbatch.retrievebatch() batch.getbatchitemhandles( ) batchitemhandle.hasexception() batchitemhandle.getexception() Sample code for batch retrieval (1) Sample code for batch retrieval (2) Sample code for batch retrieval (3)