Job Administration

The “Job Administration” area provides a tabular overview of the available jobs. Among other things, here you can activate jobs, desctivate jobs, run jobs, view job histories or edit job settings.

INFO
Using the column header tools you can filter table entries or adjust their sequence. In order to filter table entries you can also use the free-text search. And you can customize the selection of attributes that are shown in the table.

Read job information

The table of the “Job administration” card shows data about particular properties of the individual jobs. Note that some properties need to be included in the table as described below.

The following columns provide information regarding general job properties:

  • Name: This column shows the name of the respective job.
  • Enabled: This column shows wether the respective job is activated or not.
  • Language: This column shows the locale level of the respective job property data (e.g. localized descriptions).
  • Description: This column shows the multilingual descriptions of the respective job.
  • Job settings: This column shows which settings were made regarding the time and interval of the job execution.
  • Downtime: This column shows for which time period(s) the respective job is suspended.
  • Filename: This column shows the filename under which the result of the respective job will be stored.
  • Source: This column shows the source of the respective job (e.g. the datafeed behind it).

The following columns provide information regarding the job control:

  • Group: This column shows to which group the respective job belongs to
  • IP address: If there are several iPIM servers available, this column shows the IP address of the server the job is running on.
  • Parameter: This column shows the number of parameters which where created for the respective job.

The following columns provide information regarding the monitoring of jobs:

  • Runtime: This column shows the maximum expected runtime. The run time is indicated in minutes.
  • Max. inactive period: This column shows the maximum period of inactivity for a job.

The following columns provide information regarding the most recent execution of jobs:

  • Start date of last job: This column shows the date and time when the execution of the respective job started.
  • End date of the last job: This column shows the date and time when the execution of the respective job ended.
  • Error messages of the last job: This column shows the causes for the occurrence of possible errors during the execution.
  • Error in last job: This column shows whether the respective job was successfully executed or not.
  • Error in validation of last job: This column shows whether an error occurred in the optional validation of the respective job and whether the job can be executed at all.

Show/hide jobs

The table shows the native and user-configured jobs. The latter includes jobs which were created for datafeed exports or report actions etc. Native jobs are displayed by default, user-configured jobs can be shown or hidden.

  • In order to show user-configured jobs, move the “Show all jobs” toogle switch to the on position.
  • In order to hide user-configured jobs, move the “Show all jobs” toogle switch to the off position.

Show/hide job properties

Job properties are represented by the corresponding attributes. Some attributes are shown in the table by default, some attributes are shown optionally. In order to include optional attributes in the table, proceed as follows:

  1. Click on the Attribute button to call up the corresponding dialog box.
  2. Select the desired attributes:
    • In order to select an attribute, transfer it from the left column to the right column. To do this, click on the attribute.
    • In order to deselect an attribute, transfer it from the right column back to the left column. To do this, click on the attribute.
  • In order to finish the process, click on the ACCEPT button. The selected attributes are now included in the table.
  • In order to cancel the process, click on the CANCEL button.

Refresh job data

  • In order to update the listed job data, click on the refresh button.

Use job actions

Activate jobs

In order to activate a particular job, proceed as follows:

  • In the table row of the job, click on the on button to activate the job. If the process was successful, a corresponding message will appear.

Deactivate jobs

In order to deactivate a particular job, proceed as follows:

  • In the table row of the job, click on the off button to deactivate the job. If the process was successful, a corresponding message will appear.

Trigger jobs

In order to trigger a particular job, proceed as follows:

  • In the table row of the job, click on the Play button to execute the job. If the process was successful, a corresponding message will appear.

Retrieve job histories

In order to retrieve the history of a particular job, proceed as follows:

  1. In the table row of the job, click on the Historie button to call up the corresponding dialog box.
  2. Select a time period:
    • In order to retrieve the job history for a given time period, click on the “Choose date range” field. Then appears the corresponding selection menu. Here, select the desired start date and the desired end date. Following this, the selection menu closes and the job history for the selected time period is shown in the table below.
    • In order to retrieve the job history for the present day, click on the TODAY button. Following this, the job history for this time period is shown in the table below.
    • In order to retrieve the job history for the past three days, click on the LAST 3 DAYS buttons. Following this, the job history for this time period is shown in the table below.
    • In order to retrieve the job history for the past week, click on the LAST WEEK buttons. Following this, the job history for this time period is shown in the table below.
    • In order to close the dialog box again, click on the CANCEL button.

Edit job properties

Edit descriptions

In order to edit job descriptions on the different locale levels, proceed as follows:

  1. First expand, the different locale levels. To do so, click on thechevron to the rightbutton in the respective table row.
  2. Double-click in the table cell you want to edit.
  3. Make the desired changes.
  4. Leave the table cell.
  5. Possibly make further changes to other table cells.
  • In order to save your changes, click on the SAVE button.
    Pfeil nach rechtsA success message is shown.
  • In order to dismiss your changes, click on the RESET button.

Edit job settings

Via the job settings you can define the execution time and interval of a job. Alternately you can set a job to a manual execution. Then you can execute the job via the corresponding action button. In order to edit the job settings of a particular job, proceed as follows:

  1. In the table row of the respective job, double-click in the table cell of the “Job settings” column, to call up the corresponding dialog box.
  1. From the menu, select either an interval or the option “Manual” to allow for a manual execution of the job.
  2. Depending on the selected interval, make further settings:
    • If you selected the interval “Every week”, define a weekday.
    • If you selected the interval “Every second”, “Every minute” or “Every hour”, use the slider to define the desired interval length.
    • Depending on the interval you selected, define a day of the month when the job is to be started.
    • Depending on the interval you selected, define an hour of the day when the job is to be started.
    • Depending on the interval you selected, define a minute of the hour when the job is to be started.
  1. Click the ACCEPT button to confirm your settings. Afterwards the dialog box closes.
  • In order to save your settings, click on the SAVE button.
  • In order to cancel the process, click on the RESET button.

Define downtimes

You can define downtimes during which the execution of a job is suspended. To do so, proceed as follows:

  1. In the table row of the respective job, double-click in the table cell of the “Downtime” column, to call up the corresponding dialog box.
  1. Possibly define one or more weekdays. Then the selected weekdays are shown below the separator.
  2. Possibly define a time period:
    1. In the upper “Hour” field, enter the hour from which on the job is to be suspended.
    2. In the upper “Minute” field, enter the minute of the hour from which on the job is to be suspended.
    3. In the lower “Hour” field, enter the hour until which the job is to be suspended.
    4. In the lower “Minute” field, enter the minute of the hour until which the job is to be suspended.
This screenshots shows a downtime which effects that the respective job is suspended on Mondays, Fridays as well as between 01:00 and 08:00 am.
  1. Possibly define additional time periods. To do so, click on the Add button. The last set time period is then transferred to the area below the hyphen. Now enter the parameters for the additional time period. If necessary, repeat the steps described under this point to set further time periods.
  2. Click on the ACCEPT button to confirm your settings. The dialog box will then close.
  • In order to save your changes, click on the SAVE button.
    Pfeil nach rechtsA success message is shown.
  • In order to dismiss your changes, click on the RESET button.
Note
Settings regarding weekdays and time periods are considered independently. For example: A downtime setting for a particular weekday and a time period effects that the respective job is suspended on this weekday as well as on any other weekday during the defined time period.

Edit job parameters

Add parameters to a job

In order to add a parameter to a job, proceed as follows:

  1. In the table row of the respective job, double-click in the table cell of the “Parameter” column, to call up the corresponding dialog box.
  2. Click on the ADD button. Then appears a new entry in the parameter table.
  3. Double-click in the table cell of the “Value” column and enter a value.
  4. Possibly add additional parameters and enter the corresponding values.
  5. Click on the ACCEPT button. Then the dialog box closes.
  • In order to save your changes, click on the SAVE button.
    Pfeil nach rechtsA success message is shown.
  • In order to dismiss your changes, click on the RESET button.

Revoke parameters from a job

In order to revoke a parameter from a job, proceed as follows:

  1. In the table row of the respective job, double-click in the table cell of the “Parameter” column, to call up the corresponding dialog box.
  2. In the table, tick the parameter you want to revoke from the job. You can also tick multiple entries.
  3. Click on the DELETE button. Then appears the  button.
  4. Click on the  CLICK TO CONFIRM button to confirm the revoking of the parameter(s).
  5. Click on the ACCEPT button. Then the dialog box closes.
  • In order to save your changes, click on the SAVE button.
    Pfeil nach rechtsA success message is shown.
  • In order to dismiss your changes, click on the RESET button.

Show on the dashboard

Via the appropriate table column it can be specified whether a job is shown on the dashboard of iPIM CC:

  1. In the table row of the job, doubleclick in the table cell of the “Show on dashboard” column.
  2. Select the desired option:
    • YES: The job is shown on the dashboard.
    • NO: The job is not shown on the dashboard.
  3. Leave the table cell.
  • To save your settings, click on the SAVE button .
    A success message is shown.
  • To cancel dismiss your settings, click on the RESET button .