Difference between revisions of "Template Page"

From SmartWiki
Jump to: navigation, search
(→‎Coordinating the Formatting of the External Page with Internal Formatting)
m
 
(34 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
''Template Pages'', sometimes referred to as ''external pages'', are a feature in SmartSimple that:
 
''Template Pages'', sometimes referred to as ''external pages'', are a feature in SmartSimple that:
 +
 
* allow users to enter records in a SmartSimple [[UTA]] without having to log into SmartSimple;
 
* allow users to enter records in a SmartSimple [[UTA]] without having to log into SmartSimple;
 
* allow [[system administrator]]s to configure customized formatting for UTA records;
 
* allow [[system administrator]]s to configure customized formatting for UTA records;
 
* can be configured to include a confirmation page upon submission of the record.
 
* can be configured to include a confirmation page upon submission of the record.
  
−
''Template Pages'' are associated with a particular [[Level 1 Template]], [[Types|Level 2 or 3 Type]] or [[Transaction]].  
+
''Template Pages'' are associated with a particular [[Level 1 Template]], [[Types|Level 2 or 3 Type]] or [[Transaction]].
  
 
==Accessing the Template Page==
 
==Accessing the Template Page==
 +
To access the Template Page for a [[Level 1 Types|Level 1 Type]] or [[Types|Level 2 or 3 Type]]:
  
−
To access the Template Page for a [[Level 1 Template]] or [[Types|Level 2 or 3 Type]]:
 
 
# Go to the [[UTA Settings Page]].
 
# Go to the [[UTA Settings Page]].
−
# For Level 1 Templates, click on the "Templates" hyperlink. For Level 2 or 3 Types, click on the "Types" hyperlink.
+
# Click on the "Types" hyperlink.
−
# On the left-hand list of Templates or Types, click on the hyperlink for the Template or Type for which you want to configure a ''Template Page''.
+
# On the left-hand list of Types, click on the hyperlink for the Type for which you want to configure a ''Template Page''.
−
# At the top of the Edit Template/Type page, click on the "Template Page" button.
+
# At the top of the Edit Type page, click on the "Template Page" button.
−
:[[Image:L1-GettingtoTemplatePage.png|link=|500px]]
 
−
:You will now be brought to the Template Page configuration screen.
 
  
 +
: [[Image:L1-GettingtoTemplatePage.png|link=|500px]]
 +
: You will now be brought to the Template Page configuration screen.
 
To access the Template Page for a [[Transaction]]:
 
To access the Template Page for a [[Transaction]]:
 
# Go to the [[Global Settings]] page.
 
# Go to the [[Global Settings]] page.
−
# Under the [[Company & Account Settings]] header, click on the hyperlink for "Transaction Types".
+
# Under the [[Company & Account Settings|Company & Account Settings]] header, click on the hyperlink for "Transaction Types".
−
# Choose from "People" or "Company" Transaction Types from the drop-down field at the top of the page. [[Image:TransactionTypeChooser.png|thumb|Choose from ''People'' or ''Company'' Transaction Types]]  
+
# Choose from "People" or "Company" Transaction Types from the drop-down field at the top of the page. [[Image:TransactionTypeChooser.png|thumb|right|300px|Choose from <em>People</em> or <em>Company</em> Transaction Types]]
 
# On the left-hand list of Transaction Types, click on the hyperlink for the Transaction Type for which you want to configure a ''Template Page''.
 
# On the left-hand list of Transaction Types, click on the hyperlink for the Transaction Type for which you want to configure a ''Template Page''.
 
# At the top of the Edit Transaction Type page, click on the "Template Page" button.
 
# At the top of the Edit Transaction Type page, click on the "Template Page" button.
−
:[[Image:Transactions-GettingtoTemplatePage.png|link=|500px]]
 
−
:You will now be brought to the Template Page configuration screen.
 
  
 +
: [[Image:Transactions-GettingtoTemplatePage.png|link=|500px]]
 +
: You will now be brought to the Template Page configuration screen.
 
==The Template Page Configuration Screen==
 
==The Template Page Configuration Screen==
 
[[Image:L1-BlankTemplatePage.png|link=|600px]]
 
[[Image:L1-BlankTemplatePage.png|link=|600px]]
Line 32: Line 33:
 
===General Settings===
 
===General Settings===
 
* '''Activate Page''' - This Template Page will only be accessible if the "Activate Page" option is checked.
 
* '''Activate Page''' - This Template Page will only be accessible if the "Activate Page" option is checked.
−
* '''Internet Enabled''' - Making a Template Page "Internet Enabled" will allow users who are not logged into the system to access this page.
+
* '''Internet Enabled''' - Making a Template Page "Internet Enabled" will allow users who are not logged into the system to access this page. <br /><span class="single_linebreak" style="background-color: lightgray;">- Note: there is a [[Global Setting]] on the Security Tab called "''Disable Template Page Security''" that must be enabled for this to function.</span> {{SecurityToken}}
−
* '''Use Security Token for Custom Fields''' - set for security purposes.  
+
* '''Execute Submit Logic from Template Page''' - enables submit logic check when submitting from the template page. Only available against level 1 template pages.
−
* '''Execute Submit Logic from Template Page''' - See the [[Submit Logic]] page for more information.  
 
 
* '''Execute Status Triggers and Internal Status Workflows from Template Page''' - See [[Status Trigger]] and [[Workflow]] pages for more information.
 
* '''Execute Status Triggers and Internal Status Workflows from Template Page''' - See [[Status Trigger]] and [[Workflow]] pages for more information.
−
* '''Inherit Account - Only applies to an external user''' -  
+
* '''Inherit Account - Only applies to an external user''' - The current user's company will be added to the ''Account'' [[standard field]].
−
* '''Branch''' - defines the default [[branch]] of the newly-created record.  
+
* '''Branch''' - defines the default [[branch]] of the newly-created record.
−
* '''Account''' - defines the default [[Organization|account]] of the newly-created record.  
+
* '''Account''' - defines the default [[Organization|account]] of the newly-created record.
−
* '''Type''' - defines the default [[Template]] or [[Type]] of the newly-created record.  
+
* '''Type''' - defines the default [[Template]] or [[Type]] of the newly-created record.
−
* '''Status''' - defines the default [[status]] of the newly-created record.  
+
* '''Status''' - defines the default [[status]] of the newly-created record.
−
* '''Assign User Role'''
+
* '''Assign User Role''' - adds the current user to the newly-created record as an associated contact with the supplied [[role]].
−
* '''Assign Company Role'''
+
* '''Assign Company Role''' - adds the current user's company to the newly-created record as an associated organization with the supplied [[Company Role]].
−
* '''Owner'''
+
* '''Owner''' - adds the current user to the [[Owner]] field.
 
* '''Workflow''' - [[Workflow]] to be triggered upon submission of Template Page.
 
* '''Workflow''' - [[Workflow]] to be triggered upon submission of Template Page.
 
* '''URL''' - This setting will be completed by default and includes an alphanumeric "token" which serves as a unique identifier for this Template Page.
 
* '''URL''' - This setting will be completed by default and includes an alphanumeric "token" which serves as a unique identifier for this Template Page.
  
−
Note: For Transaction Template Pages, only the ''Activate Page'', ''Internet Enabled'', ''Status'', ''Workflow'' and ''URL'' settings are shown.
+
====Level 1====
 +
:* For Level 1 you will be presented with a URL in the following format, which is to create a new Level 1 record:
 +
'''<nowiki>http://alias.smartsimple.xxx/ex/ex_Apppage.jsp?token=HwkITfexoGZdgsaVla</nowiki>'''
 +
To go to a specific Level 1 record use the following syntax:
 +
: '''<nowiki>http://alias.smartsimple.xxx/ex/ex_Apppage.jsp?token=HwkITfexoGZdgsaVla&oppid=LevelOneIds&appid=appid</nowiki>'''
 +
: example:
 +
<pre>http://alias.smartsimple.xxx/ex/ex_Apppage.jsp?token=HwkITfexoGZdgsaVla&oppid=5551234&appid=543213</pre>
 +
 
 +
====Level 2====
 +
:* For Level 2 you will be presented with a URL in the following format, which is to create a new Level 2 record under the specified Level 1:
 +
'''<nowiki>http://alias.smartsimple.xxx/ex/ex_Evtpage.jsp?token=HQ0NSdsAYbdZFhZRBfBQhdQ&parentids=LevelOneIds</nowiki>'''
 +
where ''LevelOneIds'' is the Opportunity ID of the Level 1 you will be creating a new Level 2 under.
 +
: example:
 +
<pre>http://mysite.smartsimple.com/ex/ex_Evtpage.jsp?token=HQ0gNSAYbZfdhdgFhRBBFQhdQ&parentids=5551234</pre>
 +
: To go to a specific Level 2 record use the following syntax:
 +
: '''<nowiki>http://alias.smartsimple.xxx/ex/ex_Evtpage.jsp?token=HQ0gNSAYbZfdhdgFhRBBFQhdQ&parentids=LevelOneIds&eventid=eventid</nowiki>'''
 +
: example:
 +
<pre>http://alias.smartsimple.xxx/ex/ex_Evtpage.jsp?token=HQ0gNSAYbZfdhdgFhRBBFQhdQ&parentids=5551234&eventid=678543</pre>
 +
: To go to a specific Level 2 or Level 3 record while using [[ssEncrypt]] to hide the record IDs, use the following syntax:
 +
: '''<nowiki>http://alias.smartsimple.xxx/ex/ex_Evtpage.jsp?token=HQ0gNSAYbZfdhdgFhRBBFQhdQ&enparentids=LevelOneIds&codeid=eventid</nowiki>'''
 +
'''&enparentids=''' for the parent ID<br />
 +
'''&codeid=''' for the record ID
 +
: example:
 +
<pre>http://alias.smartsimple.xxx/ex/ex_Evtpage.jsp?token=HQ0gNSAYbZfdhdgFhRBBFQhdQ&enparentids=H3B3T2FdBCs6RnA9Pm4JQTMLESwFaAwvH2pcU0VGYlk~&codedid=aAVNOExzZiYtEUEcHVFIIB9TJ0o0UBA3H2JcV0VGa11b
 +
 
 +
or
 +
 
 +
https://@url@/ex/ex_Evtpage.jsp?token=HQ0gNSAYbZfdhdgFhRBBFQhdQ&enparentids=<ssEncrypt2>@parent.opportunityid@</ssEncrypt2>&codedid=<ssEncrypt2>@eventid@</ssEncrypt2></pre>
 +
 
 +
 
 +
====Transactions====
 +
: Example:to create a new '''person''' transaction (in a popup window) for the current user:
 +
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;"><input class="Button" type="button" value="Open" /></pre>
 +
 
 +
: To create a new '''company''' transaction (in a popup window) for the current organization:
 +
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;"><input class="Button" type="button" value="Open" /></pre>
 +
 
 +
 
 +
====Security====
 +
If URL encryption is enabled you must ensure the object IDs are encrypted using [[ssEncrypt]]
  
 
===HTML Template===
 
===HTML Template===
−
 
+
* This section may be renamed to match the terminology of your copy of SmartSimple. In the illustration above, ''HTML Template'' has been renamed to ''Grant Template'' because Level 1s have been renamed as "Grants" in this example.
−
* This section may be renamed to match the terminology of your copy of SmartSimple. For example, in the illustration above, ''HTML Template'' has been renamed to ''Grant Template'' because Level 1s have been renamed as "Grants" in this example.
 
 
* Clicking on the "Sample Template" hyperlink will insert a default HTML template into this setting, overwriting the current contents.
 
* Clicking on the "Sample Template" hyperlink will insert a default HTML template into this setting, overwriting the current contents.
 
* See the [[Template Page - HTML Template]] for examples of implementation.
 
* See the [[Template Page - HTML Template]] for examples of implementation.
 +
* Ensure that the content of any HTML templates confirm to all [[Accessibility legislation |Accessibility legislation]].
  
 
===Confirmation Template===
 
===Confirmation Template===
Line 59: Line 98:
 
* Clicking on the "Sample Template" hyperlink will insert a default HTML template into this setting, overwriting the current contents.
 
* Clicking on the "Sample Template" hyperlink will insert a default HTML template into this setting, overwriting the current contents.
 
* See the [[Template Page - Confirmation Template|Confirmation Template page]] for examples of implementation.
 
* See the [[Template Page - Confirmation Template|Confirmation Template page]] for examples of implementation.
 +
* Ensure that the content of the Confirmation template conforms to [[Accessibility legislation]]..
  
 
==Coordinating the Formatting of the External Page with Internal Formatting==
 
==Coordinating the Formatting of the External Page with Internal Formatting==
−
* By default, the {{l1}} external page will not pick up the formatting of the internal page (for example, [[Title Bar]]s configured as [[tabs]] will be displayed as simple Title Bars.
+
* By default, the {{l1}} external page will not pick up the formatting of the internal page (for example, [[Title Bar]]s configured as [[tabs]] will be displayed as simple Title Bars).
 
* To use the formatting defined within SmartSimple for the external page, enable the "Use Internal Formatting" setting on the [[Level_1_Templates#Template_Settings|Template Settings]] page.
 
* To use the formatting defined within SmartSimple for the external page, enable the "Use Internal Formatting" setting on the [[Level_1_Templates#Template_Settings|Template Settings]] page.
 +
 +
==See Also==
 +
* [[Template Page Variables]]
 +
* [[Controlling the Submit Button within a UTA Level 1 Template]]
 +
* [[Template Page - Confirmation Template|Confirmation Template]]
 +
 +
 +
[[Category:Universal Tracking Application]]

Latest revision as of 11:26, 15 May 2023

Template Pages, sometimes referred to as external pages, are a feature in SmartSimple that:

  • allow users to enter records in a SmartSimple UTA without having to log into SmartSimple;
  • allow system administrators to configure customized formatting for UTA records;
  • can be configured to include a confirmation page upon submission of the record.

Template Pages are associated with a particular Level 1 Template, Level 2 or 3 Type or Transaction.

Accessing the Template Page

To access the Template Page for a Level 1 Type or Level 2 or 3 Type:

  1. Go to the UTA Settings Page.
  2. Click on the "Types" hyperlink.
  3. On the left-hand list of Types, click on the hyperlink for the Type for which you want to configure a Template Page.
  4. At the top of the Edit Type page, click on the "Template Page" button.
L1-GettingtoTemplatePage.png
You will now be brought to the Template Page configuration screen.

To access the Template Page for a Transaction:

  1. Go to the Global Settings page.
  2. Under the Company & Account Settings header, click on the hyperlink for "Transaction Types".
  3. Choose from "People" or "Company" Transaction Types from the drop-down field at the top of the page.
    Choose from People or Company Transaction Types
  4. On the left-hand list of Transaction Types, click on the hyperlink for the Transaction Type for which you want to configure a Template Page.
  5. At the top of the Edit Transaction Type page, click on the "Template Page" button.
Transactions-GettingtoTemplatePage.png
You will now be brought to the Template Page configuration screen.

The Template Page Configuration Screen

L1-BlankTemplatePage.png

The Template Page Configuration Screen contains the following settings:

General Settings

  • Activate Page - This Template Page will only be accessible if the "Activate Page" option is checked.
  • Internet Enabled - Making a Template Page "Internet Enabled" will allow users who are not logged into the system to access this page.
    - Note: there is a Global Setting on the Security Tab called "Disable Template Page Security" that must be enabled for this to function.
  • Use Security Token for Custom Fields - enhances security of external sign-up and template pages by validating the fields that are submitted with expected values.
  • Execute Submit Logic from Template Page - enables submit logic check when submitting from the template page. Only available against level 1 template pages.
  • Execute Status Triggers and Internal Status Workflows from Template Page - See Status Trigger and Workflow pages for more information.
  • Inherit Account - Only applies to an external user - The current user's company will be added to the Account standard field.
  • Branch - defines the default branch of the newly-created record.
  • Account - defines the default account of the newly-created record.
  • Type - defines the default Template or Type of the newly-created record.
  • Status - defines the default status of the newly-created record.
  • Assign User Role - adds the current user to the newly-created record as an associated contact with the supplied role.
  • Assign Company Role - adds the current user's company to the newly-created record as an associated organization with the supplied Company Role.
  • Owner - adds the current user to the Owner field.
  • Workflow - Workflow to be triggered upon submission of Template Page.
  • URL - This setting will be completed by default and includes an alphanumeric "token" which serves as a unique identifier for this Template Page.

Level 1

  • For Level 1 you will be presented with a URL in the following format, which is to create a new Level 1 record:

http://alias.smartsimple.xxx/ex/ex_Apppage.jsp?token=HwkITfexoGZdgsaVla To go to a specific Level 1 record use the following syntax:

http://alias.smartsimple.xxx/ex/ex_Apppage.jsp?token=HwkITfexoGZdgsaVla&oppid=LevelOneIds&appid=appid
example:
http://alias.smartsimple.xxx/ex/ex_Apppage.jsp?token=HwkITfexoGZdgsaVla&oppid=5551234&appid=543213

Level 2

  • For Level 2 you will be presented with a URL in the following format, which is to create a new Level 2 record under the specified Level 1:

http://alias.smartsimple.xxx/ex/ex_Evtpage.jsp?token=HQ0NSdsAYbdZFhZRBfBQhdQ&parentids=LevelOneIds where LevelOneIds is the Opportunity ID of the Level 1 you will be creating a new Level 2 under.

example:
http://mysite.smartsimple.com/ex/ex_Evtpage.jsp?token=HQ0gNSAYbZfdhdgFhRBBFQhdQ&parentids=5551234
To go to a specific Level 2 record use the following syntax:
http://alias.smartsimple.xxx/ex/ex_Evtpage.jsp?token=HQ0gNSAYbZfdhdgFhRBBFQhdQ&parentids=LevelOneIds&eventid=eventid
example:
http://alias.smartsimple.xxx/ex/ex_Evtpage.jsp?token=HQ0gNSAYbZfdhdgFhRBBFQhdQ&parentids=5551234&eventid=678543
To go to a specific Level 2 or Level 3 record while using ssEncrypt to hide the record IDs, use the following syntax:
http://alias.smartsimple.xxx/ex/ex_Evtpage.jsp?token=HQ0gNSAYbZfdhdgFhRBBFQhdQ&enparentids=LevelOneIds&codeid=eventid

&enparentids= for the parent ID
&codeid= for the record ID

example:
http://alias.smartsimple.xxx/ex/ex_Evtpage.jsp?token=HQ0gNSAYbZfdhdgFhRBBFQhdQ&enparentids=H3B3T2FdBCs6RnA9Pm4JQTMLESwFaAwvH2pcU0VGYlk~&codedid=aAVNOExzZiYtEUEcHVFIIB9TJ0o0UBA3H2JcV0VGa11b

or

https://@url@/ex/ex_Evtpage.jsp?token=HQ0gNSAYbZfdhdgFhRBBFQhdQ&enparentids=<ssEncrypt2>@parent.opportunityid@</ssEncrypt2>&codedid=<ssEncrypt2>@eventid@</ssEncrypt2>


Transactions

Example:to create a new person transaction (in a popup window) for the current user:
<input class="Button" type="button" value="Open" />
To create a new company transaction (in a popup window) for the current organization:
<input class="Button" type="button" value="Open" />


Security

If URL encryption is enabled you must ensure the object IDs are encrypted using ssEncrypt

HTML Template

  • This section may be renamed to match the terminology of your copy of SmartSimple. In the illustration above, HTML Template has been renamed to Grant Template because Level 1s have been renamed as "Grants" in this example.
  • Clicking on the "Sample Template" hyperlink will insert a default HTML template into this setting, overwriting the current contents.
  • See the Template Page - HTML Template for examples of implementation.
  • Ensure that the content of any HTML templates confirm to all Accessibility legislation.

Confirmation Template

  • The Confirmation Template will be displayed after the Template Page is submitted by the end user. Variables such as sslogic can be implemented in this setting to present different confirmation pages depending on how the external page is completed.
  • Clicking on the "Sample Template" hyperlink will insert a default HTML template into this setting, overwriting the current contents.
  • See the Confirmation Template page for examples of implementation.
  • Ensure that the content of the Confirmation template conforms to Accessibility legislation..

Coordinating the Formatting of the External Page with Internal Formatting

  • By default, the Level 1 external page will not pick up the formatting of the internal page (for example, Title Bars configured as tabs will be displayed as simple Title Bars).
  • To use the formatting defined within SmartSimple for the external page, enable the "Use Internal Formatting" setting on the Template Settings page.

See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Template_Page&oldid=41165’