Online Standard Documentation & Video Tutorials (FT-2001.005)

About this document

Scope

This document provides background information as well as a functional description of the FT-2001.005 Online Standard Documentation & Video Tutorials standard feature. The described feature is supported from the release version 4.0 onwards.

Note

Online Standard Documentation & Video Tutorials is a standard feature and does not require a special license.

This feature is part of the Documentation functionality with number FN-1030.

Feature Availability

Feature overview

Goals

The aim of the Online Standard Documentation & Video Tutorials feature is to provide links that allow Enterprise Users to access external web pages, that host information about the APIs used in the CMP and the Enterprise Portal User Manual.

Functionality of the feature

CMP allows to define links that allow accessing external web pages, that host the API documentation of the CMP and also the Enterprise Portal User Manual. The Account Administrators are required to define the URLs that direct the Users to the documentation. In case no documentation is available via the defined link, the following statement will be displayed: “No documentation available”.

Note that the API documentation link is intended only for Users whose role requires them to have knowledge of APIs, however, the API documentation link is optional and will remain invisible if no Users possess the required Access Rights.

The external web pages hosting the documentation could be branded environments created specifically for customer access, furthermore CMP allows to set up URLs that link directly to the web-hosted documentation of the customer.