The Task Backend provides a mechanism for scheduling tasks in the Oracle Unified Directory. Tasks are intended to provide access to certain types of administrative functions in the server that may not be convenient to perform remotely.
Oracle Unified Directory supports tasks to backup and restore backends, to import and export LDIF files, and to stop and restart the server. The details of a task are in an entry that is below the root of the Task Backend. The Task Backend is responsible for decoding that task entry and ensuring that it is processed as requested. Tasks may be invoked immediately, but they may also be scheduled for execution at some future time. The task backend can also process recurring tasks to ensure that maintenance operations (for example, backups) are performed automatically on a regular basis.
The Task Local Backend Workflow Element component inherits from the Local Backend Workflow Element
A description of each property follows.
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ base-dn | ↓ java-class |
| ↓ enabled | |
| ↓ notification-sender-address | |
| ↓ task-backing-file | |
| ↓ task-retention-time | |
| ↓ writability-mode |
| Description | Specifies the base DN(s) for the data that the backend handles. A single backend may be responsible for one or more base DNs. Note that no two backends may have the same base DN although one backend may have a base DN that is below a base DN provided by another backend. If any of the base DNs is subordinate to a base DN for another backend, then all base DNs for that backend must be subordinate to that same base DN. |
| Default Value | None |
| Allowed Values | A valid DN. |
| Multi-valued | Yes |
| Required | Yes |
| Admin Action Required | None. No administrative action is required by default although some action may be required on a per-backend basis before the new base DN may be used. |
| Advanced Property | No |
| Read-only | No |
| Description | Indicates whether the Workflow Element is enabled for use in the server. If a Workflow Element is not enabled, then its contents are not accessible when processing operations. |
| Default Value | None |
| Allowed Values | true false |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Specifies the email address to use as the sender (that is, the "From:" address) address for notification mail messages generated when a task completes execution. |
| Default Value | The default sender address used is "opends-task-notification@" followed by the canonical address of the system on which the server is running. |
| Allowed Values | A String |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Specifies the path to the backing file for storing information about the tasks configured in the server. It may be either an absolute path or a relative path to the base of the Oracle Unified Directory instance. |
| Default Value | None |
| Allowed Values | A String |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Specifies the length of time that task entries should be retained after processing on the associated task has been completed. |
| Default Value | 24 hours |
| Allowed Values | A duration Syntax. Lower limit is 0 seconds. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Specifies the behavior that the backend should use when processing write operations. |
| Default Value | enabled |
| Allowed Values | disabled - Causes all write attempts to fail. enabled - Allows write operations to be performed in that backend (if the requested operation is valid, the user has permission to perform the operation, the backend supports that type of write operation, and the global writability-mode property is also enabled). internal-only - Causes external write attempts to fail but allows writes by replication and internal operations. |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Specifies the fully-qualified name of the Java class that provides the Task Local Backend Workflow Element implementation. |
| Default Value | org.opends.server.workflowelement.localbackend.TaskLocalBackendWorkflowElement |
| Allowed Values | A java class that implements or extends the class(es) : org.opends.server.workflowelement.WorkflowElement |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | Yes |
| Read-only | No |