Event Parameters

Events represent changes that occur in components. Each standard event occurs when it is caused by an action. For example, the User Create event occurs when a new user is added using the Add User user interface or the createUser web service method. You can optionally add custom events.
casm172
Events represent changes that occur in components. Each standard event occurs when it is caused by an action. For example, the User Create event occurs when a new user is added using the
Add User
user interface or the
createUser
web service method. You can optionally add custom events.
Each event type may have parameters associated with it. When an event occurs, the parameter values reflect the context of the event. For example, when the User Create event occurs, the associated parameter named
$user_id$
contains the User ID value for the new user just created. Event parameter values can be used in rule filters and rule actions.
Administrators can use event parameters as conditions to determine whether rules or actions are triggered. Each event type has parameters that reflect the context of the event.
Example:
The
$user_id$
parameter of the User Create event contains the User ID value for the new user.
Most parameters for event types are self-explanatory and intuitive. However, the Event Type parameters in the following sections require explanation:
Event-Based Load (EBL) data for CA Service Catalog Offerings and Requests
To enable CA Service Catalog Offerings and Requests in Service Point, CA Service Catalog sends request and offering data to the Elastic Search Server. For more information, see Perform Initial Load and Refresh Index and Data on the Search Server.
Three new Event Rule Actions namely
Featured Offering Added
,
Featured Offering Deleted
,
Option Item Added or Modified
are added with a new rule for each event. Click
Save
to update the event type information after you have added or modified an event type.
CA Service Catalog Offerings will be displayed in the Service Point if CA Service Desk Manager, CA Service Catalog, and xFlow Interface are integrated. If CA Service Catalog is installed as a standalone product, CA Service Catalog Requests and Offerings are not displayed in Service Point and the EBL Event Rules must be disabled in such cases. For more information, see Manage CA Service Catalog Featured Offerings.
Note: If
CA Service Management
SSL enabled, ensure that CA Search Server SSL certificate is imported into CA Service Catalog keystore. For more information, see Enable SSL Authentication for CA Service Management Solution.
CA Service Catalog offerings will be displayed in Service Point and will be considered for Event Based Load (EBL) if at least one CA Service Catalog Option Group is associated with the offering. Also the Availability Date for an Offering must be set so that it can be picked up by Service Point via Elastic Search server.
Two existing Event Rule Actions -
Service Change,
Service Option Group Change
, and
Request Change
are also updated with new rules to implement Service Catalog Offerings and Requests in Service Point.
  • Service Change
    : EBL Service Change Rule
  • Service Option Group Change
    : EBL Featured Offering Rule
  • Request Change
    : Sync Elastic search for request change rule
Featured Offering Add EBL Rule
This Event Type occurs when an offering is added as a Featured Offering. 
Event Parameter
Meaning
Example
$feature_type$
Featured Offering type 
$featured_in_offering_id$
Represents the Offering ID with associated Featured Offerings
$featured_offering_id$
Represents Offering ID which is Featured in another Offering
$all$
Name=value pairs of all available event parameters including additional data not available as event parameters. Also, includes variables containing old data before saving the data, causing the event to occur.
Featured Offering Deleted
This Event Type occurs when an offering is modified as a Featured Offering. 
Event Parameter
Meaning
Example
$feature_type$
Featured Offering type
$featured_in_offering_id$
Represents Offering id which has Featured Offerings associated
$featured_offering_id$
Represents Offering id which is Featured in another Offering
$all$
Name=value pairs of all available event parameters including additional data not available as event parameters. Also includes variables containing old data before the save causing the event to occur.
Option Item Added or Modified
This Event Type occurs when an Option Group or an Option associated with a Offering is added or modified. 
Event Parameter
Meaning
Example
$approval_level$
Approval level assigned to the Offering
$approval_process$
Approval process assigned to the Offering 
$base_id$
Represents Unique internal ID of Base Offering
$child_id$
Represents Unique internal ID of an Option Included in the offering definition
$id$
Unique internal ID for this item
$parent_id$
Represents Unique internal ID of Offering
$selection$
Indicates Boolean value whether this Option item is selected in the Offering definition or not. If selected value is 1 else 0
$all$
Name=value pairs of all available event parameters including additional data not available as event parameters. Also includes variables containing old data before the save causing the event to occur.
Request Create Event and Change Event
These event types occur when the request header information is modified.
You must have CA Service Catalog installed to use this event type.
Event Parameter
Meaning
Example
$completion_date$
Date the request is completed.
$created_date$
Date the request is created.
$desired_date$
Date required
$domain$
Business unit name for the requested for user or account.
ABC Corp Sales
$modified_date$
Date the request was last modified.
$name$
Request name
My new laptop
$priority$
Numeric value for request priority
3
$req_by_account_id$
Internal ID for Requested By user
10018
$req_by_user_id$
User ID for Requested By user
ABCUser
$req_for_account_id$
Internal ID for an account that is associated with Requested For user or account.
10054
$req_for_user_id$
User ID for Requested For user
ABCUser - for a request for a user
NIL - for a request for an account
$request_id$
Internal ID for request
10023
$status$
Numeric value of status of the request, for example:
400=Pending Approval800=Approved
400
$all$
Name=value pairs of all available event parameters including additional data not available as event parameters.
Also includes variables containing old data before the save causing the event to occur.
comments='My laptop for travel'
comments_eventdatatype='String'
comments_old='NIL'
Request Item Form Element Create Event and Change Event
These event types occur when a field in a form that is associated with a request item is changed.
Install Catalog Service Accounting component to use this event type.
Event Parameter
Meaning
Example
$form_elem_name$
Label for the field as it appears on the displayed form.
Employee Title
$form_elem_value$
Value for field on the form
: This value is  the HTML “value” field which is different from the choice list “label” field displayed.
Vice President (for an input type field)
1 (for a select list type field)
$subscription_detail_id$
Unique internal ID for this request item
10012
$all$
Name=value pairs of all available event parameters including additional data not available as event parameters. Also includes variables containing old data before the save causing the event to occur.
form_elem_label='Employee Title' form_elem_label_eventdatatype='String' form_elem_label_old='NIL' form_elem_name='emp_title' form_elem_name_eventdatatype='String' etc
Request Pending Action Change
The following parameters apply to the Request Pending Action Change event type and any new event types that you create based on it.
Parameter
Value
$rpa_action_type$
0=Default1=System2 =CA Workflow3=CA Process Automation4=Policy
$rpa_id$
The request_pending_action_id entry in the usm_request_pending_action table in the MDB
$rpa_object_type$
1=Service Offering (service)2 =Request Item
$rpa_reassigned_id$
The reassigned value of the request_pending_action_id entry in the usm_request_pending_action table in the MDB
$rpa_status$
0=deleted1=active2=completed by assigned user3=completed by other user4=transferred5=delegated6=terminated
$rpa_users_or_groups$
The user_id or group_id entry in the usm_request_pending_action table (mdb)
Request/Subscription Item Create Event and Change Event
These event types occur when a request or subscription item is modified. The modification is generally a change to the status of the item.
Requests or subscriptions are for service options. Service options are comprised of service option elements. When the status of a service option that is part of a request or subscription changes, this event occurs for each service option element in the service option.
Event Parameter
Meaning
Example
$account_label$
The account name for the Requested For user
ABC Corp:ABCUser(for a request for a user)
Sales (for a request for an account)
$account_no$
Internal ID for the account in $account_label$
10002
$approval_level$
Numeric value for the approval level for service
10
$approval_process$
Numeric value for the approval process, as follows:
0=No approval1=System approval process2=Workflow driven approval process
2
$category$
Numeric value for requested item category, for example:
0=Software1=Hardware
0
$category_class$
Numeric value for requested item class within category, for example:
For category 0 (Software), class 10 may be “Office”.
10
$category_subclass$
Numeric valued for requested item subclass within class within category, for example:
For category 0 (Software), class 10 (Office), subclass 10 may be “Microsoft”.
10
$charge$
Numeric value indicating whether associated amounts are a charge or credit for use by Service Accounting Component where:
0=credit
1=charge
1
$charge_date$
Date the item is first charged for by Service Accounting Component.
$code$
Code for the service option element
My Element Code
$domain$
Business Unit Name for the Requested For user or account
ABC Corp Sales
$enum_1$ through $enum_5$
Vary depending on service option element type.
$external_id$
Service option element External ID
My Element External ID
$group_id$
Numeric value indicating the occurrence of the service in a request (in case a request includes more than one copy of a service)
1
NIL (for a subscription)
$form_data_sd$ - for the Request/Subscription Item Change Event only
If this service option includes a form, then this parameter lists the details of the form in JSON structure.
To apply rules to subscription items whose type is form, append the following condition to the event filter:
“AND form_data_sd <> 'NIL'”
See Sample Data for $form_data_sd$
(after this table)
$form_data_sd_row$ for the Request/Subscription Item Change Event only
If multiple forms exist in a service option, this parameter lists the details of all these forms in JSON structure.
See Sample Data for $form_data_sd_row$
(after this table)
$id$
Unique internal ID for this request item
10012
$installments$
Numeric value indicating the number of installments for associated amounts for use by Service Accounting Component
0
$instance_name$
Optional value that is assigned when subscribing an account to a service.
My instance
$item_id$
Internal ID for requested service option element
9981
$last_charge_date$
Date the item was last charged for by Service Accounting Component.
$numeric_1$ and $numeric_2$
Vary depending on service option element type.
$offering_id$
Internal ID for requested service
10002
$offering_name$
Name of the service offering (service)
Standard Laptop Bundle
$rate_item_col$
Numeric value (zero-based) indicating the associated service option element's column position in the service option row
0
$rate_item_name$
Service option element Display Text
Standard Laptop
$rate_item_row$
Numeric value (one-based) indicating the associated service option element's row position in the service option group
1
$rate_item_text_1$
Additional text that is associated with the service option element.
For example, for a Text type service option element, this is Text Value and for a Rate type service option element, this is Display Unit Type.
/month
$rate_item_type$
Numeric value for the associated service option element where:
0=Text1=Header2=Numeric Range
3=Rate4=Application5=Agreement6=Numeric7=Boolean
8=Adjustment9=Date10=Date Range11=Day12=Allocation13=Form
3
$rate_plan_id$
Internal ID for associated service option group
10035
$rate_plan_name$
Associated service option group name
Standard Laptop Accessories
$req_by_user_id$
User ID for Requested By user
ABCUser
NIL (for a subscription)
$req_for_user_id$
User ID for Requested For user
ABCUser(for a request for a user)
NIL (for a request for an account)
NIL (for a subscription)
$request_id$
Internal ID for request
10023 (for a request)
NIL (for a subscription)
$request_name$
Request Name
My new laptop
NIL (for a subscription)
$request_priority$
Numeric value for request Priority
3
NIL (for a subscription)
$sd_row$
Numeric value (one-based) for the service option containing this service option element relative to all the service options selected with the service.
1
$status$
Numeric value of status of the requested item, for example:
400=Pending Approval800=Approved
400
$subscribed_date$
Date the item was included in a request or subscription.
$subscription_type$
Numeric value indicating the type of item where:
0=Other1=Application2=Agreement3=Adjustment4=Form
0
$text_1$ - $text_7$
Vary depending on service option element type.
$tiered_item_id$
Internal ID of the tiered service option group of the associated service option element where:
-1=Not associated with a tiered service option group
-1
$tiered_last_date$
Date the item was last charged for by Service Accounting Component.
Applicable only if the related service option element is part of a tiered service option group.
$track_as_asset$
Numeric value indicating whether this request item must be tracked as an asset where:
0=No1=Yes
1
$unsubscribed_date$
Date the item is cancelled or unsubscribed.
NIL
$all$
Name=value pairs of all available event parameters including additional data not available as event parameters.
Also includes variables containing old data before the save causing the event to occur.
account_label='Sales'account_label_eventdatatype='String'
etc
Sample Data for $form_data_sd$
The following sample data lists the details of one form:
{"name" : "dept", "value" : "001|Human Resources", "type" : "9"}, {"name" : "empid", "value" : "spadmin", "type" : "5"}, {"name" : "empName", "value" : "Administrator, Service Delivery", "type" : "5"}, {"name" : "reason", "value" : "0", "type" : "12"}
: When CA Service Catalog data is used by CA Process Automation, then in the dual list and select box fields, a comma (,) is replaced by two tildes (~~). Before using the data, the user must replace two tildes (~~) with a comma (,).
Sample Data for $form_data_sd_row$
The following sample data lists the details of two forms (10246 and 10245) in the same service option. Form 10245 includes the form type subscription ids.
{ "10246" : [ {"name" : "dept", "value" : "001|Human Resources", "type" : "9"}, {"name" : "empid", "value" : "spadmin", "type" : "5"}, {"name" : "empName", "value" : "Administrator, Service Delivery", "type" : "5"}, {"name" : "reason", "value" : "0", "type" : "12"}], "10245" : [ {"name" : "accesstype", "value" : "0", "type" : "12"}, {"name" : "buildingcode", "value" : "1|Building1", "type" : "9"}, {"name" : "date", "value" : "", "type" : "14"}, {"name" : "date_fdms$$", "value" : "", "type" : null}, {"name" : "device_code", "value" : "device access code value", "type" : "5"}, {"name" : "empid", "value" : "spadmin", "type" : "5"}, {"name" : "empname", "value" : "Administrator, Service Delivery", "type" : "5"}, {"name" : "purpose", "value" : "purpose value", "type" : "8"}] }
Notes Create and Notes Change
The Notes Create and Notes Change event types are described as follows:
Notes Create
This event type occurs when a note is created for a CA Service Catalog request. Rules associated with this event type are as follows:
  • When a note is added to a CA Service Catalog request
    : When note is added to a CA Service Catalog request, email notifications are sent.
  • When notes are added to a CA Service Catalog request
    : When a note is added to a CA Service Catalog request, it is also synchronized with the corresponding CA Service Desk Manager ticket.
  • When a CA Service Desk Manager note is synchronized to a CA Service Catalog request
    : When CA Service Desk Manager (CA SDM) note is synchronized to CA Service Catalog request, email notifications are sent.
Notes Change
This event type occur when a Note is changed or modified for a request. The following rules are associated with this event type:
  • When note with attachment(s) is edited in a CA Service Catalog request
    : When a note with attachment(s) is edited in CA Service Catalog request, E-Mail notifications are sent.
  • When note without attachment(s) is edited in a CA Service Catalog request
    : When a note without attachment(s) is edited in CA Service Catalog request, E-Mail notifications are sent.
The following event parameters associated with these event types require explanation:
Event Parameter
Meaning
Example
$source_id$
The request ID of the corresponding Note.
10510
$note_text$
Description of the note.
$ignore_notification$
Value will be true in the following cases:
  • on submission of request that has note(s).
  • When a note event is triggered for a comment with notes and attachments posted in Widgets.
Attachment Create and Attachment Change
The Attachment Create and Attachment Change event types are described with associated rules:
Attachment Create
This event type occurs when an attachment is created for a request. Rules associated with this event type are as follows:
  • When attachment is added to CA Service Catalog request
    : When an attachment is added to a CA Service Catalog request, it is added as a link to the corresponding CA Service Desk Manager ticket.
  • When attachment is added to a CA Service Catalog request:
    When an attachment is added to a CA Service Catalog request, email notification is sent.
  • When note and attachment(s) are added to a CA Service Catalog request
    : When note (s) and attachment(s) are added to a CA Service Catalog request from Widgets, email notifications are sent.
  • When a CA Service Desk Manager attachment is synchronized to a CA Service Catalog request
    : When a CA Service Desk Manager attachment is synchronized to CA Service Catalog request, email notifications are sent.
Attachment Change
This event type occurs when an attachment is changed for a CA Service Catalog request. Following rule is associated with this event type:
  • When attachment associated with a CA Service Catalog request is edited
    : When an attachment associated with a CA Service Catalog request is edited, email notifications are sent.
The following event parameters associated with these event types require explanation:
Event Parameter
Meaning
Example
$object_id$
Request ID of the corresponding attachment.
 10510
$ignore_notification$
Value will be true in the following cases:
  • on submission of request that has attachment(s).
  • for the first
    n-1
    attachments when a comment with
    n
    attachments is posted in Widgets.
For example, if a comment in Widgets has 1 note and 5 attachments, so for the first four attachments (n-1=4), the value will be true.
$attachment_url$
Specifies the URL(s) of the uploaded attachment(s).