notification-profile

Designates the people that InfoPrint notifies when specified events relating to this job occur and how InfoPrint notifies the people.

GUI label

Notification profile

DSS

All

Type

Resettable, multi-valued, complex

Syntax

-x "notification-profile={event-identifiers=event …
   delivery-address=name@node delivery-method=value
   event-comment='some text' locale=locale}"

For example,

-x "notification-profile={event-identifiers=class-state-changed
    job-completed delivery-address=joe@newhope delivery-method=message
    locale=En_US.IBM-850}"

You can omit any of these components.

Components

• event-identifiers

  Specifies the events for which the addressee receives notification that something has taken place.

  • GUI label

    Events

  • Type

    Multi-valued

  • Allowed Values

    The values can be any of the job events or classes of job events listed for the server. See the events-supported attribute for the server for more information.

  • Default Value
    • For default jobs, this component has no default values.
    • For jobs, the default values are document-aborted-by-destination, document-aborted-by-server, document-cancelled-at-destination, job-aborted-by-server, job-cancelled-by-operator, job-cannot-be-scheduled, job-completed, past-discard-time, destination-needs-attention, destination-needs-operator, destinations-not-ready-for-job

• delivery-address

  Specifies the address of the person that receives the event messages or the directory and file name where InfoPrint sends the message.

  • GUI label

    Address

  • Type

    Single-valued

  • Allowed Values

    You can enter a text string that contains the user name and node (optional) of the person that receives the information or the path to the directory and file name.

  • Default Value
    • For default jobs, this component has no default value.
    • For jobs, the default value is the login ID of the person who submitted the job.
  • Usage Guidelines

    You must specify a value for delivery-address if you specify a value of file, file-add-to, exit, or wireless for the delivery-method component.

• delivery-method

  Specifies how the user or file receives event messages.

  • GUI label

    Method

  • Type

    Single-valued

  • Allowed Values

    You can enter one of these fixed values:

    Fixed Value	Input Synonym
    electronic-mail	e-mail
    file
    file-add-to
    job-log
    message
    sapcb
    exit
    none
    wireless

  • Default Value

    message

  • Usage Guidelines
    • If you specify a value of file, file-add-to, exit, or wireless, you must specify a value for the delivery-address component.
    • If you specify a value of job-log, you cannot specify a value for the delivery-address component.
    • The sapcb notification method causes the SAP callback daemon to return messages about job events to the SAP system. The SAP print command sets this value; you should never have to specify it.

• event-comment

  Provides information that InfoPrint appends to the event message.

  • GUI label

    Comment

  • Type

    Single-valued

  • Allowed Values

    You can enter a text string of up to 4095 characters that supplies additional information.

  • Default Value

    No default value

• locale

  Defines the language and coded character set of notification messages.

  • Type

    Single-valued

  • Allowed Values

    You can enter the name of any locale for which the InfoPrint messages in the corresponding language are installed.

  • Default Value
    • For default jobs, this component has no default value.
    • For jobs, the default value is the locale of the user who submitted the job.

Usage Guidelines

A default job can have a notification profile that only has one or two components set. When you request this default job for a job, InfoPrint fills the remaining components with default values for that job.