Skip to main content
Skip table of contents

Student Orbit Setup

Overview

The ‘Student Orbit Setup’ program lets schools customise their Student Orbit mobile app homepage, including managing layout, tile order, enabling or disabling tiles, arranging elements, customising icons and links, and adjusting the colour scheme for a personalised, branded experience.

Coming Soon!

The Student Orbit app is still under development. Refer to the 'Student Orbit App' page on the TASS website for details, or contact TASS Licencing to enquire about getting Student Orbit for your school.

These customisation features are available on the following tabs:

Click here for an Administrator Note.

User Security Permissions

To access this program, users must have the 'Orbit' menu and 'Student Orbit Setup' permission points enabled in TASS.web System Admin > Users > User Maintenance or Security Role Permissions.

The ‘Student Orbit Setup’ program manages the colours, icons, and elements that make up the Student Orbit mobile app homepage.

  • The default app interface and icon colours are derived from TASS.web System Admin > Utilities > API Gateway Maintenance on the ‘OAuth2 API Applications’ tab via the ‘Metadata’ link in the Action column.

  • The school logo can be added in TASS.web System Admin > Utilities > API Gateway Maintenance on the ‘OAuth2 API Applications’ via the ‘Edit’ link in the Action column.

  • The banner and slider images set on the ‘Homepage Images’ tab of this program are also visible and can be configured in TASS.web System Admin > Utilities > Product UI Maintenance for Student Orbit'.

  • The ‘Extra Curricular Hub’ icons are set up in TASS.web Student Admin > Extra Curricular > Setup Information > Extra Curricular Setup on the 'Activity Types' tab.

  • You can also customise the School Links display in the Side Menu by selecting the ‘Student Orbit Side Menu’ checkbox in Staff Kiosk Links > School Links (Maintain).

Homepage Setup

The 'Homepage Setup' tab lets users customise the app's homepage layout, including the display of the School Name, number of tiles per row, the homepage image height, and the arrangement and sorting of elements.

Fields that require further explanation

Hide School Name in Top Text

Select this checkbox to hide the school name on the Student Orbit mobile app homepage. When this option is selected, the school name will still appear in the Side Menu.

* Tiles Per Row on Homepage

Use the drop-down list to select the number of tiles per row to display on the Student Orbit mobile app homepage. You can choose to display 2, 3 or 4 tiles per row.

* Homepage Image Height

Use this field to set the height of images on the Student Orbit mobile app homepage.

The screen height percentage must be between 10% and 80%.

Elements Grid

The elements grid summarises the elements (or features) enabled (Y) or disabled (N) in the Student Orbit mobile app, along with their names and sort order.

Click column headings to sort rows ascending or descending. Drag column headings to reorder columns.

The following elements can be customised:

Image Header

The top image banner/slider. See the ‘Homepage Image’ section below for more customisation options.

Quick Links

Basic links with no icon. These are the School Links that have the ‘Student Orbit Quicklink’ checkbox enabled in Staff Kiosk Links > School Links (Maintain).

Homepage Grid

The icons/tiles on the homepage. See the ‘Homepage Tiles’ section below for more customisation options.

Today

An overview of what is happening for the student on the current day based on their eDiary.

Upcoming Activities

An overview of upcoming activities: curricular activities, events, and extra curricular activities.

Click the ‘View’ icon in the Action column to see more details about each element, or click the ‘Edit’ icon to make changes.

When editing an element:

  • Select the ‘Enabled’ checkbox to enable the element, or untick it to disable it.

  • Use the Sort Order field to specify the order in which the element will appear on the Student Orbit mobile app homepage.

  • Then click 'Save'.

Homepage Tiles

The 'Homepage Tiles' tab lets users personalise the tiles on the Student Orbit mobile app's homepage with customisable labels, icons, and sort order.

When 'School Link' is selected as the 'Type', the 'Target' list populates with enabled School Links for Student Orbit. If 'Link Category' is chosen, the 'Target' list shows available School Link Categories for Student Orbit.

Homepage Tiles Grid

The ‘Homepage Tiles Grid’ summarises the tiles that can be customised on the Student Orbit mobile app homepage.

Click column headings to sort rows ascending or descending. Drag column headings to reorder columns.

Column

Description

Enabled

This column indicates whether a tile is enabled on the Student Orbit mobile app homepage. 'Y' means it is enabled, while 'N’ indicates the homepage tile is not enabled.

This field indicates whether the tiles are visible on the Student Orbit mobile app homepage; it does not activate the feature or control user access.

To enable app features for your school, activate the API endpoint in TASS.web System Admin > Utilities > API Gateway Maintenance under the ‘OAuth2 API Applications’ tab. Select ‘Edit’ in the Action column for ‘ORBITSTUDENT’, select the required ‘OAuth Scope - API Access’ checkboxes, then ‘Update'.

The security permissions for Student Cafe control student access to features in the Student Orbit mobile app. Permissions can be activated or deactivated in TASS.web System Admin > Users > Portal Security Permissions.

Tile Label

This column shows the label displayed on the tile within the Student Orbit mobile app homepage

Type

This column shows the Target Type the tile leads to.

Value

This column shows the Target Value selected in the Target field.

Icon

Click the ‘Attachment’ icon to download the icon image.

Sort Order

This column shows the Sort Order of the tile and the order in which it appears on the Student Orbit mobile app homepage.

Actions

image-20250605-012857.png

Click the ‘View’ icon for more information about the Homepage Tile in a read-only format.

image-20250605-012909.png

Click the ‘Edit’ icon to modify the Homepage Tile configurations.

For more information about the options on the edit screen, refer to the ‘Adding a New Homepage Tile’ section below.

image-20250605-012920.png

Click the ‘Delete’ icon to delete the Homepage Tile configuration.

Adding a New Homepage Tile

Click the ‘+Add Tile’ button to create a new Homepage Tile for the Student Orbit mobile app homepage.

Fields that require further explanation

Enabled

Select this checkbox to enable the tile and make it visible on the Student Orbit mobile app. Untick this checkbox to disable the tile and hide it from view.

* Tile Label

Enter a tile label. This label will be displayed beneath the tile icon in the Student Orbit mobile app.

* Type

* Target

Select the type of target, and the target that the tile will open/display.

Feature

Select this option in the ‘Type’ field for the tile to open a TASS feature/menu option.

In the ‘Target’ field, select the feature you want displayed.

Options include:

  • Pastoral Care

  • Events & Payments

  • Extra Curricular Hub

  • eDiary

  • Daily Notices

School Link

Select this option in the ‘Type’ field for the tile to open a school link configured for Student Cafe.

School Links can be created and maintained in Staff Kiosk Links > School Links (Maintain). Select the ‘Student Cafe’ checkbox for the School Link to appear in this drop-down list.

Then, in the ‘Target’ field, select the School Link you want to be displayed.

Link Category

Select this option in the 'Type' field to connect the Homepage Tile to a specific School Link Category from Staff Kiosk Links > School Link Categories (Maintain).

School Link Categories can be assigned to School Links in Staff Kiosk Links > School Links (Maintain).

Then, in the ‘Target’ field, select the School Link Category you want to be displayed.

* Icon Type

Use this field to specify the tile's icon type. You can select a ‘Default Icon’ or upload a ‘Custom Icon’ image.

Example

An example of the default icons that are available in this program.

image-20250605-022657.png

When using a ‘Custom Icon’, the image size should be 100px x 100px, and the file types can be .gif, .png, or .svg.

* Sort Order

Use the Sort Order field to specify the order in which the tile will appear on the Student Orbit mobile app homepage.

Click ‘Save’ to save the new homepage tile.

Homepage Images

The 'Homepage Images' tab enables users to easily customise the homepage banner and slider images, background colour, and top text colour.

Homepage Images Grid

The ‘Homepage Images Grid’ summarises the tiles that can be customised on the Student Orbit mobile app homepage.

Click column headings to sort rows ascending or descending. Drag column headings to reorder columns.

Column

Description

Enabled

This column indicates whether an image is enabled on the Student Orbit mobile app homepage. 'Y' means it is enabled, while 'N’ indicates the image is not enabled.

Image Num

This column shows the automatically assigned image number.

Image Type

This column indicates the type of image. It can either be a ‘Slider Image’ or a ‘Banner Image’.

Sort Num

This column shows the Sort Order for Image Sliders only.

Image

Click the ‘Attachment’ icon to download the icon image.

Actions

image-20250605-012857.png

Click the ‘View’ icon to see more information about the Homepage Image in a read-only format.

image-20250605-012909.png

Click the ‘Edit’ icon to modify the Homepage Image configurations. For more information about the options on the edit screen, refer to the ‘Adding a New Homepage Image’ section below.

image-20250605-012920.png

Click the ‘Delete’ icon to delete the Homepage Image, and its configurations.

Adding a New Homepage Image

Click the ‘+Add Image’ button to create a new Homepage Image for the Student Orbit mobile app homepage.

Fields that require further explanation

Enabled

Select this checkbox to enable the image and make it visible on the Student Orbit mobile app. Untick this checkbox to disable the image and hide it from view.

Image Num

This is a system-allocated sequential number that increments automatically.

Image Type

Select the Type of image:

Slider

A collection of images that slide across the Student Orbit mobile app homepage. They rotate on the homepage carousel to promote events and share information with students.

Use image sliders to market school events or showcase photos of student activities, such as sports, musicals, or excursions.

Image files can be JPEG, GIF, or PNG. The recommended size is 400px by 220px.

Important!

Image Sliders resize based on width (to fit the whole panel). Ratios less than 2:1 are not recommended, as the image will extend beyond the visible panel (vertically).

The larger an image's file size, the longer the Student Orbit home page takes to load.

Banner

A single image at the top of the Student Orbit mobile app homepage.

Image files can be JPEG, GIF, or PNG. The recommended size is 500px by 300px.

When a banner image is uploaded to Student Orbit, its dimensions are automatically resized to 500x300px to meet the app’s requirements.

Background Colour

Enter the HEX code that you want to use as the background colour for the Student Orbit mobile app homepage.

Top Text Colour

This option is only available when ‘Banner’ is selected as the Image Type. Enter the HEX code that you want to use as the top text colour for the Student Orbit mobile app homepage.

Image Hyperlink

This option is only available when ‘Slider’ is selected as the Image Type. This is Optional. Use this field to enter a URL for your Image Slider that students are redirected to when they select the image in the Student Orbit app.

Image Target

This option is only available when ‘Slider’ is selected as the Image Type and an ‘Image Hyperlink’ has been entered above. Select how you want your URL to open and display from the app: ‘Embedded’ within the app or in a ‘New Window’ outside the app.

Sort Order

This option is only available when ‘Slider’ is selected as the Image Type. Use the Sort Order field to specify the image's rotation order in the carousel.

Image

Click ‘+Choose’ to add a new image, ‘+Replace’ to change your image. For file guidelines, refer to the ‘Image Type’ section above.

Click ‘Save’ to save the new homepage image.

Colour Customisation

The 'Colour Customisation' tab allows users to personalise the colours within the app to match their school's branding and preferences on the Student Orbit mobile app homepage using HEX codes.

The default HEX codes on this tab are derived from the default colours specified for the API in TASS.web System Admin > Utilities > API Gateway Maintenance on the ‘OAuth2 API Applications’ tab via the ‘Metadata’ link in the Action column.

Fields that require further explanation

* Accent Colour

Enter the HEX code that you want to use as an accent colour. This colour will be applied to the top banner and buttons.

* Highlight Colour

Enter the HEX code that you want to use as a highlight colour. This colour will be used for the badge counter colour on the tiles.

* Icon Colour

Enter the HEX code for the primary icon colour you want to use. This colour will be used for the icons and daily digest buttons.

This colour acts as the darker shade when the ‘Two Tone Colour: Secondary Colour’ mode is chosen in the ‘Icon Colour Customisation' field.

Icon Secondary Colour

Enter the HEX code for the secondary icon colour. This field is optional, as it is used to select the secondary colour when ‘Two Tone Colour’ mode is selected in the ‘Icon Colour Customisation' field.

Tile Font Colour

Enter the HEX code that you want to use for the tile/icon label text.

* Icon Colour Customisation

Choose the icon colour style. This colour style will be applied to the icons. Options include:

Default

This option will use the default icon colour that has been specified TASS.web System Admin > Utilities > API Gateway Maintenance on the ‘OAuth2 API Applications’ tab via the ‘Metadata’ link in the Action column.

Two Tone Colour: icon colour used with gradient

This option will use the selected ‘Icon Colour’ as the darker colour and a gradient of this colour as the lighter colour.

Two Tone Colour: Secondary Colour

This option will use the selected ‘Icon Colour’ and ‘Icon Secondary Colour’ to create a two-tone colour icon.

Click ‘Save’ when complete.

Related Resources

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.