Represents site-specific connection data for a DITA Rendition Engine that is referenced by a publishing configuration. (A DITA Rendition Engine is one that uses a DITA Open Toolkit deployment for publishing documents.)


The following tables list the members exposed by IDITARenditionEngineConnection.

Public Properties

  Name Description
Public property Creator Indicates the name of the user assigned as the creator of the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Public property DateCreated Indicates the date and time the object was created. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Public property DateLastModified Indicates the date and time the object was last modified. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Public property DisplayName The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.
Public property DITADatabaseTimeout Specifies the database transaction timeout in seconds for DITA-specific publishing requests.
Public property DITAHome Specifies the fully qualified path to the directory where the DITA Open Toolkit is installed. The path can be a local mount point, a local path, or a UNC path.
Public property DITAJVMArguments Specifies optional Java Virtual Machine (JVM) arguments that will be used to invoke the DITA Open Toolkit when publishing DITA content. For example, if you are publishing a large DITA information set, you can specify additional JVM memory by setting the value of this property to -Xmx512m.
Public property DITAWorkingDirectory Specifies the fully qualified path to the working directory where DITA component documents will be downloaded from the Content Engine for publishing via the DITA Open Toolkit. The path can be a local mount point, a local path, or a UNC path.
Public property Id A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For IUser and IGroup classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, IUser.Id and IGroup.Id always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

  • PropertyDescription.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.Id.

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Public property LastModifier Indicates the name of the user who last modified the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Public property Site Identifies the site associated with a given object. A site represents a geographical area in the FileNet P8 domain. If you do not specify a site when creating the associated object, the value of that object's Site property defaults to the value of Domain.DefaultSite.
Top

See Also