View source for Tools-Widgets-Text

{{page.name: Development Module: How to Create Tools and Widgets - Subscribe-HR Wiki}}
{{page.head: Tools and Widgets}}

__TOC__

=Tools and Widgets Explained=
Subscribe-HR development platform allows users and third party developers to create extensions (Apps). Apps can include a number of simple components e.g. Objects, Fields, Actions etc. In addition Apps can have complex components with rich dynamic content. The following component types can be created through the platform:

# Widget - dashboard widget that is rendered as one of the tiles on the dashboard.
# Wizard - a start wizard that contains a number of steps to take the user through.
# Workbench - a workbench specific application.
# Tool - an application within tools area.

==Creating New Tools and Widgets Item==
# After logging into the Subscribe-HR portal, select the <b>Development</b> TAB.
# Select the <b>Tools and Widgets</b> folder.
# Select the [Add new record] button.

The following table describes all available fields.

<table border="1" width="100%" id="table3" cellspacing="0">
<tr>
<td width="206"><b><font face="Arial" size="2">Field Name</font></b></td>
<td width="484"><b><font face="Arial" size="2">Description</font></b></td>
</tr>
<tr>
<td width="206">UUID</td>
<td width="484">Unique identifier for the tool or widget.</td>
</tr>
<tr>
<td width="206">Active</td>
<td width="484">Indicates whether tool is active or not.</td>
</tr>
<tr>
<td width="206">Name</td>
<td width="484">Tool or widget name.</td>
</tr>
<tr>
<td width="206">Type</td>
<td width="484">One of the following: Widget, Wizard, Workbench or Tool.</td>
</tr>
<tr>
<td width="206">Size</td>
<td width="484">Only available if type is Widget. Options are Stat, Half or Full. "Stat" is a small tile at the top of the dashboard. "Half" is a half sized tile. "Full" is a full sized tile.</td>
</tr>
<tr>
<td width="206">Icon</td>
<td width="484">Font awesome class to use as the tool icon.</td>
</tr>
</table>
<br/>
NOTE: If you make a Widget Inactive, this widget will not be able to be added into the relevant Dashboard by a user using the "+" in the Dashboard. 

==Development Components==

===API===

This section allows developers to create RESTful API end points which can then be called from front end to provide data and content. For full documentation please refer to our [https://subscribehr.readthedocs.io/en/latest/apps.html developer portal].

===Template===

Defines an initial template that will be shown on first render. For full documentation please refer to our [https://subscribehr.readthedocs.io/en/latest/apps.html developer portal].

===Front End Javascript===

This section contains all the client side javascript code. For full documentation please refer to our [https://subscribehr.readthedocs.io/en/latest/apps.html developer portal].

===CSS===

This section contains CSS stylesheet. For full documentation please refer to our [https://subscribehr.readthedocs.io/en/latest/apps.html developer portal].

===Permissions===

Developers can define permissions required by their application in JSON format here. This definition will extend permissions that are available in Group permissions area. For full documentation please refer to our [https://subscribehr.readthedocs.io/en/latest/apps.html developer portal].

<br><br>[[File:subscribehr_logo.gif]]