Sites
The Sites tab allows users to manage the sites created. These sites are the location where you can publish the snapshot via the CMS route.
Module Interface
| Interface | Description | Required Privilege |
|---|---|---|
| CMS Site | Allow to view to CMS Sites. | mod-cms-site |
| CMS Site | Allow to edit CMS Sites metadata. | mod-cms-site-edit |
| CMS Site | Allow to publish Snapshot to CMS Site. | mod-cms-site-publish |
Add Site
This function allows you to add a site to publish your article or content.
To do so, click on the “Add” button at the upper right corner of the page.
The “New Site” dialog box will appear.
| Field | Description | Input Type | Default Value |
|---|---|---|---|
| Name | Name of the site. | Text field | Empty |
| URL Prefix | URL prefix of the site (optional). | Text field | Empty |
Key in a unique name in the “Name” field and a URL prefix in the “URL Prefix” field. If the name exist or no name is provided, the relevant error message will appear when attempt to save the new site.
Click on the “OK” button to save the new site. To abort, click on the “Cancel” button.
Once the new site is added, it will appear in the management page as unpublished, private and enabled.
Edit Site
This function allows you to edit the properties and roles of the site.
To do so, click on the 
“Edit” icon under the “Actions” column corresponding the desired site. The “Edit Site” dialog box will appear.
| Field | Description | Input Type | Default Value |
|---|---|---|---|
| Name | Name of site. | Text field | As per defined |
| Description | Brief description of site. | Text field | Empty |
| URL Prefix | URL prefix of site. | Text field | As per defined |
| Public | If selected, this site will be public. If not selected, this site is private. |
Checkbox | Not selected |
In the dialog box, you can edit the properties of the site, such as name and URL prefix. Make sure the name of the site is unique. If the name exist or no name is provided, the relevant error message will appear when attempt to save the new site.
You can also enable or disable the site and set the site as public or private. A disabled site cannot be published.
Click on the “OK” button to save the changes.
View Site
This function allows you to preview the content of the site already published without going to the site itself.
To view the site, click on the 
“View” icon under the “Actions” column corresponding the desired site.
The content will be displayed in another window tab. Do note that this function is available for published sites only.
Publish/Unpublish Site
This function allows you to publish a snapshot onto a site. A disabled site cannot be published.
To publish a site, click on the 
“Publish” icon under the “Actions” column corresponding the desired site. The “Publish Snapshot” dialog box will appear.
Select the desired snapshot from the drop-down list. Click on the “OK” button to publish the snapshot onto the site. To abort, click on the “Cancel” button.
Once the site is published, it will not be editable. You will need to unpublish it, in order to edit the site. The site is published via the CMS route using the URL prefix defined. For example, if the URL prefix is site1, the site will be published with URL as http://localhost:1740/cms/site1. If the URL prefix is empty, the URL will be http://localhost:1740/cms.
To unpublish a site, click on the 
“Unpublish” icon under the “Actions” column corresponding the desired site. A dialog box will appear prompting you to confirm the action.
To confirm the action, click on the “OK” button. Clicking on the “Cancel” button will abort the action. Once the site is unpublished, it will be editable.
Delete Site
This function allows you to delete a site that is not published. Once a site is published, you need to unpublish the site to delete it.
To delete a site, click on the 
“Delete” icon under the “Actions” column corresponding the desired site.
There is an option to undo the deletion. A notification with an “Undo” button appears right after clicking on the “Delete” icon.
Upon clicking on the “Undo” button, the deleted site is restored and is added back to the list of sites.
More Actions
This feature allows user to perform actions on multiple sites at the same time.
When the “More Actions” button located at the upper right corner of the page is clicked, a list of available actions are displayed.
If no site is selected prior clicking the button, there will be fewer actions available. To select a site, select the checkbox next to the name of the site.
| Option | Description |
|---|---|
| Select All | Selects all sites in the list. |
| Select None | Unselects all sites. |
| Invert Selection | Inverts the current selection. That is, any sites selected will be unselected and vice versa. |
| Set Roles | Selects the roles to be assigned to the sites. |
| Set Enabled True | When selected, sets the selected sites to enable. |
| Set Enabled False | When selected, sets the selected sites to disable. |
Set Roles
To set the roles for the selected sites, click on the “More Actions” button and select the “Set Roles” option. The “Set Roles” dialog box will appear.
Select the roles to have access to the site by selecting the checkboxes. Alternatively, you can search for the desired role by keying in the keyword in the search function at the top of the dialog box. You can also choose to select all, select none or invert selection by clicking on their respective icons on the right of the search function.
Click on the “OK” button to save the changes or click on the “Cancel” button to abort the action.
Set Enabled True/False
To enable or disable the sites, click on the “More Actions” button and select the “Set Enabled True” or “Set Enabled False” option respectively.
The selected sites will be enabled or disabled as selected.
An enabled site is represented with a green tick under the “Enabled” column, while a disabled site is represented with a red cross.
Refresh
After performing actions on the browser/tab, the list is reloaded to display the list of sites. The manual “Refresh” button is available and is particularly useful if you have opened multiple pages and are making changes in these sites.
The “Refresh” button is found on the upper right corner of the page. Clicking on it reloads the list of sites.
Search
There is a cross-field search function for the list of sites. It is located at the upper left corner of the page.
This provides an easy way to search through the site list. It is case-insensitive and display sites that have the entered search value in any of the values of the fields below:
- Name
- URL Prefix
- Published Date
- Snapshot
- Owner
- Roles
- Last Modified
Alternatively, you can click on the any snapshot, owner or role under the “Snapshot”, “Owner” or “Roles” columns respectively to aid the search for the sites in the page.
In the example above, site that publishes the snapshot “I18N Snapshot” is shown.
These two search methods can be combined together, with each criteria separated by a comma.