Skip Headers
Oracle® Fusion Middleware Administrator's Guide for Oracle Imaging and Process Management
11g Release 1 (11.1.1)

Part Number E12782-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to current chapter
Up
Go to next page
Next
View PDF

8 Working with Oracle UCM

Oracle I/PM uses the functionality of an Oracle database to store and retrieve uploaded documents. Documents are stored based on criteria specified in the application in which they reside.

This section contains the following topics:

8.1 Oracle Content Server Document Profiles

When an application is created in Oracle I/PM, a corresponding profile and set of profile rules are created in the Content Server repository. It is expected that a profile trigger field has been configured. For Content Server 11g, a profile trigger field should be automatically configured. For Content Server 10g, configure a profile trigger field by doing the following:

  1. Add EnableIdcProfileField=1 as a general configuration variable to the 10g Content Server config.cfg file. For information on adding a general configuration variable to Content Server, see the documentation that came with the product.

  2. Restart Content Server.

8.1.1 Global Profile Rules

The IpmRepository component sets up global profile rules to group system fields and ensure their display when an application profile is created. These profiles are created or updated each time Content Server is started.

Note:

You can disable the automatic update of the global profile rules by setting the Content Server configuration setting IpmUpdateProfileRules to 0 (zero). For information about configuring Content Server, see the Oracle Fusion Middleware System Administrator's Guide for Content Server.

The IpmRepository component creates the following rules:

Name Description Global Rule
IpmSystemFields Groups Imaging system fields. Can be used to include Oracle I/PM system fields in a profile. No
IpmSystemFields_Hide Hides the Oracle I/PM system fields by default. To show the fields, include a rule that shows the fields (see IpmSystemFields rule). Yes
IpmSystemFields_Restricted Restricts the ability to choose Oracle I/PM-specific values in security group and document type. Yes

Any global rule does not need to be referenced by a specific profile in order to be active.

8.1.2 Application Profile and Profile Rules

When an application is created, a profile and rules are created to handle the display of the application fields. The rules created for a profile group the application fields and provide any default values for those fields. The following table describes the rules:

Name Description Global Rule
IpmApp_<X>_Fields Groups the application fields No
IpmApp_<X>_Fields_Hide Hides the application fields Yes
IpmApp_<X>_Defaults Sets defaults for Imaging system (Security Group, IPN Application ID) fields and application specific fields No

In the rule names above, <X> is replaced with an internal application identifier. Any rules that are not global rules need to be reference by a profile to become active.

A profile is created for the application and is given IpmApp_<X> as the profile name, where <X> is an internal application identifier. The label for the rule is the application name.

8.1.3 Working With Folders

Oracle I/PM does not automatically assign application documents to a folder. However, by modifying an application profile and profile rules, you can automatically assign documents to a specific folder. To modify application rules to automatically assign documents to a specific folder, do the following:

  1. Create a new contribution folder to hold the application content. Make a note of the folder's identifier, for example 932000007.

  2. Add a new profile rule. Make a note of the name. For example App_<X>_Folder.

  3. Add the Folder field. The Folder field is the xCollectionID field.

  4. Set Type to Info Only.

  5. Enable Use default value and set the default value to the folder identifier obtained above. For example, 932000007. This allows people using the Content Server check in form to see the assigned folder.

  6. Enable Is derived field and set the default value to the folder identifier obtained above. For example, 932000007. This allows the value to be set upon check in from any source. For example, IPM upload.

    Setting the rule in this manner will not allow users to move content from one folder to another. This includes the trash folder. To allow movement between folders and deleting content, change derived value to use custom script and add something similar to:

    <$if not (IDC_SERVICE like "COLLECTION_DELETE_LOT|COLLECTION_RESTORE_ITEM")$>
                                               <$dprDerivedValue="932000007"$>
    <$endif$>
    
  7. Now edit the application profile rule.

  8. Add the rule just defined (App_X_Folder) to the rules section.

Note:

If an application is modified in Oracle I/PM, and the modification includes an application name change, then the rule you just added to the application profile will need to be added again.

8.1.4 Working With Oracle Universal Records Manager

Oracle I/PM does not automatically assign documents to a retention category or life cycle. However, by modifying an application's profile and profile rules, you can automatically assign documents to a retention category or life cycle. The following steps are for assigning a retention category value. If you wish to assign a life cycle, substitute xLifeCycleID for xCategoryID.

  1. Create a new retention category. Make a note of the retention category identifier. For example, you could use App X Category.

  2. Add a new profile rule. Make a note of the name. For example, you could use App_X_Category_rule.

  3. Add the Retention Category field. The Retention Category field is xCategoryID.

  4. Set the Type to Info Only.

  5. Enable Use default value and set the default value to the retention category identifier obtained above. For example, App X Category. This allows people using the Content Server check in form to see the assigned category.

  6. Enable Is derived field and set the default value to the retention category identifier obtained above (App X Category). This allows the value to be set upon check in from any source. For example, IPM upload.

    Note:

    If the category to which you are mapping the documents is a category that is a records-only category, you will also need to add a field for xIsRecord and set its default and derived values to “1”.
  7. Now edit the application's profile rule.

  8. Add the rule just defined (App_X_Category) to the rules section.

Note:

If an application is modified in Oracle I/PM, and the modification includes an application name change, then the rule you just added to the application profile will need to be added again.

8.1.4.1 Synchronizing with Oracle UCM Adapter for Oracle Content Server

When using the Oracle UCM Adapter for Oracle Content Server to allow Oracle Universal Records Manager to use multiple Content Server repositories, you must ensure that security groups are consistent between the Content Server and Oracle URM. The UCM Adapter does not synchronize security groups created by Oracle I/PM with Oracle URM.

If an application is created in Oracle I/PM that adds security groups to the Content Server repository, you must manually set up the same security groups on Oracle URM that was created by Oracle I/PM. This should be done prior to any content being uploaded to the Oracle I/PM application. Additionally, if there is any modification to an Oracle I/PM application or to document security in an application, you must manually update the security groups in Oracle URM.

Note:

Oracle I/PM metadata fields are not propagated to Oracle URM at all, so documents in Oracle URM do not have any indication of the values specified in Oracle I/PM.

8.1.5 Working With Information Rights Manager

Oracle I/PM does not automatically assign application documents to an IRM classification. However, by modifying an application profile and profile rules, you can automatically assign documents to an IRM classification.

  1. Add a new profile rule. Make a note of the name. For example App_X_IRM).

  2. Add the IRMProtection field. The IRMProtection field is xIRMProtection.

  3. Set the Type to Info Only.

  4. Enable Use default value and set the default value. This value must match an Oracle IRM context. This allows people using the Content Server check in form to see the assigned IRM classification.

  5. Enable Is derived field and set the default value. This value must match an Oracle IRM context. This allows the value to be set upon check in from any source. For example, IPM upload.

    Note:

    If IRM is not configured correctly, or the value does not match a valid context, you will be unable to check content into Content Server because it will fail IRM validation.
  6. Now edit the application profile rule.

  7. Add the rule just defined (App_X_IRM) to the rules section.

Note:

If an application is modified in Oracle I/PM, and the modification includes an application name change, then the rule you just added to the application profile will need to be added again.

8.1.6 Working With WebCenter Spaces

Oracle I/PM documents are not automatically accessible within WebCenter Spaces, but documents can be automatically assigned to Folders visible within WebCenter Spaces. Manual configuration and modification of an application profile and profile rules are required to ensure that I/PM documents will be accessible.

  1. Configure Content Server and Oracle I/PM to use the same LDAP-based identity store that Oracle WebCenter has been configured to use.

    For information on configuring WebCenter and Content Server to use an LDAP identity store, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

  2. Configure Content Server as the bridge between I/PM and WebCenter Document Service using an I/PM supported version of Java.

  3. WebCenter Spaces' Document Service uses the Folders component, and I/PM must be configured to automatically specify Folders for checked in content. For more information regarding configuring I/PM with Folders, see the section "Working With Folders".

For further information regarding WebCenter Spaces integration with Oracle Content Server, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

8.2 Understanding Document Storage

Conceptually, applications represent containers of documents with common characteristics as defined and enforced by the application. A single instance of Oracle Content Server may not be able to handle the multiple applications required by an organization. In order to scale a solution to handle the multiple applications required, multiple Content Server instances can be used. However, an application cannot be divided across multiple Content Server instances. To support multiple Oracle Content Server instances, you must associate each application with its target Content Server instance. To represent this at the Oracle I/PM level, a new object has been added to the public API known as the repository. The repository object is responsible for keeping track of the connection information to each Content Server instance. Each application will be associated with a particular repository. For more information about creating connections to repositories, see "Managing Connections".

8.2.1 Oracle Content Server Document Properties

The following table identifies how Oracle I/PM document properties map to Content Server document properties.

Oracle I/PM Document Property Content Server Property Comment
Id dDocName  
Name dOriginalName Could also come from dDocTitle but dDocTitle can be changed in Content Server user interface
Properties.ApplicationId xIPMSYS_APP_ID Custom metadata field
Properties.ApplicationName none Read from Application definition not from Content Server
Properties.BatchId xIPMSYS_BATCH_ID Custom metadata field
Properties.CharacterSetName xIPMSYS_CHAR_SET Custom metadata field
Properties.CreateDate xIPMSYS_CREATE_DATE dCreateDate is when a revision is checked in. If additional revisions are checked in, the value of dCreateDate tracks the revision. So this should be implemented as a custom metadata field.
Properties.Creator xIPMSYS_CREATOR Custom metadata field. dDocAuthor is the user who checks in a revision. If additional revisions are checked in, the value of dDocAuthor tracks the revision. So this should be implemented as a custom metadata field.
Properties.DocUrl none Will be computed with imaging code. There is a Content Server IdocScript function to compute the URL in the weblayout directory.
Properties.Language xIPMSYS_LANG Customer metadata field
Properties.LastModifiedBy dDocAuthor of latest revision  
Properties.LastModifiedDate dCreateDate of latest revision  
Properties.LockedBy dCheckoutUser Content server does not have a locking concept other than checking out a document to prevent others from checking it out.
Properties.LockedDate none  
Properties.MimeType dFormat  
Properties.RetentionPolicyName none  
Properties.Size dFileSize  
Properties.StoragePolicyDate none  
Properties.StoragePolicyName none  
Properties.Version dRevisionID This distinct from dRefLabel which can be modified by the user.
Properties.VolumeName none If a file store provider is configured and used, this could come from the rules.
FieldValues Custom metadata fields defined by Application  
Permissions.Delete Delete Can be determined from IdocScript userHasGroupPrivilege(dSecurityGroup, “D”) function (or code that implements the function).
Permissions.Grant Admin Can be determined from IdocScript userHasGroupPrivilege(dSecurityGroup, “A”) function (or code that implemented the function)
Permissions.Modify Fields Write Can be determined from IdocScript userHasGroupPrivilege(dSecurityGroup, “W”) function (or code that implements the function)
Permissions.Update Write Can be determined from IdocScript userHasGroupPrivilege(dSecurityGruop, “W”) function (or code that implements the function)
Permissions.View Read Can be determined from IdocScript userHasGroupPrivilege(dSecurityGroup, “R”) function (or code that implements the function)
AnnotationPermissions N/A Annotation permissions are managed via I/PM Entity Beans.
Revision History

Audit History

<Versions>

<Content Tracker>

Revision history is provided as part of DOC_INFO service.

Auditing history must be obtained by reading the appropriate auditing data via the Content Tracker APIs.