CustomField - Revision history

Phanousk: /* External Custom Fields */

2023-07-24T13:23:44Z

External Custom Fields

← Older revision		Revision as of 09:23, 24 July 2023
Line 62:		Line 62:

	== External Custom Fields ==		== External Custom Fields ==
	In addition to manually specifying the Custom Field values you can have an external data source for them. For this you need to write a perl module, put it in the proper directory and set the [[SiteConfig\|RT_SiteConfig]]. For details see the [https://docs.bestpractical.com/rt/4.4.6/extending/external_custom_fields.html\|manual].		In addition to manually specifying the Custom Field values you can have an external data source for them. For this you need to write a perl module, put it in the proper directory and set the [[SiteConfig\|RT_SiteConfig]]. For details see the [https://docs.bestpractical.com/rt/4.4.6/extending/external_custom_fields.html manual].

	[[Category:RT44]]		[[Category:RT44]]

Phanousk: add info about external data sources

2023-07-24T13:23:15Z

add info about external data sources

← Older revision		Revision as of 09:23, 24 July 2023
Line 61:		Line 61:
	:* Click on the desired user from Admin -> Users -> Select, this will bring you to the Modify User page where you can update the custom field accordingly		:* Click on the desired user from Admin -> Users -> Select, this will bring you to the Modify User page where you can update the custom field accordingly

			== External Custom Fields ==
			In addition to manually specifying the Custom Field values you can have an external data source for them. For this you need to write a perl module, put it in the proper directory and set the [[SiteConfig\|RT_SiteConfig]]. For details see the [https://docs.bestpractical.com/rt/4.4.6/extending/external_custom_fields.html\|manual].

	[[Category:RT44]]		[[Category:RT44]]

Maureen at 18:38, 29 March 2019

2019-03-29T18:38:21Z

← Older revision		Revision as of 14:38, 29 March 2019
Line 61:		Line 61:
	:* Click on the desired user from Admin -> Users -> Select, this will bring you to the Modify User page where you can update the custom field accordingly		:* Click on the desired user from Admin -> Users -> Select, this will bring you to the Modify User page where you can update the custom field accordingly

	~~== Simple Search Custom Field Values ==~~

	~~[[SearchCustomField]]~~

	~~== Custom Fields in Email Ticket Creation ==~~		[[Category:RT44]]

	[[~~OnCreateCheckCF~~]]

Maureen at 18:33, 29 March 2019

2019-03-29T18:33:41Z

← Older revision		Revision as of 14:33, 29 March 2019
Line 38:		Line 38:
	== Modify CustomField Value ==		== Modify CustomField Value ==

	~~=== RT 3.6 ===~~

	~~Use the bulk update option~~		[[File:Update-CF-Values.png\|Updating custom field values on Tickets\|thumb\|500px]]

	~~=== RT 3~~.~~4 ===~~		There are a number of ways to update a custom field's value depending on the custom field type.

	~~Try~~ the ~~script below based~~ on ~~[http~~:~~//use.perl.org/~Robrt/journal/25746 this journal entry]. This example renames '[[TaskType]]' values that were 'Sales Call' to 'Prospect'~~ in the ~~'Sales' queue.~~		;Tickets
			:* Click on the desired ticket, then click on Basics from the submenu or click directly on the Custom Field portlet tab, to bring you to the Modify Ticket page (see screenshot)
			:* From the ticket, you can click on Jumbo in the submenu
			:* You can also update the custom fields of multiple tickets at once, by running a search, then click on Bulk Update from the submenu

	~~<pre>~~		; Assets
	~~<nowiki>#!/home/perl/bin/perl~~		:* Click on the desired asset, then click on Basics from the submenu or click directly on the Custom Field portlet tab, to bring you to the Modify Asset page
	~~use strict~~;		:* You can also update the custom fields of multiple assets at once, by running a search from within Assets, then click on Bulk Update from the submenu
	~~use warnings;~~
	~~use lib qw(../lib);~~		; Articles
	~~use RT;~~		:* Click on the desired article, then click on Modify from the submenu to bring you to the Modify Article page
	~~use RT~~:~~:Queues;~~
	~~use RT~~:~~:Tickets;~~		; Group
	~~use Data::Dumper;~~		:* Click on the desired group from Admin -> Groups -> Select, this will bring you to the Basics page where you can update the custom field accordingly

	~~# CONFIGURATION~~		; User
	~~my $queue = 'Sales';~~		:* Click on the desired user from Admin -> Users -> Select, this will bring you to the Modify User page where you can update the custom field accordingly
	~~my $cf_name = 'TaskType';~~
	~~my $old_value = 'Sales Call'; # NB: This must be~~ a ~~valid value for~~ the CF
	~~my $new_value = 'Prospect';~~
	~~# END CONFIGURATION~~

	~~RT::LoadConfig()~~;
	RT:~~:Init();~~
	~~my $tx = RT::Tickets->new($RT::SystemUser);~~
	~~my $cf = RT::CustomField->new($RT::SystemUser)~~;
	~~my $q = RT~~:~~:Queue~~-~~>new($RT::SystemUser);~~
	~~$tx~~-~~>FromSQL(qq[queue="$queue" and "cf.$queue.{$cf_name}" = '$old_value']);~~
	~~$q->Load($queue);~~
	~~$cf->LoadByNameAndQueue(Queue => $q->Id~~, ~~Name => $cf_name);~~
	~~unless( $cf->id ) {~~
	~~# queue 0 is special case and is a synonym for global queue~~
	~~$cf->LoadByNameAndQueue( Name => $cf_name, Queue => '0' );~~
	}
	~~unless( $cf->id ) {~~
	~~print "No field $cf_name in queue ". $q->Name;~~
	~~die "Could not load~~ custom field";
	}

	~~my $i=0;~~
	~~while (my $t = $tx->Next) {~~
	~~print "Processing record #" . ++$i . "\n";~~
	~~my $type = $t->FirstCustomFieldValue($cf_name);~~
	~~print "Old Type = $type\n";~~
	~~my ($ret, $msg) = $t->DeleteCustomFieldValue(~~
	~~Field =&gt~~; ~~$cf->Id,~~
	~~Value => $type~~
	);
	~~die "Error deleting old value~~: ~~$msg" unless $ret;~~
	$t-~~>AddCustomFieldValue(~~
	~~Field => $cf~~-~~>Id~~,
	~~Value => 'Prospect'~~
	);
	~~$type = $t->FirstCustomFieldValue($cf_name);~~
	~~print "New Type = $type\n";~~
	}
	~~</nowiki>~~
	~~</pre>~~

	== Simple Search Custom Field Values ==		== Simple Search Custom Field Values ==

Maureen at 18:27, 29 March 2019

2019-03-29T18:27:01Z

← Older revision		Revision as of 14:27, 29 March 2019
Line 1:		Line 1:
	A '''Custom Field''' (CF) is a user defined property that can be applied to various parts of RT.		A '''Custom Field''' (CF) is a user defined property that can be applied to various parts of RT. Each custom field has a Name, Description and Type.

	~~Each custom field has a Name, Description and Type.~~		== Custom Field Types ==

	RT supports the following CF types:		RT supports the following CF types:
Line 31:		Line 31:
	==== First, create the Custom Field ====		==== First, create the Custom Field ====

	* Login as one with admin/superuser rights		:# Login as one with admin/superuser rights
	* Go to Admin -> CustomField -> Create		:# Go to Admin -> CustomField -> Create
	* Fill out the form appropriately and click Create		:# Fill out the form appropriately and click Create
			:# From the submenu, click on "Applies to" and check and save the desired options. '''Note:''' This step is not applicable with the Custom Field types, "Groups" or "Users".

	== Modify CustomField Value ==		== Modify CustomField Value ==

Maureen at 16:09, 29 March 2019

2019-03-29T16:09:56Z

← Older revision		Revision as of 12:09, 29 March 2019
Line 32:		Line 32:

	* Login as one with admin/superuser rights		* Login as one with admin/superuser rights
	* Go to Admin -> [[CustomField~~\|CustomFields]]~~ -> Create		* Go to Admin -> CustomField -> Create
	* Fill out the form appropriately and click Create		* Fill out the form appropriately and click Create

Maureen at 16:05, 29 March 2019

2019-03-29T16:05:32Z

← Older revision		Revision as of 12:05, 29 March 2019
Line 32:		Line 32:

	* Login as one with admin/superuser rights		* Login as one with admin/superuser rights
	* Go to Admin -> [[CustomFields]] -> Create		* Go to Admin -> [[CustomField\|CustomFields]] -> Create
	* Fill out the form appropriately and click Create		* Fill out the form appropriately and click Create

Maureen at 16:04, 29 March 2019

2019-03-29T16:04:38Z

← Older revision		Revision as of 12:04, 29 March 2019
Line 32:		Line 32:

	* Login as one with admin/superuser rights		* Login as one with admin/superuser rights
	* Go to ~~Configuration >~~ [[CustomFields]]		* Go to Admin -> [[CustomFields]] -> Create
	* Click on Create		* Fill out the form appropriately and click Create
	* Fill out the form appropriately ~~and save changes~~

	~~==== Next, place the Custom Field where you want it ====~~

	* Go to Configuration > Global > [[CustomFields]]
	* Choose where you want your [[CustomField]] to appear
	* Select the [[CustomField]] you wish to apply and click ~~'Submit'~~

	~~If you have installed RTFM you can also define CustomFields for [[RTFM]] Articles 848555157547~~

	== Modify CustomField Value ==		== Modify CustomField Value ==

Maureen at 15:11, 29 March 2019

2019-03-29T15:11:05Z

← Older revision		Revision as of 11:11, 29 March 2019
Line 1:		Line 1:
	A '''Custom~~''''''~~Field''' (CF) is a user defined property~~, usually~~ of ~~a [[Ticket]]~~.		A '''Custom Field''' (CF) is a user defined property that can be applied to various parts of RT.

	Each custom field has a Name, Description and Type.		Each custom field has a Name, Description and Type.
Line 11:		Line 11:
	* Fill in one text area (of which you can edit the size: [[ChangeCustomFieldTextAreaSize]])		* Fill in one text area (of which you can edit the size: [[ChangeCustomFieldTextAreaSize]])
	* Fill in one wikitext area		* Fill in one wikitext area
	* Fill in multiple wikitext areas
	* Upload one image		* Upload one image
	* Upload multiple images		* Upload multiple images
	* Upload one file		* Upload one file
	* Upload multiple files		* Upload multiple files
			* Combobox: Select or enter one value
			* Enter one value with autocompletion
			* Enter multiple values with autocompletion
			* Select date
			* Select datetime
			* Enter one IP address
			* Enter multiple IP addresses
			* Enter one IP address range
			* Enter multiple IP address ranges

	You can define global CustomFields or specific to a [[Queue]] (see "CUSTOM FIELDS IN QUEUES~~" at [[ManualAdministration~~]]). They can apply to [[Ticket]], [[Group]], User or Ticket [[Transaction]]s.		You can define global CustomFields or specific to a [[Queue]] (see [[ManualAdministration#CUSTOM_FIELDS_IN_QUEUES\|CUSTOM FIELDS IN QUEUES]]). They can apply to a [[Ticket]], [[Articles\|Article]], Asset, [[Group]], [[User]] or Ticket [[Transaction]]s.

	== How to set up a custom field in a nutshell ==		== How to set up a custom field in a nutshell ==

Bduye:

2016-07-21T11:05:38Z

← Older revision		Revision as of 07:05, 21 July 2016
Line 46:		Line 46:
	Try the script below based on [http://use.perl.org/~Robrt/journal/25746 this journal entry]. This example renames '[[TaskType]]' values that were 'Sales Call' to 'Prospect' in the 'Sales' queue.		Try the script below based on [http://use.perl.org/~Robrt/journal/25746 this journal entry]. This example renames '[[TaskType]]' values that were 'Sales Call' to 'Prospect' in the 'Sales' queue.

			<pre>
	<nowiki>#!/home/perl/bin/perl		<nowiki>#!/home/perl/bin/perl
	use strict;		use strict;
Line 97:		Line 98:
	}		}
	</nowiki>		</nowiki>
			</pre>

	== Simple Search Custom Field Values ==		== Simple Search Custom Field Values ==