CustomActionSnippets - Revision history

Rabin: /* We want to log all custom and standard fields to syslog, so we can generate reports and audit logs, i.e. with Splunk. This would go in transaction batch */

2021-03-07T19:14:34Z

We want to log all custom and standard fields to syslog, so we can generate reports and audit logs, i.e. with Splunk. This would go in transaction batch

← Older revision		Revision as of 15:14, 7 March 2021
Line 74:		Line 74:

	== Log custom fields and standard fields to syslog ==		== Log custom fields and standard fields to syslog ==
	~~= <span style="font-size:13px;">~~We want to log all custom and standard fields to syslog, so we can generate reports and audit logs, i.e. with Splunk. This would go in transaction batch<~~/span~~> =		* We want to log all custom and standard fields to syslog, so we can generate reports and audit logs, i.e. with Splunk. This would go in transaction batch

			<SyntaxHighlight lang="perl">
	#On ticket creation, log standard and custom fields		#On ticket creation, log standard and custom fields
	my $ticket = $self->TicketObj;		my $ticket = $self->TicketObj;
Line 108:		Line 110:

	$RT::Logger->info( $log_string );		$RT::Logger->info( $log_string );
	return 1;~~<span style="font-size:13px;">~~ </~~span~~>
			return 1;
			</SyntaxHighlight>

	== Log transaction content to syslog ==		== Log transaction content to syslog ==
Line 129:		Line 133:
	$RT::Logger->info( $log_string );		$RT::Logger->info( $log_string );
	}		}

	return 1;		return 1;
	</SyntaxHighlight>		</SyntaxHighlight>

Rabin: /* We want to log all content in tickets to syslog, so we can generate reports and audit logs, i.e. with Splunk. This would go in transaction create. */

2021-03-07T19:02:17Z

We want to log all content in tickets to syslog, so we can generate reports and audit logs, i.e. with Splunk. This would go in transaction create.

← Older revision		Revision as of 15:02, 7 March 2021
Line 111:		Line 111:

	== Log transaction content to syslog ==		== Log transaction content to syslog ==
	~~= <span style="font-size:13px;">~~We want to log all content in tickets to syslog, so we can generate reports and audit logs, i.e. with Splunk. This would go in transaction create.<~~/span~~> =		* We want to log all content in tickets to syslog, so we can generate reports and audit logs, i.e. with Splunk. This would go in transaction create.

			<SyntaxHighlight lang="perl">
	#log content of last transaction, iff it was a create, comment, or correspond		#log content of last transaction, iff it was a create, comment, or correspond
	my $ticket_id = $self->TicketObj->id;		my $ticket_id = $self->TicketObj->id;
Line 128:		Line 130:
	}		}
	return 1;		return 1;
			</SyntaxHighlight>

	= More examples =		= More examples =

Admin: 9 revisions imported

2016-04-06T20:03:35Z

9 revisions imported

← Older revision		Revision as of 16:03, 6 April 2016
(No difference)

128.223.31.192: /* Get related tickets */

2013-04-30T22:20:36Z

Get related tickets

← Older revision		Revision as of 18:20, 30 April 2013
Line 35:		Line 35:

	== Get related tickets ==		== Get related tickets ==
	If you need to grab a given ~~tickets~~ parent(s), child(ren), or other related tickets.		If you need to grab a given ticket's parent(s), child(ren), or other related tickets.

	my $ParentTickets = $self->TicketObj->MemberOf;		my $ParentTickets = $self->TicketObj->MemberOf;

128.223.31.192: /* Get related tickets */

2013-04-30T22:20:08Z

Get related tickets

128.223.31.192: /* Get related tickets */

2013-04-30T22:18:42Z

Get related tickets

← Older revision		Revision as of 18:18, 30 April 2013
Line 36:		Line 36:
	== Get related tickets ==		== Get related tickets ==
	If you need to grab a given tickets parent(s), child(ren), or other related tickets.		If you need to grab a given tickets parent(s), child(ren), or other related tickets.

	my $ParentTickets = $self->TicketObj->MemberOf;		my $ParentTickets = $self->TicketObj->MemberOf;
	my $~~FirstParentTicket~~ = $ParentTickets->Next;		my $FirstParentTicketLink = $ParentTickets->Next;
	my $~~FirstParentTicketId~~ = $~~FirstParentTicket~~->TargetObj~~->id~~;		my $FirstParentTicket = $FirstParentTicketLink->TargetObj;
	my $~~SecondParentTicket~~ = $ParentTickets->Next;		my $SecondParentTicketLink = $ParentTickets->Next;
	my $~~SecondParentTicketId~~ = $~~SecondParentTicket~~->TargetObj~~->id~~;		my $SecondParentTicket = $SecondParentTicketLink->TargetObj;

	my $DependsOnTickets = $self->TicketObj->DependsOn;		my $DependsOnTickets = $self->TicketObj->DependsOn;
	my $~~FirstDependsOnTicket~~ = $DependsOnTickets->Next;		my $FirstDependsOnTicketLink = $DependsOnTickets->Next;
	my $~~FirstDependsOnTicketId~~ = $~~FirstDependsOnTicket~~->TargetObj~~->id~~;		my $FirstDependsOnTicket = $FirstDependsOnTicketLink->TargetObj;
	my $~~SecondDependsOnTicket~~ = $DependsOnTickets->Next;		my $SecondDependsOnTicketLink = $DependsOnTickets->Next;
	my $~~SecondDependsOnTicketId~~ = $~~SecondDependsOnTicket~~->TargetObj~~->id~~;		my $SecondDependsOnTicket = $SecondDependsOnTicketLink->TargetObj;

	my $RefersToTickets = $self->TicketObj->RefersTo;		my $RefersToTickets = $self->TicketObj->RefersTo;
	my $~~FirstRefersToTicket~~ = $RefersToTickets->Next;		my $FirstRefersToTicketLink = $RefersToTickets->Next;
	my $~~FirstRefersToTicketId~~ = $~~FirstRefersToTicket~~->TargetObj~~->id~~;		my $FirstRefersToTicket = $FirstRefersToTicketLink->TargetObj;
	my $~~SecondRefersToTicket~~ = $RefersToTickets->Next;		my $SecondRefersToTicketLink = $RefersToTickets->Next;
	my $~~SecondRefersToTicketId~~ = $~~SecondRefersToTicket~~->TargetObj~~->id~~;		my $SecondRefersToTicket = $SecondRefersToTicketLink->TargetObj;

	my $ChildTickets = $self->TicketObj->Members;		my $ChildTickets = $self->TicketObj->Members;
	my $~~FirstChildTicket~~ = $ChildTickets->Next;		my $FirstChildTicketLink = $ChildTickets->Next;
	my $~~FirstChildTicketId~~ = $~~FirstChildTicket->BaseObj~~->id;		my $FirstChildTicket = $FirstChildTicketLink->TargetObj;
	my $~~SecondChildTicket~~ = $ChildTickets->Next;		my $SecondChildTicketLink = $ChildTickets->Next;
	my $~~SecondChildTicketId~~ = $~~SecondChildTicket->BaseObj~~->id;		my $SecondChildTicket = $SecondChildTicketLink->TargetObj;

	my $DependedOnByTickets = $self->TicketObj->DependedOnBy;		my $DependedOnByTickets = $self->TicketObj->DependedOnBy;
	my $~~FirstDependedOnByTicket~~ = $DependedOnByTickets->Next;		my $FirstDependedOnByTicketLink = $DependedOnByTickets->Next;
	my $~~FirstDependedOnByTicketId~~ = $~~FirstDependedOnByTicket->BaseObj~~->id;		my $FirstDependedOnByTicket = $FirstDependedOnByTicketLink->TargetObj;
	my $~~SecondDependedOnByTicket~~ = $DependedOnByTickets->Next;		my $SecondDependedOnByTicketLink = $DependedOnByTickets->Next;
	my $~~SecondDependedOnByTicketId~~ = $~~SecondDependedOnByTicket->BaseObj~~->id;		my $SecondDependedOnByTicket = $SecondDependedOnByTicketLink->TargetObj;

	my $ReferredToByTickets = $self->TicketObj->ReferredToBy;		my $ReferredToByTickets = $self->TicketObj->ReferredToBy;
	my $~~FirstReferredToByTicket~~ = $ReferredToByTickets->Next;		my $FirstReferredToByTicketLink = $ReferredToByTickets->Next;
	my $~~FirstReferredToByTicketId~~ = $~~FirstReferredToByTicket->BaseObj~~->id;		my $FirstReferredToByTicket = $FirstReferredToByTicketLink->TargetObj;
	my $~~SecondReferredToByTicket~~ = $ReferredToByTickets->Next;		my $SecondReferredToByTicketLink = $ReferredToByTickets->Next;
	my $~~SecondReferredToByTicketId~~ = $~~SecondReferredToByTicket->BaseObj~~->id;		my $SecondReferredToByTicket = $SecondReferredToByTicketLink->TargetObj;

	== Log custom fields and standard fields to syslog ==		== Log custom fields and standard fields to syslog ==

128.223.31.192: /* Get related tickets */

2013-04-30T21:42:20Z

Get related tickets

← Older revision		Revision as of 17:42, 30 April 2013
Line 36:		Line 36:
	== Get related tickets ==		== Get related tickets ==
	If you need to grab a given tickets parent(s), child(ren), or other related tickets.		If you need to grab a given tickets parent(s), child(ren), or other related tickets.


	my $ParentTickets = $self->TicketObj->MemberOf;		my $ParentTickets = $self->TicketObj->MemberOf;
	my $FirstParentTicket = $ParentTickets->Next;		my $FirstParentTicket = $ParentTickets->Next;

128.223.31.192: Added "get related tickets" section.

2013-04-30T21:42:00Z

Added "get related tickets" section.

@@ Line 34: / Line 34: @@
   return 1;
 == Log custom fields and standard fields to syslog ==
@@ Line 90: / Line 129: @@
+  }
   return 1;
- = More examples =
+= More examples =
 [[CodeSnippets]]

199.19.138.103: Content logging to syslog

2013-02-15T18:11:19Z

Content logging to syslog

@@ Line 70: / Line 70: @@
   $RT::Logger->info( $log_string );
-  return 1;<span style="font-size:13px;"></span>
+  return 1;<span style="font-size:13px;"> </span>
 = More examples =
 [[CodeSnippets]]

199.19.138.103: Add script for logging fields

2013-02-15T18:08:30Z

Add script for logging fields

New page

= Introduction =

This page introduce you with some code that can be used in [[ScripAction]]s and is part of [[CodeSnippets]] series of articles.

= Custom actions specifics =

You better read [[WriteCustomAction]] before to understand basics.

= Code snippets =

== Change ticket's queue ==

my $TargetQueueName = 'MyQueue';
my ($status, $msg) = $TicketObj->SetQueue( $TargetQueueName );
...

== Set current actor as Ticket owner ==

my $Actor = $self->TransactionObj->CreatorObj->Id;
if( $Actor != $self->TicketObj->OwnerObj->Id ) {
$RT::Logger->info("Auto assign ticket #". $self->TicketObj->id ." to user #". $Actor );

my ($status, $msg) = $self->TicketObj->SetOwner( $Actor );
unless( $status ) {
die "Error: $msg";
}
}
return 1;

== Set owner to nobody ==

We want to be able to assign cases to unprivileged customers, once they have replied the case should be released:
$self->TicketObj->SetOwner( $RT::Nobody->id );
return 1;

== Log custom fields and standard fields to syslog ==
= <span style="font-size:13px;">We want to log all custom and standard fields to syslog, so we can generate reports and audit logs, i.e. with Splunk. This would go in transaction batch</span> =
#On ticket creation, log standard and custom fields
my $ticket = $self->TicketObj;

#create a hash with all the standard fields we want
my %tkt_props;
$tkt_props{ticket} = $self->TicketObj->id;
$tkt_props{queue} = $self->TicketObj->QueueObj->Name;
$tkt_props{status} = $self->TicketObj->Status;
$tkt_props{subject} = $self->TicketObj->Subject;
$tkt_props{priority} = $self->TicketObj->Priority;
$tkt_props{owner} = $self->TicketObj->OwnerObj->Name;
$tkt_props{requestor_email} = $ticket->RequestorAddresses;

#add custom fields to the hash as well
my $CustomFields = $ticket->QueueObj->TicketCustomFields();
while (my $CustomField = $CustomFields->Next()) {
my $name = $CustomField->Name;
my $val = $ticket->FirstCustomFieldValue($name);
$tkt_props{$name} = $val;
}

#create the string to log: RT4 transaction detected: field="value" field_2="value with spaces"
my $log_string = "RT4 transaction detected:";
foreach my $k (sort keys %tkt_props) {
my $val = $tkt_props{$k}; #easier than each if you want them sorted
$k =~ s/\s+/_/g; #remove spaces from name field and replace with _
$k =~ tr/"//; #there really shouldn't be any quotes in the name, but strip them anyway
$val =~ s/\s+/ /; #replace all whitespace with a single space char for Splunk
$val =~ tr/"/'/; #replace double quotes with single for Splunk
$log_string .= qq| $k="$val"|; #wrap values in quotes
}

$RT::Logger->info( $log_string );
return 1;<span style="font-size:13px;"></span>
= More examples =

[[CodeSnippets]]

= See also =

[[WriteCustomAction]], [[CodeSnippets]], [[Scrip]]s

← Older revision		Revision as of 18:20, 30 April 2013
Line 57:		Line 57:
	my $ChildTickets = $self->TicketObj->Members;		my $ChildTickets = $self->TicketObj->Members;
	my $FirstChildTicketLink = $ChildTickets->Next;		my $FirstChildTicketLink = $ChildTickets->Next;
	my $FirstChildTicket = $FirstChildTicketLink->~~TargetObj~~;		my $FirstChildTicket = $FirstChildTicketLink->BaseObj;
	my $SecondChildTicketLink = $ChildTickets->Next;		my $SecondChildTicketLink = $ChildTickets->Next;
	my $SecondChildTicket = $SecondChildTicketLink->~~TargetObj~~;		my $SecondChildTicket = $SecondChildTicketLink->BaseObj;

	my $DependedOnByTickets = $self->TicketObj->DependedOnBy;		my $DependedOnByTickets = $self->TicketObj->DependedOnBy;
	my $FirstDependedOnByTicketLink = $DependedOnByTickets->Next;		my $FirstDependedOnByTicketLink = $DependedOnByTickets->Next;
	my $FirstDependedOnByTicket = $FirstDependedOnByTicketLink->~~TargetObj~~;		my $FirstDependedOnByTicket = $FirstDependedOnByTicketLink->BaseObj;
	my $SecondDependedOnByTicketLink = $DependedOnByTickets->Next;		my $SecondDependedOnByTicketLink = $DependedOnByTickets->Next;
	my $SecondDependedOnByTicket = $SecondDependedOnByTicketLink->~~TargetObj~~;		my $SecondDependedOnByTicket = $SecondDependedOnByTicketLink->BaseObj;

	my $ReferredToByTickets = $self->TicketObj->ReferredToBy;		my $ReferredToByTickets = $self->TicketObj->ReferredToBy;
	my $FirstReferredToByTicketLink = $ReferredToByTickets->Next;		my $FirstReferredToByTicketLink = $ReferredToByTickets->Next;
	my $FirstReferredToByTicket = $FirstReferredToByTicketLink->~~TargetObj~~;		my $FirstReferredToByTicket = $FirstReferredToByTicketLink->BaseObj;
	my $SecondReferredToByTicketLink = $ReferredToByTickets->Next;		my $SecondReferredToByTicketLink = $ReferredToByTickets->Next;
	my $SecondReferredToByTicket = $SecondReferredToByTicketLink->~~TargetObj~~;		my $SecondReferredToByTicket = $SecondReferredToByTicketLink->BaseObj;

	== Log custom fields and standard fields to syslog ==		== Log custom fields and standard fields to syslog ==