• No results found

ez Service Portal User Guide version 2.5.1

N/A
N/A
Protected

Academic year: 2021

Share "ez Service Portal User Guide version 2.5.1"

Copied!
27
0
0

Loading.... (view fulltext now)

Full text

(1)

eZ Service Portal

User Guide

version

2.5.1

(2)

Table of contents

Introduction... 3

Conventions... 3

Contacting eZ... 3

Copyright and trademarks... 3

Portal access... 4

Service Portal main page... 5

Certified eZ Software download section... 6

Maintenance and support agreement details... 7

Subscribing to update notifications... 8

Portal Access Management... 8

Adding users... 9

Authentication tokens... 9

eZ Support Services section... 11

Opening a new ticket... 12

Accessing the tickets... 14

eZ Publish monitors section... 15

eZ Publish monitors... 15

Current monitor value... 15

Monitor history... 15

Installation details... 16

eZ Publish updates section... 17

eZ Publish Updates... 17

Service Portal... 18

Download update summary... 18

Update overview... 18

The “Update history” link... 18

Name... 18 Description... 18 Created (UTC)... 18 Status... 19 Download... 19 Install an Update... 20

Automatic mode (version 4.5 or earlier)... 21

Semi manual mode (version 4.5 or earlier)... 21

Manual mode... 22

Update history... 23

Installing the eZ Network Client extension... 24

Single-sign-on... 26

First time authentication... 26

If not authenticated yet... 27

(3)

Introduction

This guide is written for users of the eZ Service Portal on eZ Systems' homepage. It is divided into sections, each dealing with separate functions or features available on the different webpages within the portal.

The eZ Service Portal, from now on referred to as “the portal”, is where you can manage your Support and Maintenance services.

In order to access this portal, you must have a user account on ez.no, which need to be associated with your subscriptions. This document describes how to use the portal.

Note that some of the information displayed in the Service Portal pages is not collected on the fly, but is updated with individual intervals.

Conventions

● Code samples, functions, variable names, etc., are printed in monospace font. ● Filenames and paths are printed in monospace italic font.

● Commands are printed in monospace bold font.

● Elements of graphical user interfaces (such as buttons and field labels) are printed in bold font.

● Component names (such as application and content class names) are capitalised, for example “Administration Interface” and “the Folder content class”).

● In sample URLs, replace “www.example.com” with the domain name of your site.

● The screenshots in this document might have been modified to fit the page or to illustrate a point, and therefore might not exactly match the display on your site.

Contacting eZ

To log a support request for your eZ Publish installation, use the support section of the portal. For non-technical questions regarding eZ Systems or eZ Publish, please contact us:

● http://ez.no/About-eZ/Contact-Us

[email protected]

We welcome your suggestions and comments on this guide. Please write [email protected].

Copyright and trademarks

Copyright © 2015 eZ Systems AS. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

(4)

Portal access

In order to access the portal, you need to log in to https ://support.ez.no. For this, you need a user account. If none has been provided for you, you can start by registering an account on https://login.ez.no/.

This account has to be associated with the portal. Contact your Account Manager with your eZ Business partner or eZ Systems to get help registering your account with your Service Portal.

A list of the portals available to you, can be found on the https ://support.ez.no page after logging in with an account that is associated with a Service Portal.

The first time you access a Service Portal, you might be asked to choose your user profile type. It is either: • Subscription holder: This is an employee or end user at the customer

Integration partner: This is an employee of the integration partner (eZ Systems partner) for your installation

The profile can be adjusted later on in “Portal access management” table (“Maintenance and Support agreement details” link).

(5)

Service Portal main page

The “Service Portal main page” is the portal's starting point. You can reach all the other pages and features in the portal, from this page.

You can use the “breadcrumbs” links following the label “support.ez.no” on the top right of this page, to quickly navigate back to the Service Portal main page.

This page is divided into sections, which are explained in details in this chapter. There are up to 3 service sections, and 2 administrative sections, depending on the support and maintenance plan, and user access level.

In the upper right corner of the Service Portal main page, there is a link to the “User Manual for Service Portal”, which is this document.

Below the link to the Service Portal documentation, there is a link to the certified eZ Software download section. The next chapter describes this section in more detail.

The drop-down list on the top left shows the user which other portals he has access to. Select a portal in the list, and click the

Select button to switch.

Below this drop-down list, you find the “Maintenance and Support agreement details” section, with general information

(6)

specific to your subscription.

Lower in the main screen you find 3 sections in a row, labeled eZ Support Services, eZ Publish monitors, and eZ Publish

updates. The last 2 sections (eZ Publish monitors and eZ Publish updates) are not relevant for SaaS-only subscriptions, i.e.

those that subscribe only to a “Software as a Service” solution, and not to eZ Publish itself. Such subscribers will see a simplified view of this page.

Each has an icon next to it, which indicates the current status of the service. The icons have different significance depending on the section it is used with. Their significance is explained in this chapter.

Certified eZ Software download section

Click the “Enterprise software downloads” link in the upper right corner in the Service Portal main page. You will now be presented with the following screen:

In this section you will find all available certified eZ Software, sorted by release numbers.

Certified eZ Software is software that has been tested and documented by eZ Systems, and is offered with support and maintenance services as part of the subscription products.

Click on the release you want, and browse through a simple hierarchy to find the desired certified eZ Software.

Click the file you wish to download1. A dialogue screen appears where you decide whether to open the file, or save the file to

disk.

Make your choices in the screen, then click “Ok” to start downloading the file. When the process is finished you continue with a normal upgrade as described in the upgrade documentation2 for the version you are installing.

1 By downloading these software packages, you agree to comply to the license agreements bundled with each of them.

2 http://doc.ez.no/eZ-Publish/Upgrading/Upgrading-to-4.4

(7)

Maintenance and support agreement details

In the upper part of the screen you will find the details about your maintenance and support agreement details. The maintenance agreement is shown just below the “Maintenance and support agreement details” as shown in Illustration 4: Subscription overview.

This screen shows you which support and maintenance plan you have selected, the renewal date for the service, and the current maintenance mode. Notice also the functionality for renewing or cancelling the agreement level.

Click “(more...)” by the lead text “Maintenance and

support agreement details” to find four new sections with your support agreement details, the installed eZ Publish software, information about the portal users, and authentication tokens (for eZ Publish 5.3 and newer) as shown in the screenshot below: This screen gives you the details of your

subscription information, the agreement level, which part of eZ Systems that handles your agreement, support response time, update mode, expiry date, support seats and support tickets left on the agreement, as well as the installation key. Listed in this screen is also the certified software included in your subscription.

Certain parts are not relevant for SaaS-only subscriptions, i.e. those that subscribe only to a “Software as a Service” solution, and not to eZ Publish itself. Such subscribers will see a simplified view of this page.

Further down you will find a list all the user accounts associated with the portal. From this screen you manage your users and

Illustration 4: Subscription overview

(8)

their access rights to the Service Portal.

Subscribing to update notifications

As a Support & Maintenance customer you can now manage your subscription to receive update notifications. You can do this in a user management interface for subscribing to update notifications. The functionality is delivered with eZ Premium service packs/eZ Premium installation.

Subscribing to update notifications: Follow the steps below to subscribe to update notifications:

• As a portal user, you log in to your portal, and click on the "Maintenance and Support agreement details" link to reach the “Portal access management” interface as shown in the screenshot below.

• You find your name in the user management table, and tick the empty checkbox in the "Update notification" column to the right of the user name.

• You click on the "Update settings" button below the table to confirm the choice.

• You receive an email with the confirmation that you have been subscribed to "Update notifications" for your Support & Maintenance agreement.

Unsubscribing to update notifications: Follow the steps below to unsubscribe to update notifications:

• As a portal user, you log in to your portal, and click on the "Maintenance and Support agreement details" link to reach the user management interface.

• You find your name in the user management table, and remove the tick in the checkbox in the "Update notifications" column to the right of the user name.

• You click on the "Update settings" button below the table to confirm the choice.

• You receive an email with the confirmation that you have been unsubscribed to "Update notifications" for your Support & Maintenance agreement.

Portal Access Management

Everyone who has access to the portal can view the list of all the users who have access to the portal. Do the following to find the interface where you can see the list of users. With portal administrator rights you will also be able to manage users and user access rights from the same screen/interface:

• In the Service Portal main page, select “Maintenance and Support Agreement details”

• In the “Service details” screen you will find the list of users at the bottom of the screen titled “Portal access management as shown in Illustration 6: Portal access management.

A brief explanation about the different properties listed with each of the users in the “Portal access management” table:

(9)

Property Description

Portal administrator Users with this checkbox ticked have the privilege to add and remove other users, in addition to grant other users the “Portal administrator” privilege, and to subscribe and unsubscribe users to the Update notifications (see next property).

Update notifications Update notifications are email sent out by eZ Systems when a new Update is available for any of the eZ Software included in the subscription. To see a list of this software, refer to the “Maintenance and support agreement details” page. When a user subscribes or unsubscribes another user to the Update notifications, an email is sent to inform this user about the change, including the name of the user who performed the change on his behalf.

Integration partner If you are an integration partner, you should indicate this by ticking this checkbox. This will enable the portal to show you information formatted for you, and ensure that the links include the parameters needed to allow integrated systems to also present you with the most efficient interface for your usage. If the checkbox is not ticked, then the portal assumes you are a representative of the subscriber. Note: This feature is currently only in use with a small test group.

Adding users

As a portal administrator you can also grant and revoke access to other users, by using the "Add users" and "Remove users" button below the table as shown in Illustration 6: Portal access management.

You add a new user by clicking the “Add users” button and enter the e-mail address of the new user in the dialog box shown in the Illustration 7: Add users.

Either you can enter the complete e-mail address directly, or you search for the correct e-mail address by entering known parts of it and pressing the “Search” button.

The results of the user searches is listed under the “Results” label. Select the user/users you want to grant access to by ticking the box next to each user. Then click on the “Give access” button to grant the user access. The user will now end up in the list of users in the “Portal access management” screen.

As a user with "Portal administrator" privileges, you can also subscribe

and unsubscribe users to the update notifications. See “Subscribe to update notifications”

The portal administrator is limited to add users up to, and including, the limit indicated by the "Support seats" value under the label "Subscription information" on the same page. Additional Support seats can be purchased by contacting eZ Systems Sales team.

Authentication tokens

At the bottom of the service details screen you will find the authentication tokens, see Illustration 8: Authentication token list. As a portal administrator you can generate authentication tokens to be used with the new, Composer-based software update system. Please note that this update system is only available for eZ Publish 5.3 Platform and newer, and for upgrades to these releases. This section also lists all the tokens associated with your installation, and lets you delete tokens that are no longer needed.

Illustration 7: Add users

(10)

You can make more than one token if you want to for organisational reasons. You create a new token by clicking the “Create token” button. This opens a dialog box where you enter a label, which is used to identify the token for yourself and your organisation. A password is displayed, which you must enter in your server configuration. This enables your server to download software updates from the eZ Systems update server.

The dialog lets you copy the password to the clipboard. After you have done so, click “Create” to add the token to your list of active tokens.

NB: You must save the password you see in the Create token dialog. After this dialog is closed, the password can no longer be retrieved. If you lose the password, you must remove the token and create a new one.

To remove one or more tokens, select the ones you want in the list, and click “Remove tokens”.

For more information, including how to enter the password in your server configuration, please see the documentation on “Using Composer with eZ Publish”:

https://doc.ez.no/display/EZP/Using+Composer

(11)

eZ Support Services section

This section provides information related to support services. Any kind of request can be submitted via the Customer Support Desk, even though it may not seem like a support request. The support team will help identify the right person or team to handle the request whenever possible.

For the sake of collaboration and continuity, everyone who has access to the your service portal has also access to the tickets. These users can then view and collaborate on tickets, and also open new tickets.

In this section you will find the following information, depending on the details of your subscription:

• List tickets (see chapter below). • Open new ticket (see chapter below)

• “Pre-paid consulting tickets left” – shows how many consulting tickets are left for this customer.

• “Support history”- shows list of completed tasks and completed issue reports with number of tickets charged for each of them. Includes both paid and unpaid services.

• A list of the latest updated tickets from the support ticket tracker. It will list up to 5 tickets.

• “eZ Market extension support” - a link that lead to a page with contact information to the different authors of the eZ Market software. These must be contacted for support for the eZ Market software.

A symbol next to the issue description indicates the status of the issue, as explained in this table:

Unresolved issue

The triangle symbol means that the issue is not yet resolved, and is considered still open.

Resolved issue

The arrow symbol means that the issue has been resolved and has been closed by a support consultant.

(12)

Opening a new ticket

In the “eZ Support Services” section in your service portal, click on the “Open new ticket” link, in order to access the Customer Support Desk to submit a support request.

You will then see a page similar to the below screenshot.

Explanation of the most important elements on this page:

1. "Subscription": You will see a list of the subscriptions you have access to, and you are required to select the one associated with your request.

2. "Subject": Enter a short headline summarizing the request. 3. "Description": Describe the request.

i. If this is a report of something that does not work as expected, please include the steps your take, and both the expected and actual results. We recommend that you include the following information as part of the description of the problem in order to facilitate a fast resolution:

▪ Server operating system.

▪ eZ Publish version, and cluster mode if in use. ▪ Database server, and version.

▪ Extensions, if involved in the problem description, and what versions of the extensions.

ii. We recommend also to describe what business goal you are trying to achieve, as there could be more than one approach to achieve it, which the support team may suggest.

iii. Files can be attached to the ticket only after it has been created.

To ensure that the support team can start working on the problem right after receiving the ticket, we recommend that you read through your description once more before submitting it. If the support team need to ask for additional information, then time will be lost while waiting for the feedback, extending the resolution time.

Confirmation of the ticket creation, and additional notifications when updates are made to it, will be sent to the ticket reporter and everyone who comments on the ticket, via email.

(13)

After you submit the ticket, it will be displayed to you like the example in the screenshot below, with a ticket number.

Explanation of the most important elements in the screenshot:

1. The box on the top right shows information about the ticket and its status.

2. Below the description field are the comments; both from support agents and customers, with the name of the author and a time stamp.

3. At the bottom the customer can enter a new comment or file attachment.

(14)

Accessing the tickets

In the “eZ Support Services” section in your service portal, click on the “List tickets” link, in order to review the tickets opened under this subscription.

You will then see a page similar to the screenshot below.

Explanation of the most important elements in the screenshot:

1. "Select subscription you want to filter with": If you have access to more than one subscription, then you can filter the list of tickets to only those associated with a single subscription, or select "All" from the drop-down menu to include tickets from all subscriptions in the list.

2. "Filter with keywords": To filter the list below, enter a text that the tickets must contain and click the "List tickets" button. Consider this a simple search feature.

3. "Include closed tickets in the list": By default, the list only includes open tickets. Ticking this checkbox includes closed tickets in the list. In the example above, this checkbox is ticked, so the list contains also resolved and closed tickets.

4. "Subject" column in the list: The subject of the ticket also serves as a link to show the ticket in full, with available actions.

Clicking the “Load more tickets...” button appends additional tickets to the list, if there are any.

To view a ticket, click on its link in the “Subject” column in the list, and you will see a page similar to the example screenshot in the previous section.

(15)

eZ Publish monitors section

The monitor section lists certain configuration items and statistics that have been extracted from the eZ Publish installation. The eZ Publish monitors “(more...)” link goes to a page that lists all the available monitors, with their current status, and the possibility to see historic data as described below.

eZ Publish monitors

This page lists the items that are being monitored and their current status. Monitor statistics are gathered via a group of PHP scripts that are installed on the eZ Publish installation. The scripts are run at specified intervals and the results of the tests are uploaded to the eZ server. Monitor scripts are automatically updated by eZ Network.

Current monitor value

The details links show the result from the most recent time that the network monitor item was run. Below is an example of the value reported by the Language name list monitor item.

● Test description – Short description of what the monitor item does. ● Status – Monitor test status. Either OK or FAILED.

● Value – Monitor result value used to determine status. ● Description – More detailed result description.

Monitor history

The history link displays a view with the monitor item's result history. The historical values are presented differently depending on the kind of data that is being monitored. Some values are presented as logs, while other are presented as graphs.

Illustration 11: Monitor detail example

(16)

Installation details

A green symbol next to the section label means that all monitors are reporting in, and a red symbol means that a monitor is not running properly, or is not reporting the expected value.

The installation details view is displaying monitor values, in a mixture of text and graphs, all in one page.

In order to access the installation details view, you need to click on the Watch more >>> link below the graphs on the Service Portal main page.

Each value is delivered by an individual monitor script which is ran on the eZ Publish installation.

Which monitor script is in use, depends on the eZ Publish branch, so your portal may display a somewhat different range of monitor values than the example screenshot below.

This page is divided into the following sections:

● System facts – Lists some of the environment elements used by eZ Publish. ● Statistics – Displays a graphical representation of collected content and visitor data. ● Extensions – A list of extension used by the eZ Publish installation.

● Kernel – If the kernel is modified, this section would reveal it.

● eZ Publish installation – A list with the languages available for content translation, the number of active siteaccesses, and the character set used by the stored content.

(17)

eZ Publish updates section

This section presents an overview of the most recent updates available, and their status.

Update pending

The “pending” symbol means that the update has been made available to the installation, but not yet installed.

Update installed

The “installed” symbol means that the update has been installed.

All patches that meet the criteria for critical and security issues specified in support and maintenance contract, are made available to the subscribers as updates3.

There is a traffic-light symbol next to the “eZ Publish Updates” header, which indicates if there are updates to urgently install. The different colours mean as follows:

• GREEN: All available Updates are installed. No action needed.

• YELLOW: There new available Updates pending to be installed, though none of the “Security Patch” type. Please review the Updates.

• RED: There are Security Patch Updates available, or there are Updates that have been pending installation for more than 2 weeks. Please review the Updates.

If there are pending Updates, then you may click on the eZ Publish Updates “(more...)” link, to see the overview of available Updates, download updates, and manage their status. These features will be described in this chapter.

eZ Publish Updates

The eZ Publish updates “(more...)” link leads to an overview of the available updates for your eZ Publish installation, and their status:

The above illustration shows several features that will be explained in this chapter.

3 As of version 4.6 of eZ Publish we have opted for a patching solution that provides only manual patching.

(18)

It is on this page, described later in this document, where you may choose to install the update, or download the patch, depending on the “Patch mode” selected. The selected mode is shown by clicking the “Maintenance and support details” lead text” and look in the Subscription information section in the “Service details” section.

Service Portal

Select one of the eZ Publish subscriptions you have, to see the Updates available to you.

Download update summary

This button allows you to download a comma-separated list of values (CSV) in a text file, which lists all the Updates that have been distributed to your version of eZ Publish, including eZ Extensions. The list shows you the name of the Update, what branch the Update is made for, its status of either Installed or Pending, when it was distributed, and a link to download the Update.

Update overview

This is the list of branches available to you. Basically, a “branch” refers to a specific version of a specific piece of software. In practical terms, this means the eZ Publish kernel itself, and all the eZ Extensions that you are entitled to. Updates are distributed per such branch, and you need to select the branch you want to see the available Updates for.

The items in the Update overview drop-down menu will also show how many Updates are installed out of the available Updates for each of the branches (kernel + extension) included in your subscription, to give you a quick indication of how up-to-date the eZ Publish installation is.

The “Update history” link

This is a link that redirects to a page that allows the user to see who installed or uninstalled which Update at which time. This feature is only available if the Service Portal has “Manual” Update Mode selected, and is described in more details in the “Update status history” section of the “Install an Update” chapter.

These are the elements of the table with the Updates:

Name

The name of the Update, indicating the type of Update, the distribution year, a serial number, and the branch it was made for.

Description

This is a more detailed description of the Update, and what problem it is meant to resolve, and the effect of it.

Created (UTC)

(19)

Status

The status indicates whether or not the Update is Installed or Pending. When the Update is distributed by eZ Systems, it becomes listed in this table with the default status of Pending.

The “Install an Update” section in this guide explains how the different Update Modes uses this status field. The update status can have the following values:

None – The Update is not yet approved, and will not be installed until it is approved by you. This status is not used if

the Update Mode is set to Manual.

Pending – The Update is available to be installed by you.

Installed – The Update is installed.

Failed – The update installation failed (most likely due to custom changes on your system in kernel / library files).

Please open a support ticket as described in the Support chapter if this occurs.

Download

(20)

Install an Update

Depending on your version of eZ Publish, and what your subscription agreement states, you have 3 different Update Modes (sometimes called Patch Mode) available; Automatic, Semi-manual, and Manual.

Independent of which Update Mode you have in your subscription, you can manually download each Update if you wish you inspect it, test it, or install it. However, we strongly recommend that you use the selected Update Mode as described in this chapter. If you for some reason find it more suitable to switch to another Update Mode, please contact the Support team as described in this guide, and request the change.

This section tells you how to install an Update by manually downloading it, and the following subsections goes through how to use each of the Update Modes.

Follow the steps below to download and install and Update.

• Log in to the service portal, and click on the “eZ Publish updates” link.

• In the “Update overview” drop-down menu, please select the branch you are interested in, and the page will reload and list the available Updates, as shown in the illustration below.

• Click on the download icon and receive a compressed Zip file.

• Open the Zip file and see that it contains all the components of the update, including an install.txt file. • See the install.txt file for details about the specific Update and how to install it.

(21)

Automatic mode (version 4.5 or earlier)

In automatic mode, the updates are installed without the need of any user interaction, because they are automatically approved for installation.

The installation list on the left side, displays other portal associated with the customer. This customer, eZ Systems Demo, have multiple eZ Publish installations with support and maintenance service, and these are listed here.

Semi manual mode (version 4.5 or earlier)

If the selected maintenance mode is “semi manual” the update list looks slightly different, with a choice to install the updates.

In this mode, the user has to choose the Install command from the drop-down list for each update, and click the Update

patch status button, in order to install the updates.

Note that the command is not sent to the installation in the same moment, but sent to the eZ Network system, which the eZ Publish Enterprise installation is synchronising with, at customised intervals. The default interval is every 8th hour, and the

default update installation is set to happen once every day, usually during the night.

Illustration 16: Update details - automatic maintenance mode

(22)

Manual mode

In manual mode, the user installs the updates himself, and then uses the Update Overview feature in the Service Portal to flag the Update as installed, for his own benefit.

See the “Install an Update” section in this guide for information on how to manually install an Update.

After having installed an Update, simply tag the Update in the Update overview table as “Installed” by selecting the “Installed” option in the drop-down-list in the “Status” column in the row of the Update. See the Status column in the below illustration.

This will allow fellow users of the Service Portal, and eZ Customer Services, to learn about the status of the Updates provided, in order get an overview of how up to date your eZ Publish Enterprise installation is.

Note that you can revert the action by clicking on the drop-down-menu item “Installed” and change it to “Pending”. It is important to understand that the portal will only allow you to tag an Update “Installed” if you have already tagged the previous Update also as “Installed”. This is because all Updates from eZ Systems have only been tested and certified on a eZ Publish installation with all the previously distributed Updates installed.

Updates for the extensions are created so that they are independent from the Updates in the kernel, unless otherwise stated in the Update Description.

Note that you need to have the Portal Admin privileges in order to change the status of the Updates. You can check if you have this privilege by going to the “Maintenance and Support agreement details” page from the Service Portal main page, and see if the “Portal Administrator” checkbox next to your name is ticked, in the “Portal access management” table. If not, then you can request this privilege, from anyone who already has this privilege.

(23)

Update history

This feature is only available if the Service Portal has “Manual” Update Mode selected, and allows the user to check who installed which Update, and at what time, and also to download an overview of this information as a comma-separated list of values (CSV) file. This link can be accessed from the “eZ Publish updates” page, via the “Update history” link on the top right corner.

The below illustration shows how the page looks.

This page is accessible by all the users who have access to the portal, including eZ Systems staff.

This page will list all Updates in a table, with the actions taken, being it Install or Uninstall, and the name and username of the person who performed the action, along with the timestamp.

There is a filter function above the table, shown as a drop-down menu, which allows you to show all actions, both for the kernel, and for all the modules / extension, or only show the actions taken on kernel Updates, or for specific modules. The filter items in the drop-down menu will also show how many Updates are installed out of the available Updates, to give you a quick overview of how up-to-date the eZ Publish installation is.

The actions are listed chronologically, with the most recent action on top.

To download the displayed information, click on the “Download data as a CSV file” button. The downloaded file can be imported into a spreadsheet for further use.

(24)

Installing the eZ Network Client extension

As an eZ Enterprise customer you need to install eZ Network for your software updates and your agreement and support details. Please click the Service Portal tab (being logged in to the eZ Publish Administration interface).

Installing the eZ Network is a step-wise process including the following steps: • 1. Start, 2. Sanity, 3. Install, 4. Finalise

The whole process takes 2-4 minutes depending on your server. Please note that this installer does not support cluster setup (including eZDFS), nor a multi database setup. For a cluster and a multi-database setup you should install eZ Network as explained in “extensions/ez_network/doc/INSTALL.txt”.

When you click the “Service Portal” tab the first time you will be presented with the eZ Network installation screen as shown below:

Click the “next” button to start the first part of the installation process, which is step 1, the Sanity check, that checks previous installations and files. If you get any error messages, please correct as reported in the error message. You will not be able to continue the installation until the sanity checks are ran successfully.

The screen below shows a typical scenario when the sanity checks were not successful:

(25)

The next step is then the installation itself. You are presented with the following screen:

Start this step by entering the network key as provided by eZ Systems and then click “Install” next to the field where you entered the network key. The installation starts. Note that an eZ Network installation typically takes 2-4 minutes depending on your server. Registering the right key is important, otherwise two scenarios might occur:

• If you enter a key with too few characters you will get an error message saying that you need to enter the correct key.

• If you enter the wrong key, but correct number of characters, the system will take you through the installation process, validating the key. However, you will get an error message saying that you will not be connected to the eZ Network.

In the last step, 3. Finalise, you are asked to setup some cronjobs for the eZ Network. Follow the instructions in the screen below to setup the cronjobs. Go to the eZ Network crontab setup, check the path, and install the following settings in the crontab (shown in the screen below):

When the cronjobs have been installed, you are ready to log in to the “Service Portal”.

Click the “Service Portal” tab again and you are ready to be authenticated on “Service Portal” and the eZ Publish

(26)

Single-sign-on

From the version 4.4 release onwards you can now experience a new single-sign-on function whereby you can move seamlessly between the Service Portal and the eZ Publish Administration interface. By authenticating yourself either place, you can access both places without repeated authentications.

First time authentication

(27)

If not authenticated yet

The steps below explain the automated authentication process:

If you have not authenticated yourself to the Service Portal the following screen is now presented:

Click on the link "here" to start the authentication process. The authentication process is an automated process; an exchange of data between the server and the local client. The authentication system asks for the user name/email and the password using the login.ez.no login screen.


When that exchange is finished, the result is saved to be used the next time the user enters the "Premium" tab. The authentication system redirects you to the eZ Publish Administration Interface Premium tab as seen in the screen below:

When authenticated

Now that you are authenticated to both systems, you will automatically be logged into the Service Portal on the next login to the Administration Interface or vice versa.

Note: At the first login, you might be asked to choose

your user profile type. It is either:

Subscription holder: This is an employee or

end user at the customer

Integration partner: This is an employee of

the integration partner (eZ Systems partner) for your installation

The profile can be adjusted later on in “Portal access management” table (“Maintenance and Support agreement details” link).

References

Related documents