# TomorrowX Portal User Guide
Version 10 | Repository 2023-03-06 21:28:46.0
## Initial Steps
Upon first login to the portal application, you may choose to edit the **Unassigned** Company and role which are created by default. This is not required and if you prefer you may leave it with its default settings. Please note that you cannot delete this entry. This unassigned company acts as a fallback for users who have yet to be assigned a company and role once registered.
### **Grouped Permissions**
**Permissions are grouped by Company/Role/User**.
When you first create a resource i.e. a page, you will see that a permission is already assigned for that page. The default permission is always assigned as a global one. Meaning that everyone can **view**, **access**, **edit** or **download** that resource ***however the resource is not yet active or visible to anyone***. You will need to enable this option for the resource in question so that a user can **view**, **access**, **edit** or **download.**
Possible Permission Combinations
* When no company or role or specific user is selected a global permission is assigned and no other permission is allowed to exist.
* When only a specific company is assigned then all roles and users within that company can **view**, **access**, **edit** or **download** that resource.
* When only a specific company and specific role are assigned then all users of that company and role can **view**, **access**, **edit** or **download** that resource.
* When only a specific company, specific role and specific user is assigned, then only that user within the company and role selected can **view**, **access**, **edit** or **download** that resource.
The above combinations can exist in parallel between companies, roles and users in one resource.
## **Companies**
### **Add a new company**
**Actions**
* Navigate to **Companies** > **Add New** or alternatively use the **Add New** button on the Company's page.
* Complete the required fields and submit the form.
**Fields**
* **Company Name**
* Enter the company name **i.e. *****TomorrowX Limited***
* **Domain check**
* Enter the company’s domain name **i.e. *****tomorrowx.com** (without www)*
* **Unique/Short Name**
* Enter a unique name for the company **i.e *****tomorrowx***
* **Approver(s) email**
* Enter a high-level e-mail address for the company. Used for approving employee actions i.e. purchasing a training course or software trial license.
* **Accounting email**
* Enter an e-mail address for the company’s account dept.
* **Currency**
* Enter the 3 letter currency code for the company **i.e *****USD***
### **Edit an existing company**
**Actions**
* Navigate to **Companies** > **View All** and select the company you would like to edit by clicking the **Edit** link to the right of the company name.
* Make any relevant changes to the fields and submit the form.
**Fields**
* **All fields from** [**Add a new company**](#add-a-new-company) **above, plus:**
* **Assign Menu**
* Select a menu to assign to this company (see [Add a new menu](#add-a-new-menu) section)
### **Assign Support Agents**
**Actions**
* Navigate to **Companies** > **View All** and select the company you would like to assign a support agent to by clicking the **Support Agents** link to the right of the company name.
* Make any relevant changes to the fields and submit the form.
**Fields**
* **Assign a New Agent**
* **Support Agent**
* Select a user from the list to assign as a support agent
* **Make Head of Support**
* Select this option to set the user assigned above as the Head of Support of a company. Only one agent may be assigned to a company as a Head of Support. To assign a new Head of Support agent, delete the existing one first and then add a new agent.
* **Assigned Agents**
View/delete assigned agents
### Assign an IP Range
**Actions**
* Navigate to **Companies** > **View All** and select the company you would like to assign an IP Range to by clicking the **IP Ranges** link to the right of the company name.
* Make any relevant changes to the fields and submit the form.
**Fields**
* **Assign a New IP Range**
* **Start IP**
* Enter the starting IP Address. If no IP range is to be used simply enter a single IP Address here. i.e. **10.10.10.10**
* **End IP**
* Enter the ending IP Address. If no IP range is to be used leave this field empty. i.e. **IP Range: 10.10.10.255**
* **Assigned IP Ranges**
View/delete assigned IP Addresses
## **Roles**
### **Add a new role**
**Actions**
* Navigate to **Companies** > **Roles** > **Add New** or alternatively use the **Add New** button on the Roles page.
* Complete the required fields and submit the form.
**Fields**
* **Role Name**
* Enter a role name i.e. **Analyst**
* **Assigned to Company**
* Select a company to assign the role to
### **Edit an existing role**
**Actions**
* Navigate to **Role** > **View All** and select the role you would like to edit by clicking the **Edit** link to the right of the role name.
* Make any relevant changes to the fields and submit the form.
**Fields**
**All fields from** [**Add a new role**](#add-a-new-role) **above, plus:**
## Users
### Add a new user
**Actions**
* Navigate to **Users** > **Add New** or alternatively use the **Add New** button on the Users page.
* Complete the required fields and submit the form.
**NOTE: Before creating a user, be sure that the company as well as the role that the user will be assigned has already been created (see** [**Add a new company**](#add-a-new-company)**).**
**Newly created user account status is always set to Inactive once created and needs to be updated to an Active state before it can be used (see** [**Edit an existing user**](#edit-an-existing-user) **below).**
**Fields**
* **First Name**
* Enter the user's first name
* **Last Name**
* Enter the user's last name
* **Email Address**
* Enter the user's company e-mail address (must use the same company domain as below)
* **Company Domain**
* Select the user's company domain name
* **Mobile Number**
* Enter the user’s mobile number (used for receiving device verification codes, OTP codes etc.)
* **Company**
* Assign a company to the user - **see note above.**
* **Role**
* Assign a role to the user - **see note above.**
### **Edit an existing user**
**Actions**
* Navigate to **Users** > **View All** and select the user you would like to edit by clicking the **Edit** link to the right of the user.
* Make any relevant changes to the fields and submit the form.
**Fields**
* **User Details**
* **All fields from** [**Add a new user**](#add-a-new-user) **above, plus:**
* **User Internal Type**
* Select the appropriate user type i.e **Client, Admin, Partner, Unassigned**
* **User Account Status**
* Enable/disable the user’s account
* **Trusted Devices**
* View/delete user’s trusted devices
### User stats
**Actions**
View user login stats on this page.
## Menus
### Add a new menu
**Actions**
* Navigate to **Config** > **Menus** and select the **Add New** button on the Menus Overview page.
* Complete the required fields and submit the form.
**Newly created user menu status is always set to Inactive once created and needs to be updated to an Active state before it can be used (see** [**Edit an existing menu**](#edit-an-existing-menu) **below).**
**Fields**
* **Menu Name**
* Enter a name for the menu **i.e. *****Internal User’s Menu***
### **Edit an existing menu**
**Actions**
* Navigate to **Config** > **Menus** and select the menu you would like to edit by clicking the **Edit** link to the right of the menu name.
* Complete the required fields and submit the form.
**Fields**
* **All fields from** [**Add a new menu**](#add-a-new-menu) **above, plus:**
* **Status**
* Select whether this menu is active or inactive from the drop down menu
### **MENU LINKS**
#### **Add a new menu link**
**Actions**
* Navigate to **Config** > **Menus** and select the Menu Links button.
* On the **Menu Links Overview** page, select the **Add New** button.
* Complete the required fields and submit the form.
**Fields**
* **Link Name**
* Enter a name for the menu link **i.e. *****Downloads***
* **Link**
* Enter the URL path of the link **i.e. *****user/downloads***
* **Link CSS Class**
* Add a custom CSS class name to be used on the \ element of the menu.
* **Link CSS Icon**
* Add a custom CSS class name to be used on the \ element of the menu which displays the icon **i.e. *****fa fa-cog*****. (**See [fontawesome.io](http://fontawesome.io/icons/) for compatible icons)
* **Sub Links**
* Select whether this menu item will have children menu items (Active) or not (Inactive)
#### **Edit an existing menu link**
**Actions**
* Navigate to **Config** > **Menus** and select the Menu Links button.
* On the **Menu Links Overview** page select the menu link you would like to edit by clicking the **Edit** link to the right of the menu link name.
* Complete the required fields and submit the form.
**Fields**
**All fields from** [**Add a new menu link**](#add-a-new-menu-link) **above, plus any modifications you wish to make.**
#### Add sub menu links
**Actions**
* Navigate to **Config** > **Menus** and select the Menu Links button.
* On the **Menu Links Overview** page select the menu link you would like to add sub links to by clicking the **Sub Links** link to the right of the menu link name.
* Complete the required fields and submit the form.
**Fields**
* **Assign New Sub Links**
* **Sub link Name**
* Enter a name for the sub link **i.e. *****white papers***
* **Sub link URL**
* Enter a URL for the sub link **i.e. *****user/downloads/white-papers***
**Assigned Sub Links**
* View/delete sub links from a main menu link
#### **Set link permissions**
**Actions**
* Navigate to **Config** > **Menus** and select the Menu Links button.
* On the **Menu Links Overview** page select the menu link you would like to set link permissions for by clicking the **Permissions** link to the right of the menu link name.
* Complete the required fields and submit the form.
**Fields**
* **Assign New Permission**
* **Company**
* Select a company from the drop down list to allow access to this menu item.
* **Role**
* If you would like to further restrict access to this menu link select a specific role for the company selected above.
* **User**
* If you would like to further restrict access to this menu link select a specific user for the company and role selected above.
* **Assigned Permissions**
* View/delete assigned menu link permissions
### **Set up an existing menu**
**Actions**
* Navigate to **Config** > **Menus** and select the menu you would like to set up by clicking the **Setup** link to the right of the menu name.
* Complete the required fields and submit the form.
**Fields**
* **Assign New Links**
* **Links**
* Select a link from the drop down to assign it to the currently selected menu
* **Sort Order**
* Enter a number in order to set the position of the menu item within the menu
* **Assigned Links**
View/delete menu links
## Pages
### Add a new page
**Actions**
* Navigate to **Config** > **Pages** and select the **Add New** button on the Pages Overview page.
* Complete the required fields and submit the form.
**Fields**
* **Page Name**
* Enter a name for the page you are creating **i.e. *****Company Profile***
* **URI Collection**
* Enter the URI collection (group of pages) **i.e. *****profile***
* **URI Controller (Page)**
* Add a URI controller name (page) **i.e. *****pages***
* **URI Method (Action)**
* Add a URI method (action) **i.e. *****view***
### **Edit an existing page**
**Actions**
* Navigate to **Config** > **Pages** and select the page you would like to edit by clicking the **Edit** link to the right of the page name.
* Complete the required fields and submit the form.
**Fields**
* **All fields from** [**Add a new page**](#add-a-new-page) **above, plus:**
* **Status**
* Select whether this page is active or inactive from the drop down menu.
### Set page permissions
**Actions**
* Navigate to **Config** > **Pages** and select the page you would like to set permissions to by clicking the **Permissions** link to the right of the page name.
* Complete the required fields and submit the form.
**Fields**
* **Assign New Permission**
* **Company**
* Select a company from the drop down list to allow access to this page.
* **Role**
* If you would like to further restrict access to this page, select a specific role for the company selected above.
* **User**
* If you would like to further restrict access to this page, select a specific user for the company and role selected above.
* **Assigned Permissions**
View/delete assigned page permissions
## Downloads
### Add a new download
**Actions**
* Navigate to **Downloads** > **Add New** or alternatively use the **Add New** button on the Downloads Overview page.
* Complete the required fields and submit the form.
**Fields**
* **File Name**
* Enter a name for your download i.e. whitepaper 1
* **No. Of Downloads Allowed**
* Enter the max number of downloads allowed - Limit Downloads field below must be set to Limited in order to be active.
* **Limit Downloads**
* In order to limit a file to a certain number of downloads, set this to Limited and set the total number of downloads allowed above.
* **File Upload**
* Choose a file to upload.
* **Mark as Featured Download**
* Select this in order to mark your file as a “Featured Download”. Featured downloads are displayed throughout the site in certain locations.
### **Edit an existing download**
**Actions**
* Navigate to **Downloads** > **View all** and select the download you would like to edit by clicking the **Edit** link to the right of the download item name.
* Complete the required fields and submit the form.
**Fields**
* **All fields from** [**Add a new download**](#add-a-new-download) **above, plus:**
* **Visibility**
* Set whether the download is visible or not.
### **Set download permissions**
**Actions**
* Navigate to **Downloads** > **View all** and select the download you would like to set permissions for by clicking the **Permissions** link to the right of the download item name.
* Complete the required fields and submit the form.
**Fields**
* **Assign New Permission**
* **Company**
* Select a company from the drop down list to allow access to this download.
* **Role**
* If you would like to further restrict access to this download, select a specific role for the company selected above.
* **User**
* If you would like to further restrict access to this download, select a specific user for the company and role selected above.
* **Assigned Permissions**
* View/delete assigned file download permissions.
### Download Stats
**Actions**
View file download stats on this page.
## Solutions
### Add a new solution
**Actions**
* Navigate to **Solutions** > **Add New** or alternatively use the **Add New** button on the Solutions Overview page.
* Complete the required fields and submit the form.
**NOTE: Before creating a new solution, be sure that you have created the appropriate solution categories and solution industries (see** [**Add a new solution category**](#add-a-new-solution-category) **and** [**Add a new solution Industry**](#add-a-new-solution-industry)**).**
**Fields**
* **Solution Name**
* Enter a name for your solution
* **Solution Image**
* Enter the filename of the image to use as the solution image. Be sure to include the file type extension.
* **Synopsis**
* Enter a short synopsis for the solution. Used on sub-solution pages.
* **Description**
* Enter a longer description for the solution which will be displayed on the individual solution page. Use the WYSIWYG editor to style the information entered.
* **Deployment Requirements**
* Enter any deployment requirements for the solution which will be displayed on the individual solution page. Use the WYSIWYG editor to style the information entered.
* **Category**
* Select a category which the solution belongs in.
* **Industry**
* Select an industry which the solutions belongs in.
* **Mark as Featured Solution**
* Select this to mark the solution as a Featured Solution. Featured solutions are displayed throughout the site in certain areas.
### **Edit an existing solution**
**Actions**
* Navigate to **Solutions** > **View all** and select the solution you would like to edit by clicking the **Edit** link to the right of the solution item name.
* Complete the required fields and submit the form.
**Fields**
* **All fields from** [**Add a new solution**](#add-a-new-solution) **above, plus:**
* **Status**
* Set whether the solution is active or inactive.
### **Set solution permissions**
**Actions**
* Navigate to **Solutions** > **View all** and select the solution you would like to set permissions to by clicking the **Permissions** link to the right of the solution name.
* Complete the required fields and submit the form.
**Fields**
* **Assign New Permission**
* **Company**
* Select a company from the drop down list to allow access to the solution.
* **Role**
* If you would like to further restrict access to a solution, select a specific role for the company selected above.
* **User**
* If you would like to further restrict access to a solution, select a specific user for the company and role selected above.
* **Assigned Permissions**
* View/delete assigned solution permissions.
### **Solution Categories**
#### **Add a new solution category**
**Actions**
* Navigate to **Solutions** > **Categories** and select the **Add New** button.
* Complete the required fields and submit the form.
**Fields**
* **Category Name**
* Enter a name for the solution category**.**
* **Category Description**
* Enter a description for the category. Used on solution category pages.
* **Category Image**
* Enter the filename of the image to use as the solution category image.
#### **Edit an existing solution category**
**Actions**
* Navigate to **Solutions** > **Categories** and select the solution category you would like to edit by clicking the **Edit** link to the right of the solution category name.
* Complete the required fields and submit the form.
**NOTE: Setting a solution category to Inactive will result to hide all solutions assigned to it.**
**Fields**
* **All fields from** [**Add a new solution category**](#add-a-new-solution-category) **above, plus:**
* **Status**
* Set whether the solution category is active or inactive.
### **Solution Industries**
#### **Add a new solution Industry**
**Actions**
* Navigate to **Solutions** > **Industries** and select the **Add New** button.
* Complete the required fields and submit the form.
**Fields**
* **Industry Name**
* Enter a name for the solution industry**.**
* **Industry Description**
* Enter a description for the industry. Used on solution category pages.
#### **Edit an existing solution industry**
**Actions**
* Navigate to **Solutions** > **Industries** and select the solution industry you would like to edit by clicking the **Edit** link to the right of the solution industry name.
* Complete the required fields and submit the form.
**Fields**
**All fields from** [**Add a new solution Industry**](#add-a-new-solution-industry) **above, plus:**
## Web Stats
### View web stats
**Actions**
* Navigate to **Web Stats.**
* View user web stats in the table displayed.
* Clicking on table rows will expand the data displayed for a user.
* You may add an alias for a specific entry to keep track.
* **View User's Click Path** displays individual pages which the user has visited.
* Clicking on table rows will again expand the row and display more Geo IP information for the specific page which the user has visited.
## Portal Settings
### Edit portal settings
**Actions**
* Navigate to **Web Stats** > **Settings**.
* Complete the required fields and submit the form.
**Fields**
* **Support Email**
* Enter an email address to use as a support email sender/receiver.
* **Info Email**
* Enter an email address to use as an informative email sender/receiver.
* **Auto Respond Email**
* Enter an email address to use as an auto response email sender/receiver.
* **Maintenance Mode**
* Enable/disable site maintenance mode.
* **Trusted Device Limit**
* Set the max number of trusted devices for users.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.tomorrowx.com/cap/guides/tomorrowx-portal-user-guide.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.