Tools and Widgets

From Subscribe-HR Wiki Help
Jump to: navigation, search
(Created page with '__TOC__ =Objects Explained= The Subscribe-HR System is an object orientated system. Every page is an object. If we were wanting to create a new page we would be creating a new o…')
 
(→‎Creating New Tools and Widgets Item)
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{page.name: Development Module: How to Create Tools and Widgets - Subscribe-HR Wiki}}
 +
{{page.head: Tools and Widgets}}
 +
 
__TOC__
 
__TOC__
  
−
=Objects Explained=
+
=Tools and Widgets Explained=
−
The Subscribe-HR System is an object orientated system. Every page is an object.
+
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:
−
If we were wanting to create a new page we would be creating a new object in the system.
+
−
<br>
+
−
The same rules apply when we are locating a page to modify it through the Development Tool. The Object we would be searching for is the exact name of the page.
+
−
<br>
+
−
<i><b>Example:</b> If I want to add an element to the Employee Medical form, guess what. The Object I am looking for is 'Employee Medical'.</i>
+
  
−
==The Relationship between Objects and Elements==
+
# Widget - dashboard widget that is rendered as one of the tiles on the dashboard.
−
The Subscribe-HR System is an object orientated system. Every page is an object.
+
# Wizard - a start wizard that contains a number of steps to take the user through.
−
If we were wanting to create a new page we would be creating a new object in the system.
+
# Workbench - a workbench specific application.
−
<br>
+
# Tool - an application within tools area.
−
An Element is an item on a page. Items are required to be linked to a page (otherwise known as an Object).
+
−
<br>
+
−
This is enforced by requiring that an Object be selected first before an Element can be created.
+
−
<br>
+
−
<i><b>Example</b>: If I want to create a new element and add this to the Employee Medical form, I would have to select Objects, locate the Object called Employee Medical and then select Elements.</i>
+
  
−
==Creating New Objects==
+
==Creating New Tools and Widgets Item==
 
# After logging into the Subscribe-HR portal, select the <b>Development</b> TAB.
 
# After logging into the Subscribe-HR portal, select the <b>Development</b> TAB.
−
# Select the <b>Objects</b> folder.
+
# Select the <b>Tools and Widgets</b> folder.
 
# Select the [Add new record] button.
 
# Select the [Add new record] button.
−
# Enter the <b>Object Name.</b> This should be the page name.
+
 
−
# Enter the <b>Object menu name.</b> This is the name you wish the menu item to be called.
+
The following table describes all available fields.
−
# Select from the <b>Belongs to module</b> drop down which module the Object should belong to. You are specifying where this page should be available in the system. If you are creating a new page for Human Resources, then selecting Human Resources from the drop down is very ideal.<br>If you require this same page to appear in more than one module you will need to create a separate object for that module.
+
 
−
# Check the <b>Remove from menu</b> if you do not want this item to appear in the menu of the selected module.
+
<table border="1" width="100%" id="table3" cellspacing="0">
−
# Check the <b>Store single record only</b> if you wish the system to not allow multiple records.
+
<tr>
−
# Check the <b>Include in WSDL</b> (Web Services Description Language) if you wish to enable third party integration on this page, which allows data to be retrieved and sent to from an external application.
+
<td width="206"><b><font face="Arial" size="2">Field Name</font></b></td>
−
# Select the <b>Form behaviour</b>.<br><b>Stay On The Form After Save</b>, when data is created and saved will cause the page to refresh and remain on that record.<br><b>Redirect To Search After Save</b> when data is created and saved will cause the page to redirect back to the Objects search page and show a list of all records.
+
<td width="484"><b><font face="Arial" size="2">Description</font></b></td>
−
# Select app in <b>Belongs to App</b> field if this object is to be added to one of your apps.
+
</tr>
−
# Select the [Save] button.
+
<tr>
−
<b>Mandatory fields are marked with Red Asterisk, the record will not be saved unless mandatory fields are filled in first.</b>
+
<td width="206">UUID</td>
−
<br>
+
<td width="484">Unique identifier for the tool or widget.</td>
−
<br>
+
</tr>
−
After the Object has been saved, you will notice sub folders off the Objects menu.
+
<tr>
−
some of these are:
+
<td width="206">Active</td>
−
* Elements
+
<td width="484">Indicates whether tool is active or not.</td>
−
* Actions
+
</tr>
−
* Relationships
+
<tr>
−
* Workflow Tasks
+
<td width="206">Name</td>
−
* Workflow Forms
+
<td width="484">Tool or widget name.</td>
−
* Snippets
+
</tr>
−
* Layout
+
<tr>
−
<br>
+
<td width="206">Type</td>
−
It is important to know that the Object will not appear on the menu of the selected module unless it has at least one element created for that object.
+
<td width="484">One of the following: Widget, Wizard, Workbench or Tool.</td>
 +
</tr>
 +
<tr>
 +
<td width="206">Group type</td>
 +
</tr>
 +
<tr>
 +
<td width="484">Which Dashboard the Widget belongs to.</td>
 +
</tr>
 +
<tr>
 +
<td width="206">Access Level</td>
 +
<td width="484">User Group Access that can access the Widget. E.g. Employee, Manager, People and Culture</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. "Third" Specifically for the "Activation Hub". "Side" which is for the Community Dashboard.</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]]
 
<br><br>[[File:subscribehr_logo.gif]]

Latest revision as of 02:04, 10 August 2023

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:

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

Creating New Tools and Widgets Item

  1. After logging into the Subscribe-HR portal, select the Development TAB.
  2. Select the Tools and Widgets folder.
  3. Select the [Add new record] button.

The following table describes all available fields.

Field Name Description
UUID Unique identifier for the tool or widget.
Active Indicates whether tool is active or not.
Name Tool or widget name.
Type One of the following: Widget, Wizard, Workbench or Tool.
Group type
Which Dashboard the Widget belongs to.
Access Level User Group Access that can access the Widget. E.g. Employee, Manager, People and Culture
Size 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. "Third" Specifically for the "Activation Hub". "Side" which is for the Community Dashboard.
Icon Font awesome class to use as the tool icon.


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 developer portal.

Template

Defines an initial template that will be shown on first render. For full documentation please refer to our developer portal.

Front End Javascript

This section contains all the client side javascript code. For full documentation please refer to our developer portal.

CSS

This section contains CSS stylesheet. For full documentation please refer to our 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 developer portal.



Subscribehr logo.gif

Retrieved from "https://wiki.subscribe-hr.com.au/index.php?title=Tools-Widgets-Text&oldid=11296"