Show TOC

Procedure documentationCreating a Queue Locate this document in the navigation structure

 

A queue contains jobs waiting to be processed by one or more process servers. Queues allow:

  • Resource limiting - you can limit the number of jobs running on a queue.

  • Routing using queue providers - queues can route jobs to one or more process servers.

A queue can be served by more than one process server at the same time. You can link a queue to a process server by creating a queue provider. When a job enters the queue it will be executed by an active process server that serves the queue.

A queue can be open or held. While a queue is held, the central server will not start any new jobs in the queue.

A queue is automatically held if:

  • There are no process servers associated with the queue.

  • The time window on the queue is held.

  • All queue providers are held. A queue provider is held if:

    • The queue provider has been put on hold by an operator.

    • The process server associated with the queue provider is stopped.

A queue might appear held to you while it is open to others; this is usually due to the fact that you cannot see any of the running process servers that are serving the queue.

A queue can also be held and released by operators, a queue held by an operator will be in status 'ClosedHeld'. If a queue is held, no more jobs will start in that queue.

It is also possible to hold the individual queue providers (for example, to hold a provider linking the queue CRM to the process server CR6). This allows the queue to continue feeding jobs to other process servers. This is useful when it is necessary to shut down a single process server, but leave the queue feeding others. The process to follow in this case is:

  • Hold each queue provider that connected to the process server you want to shut down.

  • Wait for all jobs currently running on the process server to reach a final state.

  • Shut down the process server.

When starting up, the reverse process is necessary:

  • Start up the process server.

  • Release each queue provider.

Queues are part of the Environments section in the navigation bar. The following standard queues are provided with SAP CPS:

  • System - the queue for processing system jobs.

Please note that you cannot change (hold, for example) the System queue, so you should create your own for scheduling your System jobs.

Note Note

SAP recommends you to specify a time zone on a queue, especially when you tie a time window to it to make sure the correct time is used.

End of the note.
Actions

Queues support the following actions:

Action

Description

Hold

Holds the queue, this prevents new jobs from starting (changing from state Queued to Running) in the queue. Jobs that are already running will continue to run.

Release

Releases the queue, this releases a queue that is held. This action only works if the queue is in status ClosedHeld (which means that it is held by the operator).

Monitor related Jobs

Opens the job monitor with a filter displaying jobs related to the current queue

Export

Export the queue into a CAR file

Edit

Edit the queue

Edit Security

Edit the security of the queue

Delete

Delete the queue

Duplicate

Make a copy of the queue to create a similar one

Expand All

Expand all queues in the current filter

New

Create a new queue

Filter > New Filter

Create a new queue filter

Filter > Edit Filter

Edit current queue filter

Filter > Delete

Delete current queue filter

Note Note

If a queue and/or a queue provider has/have a time window, it is always wise to specify a time window, especially when the time window has not time zone.

End of the note.
Deleting Queues

You can only delete queues when no other objects relate to them. For example, if there are still jobs that ran in the queue, the queue cannot be deleted until all jobs have been deleted, likewise if job definitions reference the queue as a default queue. You can see all jobs and job definitions that relate to the queue in the Related Objects in the lower detail pane and on the show page.

Security

Privilege

Description

Queue.Create

Create queues

Queue.Delete

Delete queues

Queue.Edit

Edit queues

Queue.View

Access queues

Queue.ViewJobs

View the jobs in the queue

Queue.SubmitOnto

Submit jobs onto the queue

You can grant privileges on two levels, Access and Admin; a privilege granted on Admin level allows the grantee to grant the privilege to other users. These privileges can be granted system-wide, per partition or isolation group.

If you have the security module, which requires the Module.Security license key, you have an additional Security tab on the queue. It allows you to specify which users can access, edit, and delete the queue.

Procedure

  1. Choose   Environment → Queues  .

  2. From the context menu, choose New.

  3. Fill in the details on the different tabs, refer to the Values section below.

  4. Choose Save and Close.

Queue

  • Name - The name of the queue.

  • Application - The name of the application used to group this object.

  • Description - The description of the queue.

  • Comment - A comment about the queue.

  • Execution Size - The number of concurrent jobs in the queue.

  • Inclusive - If set to true, the queue size includes waiting jobs.

  • Hold Level - Jobs below this priority level will not be started.

  • Time Window - The time window during which the queue will release the jobs.

  • Time Zone - The time zone to use for the time window (if specified).

  • Overdue - Set scripts that are not run within their time window to status OVERDUE

Providers

  • Process Server - The process server name.

  • Held - Is this queue provider closed? (Y or N)

  • Execution Size - The number of concurrent jobs in the queue.

  • Inclusive - If set to true, the queue size includes waiting jobs.

  • Hold Level - Jobs below this priority level will not be started.

  • Time Window - The time window during which the queue provider will release the jobs.

  • Time Zone - The time zone to use for the time window (if specified).

Example

  1. Choose   Environment → Queues   in the Navigation bar.

  2. Choose New and fill in the values below.

  3. Choose Save & Close to save the new queue and close the edit window.

Queue tab

Name: Process_Reports_Queue

Application: [none]

Description: Process Reports Queue

Comment: This queue is used to process reports.

Execution Size: 10

Inclusive: Checked

Hold Level: 20

Time Window: System_Week_Friday

Time Zone: Europe/Berlin

Overdue: Unchecked

Providers tab

Process Server: SYSTEM

Held: Unchecked

Execution Size: 20

Inclusive: Checked

Hold Above Page Rate:

Time Window: [none]

Time Zone: [none]

More Information