View source for Sites

==About Sites==
The Sites feature enables designers and web developers to build and deploy public web sites and web-based applications using the {{enterprisebrand}}. These Dynamic Sites leverage the backend data and content that reside within a user account. Dynamic Sites eliminate the need for a specific web server or database and instead leverage the robust administration and presentation capabilities of the {{enterprisebrand}}, as well as its relational database.

Dynamic Sites are defined by Java Server Pages (JSPs) and any included [[Static Resources|static resource]] files (images, CSS, etc.). The web pages can be accessed by both authenticated (registered) and unauthenticated (anonymous) users. They can be customized using both CSS and {{^jQuery}} widgets. (You can can also upload other JavaScript libraries as static resources, and use them in your pages.)

In addition to [[Pages]], a developer can use [[Classes]]/[[Controller Interface|Controllers]] to write business logic, adhering to the industry standard [[Working_with_Pages_and_Classes#MVC|MVC]] architecture, where Pages handle the View, Classes and Controllers handle the Controller level, both of which interact with data stored on the platform (the Model) using the platform's [[Java API]] and [[REST API]].

Sites are accessed using URLs that point to pages, controllers, and [[Action Tags]].

{{TenantFeatureByName|Manage Sites}}

==Using Sites==
Dynamic Sites can be used to build many kinds of web sites:
:;Portal web sites: Run your entire public corporate web site on {{enterprisebrand}} Dynamic Sites, or create intranet sites by IP restricting the sites. In addition, Dynamic Sites enable you to create authenticated and unauthenticated pages and data to be served directly to your audience, making it ideal for portals.
:;Interactive business applications: Use {{enterprisebrand}} Dynamic Sites to create interactive web applications where users can interact with complex business processes. For example, you may create a job posting and resume submission application or create an application for mobile updates to {{enterprisebrand}} data.
:;Community and social networking: {{enterprisebrand}} Dynamic Sites can be used to design websites that engage a community of users to submit and vote on ideas, exchange information, or securely collaborate on projects.

===Login Options===
Users can always create a new username and password. But by including the appropriate tags, the site can also allow users to login:
:* Using a Facebook ID ([[]])
:* Using a Google ID ([[]])
:* Using their Gmail account ([[]])

<!--
TO BE REPLACED
===Sample Sites===
These sites are running on the {{enterprisebrand}}. You can interact with them to see them in action, or install the applications and take them apart to see how they work:

:* [http://www.longjump.com/networking/sites/1555611998/jobs Employment Jobs Site]: 
::*Employers can post jobs, including job type, category, location, experience, requirements and education 
::*Potential candidates can view and search the job list, and apply for jobs

:* [http://www.longjump.com/networking/sites/1555611998/tms Issue Tracking / Ticket Management Site]
::*Clients can post questions or issues, receive automated email messages, communicate with support agents and review conversations.
::*Support agents can prioritize and process tickets, assign tickets to individual agents or departments, track ticket status and conversations.
-->

==Terms Used in Sites==

===Site User===
::* A Site User is any user that registers with the site. 
::* When a Site User registers, a [[User]] record is created for them, so they are guaranteed to have a unique identity in the platform instance. 
::* That identity can be used to store profile information. 
::* Operations they perform are undertaken with that identify. (The operations that can be performed are determined by the [[Role]] associated with Site Users.)
::* However, that identity does ''not'' have the ability to log into the platform.
::* A Site User therefore does not count as a "platform user", from the standpoint of tenant billing. (From that standpoint, only platform users count. So if you have 5 people in your organization, and 100,000 Site Users, your tenancy is considered to have only 5 billable "users".)

===Anonymous Site User===
::* Someone can use the site without registering, as well. 
::* In that case, they perform operations using the default identity configured for the site.
::* The [[Role]] associated with the default identity determines which operations can be performed without registering.

===Base URL===
{{:Base URL}}

==Add or Edit a Site==
# '''Designer > Sites'''
# Click '''[New Site]''', or <br/>Select a Site and click '''[Edit]'''
# Fill in the Site properties.
{{:Site Properties}}

==Building Site URLs==
{{:Building Site URLs}}

==Using Controllers and Pages==
Used to customize the business logic for the Site. In this case, all the responsibility of the data model, business logic and display part is written by the user.


:{| border="0" cellpadding="5" cellspacing="0"
|-
| ||valign="top"|URI||<tt>Base URL + "/controller/{controller}"</tt><br><tt>Base URL + "/pages/{page}"</tt>
|-valign="top"
| ||Examples:
|<tt>{{platformURL}}/sites/123456/{site}/controller/JobsController</tt><br><tt>{{platformURL}}/sites/123456/{site}/pages/MyPage.jsp</tt>
|}

;Parameters:
:;{parameter_name}:Any parameter needed for any controller/page written by the user. Please refer to the Classes/Pages documentation on how to write controller/pages.

==Included Server-Side Actions==
{{:Server-Side Actions}}

==Tag Library==
{{:Tag Library}}

==Site API==
Site API is a group of Java APIs related to Sites functionality. You can use these API's within a Page, Data Policy, or Class.

;<tt>isUserLoggedIn</tt>:Determines whether a site user is logged in or not. 

:;Method Signature:<tt>public static boolean isUserLoggedIn()</tt>

:;Returns:''true'' if the user is logged in, ''false'' otherwise

:;Example:
::<syntaxhighlight lang="java" enclose="div">
<% if(!SiteAPI.isUserLoggedIn()) { %>
  <td align="left"><a href="<lj:url resource="pages/login.jsp"/>">Login</a></td>
  <td align="left"><a href="<lj:url resource="pages/register.jsp"/>">Register</a></td>
<% } %>
<% if(SiteAPI.isUserLoggedIn()) { %>
<td><a href="<lj:url resource="pages/ticketList.jsp"/>?fieldList=number,type,subject,status,date_modified,description&sortBy=number&sortOrder=desc&page=0&pageSize=25">List of Tickets</a> | </td>
<td><a href="<lj:url resource="pages/ticket.jsp"/>?action=add">Add New Ticket</a> | </td>
<td><a href="<lj:url resource="pages/ticketList.jsp"/>?fieldList=number,type,subject,status,date_modified,description&sortBy=number&sortOrder=desc&page=0&pageSize=25&filter=status not equal to 'cl'">Hide Closed Tickets</a> | </td>
<td><a href="<lj:url resource="pages/updateProfile.jsp"/>">Update My Profile</a> | </td>
<td><a href="<lj:url resource="pages/changePassword.jsp"/>">Change Password</a> | </td>
<td><a href="<lj:logout />">Logout</a></td></tr>
<% } %>
</syntaxhighlight>

;<tt>isUserValid</tt>:Determines whether a username is valid or not. Common use case is forgot password, where you need to validate if user entered username is valid or not.

:;Method Signature:<tt>public static boolean isUserValid(String username)</tt>

:;Returns:''true'' if the username is valid, ''false'' otherwise.

:;Example:
:<syntaxhighlight lang="java" enclose="div">
import com.platform.api.*;


public class ValidateUser implements Controller
{
  public ControllerResponse execute(HashMap params) throws Exception
  {
    String username = (String) params.get("username");
    ControllerResponse cr = new ControllerResponse();
    if(username == null || username.equals(""))
    {
      Result res = new Result(-1, "", 
         "Username is blank. Please enter a non-blank value for Username");
      cr.setData(res);
      cr.setTargetPage("forgot.jsp");
    }
    else if(!SiteAPI.isUserValid(username))
    {
      Result res = new Result(-1, "", "Invalid username " + username);
      cr.setData(res);
      cr.setTargetPage("forgot.jsp");
    }
    else
    {
      Result res = new Result(0, "", "Valid User");
      cr.setTargetPage("secQuestion.jsp?username=" + username);
    }    
    return cr;
  }
}
</syntaxhighlight>
<noinclude>

[[Category:{{Features}}]]
[[Category:Logic| 4]]
</noinclude>