Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Allows a user to send feedback to the site administrator.

Note that for this action to work the action must be added to the client configuration but also a feedback and mail server configurations must also be configured.

ID

weave.emailFeedback

Namespace

com.cohga.server.feedback

Tags

config

NameTypeCardinalityDescription
classificationtype1..1A list of different types of feedback the user can provide
tostring1..1The email address the feedback should be sent to
emailDomainstring0..1

Set a default From address email domain. If this value is set the From email address will be made based on the user id and this domain (unless the user is anonymous).

If this value is not set, or the user is anonymous, the user will have to enter a From address when submitting feedback.

Setting this value only makes sense if users must log in to access the system.

subjectPrestring0..1A prefix to include in the email subject. This value, followed by ": ", will be prepended to the Subject value the user enters, allowing the submitted emails to be filtered more easily.
includeMapboolean0..1Set the default state of the "Include Map" input field, default it true.

type

NameTypeCardinalityDescription
typestring1..nThe type of feedback the user is providing, e.g. Bug Report, Data Issue, etc.
Example feedback and email configuration
<?xml version="1.0" encoding="UTF-8"?>

<config xmlns="urn:com.cohga.server.config#1.0" xmlns:feedback="urn:com.cohga.server.feedback#1.0" xmlns:mail="urn:com.cohga.server.mail#1.0">

	<feedback:config>
		<to>feedback@cohga.com</to>
		<emailDomain>cohga.com</emailDomain>
		<subjectPre>WEAVE</subjectPre>
		<classification>
			<type>Bug Report</type>
			<type>Data Issue</type>
			<type>Feedback</type>
			<type>Help</type>
			<type>Map Request</type>
			<type>Other</type>
		</classification>
	</feedback:config>

	<mail:smtp>
		<host>mail.cohga.com</host>
		<username>sforbes</username>
		<password>ENCEAUFJCUABCFXEMFQEBFJEBZJAKFCXGME</password>
	</mail:smtp>

</config>
Example client configuration
<?xml version="1.0" encoding="UTF-8"?>

<config xmlns="urn:com.cohga.server.config#1.0" xmlns:client="urn:com.cohga.html.client#1.0">

	<client:config id="feedback_example">
		<!-- other configuration items -->

		<toolbar>
			<item action="weave.emailFeedback"/> <!-- note there are nothing to configure here, it's done in the feedback config -->

			<!-- other configuration items -->
		</toolbar>

		<!-- other configuration items -->
	</client:config>

</config>

  • No labels