The Common Catalog Task document is an XML schema that contains default fields for mapping catalog task form values from one system to another. The common catalog task format mirrors what one would see in an ITIL view of a Catalog Task form with related lists expressed in embedded XML form.

Common Catalog Task is found available as part of the Common Request update set.

What's on this page?


Sample Common Catalog Task

A sample Common Catalog Task looks like this:

<common_catalog_task>
    <action />
    <active />
    <activity_due />
    <additional_assignee_list />
    <affected_cis>
        <affected_ci>
			<ci_class />
            <ci_name />
            <ci_id />
        </affected_ci>
    </affected_cis>
    <approval />
	<approvers>
      <approver>
         <created />
         <approver_name />
         <assignment_group_name/>
         <approver />
         <state />
         <comments/>
         <approver_email />
         <assignment_group/>
      </approver>
   	</approvers>
    <approval_history />
    <approval_set />
    <assigned_to_name />
    <assigned_to_email />
    <assignment_group_name />
    <assignment_group />
    <attachments>
        <attachment>
            <data />
            <size_bytes />
            <file_name />
            <sys_id />
            <content_type />
        </attachment>
    </attachments>
    <business_duration />
    <business_service_name />
    <business_stc />
    <calendar_duration />
    <calendar_stc />
    <caller />
    <caller_id />
    <caller_full_name />
    <caller_first_name />
    <caller_last_name />
    <caller_email />
    <category />
    <caused_by />
    <child_incidents />
    <close_code />
    <close_notes />
    <closed_at />
    <closed_by_id />
    <closed_by_full_name />
    <cmdb_ci_id />
    <cmdb_ci_name />
    <comments />
    <comments_and_work_notes />
    <company_id />
    <company_name />
    <contact_type />
    <correlation_display />
    <correlation_id />
    <delivery_plan_display />
    <delivery_task_display />
    <description />
    <due_date />
    <escalation />
    <expected_start />
    <follow_up />
    <group_list />
	<group_approvals>
		<group_approval>
			<approval />
			<approval_user />
			<short_description />
		</group_approval>
	<group_approvals>
    <impact />
    <incident_state />
    <knowledge />
    <location_id />
    <location_name />
    <made_sla />
    <notify />
    <number />
    <opened_at />
    <opened_by_id />
    <opened_by_full_name />
    <opened_by_email />
    <order />
    <parent_id />
    <parent_incident_number />
    <priority />
    <problem_id />
    <problem_number />
    <provider />
    <reassignment_count />
    <reopen_count />
    <resolved_at />
    <resolved_by_id />
    <resolved_by_full_name />
    <resolved_by_email />
    <rfc_id />
    <rfc_display />
    <severity />
    <short_description />
    <sla_due />
    <state />
    <subcategory />
    <time_worked />
    <urgency />
    <variables />
    <watch_list />
    <work_end />
    <work_notes />
    <work_start />
</common_catalog_task>




Embedded Records

Embedded records are fields in the Common Catalog Task document that cannot be mapped by singular values. Instead, they are entirely different records included inside the Common Catalog Task document to be created on the subscribing system.

The following are examples of the embedded records in Common Catalog Task: 

Configuration Item's Affected Embedded Record


The CI affected field in the Common Catalog Task is an embedded record that, when populated, will create a new ci affected on the system receiving the Common Catalog Task.

Table Map Source FieldDefinition
ci_classClass name of the configuration item
ci_nameName of the configuration item
ci_idUnique record identifier of the configuration item

Group Approval Embedded Record


The group approval field in the Common Catalog Task is an embedded record that, when populated, will create a new ci affected on the system receiving the Common Catalog Task.

Table Map Source FieldDefinition
approvalStatus of the catalog task's approval

approval_user

Unique record identifier of the approval user
assignment_groupUnique record identifier of the assignment group
short_descriptionShort description of the group approval

Approver Embedded Record


The approver field in the Common Catalog Task is an embedded record that, when populated, will create a new approver on the system receiving the Common Catalog Task.

Table Map Source FieldDefinition
createdDate the record was created on
approver_nameName of the approver
assignment_group_nameName of the assignment group
approverUnique record identifier of the approver record
commentsComments of the approver
approver_emailEmail of the approver
assignment_groupUnique record identifier of the assignment group record

Attachment Embedded Record


The attachment field in the Common Catalog Task is an embedded record that, when populated, will create a new attachment on the system receiving the Common Catalog Task.

Table Map Source FieldDefinition
dataAttachment data in an encoded string format
size_bytesMeasurement of how much the attachment data contains
file_nameName of the attached file 
sys_idUnique record identifier of the attachment
content_typeAttachments content type (i.e jpeg, png, txt, etc.)