WritingPortlets - Revision history

Phanousk at 14:58, 27 August 2018

2018-08-27T14:58:22Z

← Older revision		Revision as of 10:58, 27 August 2018
Line 4:		Line 4:

	They can also appear on the Self-Service interface, but have to be hard-coded, because Self-Service users don't get the same preferences available to them. You need to manually edit <rt-base-dir>/local/html/SelfService/index.html. You just have to create your element in <rt-base-dir>/local/html/SelfService/Elements and call it from within the index.html file with something like:		They can also appear on the Self-Service interface, but have to be hard-coded, because Self-Service users don't get the same preferences available to them. You need to manually edit <rt-base-dir>/local/html/SelfService/index.html. You just have to create your element in <rt-base-dir>/local/html/SelfService/Elements and call it from within the index.html file with something like:
			<pre>
	&~~lt;&~~ /SelfService/Elements/[[MyPortlet]] &~~amp;>~~		<& /SelfService/Elements/[[MyPortlet]] &>
			</pre>

	This example works with RT 3.8.8 and may work with older versions too - your mileage may vary.		This example works with RT 3.8.8 and may work with older versions too - your mileage may vary.

	There are at least two things you have to do to create a portlet:		There are at least two things you have to do to create a portlet:
			* Create a MASON template file in <tt><nowiki><rt-base-dir>/local/html/Elements</nowiki></tt> that defines your portlet's behaviour.
	# Create a MASON template file in ~~<~~rt-base-dir~~>~~/local/html/Elements that defines your portlet's behaviour.		* Install your portlet by adding it's name to the HomepageComponents configuration variable in RT_SiteConfig.pm.
	# Install your portlet by adding it's name to the HomepageComponents configuration variable in RT_SiteConfig.pm.

	Once you have created and installed your portlet, you of course, have to restart Apache.		Once you have created and installed your portlet, you of course, have to restart Apache.

Phanousk: /* Installing a portlet into RT-at-a-glance */

2018-08-27T14:50:16Z

Installing a portlet into RT-at-a-glance

← Older revision		Revision as of 10:50, 27 August 2018
Line 35:		Line 35:

	Edit your RT_SiteConfig.pm file, and edit the $HomepageComponents variable (if it hasn't got one, copy it from the RT_Config.pm file). Add the name of your MASON template file, in this example, "ExternalPage":		Edit your RT_SiteConfig.pm file, and edit the $HomepageComponents variable (if it hasn't got one, copy it from the RT_Config.pm file). Add the name of your MASON template file, in this example, "ExternalPage":
			Set($HomepageComponents, [qw(QuickCreate Quicksearch MyCalendar
	Set($HomepageComponents, [qw(QuickCreate Quicksearch MyCalendar		MyAdminQueues MySupportQueues MyReminders RefreshHomepage
	MyAdminQueues MySupportQueues MyReminders RefreshHomepage		ExternalPage
	ExternalPage		)]);
	)]);

	Go to the "RT at a glance" page, click on the "Edit" link in the top right corner.		Go to the "RT at a glance" page, click on the "Edit" link in the top right corner.

	In the "Customize RT at a glance" page, add the ExternalPage portlet to the section you prefer, by choosing it in one of the left-hand columns and then clicking on the button that resembles a right arrow.		In the "Customize RT at a glance" page, add the ExternalPage portlet to the section you prefer, by choosing it in one of the left-hand columns and then clicking on the button that resembles a right arrow.

Phanousk: /* Create a MASON template file */

2018-08-27T14:49:33Z

Create a MASON template file

← Older revision		Revision as of 10:49, 27 August 2018
Line 19:		Line 19:

	Here's an example MASON template which creates an inline frame containing a web-page from another site:		Here's an example MASON template which creates an inline frame containing a web-page from another site:
			<pre>
	&~~lt;&~~\|/Widgets/TitleBox, title =~~>~~ loc('External Page')&~~amp;>~~		<&\|/Widgets/TitleBox, title => loc('External Page')&>
	~~<~~table~~>~~		<table>
	~~<~~tr~~>~~		<tr>
	~~<~~td~~> <~~iframe name="external page" src="http://wiki.bestpractical.com/" height="480" width="640" frameborder="0" ~~>~~		<td> <iframe name="external page" src="http://wiki.bestpractical.com/" height="480" width="640" frameborder="0" >
	~~<~~/iframe~~>~~		</iframe>
	~~<~~/td~~>~~		</td>
	~~<~~/tr~~>~~		</tr>
	~~<~~/table~~>~~		</table>
	~~<~~/&~~amp;>~~		</&>
			</pre>
	For this example, the file is saved as "ExternalPage" in the ~~<~~rt-base-dir~~>~~/local/html/Elements directory.		For this example, the file is saved as "ExternalPage" in the <tt><nowiki><rt-base-dir>/local/html/Elements</nowiki></tt> directory.

	== Installing a portlet into RT-at-a-glance ==		== Installing a portlet into RT-at-a-glance ==

Barton: /* Installing a portlet into RT-at-a-glance */

2017-01-08T23:20:59Z

Installing a portlet into RT-at-a-glance

← Older revision		Revision as of 19:20, 8 January 2017
Line 36:		Line 36:
	Edit your RT_SiteConfig.pm file, and edit the $HomepageComponents variable (if it hasn't got one, copy it from the RT_Config.pm file). Add the name of your MASON template file, in this example, "ExternalPage":		Edit your RT_SiteConfig.pm file, and edit the $HomepageComponents variable (if it hasn't got one, copy it from the RT_Config.pm file). Add the name of your MASON template file, in this example, "ExternalPage":

	Set($HomepageComponents, [qw(QuickCreate Quicksearch MyCalendar		Set($HomepageComponents, [qw(QuickCreate Quicksearch MyCalendar
	MyAdminQueues MySupportQueues MyReminders RefreshHomepage		MyAdminQueues MySupportQueues MyReminders RefreshHomepage
	ExternalPage		ExternalPage
	)]);		)]);

	Go to the "RT at a glance" page, click on the "Edit" link in the top right corner.		Go to the "RT at a glance" page, click on the "Edit" link in the top right corner.

	In the "Customize RT at a glance" page, add the ExternalPage portlet to the section you prefer, by choosing it in one of the left-hand columns and then clicking on the button that resembles a right arrow.		In the "Customize RT at a glance" page, add the ExternalPage portlet to the section you prefer, by choosing it in one of the left-hand columns and then clicking on the button that resembles a right arrow.

Admin: 5 revisions imported

2016-04-06T20:39:47Z

5 revisions imported

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

14.201.100.176: remove paragraph not contributing to the subject matter

2014-07-29T07:36:31Z

remove paragraph not contributing to the subject matter

New page

= How to write a Homepage Component (Portlet) =

Portlets are the panels that appear in your "RT-at-a-glance" home page, such as "n Highest Priority Tickets I own", "Quick Ticket Creation" and "Quick Search". When you click on the "Edit" link on your home page (or go there via your preferences), you can select which of the available portlets are displayed in the "body" (left) or "summary" (right) columns of the home page.

They can also appear on the Self-Service interface, but have to be hard-coded, because Self-Service users don't get the same preferences available to them. You need to manually edit <rt-base-dir>/local/html/SelfService/index.html. You just have to create your element in <rt-base-dir>/local/html/SelfService/Elements and call it from within the index.html file with something like:

<& /SelfService/Elements/[[MyPortlet]] &>

This example works with RT 3.8.8 and may work with older versions too - your mileage may vary.

There are at least two things you have to do to create a portlet:

# Create a MASON template file in <rt-base-dir>/local/html/Elements that defines your portlet's behaviour.
# Install your portlet by adding it's name to the HomepageComponents configuration variable in RT_SiteConfig.pm.

Once you have created and installed your portlet, you of course, have to restart Apache.

== Create a MASON template file ==

Here's an example MASON template which creates an inline frame containing a web-page from another site:

<&|/Widgets/TitleBox, title => loc('External Page')&>
<table>
<tr>
<td> <iframe name="external page" src="http://wiki.bestpractical.com/" height="480" width="640" frameborder="0" >
</iframe>
</td>
</tr>
</table>
</&>

For this example, the file is saved as "ExternalPage" in the <rt-base-dir>/local/html/Elements directory.

== Installing a portlet into RT-at-a-glance ==

Edit your RT_SiteConfig.pm file, and edit the $HomepageComponents variable (if it hasn't got one, copy it from the RT_Config.pm file). Add the name of your MASON template file, in this example, "ExternalPage":

Set($HomepageComponents, [qw(QuickCreate Quicksearch MyCalendar
MyAdminQueues MySupportQueues MyReminders RefreshHomepage
ExternalPage
)]);

Go to the "RT at a glance" page, click on the "Edit" link in the top right corner.

In the "Customize RT at a glance" page, add the ExternalPage portlet to the section you prefer, by choosing it in one of the left-hand columns and then clicking on the button that resembles a right arrow.