UnifyTutorial

From VYRE

Jump to: navigation, search


Tutorial Introduction
Unify Tutorial
Unify Tutorial Series
Series Beginner
Unify Tutorial Introduction
Position in series 1
Next in Series Building a Basic Site
Prerequisites Installing Unify


Contents

Introduction

VYRE Unify is a content management platform that enables the creation and management of dynamic websites and applications. It is a Portlet based application written in Java that runs in the Apache Tomcat application server.

Unify runs as two separate web applications which are referred to as vyre4 (back end) and www (front end). The back end interface is deployed on the vyre4 context path and as such is accessed by adding "vyre4" after the domain name or IP address of the instance E.G. http://tutorial.vyre.com/vyre4. The back end is the interface through which the developer would create and manage the system and the front end is the end user view of the system. The majority of user created data is stored as XML on the file system. Unify then offers a suite configurable portlets to offer a range of functions. Each portlet has at least two modes: an edit mode which is only available to the back end (vyre4) user and allows the configuration of the portlet instance, and a view mode which displays the output of the portlet; the view mode is available to both front and back end. For more information on working with portlets see: Working with Unify Portlets.


Back end (vyre4) User Interface

To get started we first need to log in to the back end. By default, all Unify instances come with one admin account which is configured on first log in. Contact your Unify administrator if you aren’t aware of the admin account credentials. If you’ve just installed the system yourself you’ll be prompted for a username and password on first login.

Navigate to http://tutorial.vyre.com/vyre4 replacing "tutorial.vyre.com" with the domain name of your instance. If you’ve installed this yourself and / or you don’t have a domain name, then the IP address of the server on which Unify resides is suitable. E.G. http://192.168.1.110/vyre4.

Once you’ve logged in, you’ll be presented with the back end interface shown below:

Unify Backend Interface

The interface is split into 3 main sections as shown in the diagram above.

  • Left hand menu frame – This is the main navigation pane and is split into two sections. At the bottom is the module navigation that allows the user to switch between modules. The top section shows module specific menu options.
  • Top navigation – This area shows contextual navigation related to the selected option in the left hand menu.
  • Main content frame – This window is the main working window which could show the web page you are working on, a JavaScript file you could be editing or a portlet you might be configuring. This is where you will do most of the work.

Unify is split into 5 modules: Publishing, Content, Reporting, Users and Groups and Configuration which are briefly outlined below.

Publishing Module

Publishing Module Navigation

The Publishing Module is the area for working with presentation specific components for creating / modifying sites, pages and code. Some key information is listed below:

  • Sites – One instance of Unify can serve multiple websites simultaneously with the ability to bind multiple domain names to each site. This is the area that holds each of the sites and their pages.
  • Files – This area holds all the publishing resources such as CSS, JavaScript and XSL files as well email templates and other Unify specific code.
  • Page Templates - Unify uses page templates to define a common look and feel across multiple web pages.
  • Pages – Every page is based on a page template. Pages are accessed from within the site menu.

All Unify publishing entities (pages, page templates, code) are deployable. This means that they can be worked on in the back end, without the changes being visible on the front end. Once the entity is in a ready state, the entity can be deployed. This has the effect of compiling and copying the entity to the front end web application, making it available to the end user.

Content Module

Content Module Navigation

The Content module is the area for working with all things data related.

Here you can create and configure content repositories for holding your data, search and view your data, upload files and create configurations for exporting and importing data.

There are two different types of content repositories: Data Stores and File Stores. Data stores are for holding textual data such as news articles or blog posts whereas file stores hold binary data such as images or audio files.

Stores contain attributes of specific data types that define the structure of the data to be kept in the store. Each store comes with default attributes – name, description and keywords, as well as system created values for the creation date, last modification date, creator and last modifier. You can also add custom attributes and attribute types to better fit your data. It is also possible to create relationships between stores by linking items. For example a store holding blog articles, could be linked to a store holding comments to represent the comments on a particular blog article.


Reporting Module

Reporting Module Navigation

The Reporting module allows administrators to configure and save custom SQL reports directly to the Unify database. It is also the area for viewing analytic data on items such as view count, and performing data integrity checks.


Users and Groups Module

Users and Groups Module Navigation

The Users and Groups module is the configuration area for users, groups and their permissions. Unify uses the concept of a realm to define a collection of users authenticated against a specific data source. By default Unify come with one realm known as the default realm which authenticates against a local database. More realms may be added if needed, and it's possible to connact to a LDAP source such as Microsoft's Active Directory. This module holds the Audit Trail which tracks the actions of users both in the front and back ends of the system, as well as managing configurations for synchronising the user base with third party forums.


Configuration Module

Configuration Module Navigation

The Configuration module holds information about the system such as memory usage and process queues and allows the configuration of certain aspects of the system.

Personal tools