Job producer code handler elements

<JobProducerCodeHandler> elements in security-config.xml determine the access a producer has to the different job types in PolicyCenter. For example, an <JobProducerCodeHandler> element can define who has permission to create a submission job.

There is no limit to the number of <JobProducerCodeHandler> elements that can exist in security-config.xml. Each <JobProducerCodeHandler> element can contain zero to many <SystemPermType> and <ProducerStatus> elements.

This element has the following syntax.

<JobProducerCodeHandler jobType = "type" permKey="perm" desc="..." noPermissionDisplayKey="...">
  <SystemPermType code="code" />
  <ProducerStatus code="status" />
  ...
</JobProducerCodeHandler>

The attributes on the various elements have the following meanings.

Element

Attribute

Required

Description

JobProducerCodeHandler

jobType

Yes

The type of Job entity to which the permission applies, for example, a Submission or Renewal job.

permkey

Yes

The application permission to grant. The permkey attribute becomes a property on the specified job type (jobType). To access the entity property, use the following notation:

  perm.jobType.permkey

desc

No

A human-readable description of the permission.

noPermissionDisplayKey

No

A display key that provides the text to show if the user does not have a required permission.

SystemPermType

code

Yes

A code value defined in the SystemPermissionType typelist.

ProducerStatus

code

Yes

The status of the producer associated with the policy. This must be a value defined in the ProducerStatus typelist.

The following example illustrates a JobProducerCodeHandler element.

<JobProducerCodeHandler jobType="Reinstatement" permKey="view" 
       desc="Permission to view a reinstatement">
  <SystemPermType code="viewreinstate"/>
<ProducerStatus code="Limited"/>

Notice that:

  • The value of jobType is Reinstatement.
  • The application permission key is view.
  • The system permission type is viewreinstate.
  • The element explicitly grants permission to view the details of a policy reinstatement job to producers with a status of Limited. PolicyCenter gives any producer with a status of Active this permission automatically. Thus, only producers with a status of Active or Limited can view the details of reinstatement submission job.

See also