Show TOC

Procedure documentationCreating Submit Frames Locate this document in the navigation structure

 

A submit frame is a set of rules that control the repetitive execution of a job. When a job definition is submitted and a submit frame is used, the corresponding jobs are restarted automatically by a process server according to the frequency defined in the submit frame.

Simple multiple executions of a job definition can also be achieved by specifying a recurrence. A job recurrence is specified for one or more jobs when you submit a job definition. A submit frame is an object that can be reused for multiple jobs.

A submit frame is made of one or more submit frame elements defining the cycle. If more than one submit frame element is specified, the total cycle is a union of all submit frame elements.

Submit frames are part of the 'Environment' section in the navigation bar. The following standard submit frames are provided with SAP CPS:

  • System_DeleteJobFilesSubmitFrame - the submit frame to use for the System_DeleteJobFiles job.

  • System_ProcessKeepClausesSubmitFrame - the submit frame to use for the System_ProcessKeepClauses job.

  • System_UpdateJobStatisticsSubmitFrame - the submit frame to use for the System_UpdateJobStatistics job.

Actions

Submit frames support the following actions:

Action

Description

Export

Export the submit frame into a CAR file

Edit

Edit the submit frame

Edit Security

Edit the security of the submit frame

Delete

Delete the submit frame

Duplicate

Make a copy of the submit frame to create a similar one

Expand All

Expand all submit frames in the current filter

New

Create a new submit frame

Filter > New Filter

Create a new submit frame filter

Filter > Edit Filter

Edit current submit frame filter

Filter > Delete

Delete current submit frame filter
Finding Submit Frames

You can search for submit frames using filters and the Search Submit Frames box on the Submit Frames tab. This box is known as the intelliSearch box and located under your username on the top right-hand side of the user interface. Filters allow you to specify a list of objects with static criteria. IntelliSearch allows you to specify complex queries in a simple way using prefixes. Prefixes are used to specify which property you are searching in and have short and long syntaxes. For example, if you want to display all submit frames with the term import in the comment, you would use the search criteria as follows:

c:import

You can search more than one property, as follows:

c:import n:Bi

Note Note

No spaces should be entered before or after the colon (:).

End of the note.

See the Advanced Object Search for more information.

The following table illustrates the available prefixes for submit frames:

Prefixes

Description

n, name

searches the name property

c, com, comment

searches the comment property

d, desc, description

searches the description property
Deleting Submit Frames

You can only delete submit frames when no other objects relate to them. For example, if there are jobs that have run with the submit frame, the submit frame cannot be deleted until all jobs that ran with it have been deleted. You can see all jobs that relate to the submit frame in Related Objects in the lower detail pane and on the show page.

The table in related objects contains three columns:

  • Type - the type of object with a link to it

  • Related Object - the name of the object with a link to it

  • Used As - objects can sometimes be used in different roles

Security

Privilege

Description

SubmitFrame.Create

Create submit frames

SubmitFrame.Delete

Delete submit frames

SubmitFrame.Edit

Edit submit frames

SubmitFrame.View

Access submit frames

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 submit frame. It allows you to specify which users can access, edit, and delete the submit frame.

Procedure

  1. Choose   Environment → Submit Frames  .

  2. Choose Refresh to see all existing submit frames.

  3. Choose New to create a submit frame.

  4. Fill in the details, refer to the section below.

  5. Choose Save and Close to save the submit frame.

Submit Frame

  • Name - The name of the submit frame.

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

  • Description - The description of the submit frame.

  • Comment - A comment about the submit frame.

Elements

  • Every Number Of - The cycle interval in seconds, minutes, days or months. The unit of measure is specified in the Unit field.

  • Unit - The unit of measure: seconds, minutes, days or months.

  • During Time Window - An optional time window during which the submit frame interval can generate submits.

  • Skip when time window is closed - If this option is selected, the submit frame element must fall inside the defined time window. If it is not selected, the first submit frame element occurs as soon as the time window is opened. This option is only applicable if During Time Window defined.

  • Start Time - The start time of the job, this is only available when the Unit is set to Days, Months or Years.

Example

  1. Choose   Environment → Submit Frames   in the Navigation bar.

  2. Choose the New button and fill in the values below for the Submit Frame tab.

  3. Choose the New button and fill in the values for the Elements tab.

  4. Choose Save & Close to save the new submit frame and close the edit window.

Submit Frame tab

Name: EveryHour

Description: Every hour

Elements tab

Every number of: 1

Unit: Hours

Must Fit Time Window: Unchecked

More Information

Defining Execution Times with Time Windows

Using Recurrences