ConfigPortal - Configuration Interface [C OG]
Please note that for ConfigPortal in a VidiNet context, not all of the use case pages and function described here are available. Please refer to VidiNet’s ConfigPortal documentation for more details.
An Introduction to ConfigPortal
ConfigPortal is the entry point for configuring any of the members of the product family. ConfigPortal provides users with a palette of configuration Pages that are mostly themed on functional use case scenarios, entire system configurations as well as external interfaces. This provides users with a streamlined and organized approach for managing configuration topics. Additionally, different aspects relevant to particular use case scenarios have been grouped together in a logical manner, preventing users from having to unnecessarily navigate through ConfigPortal’s UI. All available from a single unified Use Case Page.
Besides the GUI, an Application Programmable Interface (API) also forms part of the ConfigPortal to deliver the configuration parameters to the different products. The file-based data store, the configuration repository, is the part of the product that persists the configuration data.
What are the benefits that come with the ConfigPortal?
Users are able to enact configurations for their entire product family from a web frontend.
The ConfigPortal-GUI provides a user-friendly interface structured in use cases.
Accurate and reliable versioning of configuration data in the ConfigPortal backend.
Detailed change history of the configuration data.
Editable Staging scenarios are realized, allowing to test and troubleshoot the system.
Key Features
The list below offers an overview of the key features offered by ConfigPortal. Each of these features is described in detail in dedicated sections.
Active Staging allows functional copies of your systems to exist in different Environments for the purpose of testing, troubleshooting and system debugging.
Active Notifications are used to notify different products of configuration changes, avoiding the necessity of manually restarting components after a change.
Versioning of configuration data in the backend allows for configuration change transparency.
Change History is represented via a timeline, informing users of configuration changes over time.
Development Toolkit usable by 3rd party integrators when developing features using the product family integration possibilities.
User Management of ConfigPortal to allow different users different options on configurations like add, edit, view.
Workflow Designer integration to manage workflow definitions in CP and to connect use cases to dedicated workflows.
Global MAM configuration such as paths or metadata can be managed inside the ConfigPortal as global objects usable in use cases.
General Pages managing functionalities of ConfigPortal, such as editable Staging inside the GUI.
Reading this Document
It is important to note that the ConfigPortal topics covered in this document are based on the totality of products and their Use Case Pages for this particular release. A customer’s system and ConfigPortal, may not include all of the products and respective Use Case Pages, as not all products or Use Cases may be present in their particular context.
Enterprise Requirements
ConfigPortal is delivered together and installed along with products. As such, ConfigPortal’s requirements are matched by the product intended for installation.
Please note that installation and setup is performed by Arvato Systems engineers.
Accessing ConfigPortal
Due to the sensitive nature of ConfigPortal’s capabilities and array of editing functions, it is important to note that access to ConfigPortal is restricted to certain user groups. Additionally, the functions and actions available to users are also limited to the roles available to the user.
Depending on the roles granted to specific groups and the users assigned to those groups, users may reach ConfigPortal entering the following address:
ConfigPortal
EXAMPLE ConfigPortal Link |
https://your_k8s_host/configportal/ui |