Revision as of 05:50, 7 December 2018

Layouts Explained

The Layout is what defines what elements appear and their position on the page. You are required to have an Object and Elements created before you can use the Layout.
Once you have the Object and Elements created, you simply drag the elements from the fields list onto the page and position them. Save the Layout and you are done.

You must select the Save button or your changes will not be reflected.

Creating a New Layout

1. After logging into the Subscribe-HR portal, select the Development TAB.
2. Select the Objects folder.
3. Select the Object you wish to modify
4. Select the Layout SubFolder.
   
5. Select the Create New button on the top left.
6. Enter the name of your custom layout. Note: this is not visible to the user and is used solely to distinguish between multiple layouts.
7. Select JavaScript and enter your JavaScript into the editor.
8. Select the green Save button on the top right side of the page.

Modifying Layouts

1. After logging into the Subscribe-HR portal, select the Development TAB.
2. Select the Objects folder.
3. Select the Object you wish to modify the Layout of.
   If you wish to create a new object please see the documentation Creating New Objects and Creating New Elements.
4. Select the Layout SubFolder.
   
5. select the layout you wish to edit.
6. Select and drag the elements in the order you wish them to appear in the record.
7. Select Remove at the bottom left of each field to hide it from view.
8. Select Add Field to make an additional element viewable in the record. To select which field is displayed, click the drop down and make a selection.
9. Select Add Heading to separate fields with the heading you enter, on the same tab/page.
10. Select Add HTML to add a field that accepts text in HTML format.
11. Select the green Save button on the top right side of the page.

New tab

By selecting the Add Tab option at the bottom of the page, you are creating a new page off the General page under the same Object. This is accessible via a TAB that is present on the top of the General page.
You should notice that an empty page appears below the General page on the Layout screen. The newly created TAB will not be saved unless the page contains at least one element.

1. Select the Add Tab option, located at the very bottom of the layout page.
2. Enter the name of the tab e.g. Safety
3. Select Add Field and select the field that you want to appear by clicking the drop down and choosing on of the options.
4. Select the green Save button on the top right side of the page.

Add Heading

To add a heading:

1. Select the Add heading option.
2. Drag the heading to where you would like it in the form.
3. Insert Text into the heading.
4. Select the green Save button on the top right side of the page.

Custom HTML

Custom HTML can be used to create totally custom section where you can change the layout the fields in the form. TO add fields, you will need to write the field name into the HTML. The field names can be found in the Developer Tool, by clicking on the element name and use the "Element Field Name". Please not that this tool is for more Technically Orientated users.

1. Select the Add HTML button.
2. Move the Custom area around in the form to the desired location.
3. Type in the required HTML.
4. Select the green Save button on the top right side of the page.

Edit JavaScript

The Edit JavaScript option allows you to add some custom JavaScript to a form. This option loads a JavaScript editor in which you can write your custom JavaScript.

1. Select the JavaScript option.
2. Enter your JavaScript into the editor.
3. Select the green Save button on the top right side of the page.

The Fields Box

The Fields box contains new elements that have been created but not yet placed in a layout.
To place an element in a layout simply select the desired field and drag this to one of the TAB pages.
Removing an element from a TAB Page
To remove an element from a TAB page select the X next to the element. This will place the element back into the Fields box.
Moving an element to another TAB Page
To move an element from one TAB Page to another, simply select and drag the element to the other TAB Page, and select the Save layout option.

Changing the Sort Order of fields on the Search

1. After logging into the Subscribe-HR portal, navigate to the Development TAB.
2. Select the Objects Folder.
3. Select the object that you wish to modify.
   Example: If you are modifying the order of fields on the Employee Property screen then search for Employee Property in the objects search.
4. Select the Layout SubFolder

Elements that have been created and flagged with Display on Search Results will appear on the search form of the object. But when they appear they will appear in natural order.
The Search Fields Display Order section under the Layout SubFolder allows the user to customise the order / position that the field appears on the search form.
By selecting the Layout SubFolder we can see the Search Fields Display Order section.
The Search Fields Display Order section is automatically populated with any elements (fields) that are flagged with Display on Search Results.

1. To change the order that the elements appear in simply drag the desired element into position.
2. Select [Save Layout].

The first element in the list will appear as the first on the search form from the left.