---
title: "Activity Maintenance"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28392012/Activity%20Maintenance"
format: markdown
---
# Overview
The **Activity Maintenance **screen allows you to define how a screen, within Frameworks, is displayed and configured. Using activity maintenance you can customise your instance of Frameworks at the screen level (remove fields from a screen).
> Macro (include)
# What is an Activity?
An Activity is where an action can be performed by a user. Simply any time Frameworks opens a new tab, at the top of the screen, or window this is an Activity.
> ℹ️ **Examples of Activities**
> ℹ️
> ℹ️ - [My Shortcuts](https://kb.myframeworks.com.au/space/FRAM/445382659/About+the+Frameworks+Home+Dashboard#5.-My-Shortcuts)
> ℹ️ - [Supplier Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28390076)
> ℹ️ - [Credit Information ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28378802) is an activity however **Account Balance, Credit Data **and **Credit References **are tabs within the Credit Information activity.
# Accessing the Activity Maintenance Screen
To access the Activity Maintenance screen, perform the following:
1. Click the F**rameworks Menu** then navigate to **System Administration > Screens & Menus > Activity Maintenance** from the navigation tree.
2. Using the **Find/Edit** command button opens up the **Activity Definition Finder **allowing you to find and edit existing Activities in your Frameworks.
# Finding Activities to Edit
To find an Activity to edit, perform the following:
> Macro (include)
# Navigating the Activity Maintenance Screen
Once you open the **Activity Maintenance** Screen, you will be able to view, add, and edit the screen layout of an activity.
The Activity Maintenance screen is made up of 3 main sections. These are:
## 1. The Header (Details) Information
In this section, you are able to view and edit the Activities details.
> ℹ️ Click **New** or **Find/Copy** to define a new Activity and enter/updated the required details defined below.
The information displayed here is:
- **Device**: This defines on what type of device the Activity will be displayed.
- **All **is for all devices
- **Desktop**: is for desktop devices and Laptop devices
- **Tablet**: is for larger mobile devices
- **Handset**: is for smaller mobile devices
- **Key** **Type**: This defines if the Activity is a **System **(Global) or a **Site** specific Activity.
- **Key**: This defines the specific **Site/Customer ID **the Activity is related to.
- **Activity**: This is the unique identifier for the Activity.
- **Description**: The description for the activity is what is displayed in Frameworks. This will be displayed in areas such as the main menu, on the Activity tab, on the section heading and/or on the window heading.
> ℹ️ The **Description** field is the only editable field for existing Activities.
## 2. The Activity Maintenance Tabs
### 1. Details Tab
The **Details tab** displays the information about an Activities layout, elements and formatting.
> ❌ Any changes to the **Details Tab** should ONLY be done in consultation with [Sterland Support](https://kb.myframeworks.com.au/page/support). Any customisation to the details may be overwritten in future updates.
The Details tab consists of 2 sections:
#### **1. Activity Details**
In this section of the details tab, you can view and edit the following information:
- **Type**: This drop-down menu contains the Activities definition type. This is a template for the layout of the Activity.
- **Service**: This field defines the code used to run the activity.
- **Tab** **Icon**: This is the icon that will be displayed in the main menu and in the Activities tab.
- Click on the **Tab Icon **hyperlink to view all the available icons. Copy and paste the icon name into the field.
- Leave the field empty for no icon.
- **Export and Import**: The **Export** and **Import** buttons allow you to export and import the Activity Details as an *.xml file.
#### **2. Element Details**
In this section of the details tab you can view and edit the following information:
- The screen **elements** grid, this displays each items **Sub Key, Name **and **Value. **Click on a line to view the details to the right.
- The screen **elements **details, these are:
- **SubKey**: This is the type of action that an element is performing.
- **Name**: This is the name of the element. The format for this is **tableName.fieldName**
- **Value**: This is the value of the action for the element.
- **Contract** **Type** and **Contract**: additional code to perform a task.
### UI Definition
The **UI Definition** allows you to modify how the system looks. The JSON string (in the **UI definition** tab) correlates with what is displayed on the screen.
> ❌ Any changes to the **UI Definition **should ONLY be done in consultation with [Sterland Support](https://kb.myframeworks.com.au/page/support). Any customisation to the UI Definition may be overwritten in future updates.
### Site Customisation
The **Site Customisation **tab allows you to customise Frameworks for selected elements on the screen/s.
> ⚠️ Any customisations should be done in **Site Customisation. **This allow you to keep changes you have made even when your Frameworks is updated.
These SubKey elements including:
- **Item format**: This option allows you to edit the format of a field, for example, the value of number of decimal places might be ***>>>,>>9.99 ***or the max number of characters might be ***x(30).***
- **Item hidden**: This option allows you hide items from being visible on the screen or window.
- **Item Label**: This option allows you to rename/re-label a field.
- **Item** **Read-Only**: This option allows you to disallow editing for a specific field and view is only.
- **Item Tooltip**: This option allows you to add a Tooltip when hovering over a field.
- **Window height/Window width**: These options allow you to change a fields height and width.
> ✅ Refer to [Site Customisations](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30531106) for more information on how to customise fields in you Frameworks.
## The Command Buttons
Using the **Command Buttons **you are able to:
- Define a new activity by clicking on the **New** button.
- Create your own site customisations using the **Find/Edit** button.
- Copy an existing Activity by using the **Find/Copy **button.
- **Save** or **Cancel** any changes made and **Close** the Activity Maintenance screen.
> ❌ Caution should be taken when using the **Delete **button.
# Additional Information
> ✅ Refer to [Site Customisations](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30531106) for more information on how to customise fields in your Frameworks.