Custom fields

Introduction Create new fields on the AcyMailing User profile Create a phone number field Create a gender field Create an information field Order my fields Display these fields on the Back-end User profile Display these fields on the Front-end User profile Display these fields on the Back-end User listing Display these fields on the AcyMailing Module Display these fields on your registration page Get some statistics about the custom fields Examples Country field US States field Canada provinces field Brazilian States field Australian States Frequently Asked Questions How many custom fields can I add? How can I translate the inserted fields? How can I display the user custom fields on the notification message?

Introduction

Using AcyMailing Enterprise (this feature has been added to AcyMailing 1.2.0), you can add extra fields to your subscription form, to the user profile on the front-end and on the back-end.

You will then be able to filter your users based on these fields or include these fields in a Newsletter.

You will also be able to import users with those fields and export the extra fields as well.

This system should meet most of your needs and enable you to create personal subscription form.

If you want to personalize more your subscription form, you can still integrate AcyMailing with a Form component using the subscription via URL.

Create new fields on the AcyMailing User profile

• Log in on the back-end and access the AcyMailing Component
• Click on the menu Configuration -> Custom Fields to manage your fields
  

  

• You will be redirected to the custom fields area where you should see three fields by default : name, email and html (which are the fields used to display the name, email and receive html/text option)



• Click on the button "New" to add a new field

Create a phone number field

• We will create a phone number field so that users may enter their phone number to be contacted
  

  

• This field is a simple "Text" input so we selected the Field type "Text".
• We don't want this field to be required, users may subscribe without entering their phone number
• We want to publish this field and display it on the front-end profile and on the back-end profile
• Click on the button "Apply", the field will be saved and you will now see how the field will be displayed on the preview area.
• Once saved, you won't be able to change the column name of your field. You can still change its Label or any other information.



 

Create a Gender field

• We will now add a Gender field as our goal is to include in our Newsletter "Hello Mr John..."



• The Gender field is a single Drop-down.
• We will make it a require field so if the user didn't select any value, an error message will be displayed
• We add a series of values (the first option has a title but no value so that if this option is selected, which is the case by default, the form won't be submitted as it's a required field)
• We click on the "Apply" button to check how the field looks like.



 

Create an information field

• We will now create an information field. We will nevertheless make sure this field is published but only displayed on the back-end as our goal is simply to add information about the user if we contact him.



 

Order my fields

• You should now see your three new fields on the Fields interface and you can change the ordering of your fields to meet your needs.



• We didn't want to display the default field receive Text/HTML on our front-end interface so we unpublished it as you can not delete a core field.

Display these fields on the Back-end User profile

• Our fields are now added and the published fields will be displayed on the User back-end profile if you selected so.
• The Core fields will be always displayed on the back-end profile even if they are unpublished.
• There is no check on the fields on the back-end so you can really add any value you want and even leave the required fields empty.

Display these fields on the Front-end User profile

• Based on the options you selected, the fields will be added or not to the user profile on the front-end.
• This profile can be accessible when the user clicks on the link "Modify your subscription" in the Newsletter or if you display this page to subscribe your users.
• If you only use this page to modify the subscription of the user, you can even remove the e-mail field to not give the possibility to your users to modify their e-mail address.

Display these fields on the Back-end User Listing

• The same way, you can also modify your Back-end User listing to display the information you want.
• The published fields with the option "Back-end Listing" enabled will be displayed on the AcyMailing User listing.
• You will be able to search in the fields and order them the way you want.

Display these fields on the AcyMailing Module

• You probably realized that there is no option on the field interface to add the field on the AcyMailing module.
  We didn't add it to our interface as you can duplicate the AcyMailing module and each module will be independent so we took the decision to add the field selection on the module parameters themselves.
• Log in on the back-end and access the Joomla Module manager



• Edit your AcyMailing module



• You will find a parameter "Displayed fields".



• Click on the button "Select" to display all your of available fields and select the ones you want to include in your module



• Select the fields you want to add to your module and then click on the "Apply" button.
• Save your module to see the new fields on your module.



• You can off course add any other field and display them the way you want (text outside the field, inside the field...)

Display these fields on your registration page

You can display the extra fields you created on your Joomla registration page but also on the Virtuemart, Hikashop, CCUsers, AlphaRegistration, Tienda, redShop, ExtendedReg...

Access the AcyMailing configuration page, tab plugins and edit the AcyMailing : (auto)Subscribe during Joomla registration pugin.

On the Basic options, you can see an option to select fields displayed on the registration page.

Select your fields using the selection button, select after what existing field you want the AcyMailing fields to be added and then save the plugin.

Go back on your registration form to see the fields.

You can add some CSS on the Custom CSS area in the plugin if needed.

Get some statistics about the custom fields

If you create a custom field using the type Radio, CheckBoxes or Dropdown, you can see some statistics about it if access your custom field.

Examples

Country field

To create a country field, first create a new field in AcyMailing.

Then access your database (using phpMyAdmin for example), select the table "#__acymailing_fields" and edit the field you just created.

In the textarea "value", copy paste the following code:

Show / hide php code

AFG::Afghanistan
ALB::Albania
DZA::Algeria
ASM::American Samoa
AND::Andorra
AGO::Angola
AIA::Anguilla
ATA::Antarctica
ATG::Antigua and Barbuda
ARG::Argentina
ARM::Armenia
ABW::Aruba
AUS::Australia
AUT::Austria
AZE::Azerbaijan
BHS::Bahamas
BHR::Bahrain
BGD::Bangladesh
BRB::Barbados
BLR::Belarus
BEL::Belgium
BLZ::Belize
BEN::Benin
BMU::Bermuda
BTN::Bhutan
BOL::Bolivia
BIH::Bosnia and Herzegowina
BWA::Botswana
BVT::Bouvet Island
BRA::Brazil
IOT::British Indian Ocean Territory
BRN::Brunei Darussalam
BGR::Bulgaria
BFA::Burkina Faso
BDI::Burundi
KHM::Cambodia
CMR::Cameroon
CAN::Canada
CPV::Cape Verde
CYM::Cayman Islands
CAF::Central African Republic
TCD::Chad
CHL::Chile
CHN::China
CXR::Christmas Island
CCK::Cocos (Keeling) Islands
COL::Colombia
COM::Comoros
COG::Congo
COK::Cook Islands
CRI::Costa Rica
CIV::Cote D'Ivoire
HRV::Croatia
CUB::Cuba
CYP::Cyprus
CZE::Czech Republic
DNK::Denmark
DJI::Djibouti
DMA::Dominica
DOM::Dominican Republic
TMP::East Timor
ECU::Ecuador
EGY::Egypt
SLV::El Salvador
GNQ::Equatorial Guinea
ERI::Eritrea
EST::Estonia
ETH::Ethiopia
FLK::Falkland Islands (Malvinas)
FRO::Faroe Islands
FJI::Fiji
FIN::Finland
FRA::France
FXX::France, Metropolitan
GUF::French Guiana
PYF::French Polynesia
ATF::French Southern Territories
GAB::Gabon
GMB::Gambia
GEO::Georgia
DEU::Germany
GHA::Ghana
GIB::Gibraltar
GRC::Greece
GRL::Greenland
GRD::Grenada
GUM::Guam
GTM::Guatemala
GIN::Guinea
GNB::Guinea-Bissau
GUY::Guyana
HTI::Haiti
HMD::Heard and McDonald Islands
HND::Honduras
HKG::Hong Kong
HUN::Hungary
ISL::Iceland
IND::India
IDN::Indonesia
IRN::Iran
IRQ::Iraq
IRL::Ireland
ISR::Israel
ITA::Italy
JAM::Jamaica
JPN::Japan
JOR::Jordan
KAZ::Kazakhstan
KEN::Kenya
KIR::Kiribati
PRK::Korea, North
KOR::Korea, South
KWT::Kuwait
KGZ::Kyrgyzstan
LAO::Laos
LVA::Latvia
LBN::Lebanon
LSO::Lesotho
LBR::Liberia
LBY::Libyan Arab Jamahiriya
LIE::Liechtenstein
LTU::Lithuania
LUX::Luxembourg
MAC::Macau
MKD::Macedonia
MDG::Madagascar
MWI::Malawi
MYS::Malaysia
MDV::Maldives
MLI::Mali
MLT::Malta
MHL::Marshall Islands
MRT::Mauritania
MUS::Mauritius
MYT::Mayotte
MEX::Mexico
FSM::Micronesia
MDA::Moldova
MCO::Monaco
MNG::Mongolia
MNE::Montenegro
MSR::Montserrat
MAR::Morocco
MOZ::Mozambique
MMR::Myanmar
NAM::Namibia
NRU::Nauru
NPL::Nepal
NLD::Netherlands
ANT::Netherlands Antilles
NCL::New Caledonia
NZL::New Zealand
NIC::Nicaragua
NER::Niger
NGA::Nigeria
NIU::Niue
NFK::Norfolk Island
MNP::Northern Mariana Islands
NOR::Norway
OMN::Oman
PAK::Pakistan
PLW::Palau
PAN::Panama
PNG::Papua New Guinea
PRY::Paraguay
PER::Peru
PHL::Philippines
PCN::Pitcairn
POL::Poland
PRT::Portugal
PRI::Puerto Rico
QAT::Qatar
ROM::Romania
RUS::Russia
RWA::Rwanda
KNA::Saint Kitts and Nevis
LCA::Saint Lucia
VCT::Saint Vincent and the Grenadines
WSM::Samoa
SMR::San Marino
STP::Sao Tome and Principe
SAU::Saudi Arabia
SEN::Senegal
SRB::Serbia
SYC::Seychelles
SLE::Sierra Leone
SGP::Singapore
SVK::Slovakia
SVN::Slovenia
SLB::Solomon Islands
SOM::Somalia
ZAF::South Africa
SGS::South Georgia and the South Sandwich Islands
ESP::Spain
LKA::Sri Lanka
SHN::St. Helena
SPM::St. Pierre and Miquelon
SDN::Sudan
SUR::Suriname
SJM::Svalbard and Jan Mayen Islands
SWZ::Swaziland
SWE::Sweden
CHE::Switzerland
SYR::Syrian Arab Republic
TWN::Taiwan
TJK::Tajikistan
TZA::Tanzania
THA::Thailand
TGO::Togo
TKL::Tokelau
TON::Tonga
TTO::Trinidad and Tobago
TUN::Tunisia
TUR::Turkey
TKM::Turkmenistan
TCA::Turks and Caicos Islands
TUV::Tuvalu
UGA::Uganda
UKR::Ukraine
ARE::United Arab Emirates
GBR::United Kingdom
UMI::United States Minor Outlying Islands
USA::United States of America
URY::Uruguay
UZB::Uzbekistan
VUT::Vanuatu
VAT::Vatican City State
VEN::Venezuela
VNM::Vietnam
VGB::Virgin Islands (British)
VIR::Virgin Islands (U.S.)
WLF::Wallis and Futuna Islands
ESH::Western Sahara
YEM::Yemen
YUG::Yugoslavia
ZAR::Zaire
ZMB::Zambia
ZWE::Zimbabwe

US States field

To create a US States field, first create a new field in AcyMailing.

Then access your database (using phpMyAdmin for example), select the table "#__acymailing_fields" and edit the field you just created.

In the textarea "value", copy paste the following code:

Show / hide php code

AL::Alabama
AK::Alaska
AZ::Arizona
AR::Arkansas
CA::California
CO::Colorado
CT::Connecticut
DE::Delaware
DC::District of Columbia
FL::Florida
GA::Georgia
HI::Hawaii
ID::Idaho
IL::Illinois
IN::Indiana
IA::Iowa
KS::Kansas
KY::Kentucky
LA::Louisiana
ME::Maine
MT::Montana
NE::Nebraska
NV::Nevada
NH::New Hampshire
NJ::New Jersey
NM::New Mexico
NY::New York
NC::North Carolina
ND::North Dakota
OH::Ohio
OK::Oklahoma
OR::Oregon
MD::Maryland
MA::Massachusetts
MI::Michigan
MN::Minnesota
MS::Mississippi
MO::Missouri
PA::Pennsylvania
RI::Rhode Island
SC::South Carolina
SD::South Dakota
TN::Tennessee
TX::Texas
UT::Utah
VT::Vermont
VA::Virginia
WA::Washington
WV::West Virginia
WI::Wisconsin
WY::Wyoming

We wanted to thanks Jonathan for the list of countries and states.

Canada Provinces field

To create a provinces field, first create a new field in AcyMailing.

Then access your database (using phpMyAdmin for example), select the table "#__acymailing_fields" and edit the field you just created.

In the textarea "value", copy paste the following code:

Show / hide php code

N/A::N/A
 AB::Alberta
 BC::British Columbia
 MB::Manitoba
 NB::New Brunswick
 NL::Newfoundland and Labrador
 NT::Northwest Territories
 NS::Nova Scotia
 NU::Nunavut
 ON::Ontario
 PE::Prince Edward Island
 QC::Quebec
 SK::Saskatchewan
 YT::Yukon

Thank you Mr BlackBoot !

Brazilian States field

To create a states field, first create a new field in AcyMailing.

Then access your database (using phpMyAdmin for example), select the table "#__acymailing_fields" and edit the field you just created.

In the textarea "value", copy paste the following code:

Show / hide php code

AC::Acre
 AL::Alagoas
 AP::Amapá
 AM::Amazonas
 BA::Bahia
 CE::Ceará
 DF::DistritoFederal
 ES::EspíritoSanto
 GO::Goiás
 MA::Maranhão
 MT::MatoGrosso
 MS::MatoGrossodoSul
 MG::MinasGerais
 PA::Pará
 PB::Paraíba
 PR::Paraná
 PE::Pernambuco
 PI::Piauí
 RJ::RiodeJaneiro
 RN::RioGrandedoNorte
 RS::RioGrandedoSul
 RO::Rondônia
 RR::Roraima
 SC::SantaCatarina
 SP::SãoPaulo
 SE::Sergipe
 TO:Tocantins

Thanks to Bento for providing us with this list.

Australian States

To create a states field, first create a new field in AcyMailing.

Then access your database (using phpMyAdmin for example), select the table "#__acymailing_fields" and edit the field you just created.

In the textarea "value", copy paste the following code:

Show / hide php code

 
ACT::Australian Capital Territory
 NSW::New South Wales
 NT::Northern Territory
 QLD::Queensland
 SA::South Australia
 TAS::Tasmania
 VIC::Victoria
 WA::Western Australia

Thank you Geoff !