JOC Cockpit - Customizations

Scope

• Customizations are a powerful means to create and manage custom filters that are available for any list view with the JOC Cockpit.
• By default customizations are private, however, they can be shared across teams.
• Permissions can be managed to allow specific roles to manage shared customizations.
• Shared customizations are stored centrally and are provided for any device that is used by a user.

Management of Customizations

• Customizations can be held privately, i.e. they are accessible exclusively for the current user.
• In addition customizations can be shared across teams.
• Shared customizations are updated when loading the respective view in the JOC Cockpit.

Creating Customizations

Customizations are context-dependent - a customization configured for a Job Chain will differ from one configured for the Daily Plan.

This can be seen in the modal windows for the configuration of History and Daily Plan Customizations shown below.

History Customization

(Screenshot made from JOC Cockpit Dark accessible theme)

Daily Plan Customization

(Screenshot made from JOC Cockpit Midnight Blue theme)

Configuration

• Customization names

  • Customization names can be freely chosen.

• Folders

  • The filter parameters used to limit entries in a result list view to specific folder can be selected from the JobScheduler's live tree or specified by a regular expression. In the Daily Plan Customization Window the Jobs and Job Chains fields must include the individual Job Chain or Job - e.g. /test/hello_world/job_chain01. A regular expression such as that shown in the screenshot above must be used to show all the Jobs or Job Chains in a folder.

• Time ranges

  • The time range can be specified with a relative expression that includes the use of the words now and today, optionally in combination with a number of seconds (in combination with now - see example below), hours (h), days (d), weeks (w), months (M) or years (y).

  • Definition of dates and times

    • The definitions used for relative dates and times differ, so last week runs from Monday to Sunday whereas the last hour runs from 60 minutes ago to now.
    • Seconds and hours:
      • are relative to now, so -2h is two hours ago
    • Days, weeks, months and years
      
      • The definition of days, weeks, months and years depends on the context - that is on whether it is a from or a to date:
        
        • From dates start at the beginning of the date (i.e. a day starts at 00:00, a week starts on Monday, etc):
          
          • ±0w means starting on Monday of the current week
          • -3w means starting on the Monday three weeks ago
        • To dates end at the end of a date (i.e. a day ends at 24:00, a week ends on Sunday, etc):

          • ±0M means ending on the last day of the current month

          • +3M means ending on the last day of the month in three months time

    • Some points in time can be combined: for example, -1w+2d, -1y+3M but weeks and months cannot be combined.
    • Examples for events in the past:
      • Executed in the last 10 minutes: now-600
      • Executed in the last hour (i.e. in the last 60 minutes): -1h
      • Executed yesterday: -1d to -1d
      • Executed from yesterday 00:00 onward (i.e. yesterday and today): -1d
      • Executed this week: -0w
      • Executed last week: -1w to -1w
      • Executed last month: -1M to -1M
      • Executed since the start of last month (i.e. last month and the current month): -1M
      • Executed in the first quarter of the current year: -0y to -0y+3M
      • Executed in the second quarter of last year: -1y+3M to -1y-6M
    • Examples for events in the future:
      • To be executed today: +0d
    • Examples bridging the present:
      • For the current week: -0w to -0w or +0w to +0w

  • Definition Changes

    • The interpretation of time ranges was modified in Release 1.11.5 - for details see issue JOC-332 - Getting issue details... STATUS .

Customizations vs. Advanced Search

In contrast with Customizations, the JOC Cockpit's  Advanced Search function allows absolute start and end dates and times to be used. These are not available in customizations, which are intended to be saved and reused.

Advanced Search configurations can be saved as Customizations, without any absolute start and end dates and times.

Managing Customizations

Configuration

• The name of the currently active customization is displayed with the Customization menu.
• The list of available private and shared customizations is also displayed.
• Clicking the circled x symbol deactivates an active customization, this operation does not remove a customization.

Edit Customizations

Configuration

• The list includes customizations that are marked as shared (or otherwise are private).
• The star symbol in front of the customization name can be clicked to select a favorite customization that would automatically become active whenever the associated list is viewed and no other customizations are active.

Permissions

For details of Permission sets see Authentication and Authorization - Permissions for the JOC Cockpit Web Service

Private Customizations

• By default customizations created by a user are private, i.e. they are accessible exclusively for the given account.
• By default users have all the permissions required to manage private customizations, i.e. create, view, edit, delete and share:
  • Permission sos:products:joc_cockpit:customization:private:view
  • Permission sos:products:joc_cockpit:customization:private:edit_content
  • Permission sos:products:joc_cockpit:customization:private:delete
  • Permission sos:products:joc_cockpit:customization:private:make_shared allows a private customization to be shared.

Shared Customizations

• By default exclusively the application_manager roles is granted permissions to manage shared customizations.
• Users granted the relevant permissions can managed shared customizations:
  
  • Permission sos:products:joc_cockpit:customization:share allows a shared customization to be created.
  • Permission sos:products:joc_cockpit:customization:share:view 
  • Permission sos:products:joc_cockpit:customization:share:edit_content
  • Permission sos:products:joc_cockpit:customization:share:delete
  • Permission sos:products:joc_cockpit:customization:share:make_private allows a shared customization to be made private.