Tools and Widgets

From Subscribe-HR Wiki Help
Jump to: navigation, search
Line 4: Line 4:
 
__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.
+
<br />
−
# Enter the <b>Object menu name.</b> This is the name you wish the menu item to be called.
+
<table border="1" width="100%" id="table3" cellspacing="0">
−
# 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.
+
<tr>
−
# Check the <b>Remove from menu</b> if you do not want this item to appear in the menu of the selected module.
+
<td width="206"><b><font face="Arial" size="2">Field Name</font></b></td>
−
# Check the <b>Store single record only</b> if you wish the system to not allow multiple records.
+
<td width="484"><b><font face="Arial" size="2">Description</font></b></td>
−
# 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.
+
</tr>
−
# 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.
+
<tr>
−
# Select app in <b>Belongs to App</b> field if this object is to be added to one of your apps.
+
<td width="206">UUID</td>
−
# Select the [Save] button.
+
<td width="484">Unique identifier for the tool or widget.</td>
−
<b>Mandatory fields are marked with Red Asterisk, the record will not be saved unless mandatory fields are filled in first.</b>
+
</tr>
−
<br>
+
<tr>
−
<br>
+
<td width="206">Active</td>
−
After the Object has been saved, you will notice sub folders off the Objects menu.
+
<td width="484">Indicates whether tool is active or not.</td>
−
some of these are:
+
</tr>
−
* Elements
+
<tr>
−
* Actions
+
<td width="206">Name</td>
−
* Relationships
+
<td width="484">Tool or widget name.</td>
−
* Workflow Tasks
+
</tr>
−
* Workflow Forms
+
<tr>
−
* Snippets
+
<td width="206">Type</td>
−
* Layout
+
<td width="484">One of the following: Widget, Wizard, Workbench or Tool.</td>
−
<br>
+
</tr>
−
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.
+
<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/>
 +
 
 +
 
  
 
<br><br>[[File:subscribehr_logo.gif]]
 
<br><br>[[File:subscribehr_logo.gif]]

Revision as of 11:08, 16 March 2020

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.


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.
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.
Icon Font awesome class to use as the tool icon.





Subscribehr logo.gif

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