R9 - Configuring Job Definition

Owned by Persia Xenopoulou (Deactivated)
Jan 29, 2016
4 min read

What does this section cover?

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

ActionValidationsRestrictions
General
  • Multiple Job definitions can exist in the system but each one should have a unique name and alternative code.
  • Only one active Job definition can exist at any given time.
  • If no active Job definition exists, then no Job processes can be performed. 
  • Rules and restrictions specified in Job definitions are applied during the creation and maintenance of a Job. 
Create
  • All mandatory fields must be provided
  • Action Types and Sub 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
  • Not Applicable

Jobs Definition attributes 

Name

Description

 NumberAn auto generated number that uniquely identifies the accounts receivable definitions
 Name*The name of the definition
 Alternative 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 specified
DescriptionA description for the definition
StateThe state of the definition which can be active or inactive.
Allowed Job Types
Job TypesThe job types that can be used by users
Allowed Cancellation Reasons
Cancellation ReasonsThe cancellation reasons that are allowed to be selected on cancelling jobs. The default cancellation reason is specified through this section as well
Communication Settings
Communication Triggers

The communication settings for the emails. Based on the settings defined an email can be automatically sent based on each trigger and using the selected communication template. The states that an email can be automatically sent after each state change are:

  • On Creating: If enabled then a communication will be sent whenever a job is created
  • On Updating Requested Information: If enabled then a communication will be sent whenever the requested information of a job is updated
  • On Starting Progress: If enabled then 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 then a communication will be sent whenever a job is cancelled (i.e. the life cycle state changes to "Cancelled")
  • On Completing: If enabled then a communication will be sent whenever a job is completed (i.e. the life cycle state changes to "Completed")
Communication templates

The communication template that will be used to create the communication for each trigger. Only effective communication templates having direction equal to outgoing can be selected.

One Communication template must be selected for each enabled trigger. Communication Template can be added for the following fulfillment scopes

  • Activate Subscription
  • Deactivate Subscription
  • Cancel Subscription
  • Add Subscription Services
  • Cancel Subscription Services
  • Change Subscription Location
  • Swap Subscription Installed Items - AVAILABLE FROM CRM.COM R9.0.0
  • Swap Subscription Services - AVAILABLE FROM CRM.COM R9.0.0
Communication Queue External SystemOptionally an external system can be specified for each communication template.
Subscription Settings
 

The subscription action types and sub-types that will be used when 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 are configured for each one of the supported subscription action behavior or business classification codes. View Configuring Subscription Action and Sub Action Types for more information

Selection for the following Subscription Action Types is available


  • Become Subscriber Action Type
    • Become Subscriber Sub Action Type
  • Activate Subscription Action Type
    • Activate Subscription SubAction 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 - AVAILABLE FROM CRM.COM R9.0.0
    • Swap Subscription Installed Items Sub Action Type
  • Swap Subscription Services Action Type - AVAILABLE FROM CRM.COM R9.0.0
    • Swap Subscription Services Sub Action Type

Start Work Rules
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

  1. Navigate to CONFIGURATION > CRM APPLICATION > JOBS > SET UP BUSINESS DEFINITIONS 
  2. Either search for an existing one or from the Top Menu click on NEW
    JOBS DEFINITION

  3. MAIN INFORMATION

    1. Provide the required information
       

  4. ALLOWED TYPES

    1. Click on ADD
    2. Select the Job Type from the drop down list
      Repeat the process for all Job Types you would like to make available for usage

  5. ALLOWED CANCELLATION REASONS

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

  6. COMMUNICATION SETTINGS

    1. Select the stages for which you want to send an email 
      1. For each scope and trigger you can select

        1. Communication Template

        2. Communication Queue External System 

  7. SUBSCRIPTION SETTINGS

    1. Action Type and Sub Action type are visible only if applicable. Select the action types that should be applied when each type of action is executed 

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

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

  8. START WORK RULES

    1. Job Types
      1. Click on ADD
      2. Search and select the Job Types that will require an approval
    2. Start Work Authorisations
      1. 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
      2. Use the Search modal to select the user or unit you would like to add.
      3. You can select any type of Organisational unit according to the restrictions that you would like to set, or none at all
        JOB DEFINITION START WORK RULES
  9. From the Top Menu click on SAVE

  10. LOG INFORMATION

    Log information section keeps all the logging information related to the specific record

    • Basic set of information available in all entities
      • Created By User: The user that created the entity
      • Created By Unit: The unit of the user that created the entity
      • Updated By User: The user that last updated the entity
      • Updated by Unit: The unit of the user that last updated the entity
      • Date Created: The date the account was entity
      • Date Updated: The date the account was last entity
        LOG DETAILS

Deleting Jobs Definitions

  1. Search for the entity that you would like to delete
    Visit  Using Summary Pages   to find out how you can search using CRM.COM Summary Screens
  2. Click on the link of the record you would like to delete, to be transferred to the Data Entry page
  3. From the actions menu click on "DELETE"
     The entity will be deleted given that the validations are satisfied

Changing the Life Cycle State of Jobs Definition

  1. Navigate to the module you would like to activate a different definition for
  2. From the menu click of the Summary page click on ACTIONS >  ACTIVATE DEFINITION
    Activating
  3. From the Drop Down select the definition you would like to set as active
  4. Click on "SAVE"
    System will switch between active and inactive definitions

Visit Understanding Jobs for business examples related to Configuring Jobs Definition

Related Areas

Popular Labels