Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Back to Jobs Main Page

Excerpt
hiddentrue

Learn how you can to configure Jobs Business Definition Definitions that will dictate the overall behavior behaviour of Jobs

What does this section cover?

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

What are Jobs Definitions?

Jobs definitions

Navigating to Jobs Definitions

Info

CONFIGURATION > CRM APPLICATION > JOBS > SET UP BUSINESS DEFINITIONS

What are Jobs Definitions?

Jobs Definitions is a set of business rules used to control the behavior of Jobs throughout their whole life cycle. Allowed Job Types to be used, must be defined in the definition.

Creating, Editing & Deleting Validations & Restrictions

behaviour of Jobs throughout their Life Cycle.

Jobs Definitions can be edited, deleted and have their Life Cycle State changed provided that Validations & Restrictions are met.

  • Navigate to Jobs Definitions and explore existing records via the Summary page
  • Click on the link (name or number) of the record of your interest to access the Data Entry page and see more detail.

  • Use the Actions Menu to create a NEW Definition, modify (EDIT), or DELETE an existing one.  

  • Use BACK to return to the Summary page and CANCEL to revert any unwanted changes made to the Definition. 

  • Click on the Audit Log button to view a log of changes performed on the displayed Jobs Definition.

Check the Validations & Restrictions Table below for a list of available Actions when working with Jobs Definitions, including each Action's related validations and restrictions. View the Attributes Table for a comprehensive description of the Jobs Definitions fields.

 Jobs DefinitionsImage Added

Anchor
validations
validations
Validations & Restrictions 

ActionValidationsRestrictions
General
  • Multiple Job definitions Jobs Definitions can exist in the system, but each one should have a unique name and alternative code.Only one active Job definition can Name and Alternative Code
  • Only one 'Active' Jobs Definition can exist at any given time.
  • If no active Job definition 'Active' Jobs Definition exists, then no Job processes Jobs can be performed. created
  • Rules and restrictions specified in Job definitions Jobs Definitions are applied during the creation and maintenance of a Job. 
Create
  • Mandatory Fields must be defined
  • At least one Job Type should be included in the Allowed Job Types while creating or updating Jobs Definitions
  • Status
    colourRed
    titleApplicable Up to CRM.COM R9.0.0
    Action Types and Sub action types -Action Types have been selected if they are configured in the system
  • Job Types must be configured
  • At least one Job type should be included in the allowed Job types while creating or updating Job definitions
Delete
  • A definition can be deleted as long as it is not the active one
 
Jobs Definition attributes 
Edit
  • Mandatory Fields must be defined
  • Name and Alternative Code must beunique
  • Not Applicable
Delete
  • Not Applicable
  • Cannot be deleted if it's the 'Active' Definition

Anchor
attributes
attributes
Attributes

An * indicates a field is mandatory 

Select the Job Type from the drop down list
Repeat the process for all Job Types you would like to make available for usage

ALLOWED CANCELLATION REASONS

  • Click on ADD
  • Select the cancellation reason from the drop down list
  • Repeat the process for all reasons you would like to make available for usage
  • Select the default reason

    COMMUNICATION SETTINGS

    Select the stages for which you want to send an email For each scope and trigger you can select
  • Communication Template

  • Communication Queue External System 
  • SUBSCRIPTION SETTINGS

    1. Become Subscriber Action Type: Select action type from the drop down if you have configured custom actions in the system, using the specific behaviour code

    2. Become Subscriber Sub Action Type: Select action type from the drop down if you have configured custom actions in the system, using the specific business classification code

    3. Classification, Action Type and Sub Action type are visible only if applicable
  • START WORK RULES

  • JOB DEFINITION START WORK RULESImage Removed
  • Job Types
  • Click on ADD
  • Search and select the Job Types that will
     NameAllowed Allowed The communication settings for the The subscription action types and sub-types

    Name

    Description

     Number
    Main Information
    NumberAn auto-generated number that uniquely identifies the accounts receivable definitionsJobs Definitions
    Name*The name of the definitionDefinition
     Alternative codeAlternative Code*An alternative code for the definition. On creating a new definition it defaults to the first letter of each word included in the name (in Capitals), if nothing else is specifiedDefinition. Unless otherwise specified, the codes for new Definitions default to the Definition's Name initials in capital letters.
    DescriptionA description for of the definitionDefinition
    StateThe state of the definition Definition which can be active or inactive. Only one active definition can exist at any point'Active' or 'Inactive'.
    Allowed Types
    Job Types

    The

    job types

    Job Types that can be used

    by users

    . The following fields are available:

    • Name
    • Description
    • Fulfilment Scope
    • Fulfilment Method
    Allowed Cancellation Reasons
    Cancellation ReasonsThe cancellation reasons that are allowed to Cancellation Reasons that can be selected on cancelling jobs. The default cancellation reason Cancellation Reason is also specified through this section as well.

    Communication Settings -

    Status
    colourRed
    titleApplicable Up to CRM.COM R9.0.0

    Note

    From CRM.COM R10 and onward this is now configured only at the Job Type

     

    Communication Triggers

     

    The Communication Settings for emails. Based on the defined settings defined an email can be automatically sent based on each trigger and triggered using the selected communication template. The states that an email can be automatically sent after each state change arechange of state thatresultin an automatic email:

    • On Creating: If enabled, a communication will be sent whenever a job is created
    • On Updating Requested Information: If enabled, a communication will be sent whenever the requested information of a Job is updated
    • On Starting Progress: If enabled, a communication will be sent whenever the progress of a job starts (i.e. the Life Cycle State changes to 'In Progress')
    • On Canceling: If enabled, a communication will be sent whenever a job is cancelled (i.e. the Life Cycle State changes to 'Cancelled')
    • On Completing: If enabled, a communication will be sent whenever a job is completed (i.e. the Life Cycle State changes to 'Completed')

    Communication Templates

     

    The Template that will be used to create the Communication for each trigger. Only 'Effective' Communication Templates with an outgoing direction can be selected.

    One Communication Template must be selected for each enabled trigger. A Communication Template can be added for the following Fulfilment Scopes:

    • Activate Subscription
    • Deactivate Subscription
    • Cancel Subscription
    • Add Subscription Services
    • Cancel Subscription Services
    • Change Subscription Location
    • Swap Subscription Installed Items
    • Swap Subscription Services

    Communication Queue External System

    Optionally an external system can be specified for each Communication Template.
    Subscription Settings -
    Status
    colourRed
    titleApplicable Up to CRM.COM R9.0.0
    Subscription Action Types -Sub Types

    The Subscription Action Types and Sub-Types that will be used when

    subscription

    Subscription actions are automatically created during

    a job's processing. The subscription action types and sub-type is mandatory information but only if such types and sub-types

    the processing of a Job. The Subscription Action Types and Sub-Type is mandatory information, as long as such Types and Sub-Types are configured for each

    one

    of the supported

    subscription

    Subscription action

    behavior

    behaviours or

    business classification

    Business Classification codes.

    Job TypesThe list of job types that are requiring an approval
    Start Work AuthorisationsA list of users or units that can approve jobs, considering that they have access to the group owning the job. Multiple users or units can be specified in this list. This information is mandatory if job types are specified

    Defining your own Jobs Definition tailored to your company's needs

  • Navigate to Configuration > CRM Application > Jobs > Set up Business Definitions 
  • Either search for an existing one or from the Top Menu click on NEW
    JOBS DEFINITIONImage Removed
  • MAIN INFORMATION

    1. Provide the required information
       

  • ALLOWED TYPES

  • Click on ADD
  • You can select any type of Organisational unit according to the restrictions that you would like to set, or none at all
  • LOG INFORMATION

  • Include PageLog Information - GlobalLog Information - Global
  • From the Top Menu click on SAVE
  • Deleting Jobs Definitions

    Include PageDeleting a record - GlobalDeleting a record - Global

    Changing the Life Cycle State of Jobs Definition

    Include PageChanging the Life Cycle State of a Definition - GlobalChanging the Life Cycle State of a Definition - Global

     

    Selection for the following Subscription Action Types is available

    • Become Subscriber Action Type
      • Become Subscriber Sub-Action Type
    • Activate Subscription Action Type
      • Activate Subscription Sub-Action Type
    • Deactivate Subscription Action Type
      • DeactivateSubscription Sub-Action Type
    • Cancel Subscription Action Type
      • Cancel Subscription Sub-Action Type
    • Add Subscription Services Action Type
      • Add Subscription Services Sub-Action Type
    • Cancel Subscription Services Action Type
      • Cancel Subscription Services Sub-Action Type
    • Change Subscription Location Action Type
      • Change Subscription Location Sub-Action Type
    • Swap Subscription Installed Items Action Types
      • Swap Subscription Installed Items Sub-Action Type
    • Swap Subscription Services Action Type
      • Swap Subscription Services Sub-Action Type
    Note

    View Configuring Subscription Action and Sub Action Types for more information.

    Start Work Rules -
    Status
    colourRed
    titleApplicable Up to CRM.COM R9.0.0
    Job TypesThe list of Job Types that require an approval
    Start Work Authorisations
  • Click on ADD and specify at least one user or unit that will be responsible for approving Jobs of types specified in the previous step. Select between
    1. USER
    2. UNIT
  • Use the Search modal to select the user or unit you would like to add.
  • A list of Users or Units that can approve Jobs, provided they have access to the Group owning the job. Multiple Users or Units can be specified in this list. This information is mandatory if Job Types are specified.
    Log Information
    Log DetailsThe standard set of Log Details information available in all entities
    Panel
    namegrey

    Related Areas

    Filter by label (Content by label)
    showLabelsfalse
    spacesV4Manual
    showSpacefalse
    excerpttrue
    labelsjobs-basics-r7,jobs-advanced-r7,jobs-admin-r7

    Popular Labels

    heatmap
    Panel
    namegrey
    Popular Labels
    spaceKeyV4Manual
    style

    Helpful Links

    Filter by label (Content by label)
    showLabelsfalse
    spacesV4Manual
    showSpacefalse
    labelsglobal