The Core Job Plugin provides several out-of-the-box jobs for use with the Registry Job Shell.

The Core Job Plugin replaces the Identifier Assignment Job Plugin and Provisioner Job Plugin (Registry v3).

Configuration

  1. This is a core plugin, and so is enabled by default.

General Usage

Core Jobs can be run via the command line either synchronously with -s, or asynchronously with -a. When run asynchronously, a Registry Job will be queued, and executed during the next execution of Registry Job Shell in run queue (-r) mode. Some jobs can also be scheduled to run asynchronously via the web interface, details of which are provided below.

Note that when CO ID is provided as a command line argument, it must be provided even if another argument implies a specific CO.

Available Jobs

Bulk

Perform bulk operations.

Usage (Web Interface)

A web interface to Bulk Job is not yet available. (CO-2088)

Usage (Command Line)

$ ./Console/cake job CoreJob.Bulk -s --coid co --action action --recordType recordType --records records [--actionArgs args]

  • co: Numeric CO ID to run bulk actions for.
  • action: Bulk action to run:
    • expunge: Expunge CO Person records
    • updateStatus: Update the status of CO Person or CO Person Role records
  • recordType: Type of records to process (must be supported by action): CoPerson, CoPersonRole
  • records: A comma separated list of records (of type recordType) to process
  • args: A comma separated list of action specific key=value pairs

(info) Keep in mind operating system limits on command line arguments may constrain the number of records that can be passed at a time. If these limits are reached, simply split the record set into multiple commands.

Supported Actions

ActionSupported Record TypesAction Specific Arguments
expungeCoPerson
updateStatusCoPerson, CoPersonRolestatus: New status (must use code as defined in Lib/enum.php)

Examples

$ ./Console/cake job CoreJob.Bulk -s -c 41 --action expunge --recordType CoPerson --records 2660,2661,2662
$ ./Console/cake job CoreJob.Bulk -s -c 41 --action updateStatus --actionArgs status=S --recordType CoPersonRole --records 1093,1218

Expire

Run Expiration Policies.

(info) Prior to Registry v4.0.0, this functionality was provided as a Registry Job Shell task.

Usage (Command Line)

$ ./Console/cake job CoreJob.Expire -s --coid co

  • co: Numeric CO ID to run expirations for.

GarbageCollector

Perform Garbage Collection.

(info) This job should be automatically scheduled, and should ordinarily not need to be manually scheduled.

Usage (Web Interface)

This Job can be scheduled via CO Settings >> Schedule Job if there is no currently scheduled Garbage Collector.

Usage (Command Line)

$ ./Console/cake job CoreJob.GarbageCollector -s --coid co [--object_type type]

  • co: Numeric CO ID to run garbage collection for.
  • object_type: Type of object to perform Garbage Collection for: Co is the only object currently supported

IdAssign

Run Identifier Assignment.

(info) In Registry v3.3.x, this functionality was provided by the Identifier Assignment Job Plugin.

Usage (Web Interface)

This Job can be scheduled using the UI via COConfigurationIdentifier Assignments > Autogenerate Identifiers For All.

Usage (Command Line)

$ ./Console/cake job CoreJob.IdAssign -s --coid co [--object-type type [--object_id id]]

  • co: Numeric CO ID to run identifier assignment for.
  • id: Numeric ID of the object to run identifier assignment for. If specified, --object-type must also be specified. If omitted, run identifier assignment for all objects of the specified type.
  • type: Object type to run identifier assignment for: CoDepartment, CoGroup, or CoPerson. If omitted, run identifier assignment for all object types.

Provision

Run Provisioning.

(info) In Registry v3.3.x, this functionality was provided by the Provisioner Job Plugin (Registry v3).

Usage (Web Interface)

This Job can be used to schedule bulk reprovisioning using the UI via CO Configuration > Provisioning Targets > Reprovision All.

This Job can be used to provide asynchronous provisioning by setting the Provisioning Target Mode appropriately.

Usage (Command Line)

$ ./Console/cake job CoreJob.Provision [-a|-s] --coid co --co_provisioning_target_id ptid --record_type (CoEmailList|CoGroup|CoPerson|CoService|All) [--record_id recid] [--provisioning_action action]

  • co: Numeric CO ID to run provisioning for.
  • co_provisioning_target_id: Numeric CO Provisioning Target ID to run provisioning for.
  • action: Provisioning Action to pass to provisioner plugin (default is ModelReprovisionRequested, available as of Registry v4.0.0)
  • record_type: Type of record to reprovision
  • record_id: Numeric ID of record type to reprovision

Sync

Synchronize Org Identity Sources.

(info) Prior to Registry v4.0.0, this functionality was provided as a Registry Job Shell task.

(warning) When syncing all sources, sub-jobs will be started for each source. Canceling the parent job will prevent new jobs from starting, but will not stop the in-progress job.

Usage (Command Line)

$ ./Console/cake job CoreJob.Sync -s --coid co [--ois_id ois_id] [--force] [--source_key source_key] [--reference_id reference_id]

  • co: Numeric CO ID to run Org Identity Source sync for.
  • force: Force Org Identity Source sync, as described here.
  • ois_id: Org Identity Source ID to run sync for. (If omitted, sync all configured sources in the CO.)
  • reference_id: When source_key is specified, link the source record with the CO Person identified by the provided Identifier of type Reference, if found. Available as of Registry v4.1.0. 
  • source_key: Sync only the record identified by the specified Source Key (SOR ID). Available as of Registry v4.1.0.

ValidateGroupMember

Reprovision records based on Group Validity Dates. As of Registry v4.0.2, this job will also process CO Group Nesting changes due to validity dates taking effect.

(info) Prior to Registry v4.0.0, this functionality was provided as a Registry Job Shell task.

Usage (Command Line)

$ ./Console/cake job CoreJob.ValidateGroupMember -s --coid co

  • co: Numeric CO ID to run validation for.

Vet

Perform Person Vetting by processing queued Vetting Requests.

Usage (Web Interface)

An individual Vetting Request can be registered via CO PersonVetting RequestsRegister Vetting Request.

Usage (Command Line)

$ ./Console/cake job CoreJob.Vet [-a|-s] --coid co

  • co: Numeric CO ID to run Vetting for.