This topic lists the custom macros and methods you can use in
| Companyname |
|---|
Macros
Macros are based on the Velocity template language. Each of these can be used to insert
| Companyname |
|---|
The $subtypeName parameter is used in several EUI macros. It refers to the logical table name, which can be found in the Table wizard. For example, the logical table name for the Contracts table is contract. For subtables, the syntax is table.subtype, for example person.employee or ticket.enhancement.
| Table of Contents | ||||
|---|---|---|---|---|
|
ew_chat
#ew_chat($sessionHash)
This macro lets end users start a chat session. It forms a URL with the chat session ID encoded.
Usage example:
| Code Block | ||
|---|---|---|
| ||
<a href='#ew_chat("46326e7a79564f5a3271376f4257786b5945344e46413d3d")' target=blank>Do chat!</a> |
You can obtain the sessionHash from the Chat setup wizard as follows:
First select "Web page outside the program" on the General tab:
Then copy the session Hash displayed on the HTML tab:
#ew_create_record($subtypeName $returnURL $returnFrame)
Use this macro to insert a new record form into an EUI template. It creates a URL that links to the standard record create page for a given table.
To find the sessionHash:
- Go to Setup > Chat and edit the chat configuration.
- On the General tab, select "Web page outside the program," then click Next to proceed to the Access tab.
- When the HTML tab appears, click it.
- In the HTML text box, locate "sessionHash=" and select the sequence after it.
- Copy the hash, return to the EUI template code, and paste it into the macro.
Usage example:
| Code Block | ||
|---|---|---|
| ||
<a href='#ew_chat("46326e7a79564f5a3271376f4257786b5945344e46413d3d")' target=blank>Do chat!</a> |
ew_create_record
#ew_create_record($subtypeName $returnURL $returnFrame)
Use this macro to insert a new record form into an EUI template. It creates a URL that links to the standard record create page for a given table. See Creating a New Page Tutorial for an example of how this can be used.
| Parameter Name | Description |
|---|---|
| Logical name of the table in which the new record should be created. The logical name is shown in the |
| Parameter Name | Description |
| Logical name of the table in which the new record should be created. The logical name is shown in the tables wizard. Can contain subtable chains like case.question, contact.employee etc. |
| URL to return to after the ticket is created or cancel is pressed. |
| Name of the iframe that contains the view of the table that needs to be refreshed once the operation is completed. |
ew_dashboard
#ew_
...
dashboard($dashboardName $showMenu)
This Use this macro inserts a record edit form to insert a dashboard URL into an EUI template. It creates a URL that links to the standard record editing page for a given table and record IDPlace the URL in a frame or other HTML content container to show a dashboard in the EUI. Dashboards are shown according to user permissions for power users, and users who are not part of a power user group can only see Hotlink, Table, URL, Image and Text widgets.
| Parameter Name | Description |
|---|---|
| Logical The name of the table dashboard as it appears in which the new record should be created. The logical name is shown in the tables wizard. Can contain subtable chains like case.question, contact.employee etc. |
| The id of the record to edit |
| URL to return to after the ticket is created or cancel is pressed |
| Name of the iframe that contains the view of the table that needs to be refreshed once the operation is completed. |
#ew_faq($subtypeName)
Inserts the FAQ interface for a given table, as defined in the FAQ setup. See Search FAQ Setup for more information.
#ew_forward($templateName)
the dashboard list. If the $dashboardName value is empty, the most recently selected dashboard is shown; if no dashboard has been selected, the default dashboard is shown. | |
| Use $showMenu to specify whether to show the dashboards drop-down list at the top. If the $showMenu value is empty, the default setting is True, which shows the list. |
ew_edit_record
#ew_edit_record($subtypeName $recordId $returnURL $returnFrame)
This macro inserts a record edit form into an EUI template. It creates a URL that links to the standard record editing page for a given table and record IDThis URL simply creates links between EUI template pages without losing the user's session ID. Use this whenever you create links between pages; it creates a URL to forward the user to the specified template.
| Parameter Name | Description |
|---|
$templateName
|
Template name. If the template doesn't exist, using this URL will result in an error to allow the designer to debug and fix errors
Example usage:
| Code Block | ||
|---|---|---|
| ||
<a href="#ew_forward("testContacts.htm")">Contacts</a> |
#ew_image($imageName)
Forms the URL to the image with the given name. As an admin user, you can upload images to your KB via the staff interface in the Look & Feel section. The $imageName parameter should be a relative path to the image from the
| Companyname |
|---|
| Code Block |
|---|
<img src="#ew_image('/gif/icon21.png')" alt="Next" /> |
Image names with spaces or special characters should be properly URL encoded. For example, linking to an image called icon 21.png requires the following format, replacing the space with %20:
| Code Block |
|---|
<img src="#ew_image('/gif/icon%2021.png')" alt="Next" /> |
#ew_include($templateName)
This macro is a shortcut to include the contents of one EUI Template in another.
...
$templateName
...
Includes $templateName into the current one. This allows admins to reuse common pieces of code in different templates. See EUI Template Configuration for an example of how this can be used.
Logical name of the table in which the new record should be created. The logical name is shown in the tables wizard. Can contain subtable chains like case.question, contact.employee etc. | |
| The ID of the record to edit |
| URL to return to after the ticket is created or cancel is pressed |
| Name of the iframe that contains the view of the table that needs to be refreshed once the operation is completed. |
ew_faq
#ew_faq($subtypeName)
Inserts the FAQ interface for a given table, as defined in the FAQ setup. See Search FAQ Setup for more information.
ew_forward
$ew_forward($templateName)
This URL simply creates links between EUI template pages without losing the user's session ID. Use this whenever you create links between pages; it creates a URL to forward the user to the specified template.
| Parameter Name | Description |
|---|---|
| Template name. If the template doesn't exist, using this URL will result in an error to allow the designer to debug and fix errors |
Example usage:
| Code Block | ||
|---|---|---|
| ||
<a href="#ew_forward("testContacts.htm")">Contacts</a> |
ew_image
#ew_image($imageName)
Forms the URL to the image with the given name. As an admin user, you can upload images to your KB via the power user interface in the Look & Feel section. The $imageName parameter should be a relative path to the image from the
| Companyname |
|---|
| Code Block |
|---|
<img src="#ew_image('/gif/icon21.png')" alt="Next" /> |
Image names with spaces or special characters should be properly URL encoded. For example, linking to an image called icon 21.png requires the following format, replacing the space with %20:
| Code Block |
|---|
<img src="#ew_image('/gif/icon%2021.png')" alt="Next" /> |
ew_include
#ew_include($templateName)
This macro is a shortcut to include the contents of one EUI Template in another.
| Parameter Name | Description |
|---|---|
| Includes $templateName into the current one. This allows admins to reuse common pieces of code in different templates. |
ew_languages
#ew_languages
#ew_languages($controlName $onChange $controlStyle)
Renders a list of available languages for the current user with a particular HTML style. The style needs to be passed here as a parameter, because
| Companyname |
|---|
...
$controlName
...
Required name of the HTML select list.
...
$onChange
...
JavaScript code to be run when a language is selected.
...
$controlStyle
...
CSS class name for the select list control.
...
($controlName $onChange $controlStyle)
Renders a list of all available languages available in for the system current user with a particular HTML style. We need to pass the style The style needs to be passed here as a parameter, because
| Companyname |
|---|
| Parameter Name | Description |
|---|---|
| Required name of the HTML select list. |
| JavaScript code to be run when a language is selected. |
| CSS class name for the select list control. |
ew_languages_all
#ew_languages_
...
all(
...
$controlName $onChange $controlStyle)
Sets the language (locale) for the current user session to the specified one if the language is available for the user.
| Parameter Name | Description |
|---|---|
| ISO-639 language code ("en", "de", "fr") |
#ew_login($kbName $redirectTo)
Prints the
| Companyname |
|---|
...
$kbName
...
name of KB to login
...
$redirectTo
...
name of template to be used after successful login
Renders a list of all languages available in the system with a particular HTML style. You need to pass the style here as a parameter, because
| Companyname |
|---|
| Parameter Name | Description |
|---|---|
| Required name of the HTML select list. |
| JavaScript code to be run when a language is selected. |
| CSS class name for the select list control. |
ew_locale
#ew_locale($localeName)
Sets the language (locale) for the current user session to the specified one if the language is available for the user
#ew_logout($url)
Logs out of
| Companyname |
|---|
| Parameter Name | Description |
|---|---|
| URL to be redirected after logout, such as a confirmation message or intranet home page. |
...
| language | xml |
|---|---|
| title | Example usage |
...
| Java 7 locale code ("en", "de", "fr") |
...
...
ew_logins
#ew_login($kbName $redirectTo)
Prints the
| Companyname |
|---|
#ew_new_search($subtypeName $frameName $allowSaving $returnURL $params)
Provides a piece of JavaScript, mostly for use in onClick event handlers, that runs the new Saved Search wizard. When returning to $returnURL, an additional request parameter is appended for the created saved search - searchID. You can use it in your own code, for example to update a list of available Saved Searches.
| Parameter Name | Description |
|---|---|
| Table for which the search should be created |
| The name of HTML iframe in which to display the results after the Wizard has finished. |
| "true" if the user should be allowed to save the created search, otherwise "false". |
| URL that should be applied to $frameName after wizard has finished. If "", than the standard table search will be used. |
| Visualization Parameters formed as a request query, e.g. "showstatus=false&showpages=false..." etc. They will be applied to the table view for $subtypeName. Use this parameter if you leave $returnURL empty. Otherwise add required Parameters to $returnURL directly. |
...
| name of KB to login |
| name of template to be used after successful login |
ew_logout
#ew_logout($url)
Logs out of
| Companyname |
|---|
| Parameter Name | Description |
|---|---|
| URL to be redirected after logout, such as a confirmation message or intranet home page. |
| Code Block | ||||
|---|---|---|---|---|
| ||||
<a href="#ew_logout("http://www.example.com")">Click to logout</a> |
ew_new_search
#ew_new_search($subtypeName $frameName $allowSaving $returnURL $params)
Provides a piece of JavaScript, mostly for use in onClick or onChange event event handlers, that runs a search for a table in an iFrame. the new Saved Search wizard. When returning to $returnURL, an additional request parameter is appended for the created saved search - searchID. You can use it in your own code, for example to update a list of available Saved Searches.
| Parameter Name | Description |
|---|---|
| showTable for which the search should be created |
| The name of HTML iframe in which to display the results . |
| The id of the HTML control which contains the query to use (for example a form field) |
| String of request Parameters that will be passed to the table in $frameName. See the #ew_table macro, and the following parameter list for details. |
#ew_recordfield ($subtypeName $recordID $fieldName)
Forms the URL to show the Report or Chart with the given name.
...
$subtypeName
...
Logical table name containing the record, e.g. "document" or "person.employee".
...
$recordID
...
The ID of the record you want to access, e.g. "224".
...
$fieldName
...
Field name in the selected table, for example "description" or "attached_files".
| Code Block | ||
|---|---|---|
| ||
#ew_recordfield("documents","224","description_text") |
#ew_repchart ($repchartName $repchartType $tableName)
Forms the URL to show the Report or Chart with the given name from the specified table.
...
$repchartName
...
Name of report or chart as listed in the Table Charts/Reports list.
...
$repchartType
...
Type of the report or chart. Allowed values are [html, image, excel, plain/text].
...
$tableName
...
Name of the table containing the report or chart.
#ew_scripts()
Introduces a link to certain required JavaScript functions. The default
| Companyname |
|---|
#ew_searches_list($subtypeName $frameName $controlName $controlStyle $params $selectedSearch)
Draws an HTML select list control with the Saved Searches available, taking into account access permissions.
...
$subtypeName
...
Name of the table for which to display the appropriate searches.
...
$frameName
...
Name of the iframe that contains the view of the table that needs to be refreshed once a search is selected.
...
$controlName
...
Required name of the HTML select list.
...
$controlStyle
...
CSS class name to be applied to the select list.
...
$params
...
String of the request Parameters that will be passed to the table in $frameName. See the #ew_table macro, and the following parameter list for details.
...
$selectedSearch
...
Name of the search to be selected in list initially
#ew_session()
Prints
| Companyname |
|---|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<a href="/gui2/eui2template/testContacts.htm;#ew_session()">Contacts</a> |
results in:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<a href="/gui2/eui2template/testContacts.htm;jsessionid=D7988DF0E8E173... |
#ew_status()
Prints to screen last operation status stored in the request, ActionStatus. This macro requires no parameters.
#ew_table($subtypeName $viewName $searchName $queryString $params $frameName $frameStyle)
Draws an HTML iframe with the specified
| Companyname |
|---|
...
$subtypeName
...
The table to show.
...
$viewName
...
The view to use for table. Note that it's localized for now, so different names should be used for different languages
...
$searchName
...
The search name to apply to the table. Can be used simultaneously with $queryString
...
$queryString
...
The query to be applied to the table. When used, the result is the same as if the user had typed the contents of this string into the search box. See the #ew_query macro below.
...
$params
...
Visualization Parameters formed as a request query, e.g. "showstatus=false&showpages=false..." etc. Use it for precise tuning of the table's display features. See the parameter list at the end of this section for more details.
...
$frameName
...
The required name of the resulting iframe. This is needed so that you can refer to it in other macros or pieces of JavaScript (for example to refresh the table view after a search has been applied - see the tutorial).
...
$frameStyle
...
The CSS style name to be applied to the iframe.
#ew_user()
Prints the current user login to screen. This macro does not take parameters.
#ew_userfield($fieldName)
Prints the current user's record field value. This macro is rendered to be human-readable; for example, choice values will be returned as 'Yes'.
...
$fieldName
...
A logical name of the field to return. Example: #ew_userfield("_16_company_name0")
#ew_userid()
Prints the current user ID to screen; requires no parameters.
#ew_url($url)
...
$url
...
Prints to screen $url with the application url prefix and session data encoded. If you want to make an asset for your portal page available for portal users but not to anyone else, for example an image logo, then you can upload it to the
| Companyname |
|---|
Example usage:
| Code Block | ||
|---|---|---|
| ||
<img border = "0" src = "#ew_url("images/logo.jpg")"/> |
#ew_view_record($subtypeName $recordId $returnURL $returnFrame)
Creates a URL which links to the record view.
...
$subtypeName
...
Logical name of the table in which the record should be viewed.
...
$recordId
...
The ID of the record to view.
...
$returnURL
...
URL to return to after the ticket is created or cancel is pressed
...
$returnFrame
...
Name of the iframe that contains the view of the table that needs to be refreshed once the operation is completed.
Visualization Parameters ($params)
Visualization parameters apply to the following macros:
#ew_table#ew_searches_list#ew_query#ew_new_search
...
showSearchCriteria
...
Whether used search criteria will be shown to user
...
workWithPopUp
...
Determines whether edit and new operations should be performed within the current frame or the pop-up window
...
showToolBar
...
Show toolbar on top of table.
...
showNavigation
...
Show pages navigation above the table
...
showStatus
...
Show status of operations on above the table
...
showfastsearch
...
Show search dialog for the table
...
Turn on Context for text searches
Usage: turn on Context for text searches from the EUI 2 by using:
#ew_query("contract" "my_table" "queryId" "showToolBar=false&showNavigation=true&showfastsearch=false&search_context=true")
Additional Tools
Some helper macros have been implemented to be used in Velocity templates.
User related tools
In a template, the $ewUser macros can be used with several methods:
...
$ewUser.isInGroup(group_name)
Returns true if current user belongs to any of pointed groups. False otherwise.
gr_name - names of groups separated by comma.
Example:
| Info |
|---|
#if ($ewUser.isInGroup("Staff,admin")) This is text for permitted users only #else This is text for all other users #end |
...
$ewUser.isInTeam(team_name)
...
Returns true if current user belongs to any of specified teams. False otherwise.
team_name - names of teams separated by comma
...
$ewUser.getCurrentUserLogin()
...
Returns login name of the current user
...
$ewUser.getCurrentUserField(field)
...
Returns string with the field value from the current user contact.
field - name of the contact field.
Example: Welcome $ewUser.getCurrentUserField("full_name")!
after the Wizard has finished, e.g. "opener.my_table". | |
| "true" if the user should be allowed to save the created search, otherwise "false". |
| URL that should be applied to $frameName after wizard has finished. If "", than the standard table search will be used. |
| Visualization Parameters formed as a request query, e.g. "showstatus=false&showpages=false..." etc. They will be applied to the table view for $subtypeName. Use this parameter if you leave $returnURL empty. Otherwise add required Parameters to $returnURL directly. |
ew_query
#ew_query($subtypeName $frameName $controlId $params $viewName)
Provides a piece of JavaScript, mostly for use in onClick or onChange event handlers, that runs a search for a table in an iframe.
| Parameter Name | Description |
|---|---|
| The name of the table to show |
| The name of HTML iframe in which to display the results. |
| The id of the HTML control which contains the query to use (for example a form field) |
| String of request Parameters that will be passed to the table in $frameName. See the #ew_table macro, and the following parameter list for details. |
$viewName | Label of the View to be applied to the search results. Note that when ew_query is used inside of ew_table, any view associated with a search specified by the ew_table macro takes precedence, as does the viewName specified in that macro if the search itself doesn't have an associated view. |
ew_recordfield
#ew_recordfield ($fieldName $subtypeName $recordID)
Forms the URL to show the field value from the record and table specified.
| Parameter Name | Description |
|---|---|
| Field name in the selected table, for example "description" or "attached_files". |
| Logical table name containing the record, e.g. "document" or "person.employee". |
| The ID of the record you want to access, e.g. 224. |
| Code Block | ||
|---|---|---|
| ||
#ew_recordfield("description_text" "document" 224) |
ew_repchart
#ew_repchart ($repchartName $repchartType $tableName)
Forms the URL to show the Report or Chart with the given name from the specified table.
| Parameter Name | Description |
|---|---|
| Name of report or chart as listed in the Table Charts/Reports list. |
| Type of the report or chart. Allowed values are [html, image, excel, plain/text]. |
| Name of the table containing the report or chart. |
ew_scripts
#ew_scripts()
Introduces a link to certain required JavaScript functions. The default
| Companyname |
|---|
ew_searches_list
#ew_searches_list($subtypeNames $frameName $controlName $controlStyle $params $selectedSearch $viewName)
Draws an HTML select list control with the Saved Searches available, taking into account access permissions.
| Parameter Name | Description |
|---|---|
| Name of the table or tables for which to display the appropriate searches. To show searches from multiple tables, enter a comma-delimited list of tables. If you enter multiple tables here, the $selectedSearch and $viewName parameters are ignored. |
| Name of the iframe that contains the view of the table that needs to be refreshed once a search is selected. |
| Required name of the HTML select list. |
| CSS class name to be applied to the select list. |
| String of the request Parameters that will be passed to the table in $frameName. See the #ew_table macro, and the following parameter list for details. |
| Name of the search to be selected in list initially |
$viewName | Label of the View to be applied to the search results |
ew_session
#ew_session()
Prints
| Companyname |
|---|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<a href="/gui2/eui2template/testContacts.htm;#ew_session()">Contacts</a> |
results in:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<a href="/gui2/eui2template/testContacts.htm;jsessionid=D7988DF0E8E173... |
ew_status
#ew_status()
Prints to screen last operation status stored in the request, ActionStatus. This macro requires no parameters.
ew_table
#ew_table($subtypeName $viewName $searchName $queryString $params $frameName $frameStyle $showLabel)
Draws an HTML iframe with the specified
| Companyname |
|---|
| Parameter Name | Description |
|---|---|
| The table to show. |
| The view to use for table. Note that it's localized for now, so different names should be used for different languages. Also note that any view associated with the applied search takes precedence over this parameter. Both of these take precedence over the view specified in any ew_query macro used inside of this macro. |
| The search name to apply to the table. Can be used simultaneously with $queryString |
| The query to be applied to the table. When used, the result is the same as if the user had typed the contents of this string into the search box. See the #ew_query macro below. |
| Visualization Parameters formed as a request query, e.g. "showstatus=false&showpages=false..." etc. Use it for precise tuning of the table's display features. See the parameter list at the end of this section for more details. |
| The required name of the resulting iframe. This is needed so that you can refer to it in other macros or pieces of JavaScript (for example to refresh the table view after a search has been applied - see the tutorial). |
| The CSS style name to be applied to the iframe. |
ew_user
ew_user()
Prints the current user login to screen. This macro does not take parameters.
ew_userfield
#ew_userfield($fieldName)
Prints the current user's record field value. This macro is rendered to be human-readable; for example, choice values will be returned as 'Yes'. In practice, enter the logical name of the field in quotation marks.
| Parameter Name | Description |
|---|---|
| A logical name of the field to return. Example: |
ew_userid
#ew_userid()
Prints the current user ID to screen; requires no parameters.
ew_url
#ew_url($url)
| Parameter Name | Description | |
|---|---|---|
| Prints to screen $url with the application url prefix and session data encoded. If you want to make an asset for your portal page available for portal users but not to anyone else, for example an image logo, then you can upload it to the
|
Example usage
| Code Block | ||
|---|---|---|
| ||
<img border = "0" src = "#ew_url("images/logo.jpg")"/> |
ew_view_record
#ew_view_record($subtypeName $recordId $returnURL $returnFrame)
Creates a URL which links to the record view .
| Parameter Name | Description |
|---|---|
| Logical name of the table in which the record should be viewed. |
| The ID of the record to view. |
| URL to return to after the ticket is created or cancel is pressed |
| Name of the iframe that contains the view of the table that needs to be refreshed once the operation is completed. |
Visualization Parameters ($params)
Visualization parameters apply to the following macros:
#ew_table#ew_searches_list#ew_query#ew_new_search
| Parameter Name | Values (default in bold) | Description |
|---|---|---|
| true, false | Whether used search criteria will be shown to user |
| true, false | Determines whether edit and new operations should be performed within the current frame or the pop-up window |
| true, false | Show action bar on top of table |
showLabel | true, false | Show label for the table |
| true, false | Show pages navigation above the table |
| true, false | Show status of operations on above the table |
| true, false | Show search dialog for the table |
search_context | true, false | Turn on Context for text searches Usage: turn on Context for text searches from the EUI2 by using:
|
_saved_search_id | any saved search id | Filter text searches by a saved search Usage: |
$ewPermission.table
The $ewPermission.table macro describes permission actions for individual users or groups. It returns true when a user has the permission to do the specified action. To add more than one action type, separate each phrase with a comma. For example, $ewPermission.table ("create", "delete_others").
...
| title | $ewPermission.table list |
|---|
...
create
...
Allow user to create a new record
...
delete_own
...
Allow user to delete own records
...
delete_others
...
Allow user to delete others’ records
...
mass_delete
...
Allow user to delete multiple records
...
dele_oth_if_pub_y
...
Delete others’ records if published field is yes
...
massedit
...
Allow user to perform mass edit
...
import_multiple
...
Allows import of multiple records from a file
...
export_multiple
...
Allows export of multiple records to a file
...
link_multiple_recs
...
Link multiple records using the Link menu
...
print_recs
...
Print records using the printer icon
...
view_own
...
Allow user to view own records
...
view_others
...
Allow user to view others’ records
...
view_own_if_pub_y
...
View own records if published field is yes.
...
view_oth_if_pub_y
...
View others’ records if published field is yes.
...
edit_own
...
Allow user to edit own records
...
edit_others
...
Allow user to edit others’ records
...
mod_own_s_searches
...
Allow user to modify/delete saved searches that they created
...
mod_all_s_searches
...
Allow user to modify/delete all saved searches
...
mod_own_s_views
...
Allow user to modify/delete saved views that they created
...
mod_all_s_views
...
Allow user to modify/delete all saved views
...
mod_own_s_reports
...
Allow user to modify/delete saved reports that they created
...
mod_all_s_reports
...
Allow user to modify/delete all saved reports
...
pub_s_reports
...
Allow user to publish saved reports
...
v_own_with_ssearch
...
View own entries that satisfy the saved search
...
v_oth_with_ssearch
...
View others’ entries that satisfy the saved search
...
e_own_with_ssearch
...
Edit own entries that satisfy the saved search
...
e_oth_with_ssearch
...
Edit others’ entries that satisfy the saved search
...
d_oth_with_ssearch
...
delete others’ entries that satisfy the saved search
...
acc_oth_ss
...
Allow access to others’ saved searches
...
acc_oth_ss_py
...
Allow access to others’ saved searches if Published=Yes
...
view_faq
...
Allow user to view FAQs
...
view_faq_with_ss
...
View FAQs that satisfy the saved search
...
ed_rec_tab_view
...
Edit records from table view
...
omit_table_label
...
Allow user to set show label on view/editing on General tab
...
copy_recs
...
Copy $table-label-plural
...
show_in_main_tabs
...
Allow user to see it in main tabs
...
allow_sel_ed_flds
...
Allow user to select editable fields in view they can edit
...
apply_to_subtabls
...
Apply changes to subtables (in groups wizard)
...
apply_all_to_subtabls
...
Apply everything to subtables (in groups wizard)
...
create_calendar
...
Create calendar records on specific subtype
...
c_cal_with_ssearch
...
Create calendars on records that satisfy the saved search
...
view_own_calendar
...
View own calendar entries
...
v_own_cal_with_ssearch
...
View own entries that satisfy the saved search
...
view_others_calendar
...
View other peoples’ calendar entries
...
others_cal_with_ssearch
...
View other peoples’ entries that satisfy the saved search
...
edit_own_calendar
...
Edit own calendar entries
...
e_own_cal_with_ssearch
...
Edit own entries that satisfy the saved search
...
edit_others_calendar
...
Edit other peoples’ calendar entries
...
e_others_cal_with_ssearch
...
Edit other peoples’ entries that satisfy the saved search
...
delete_own_calendar
...
Delete own calendar entries
...
d_own_cal_with_ssearch
...
Delete own entries that satisfy the saved search
...
delete_others_calendar
...
Delete other peoples’ calendar entries
...
d_others_cal_with_ssearch
...
Delete other peoples’ entries that satisfy the saved search
...
view_comm_from
...
View outgoing email address FROM
...
edit_comm_from
...
Edit outgoing email address FROM
...
view_comm_replyto
...
View send-back email address REPLY-TO
...
edit_comm_replyto
...
Edit send-back email address REPLY-TO
...
create_comm
...
Create a communication record linked to the given subtype
...
mod_own_eml_tmpl
...
Allow users to modify/delete own email templates
...
mod_all_eml_tmpl
...
Allow users to modify/delete all email templates
...
viewsend_own_eml_tmpl
...
Allow viewing/sending only their own email templates
...
viewsend_ownpublished_eml_tmpl
...
Allow viewing/sending own and published email templates
...
viewsend_ownpublished_eml_tmpl
...
Allow viewing/sending own and published email templates
...
viewsend_all_eml_tmpl
...
Allow viewing/sending of all email templates
...
publish_eml_tmpl
...
Allow user to publish email templates
...
cr_mod_own_ptmpl
...
Create/modify own print templates
...
cr_mod_all_ptmpl
...
Create/modify all print templates
...
use_all_ptmpl
...
Use all print templates
...
use_ownpub_ptmpl
...
Use/own/publish print templates
...
can_pub_ptmpl
...
User can publish print templates
Response related tools
The $ewResponse tool can be used with several methods in a template:
...
$ewResponse.nocache()
...
Set response header not to cache the template
...
$ewResponse.cache(time)
...
Set response header to cache content for time minutes
Localization related tools
Templates are designed with national language support. The text displayed to users can be maintained in separate language-based templates and displayed based on the locale. There are predefined templates with names such as translation.properties that contain localized text in the form
key1=value1
key2=value2
If you want to translate your templates to another language, you should create a template named translation_<language-code>.properties and insert your translations there. If a key is not found in the localized properties template, the text from the default translation.properties file is used.
...
$ewText.get($key)
...
Reads the current session locale, then looks up the key line in the corresponding translation.properties file and prints the text value to the screen.
For example: Welcome To $ewText.get("home.sc.title")!
...
$ewText.get(key)
...
Returns localized message
...
$ewText.get(key, [value1, value2,...])
...
Returns localized message with values substituted
...
This method returns values from the system-wide properties file rather than the EUI Template. Use the key name from the file GUI2.properties in the
| Companyname |
|---|
For example, $text.eui.name.text1 displays 'User:' when used in an EUI template.
Knowledgebase related tools
The $ewUtils tool returns name and label information about the knowledgebase.
$ewUtils.thisProjectLabel
Returns the knowledgebase label when included in a template.
$ewUtils.thisProjectName
| Hide If | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Related articles
|