41
iTeleFusion Administrator's Guide Version 1.0

Technical Writing Sample: Software Admin Guide

Embed Size (px)

DESCRIPTION

A software administrator's user manual co-authored by writer and editor John Melendez.ABOUT THE AUTHOR: John Melendez is a freelance technical writer reporting on high tech, the environment, sustainability, alternative energies and "green" issues. John Melendez is a writer for hire. To email him, go to http://www.emailmeform.com/fid.php?formid=19595See other interesting reads at: . Writing Samples: http://www.associatedcontent.com/johnmelendez Publication Samples: http://tinyurl.com/jm-pubs Outlook RSS Feed: http://www.associatedcontent.com/rss/user_76423.xml

Citation preview

Page 1: Technical Writing Sample: Software Admin Guide

iTeleFusion Administrator's Guide

Version 1.0

Page 2: Technical Writing Sample: Software Admin Guide
Page 3: Technical Writing Sample: Software Admin Guide

iTeleFusion Administrator's Guide

Version 1.0

Page 4: Technical Writing Sample: Software Admin Guide
Page 5: Technical Writing Sample: Software Admin Guide

ITeleFusion Administrator’s Manual Product Support Version 2.0 i

©1999-2001 NISSI Media, Inc. (“NISSI”) All rights reserved.

Printed in the United States of America. Reproduction or transmission of this work in any form or by any means whatsoever, electronic or mechanical, without the express written permission of NISSI is strictly forbidden.

Trademarks used in this text:

NISSI Media and iTeleFusion are trademarks of NISSI; Microsoft and MS-DOS are registered trademarks and Excel, PowerPoint, Word, Windows, Windows NT and Windows 2000 are trademarks of Microsoft Corporation. Certain marks may be registered in various jurisdictions.

Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names or to their respective products for identification purposes.

June 2001

Page 6: Technical Writing Sample: Software Admin Guide

Master Administration

Product Support ITeleFusion Administrator’s Manual ii Version 2.0

Page 7: Technical Writing Sample: Software Admin Guide

ITeleFusion Administrator’s Manual Product Support Version 2.0 iii

Contents Preface...................................................................................... 1

Product Support ..................................................................................... 1 Audience ................................................................................................ 2 How to Use This Guide ......................................................................... 2 Typographical Conventions ................................................................... 2 Related Documentation.......................................................................... 3

Chapter 1 - Master Administration ......................................... 5 Introduction............................................................................................ 5

Log in ............................................................................... 5 Company/Group Info Management ....................................................... 6

Edit ................................................................................... 7 Delete ............................................................................... 8 Register New Service ....................................................... 9

Feature Control .................................................................................... 10 Security ................................................................................................ 12 Change Password................................................................................. 14

Chapter 2 - Corporate Administration.................................. 17 Log in................................................................................................... 17

Chapter 3 - User Information Management.......................... 19 Add New Users.................................................................................... 19 Edit User Information .......................................................................... 22 Delete Users......................................................................................... 23

Chapter 4 - Directory Management ...................................... 25 Add a User to a Directory .................................................................... 25 Rename a Directory ............................................................................. 26 Delete a User from a Directory............................................................ 27 Move a User......................................................................................... 27

Chapter 5 - User Statistics .................................................... 29 Number of Current Users..................................................................... 29 Number of Users in Directory.............................................................. 30

Chapter 6 - Domain Information Management .................... 31 Domain Information ............................................................................ 31 Change ID and Password ..................................................................... 31

Index ....................................................................................... 33

Page 8: Technical Writing Sample: Software Admin Guide

Master Administration

Product Support ITeleFusion Administrator’s Manual iv Version 2.0

Page 9: Technical Writing Sample: Software Admin Guide

ITeleFusion Administrator’s Manual Product Support Version 2.0 1

Preface ITeleFusion requires administrative functions in two ways:

• Master Administration

• Corporate Administration

This guide covers how both the Master and Corporate sites function to manage iTeleFusion services and Administration IDs.

Product Support Support services are available to support NISSI products. Contact your regional NISSI office for more information regarding sales, service, and support.

NISSI can be reached directly at:

Nissi Headquarters NISSI Media, Inc. 21515 Hawthorne, Blvd., 2nd Floor Torrance, CA 90503 USA Tel: (310) 792-2000 Fax: (310) 792-2244 [email protected]

Nissi Korea Champs-Elysees Center2nd Floor 889-5, Daechi-Dong Kangnam-Ku, Seoul KOREA 135-280 Tel: +82 (2) 556-3114 Fax: +82 (2) 556-3124 [email protected]

Nissi Singapore 7 Temasek Boulevard#22-03 Suntec Tower One Singapore 038-987 Tel: +65 338-0770 Fax: +65 338-1159 [email protected]

Technical Support [email protected]

Page 10: Technical Writing Sample: Software Admin Guide

Master Administration

Audience ITeleFusion Administrator’s Manual 2 Version 2.0

Audience This manual is intended for company administrators that are responsible for creating user IDs and passwords. This manual also addresses the Master Administrative site, and its functionality.

For further information regarding the usage, configuration and development of products and services, refer to the iTeleFusion User Manual.

How to Use This Guide This manual is divided into the following chapters. It is recommended that you first read through the Introduction chapter to familiarize yourself with the basic workings of iTeleFusion before moving on. More advanced users may refer to the Table of Contents to locate exact information.

Chapter Description

Preface Outlines the purpose, use, and typographical conventions used in this manual.

Chapter 1 Master Administration — Describes how to create Administartive IDs for use in the Corporate Administration site.

Chapter 2 Corporate Administration — Covers how to log in to the Administrative Sub Domain site

Chapter 3 User Information Management — Details how to add new users and edit user information.

Chapter 4 Directory Management — Outlines how to add, move, rename and delete sub domains.

Chapter 5 User Statistics — Covers the information provided regarding number of registered users.

Chapter 6 Domain Information Management — Covers domain information and changing of administrative passwords.

Typographical Conventions The following typographical conventions are used in this manual:

Convention Meaning

Bold All headings and notes

Arial All table text

Microsoft conventions for Windows based applications

Windows Menus Menu items Dialog boxes Icons Buttons

Page 11: Technical Writing Sample: Software Admin Guide

ITeleFusion Administrator’s Manual Related Documentation Version 2.0 3

Related Documentation The following publication can be used in conjunction with this guide:

iTeleFusion User Manual

Page 12: Technical Writing Sample: Software Admin Guide
Page 13: Technical Writing Sample: Software Admin Guide

Master Administration

ITeleFusion Administrator’s Manual Introduction Version 2.0 5

Chapter 1 - Master Administration

Introduction The Master Administration site is used to create corporate administrative IDs. The corporate administrator manages user IDs for iTeleFusion, as well as password administration.

Log in A Master ID and password are required for Master Administrative access. To log in to iTeleFusion Master Administration, enter your Master ID and password in the log in screen:

Click the Log In button. The Group/Company Information screen appears:

Three links make up the Master Administrative site:

• Group/Company Information

• Feature Control

• Security

Page 14: Technical Writing Sample: Software Admin Guide

Master Administration

Company/Group Info Management ITeleFusion Administrator’s Manual 6 Version 2.0

Company/Group Info Management After you have logged in, the first screen that appears is Company/Group Info Management. This screen shows displays the names of registered companies, as well as the iTeleFusion services being used:

The following table describes the fields within the Company/Group Info Management screen.

Field Description

Company ID used to log in

Name of company used to log in

Date company registered for iTeleFusion Services

Email address for notifying company of any service realted issues

Phone number for notifying company of any service realted issues

Link for accessing the Edit Sub Domain screen

Deletes company account

Indicates if service is activated; service is activated or deactivated via the Edit link

Indicates if service is activated; service is activated or deactivated via the Edit link

Indicates if service is activated; service is activated or deactivated via the Edit link

Indicates if service is activated; service is activated or deactivated via the Edit link

Indicates if service is activated; service is activated or deactivated via the Edit link

Indicates if service is activated; service is activated or deactivated via the Edit link

Page 15: Technical Writing Sample: Software Admin Guide

Master Administration

ITeleFusion Administrator’s Manual Company/Group Info Management Version 2.0 7

Edit The Edit link opens the Edit Sub Domain screen. Changes to any iTeleFusion service are made using this screen. The Edit link is located in the upper right portion of the screen:

The Edit Sub Domain screen:

The following table describes the fields and buttons within the Edit Sub Domain screen.

Field/Button Description

Name of the registered company using iTeleFusion services

Homepage of the registered company using iTeleFusion services

Email address for notifying company using iTeleFusion services

Phone number for notifying company using iTeleFusion services

Drop down menu that controls service; yes activates sercive, no disables service

Drop down menu that controls service; yes activates sercive, no disables service

Drop down menu that controls service; yes activates sercive, no disables service

Field/Button Description

Page 16: Technical Writing Sample: Software Admin Guide

Master Administration

Company/Group Info Management ITeleFusion Administrator’s Manual 8 Version 2.0

Drop down menu that controls service; yes activates sercive, no disables service

Drop down menu that controls service; yes activates sercive, no disables service

Saves any changes made within the Sub Domain screen

Cancels any changes made within the Sub Domain screen

Save Changes

If you save any changes, the following appears:

Delete To eliminate an account, click the Delete link. It is located in the far right portion of the Company/Group Information Management screen:

A confirmation prompt appears when the Delete link is selected:

To delete the account, press OK. To abort the deletion, select Cancel.

Page 17: Technical Writing Sample: Software Admin Guide

Master Administration

ITeleFusion Administrator’s Manual Company/Group Info Management Version 2.0 9

Register New Service For a company to use iTeleFusion services, it must first be added into the administration site.

A company is added using the Register New Service button:

To add a new company, perform the following:

1. Click the Register New Service button. The Register New Sub Domain screen appears:

The following table describes the fields and buttons within the Register New Sub Domain screen.

Field/Button Description

Name of a sub group within a company

Name of the company being added for new iTeleFusion services

URL of company website

Email address for notifying company using iTeleFusion services

Phone number for notifying company using iTeleFusion services

Page 18: Technical Writing Sample: Software Admin Guide

Master Administration

Feature Control ITeleFusion Administrator’s Manual 10 Version 2.0

2. Fill in the fields of the Register New Domain screen as follows:

� Company/Group: Enter the name of a group. This can be considered a sub group within the company.

� Company Name: Enter the name of the company. � Homepage: Enter the company’s home webpage. � Contact Email: Enter a company email address

where information can be sent. � Contact Phone: Enter a company telephone number

for voice contact.

In Feature Setting section, select which iTeleFusion services the company will use:

Select Yes to activate the UMS service. No indicates the service is inactive.

Select Yes to activate My Desk service. No indicates the service is inactive.

Select Yes to activate the Video Conference service. No indicates the service is inactive.

Select Yes to activate the Text Conference service. No indicates the service is inactive.

Select Yes to activate the iTeleFusion Fax service. No indicates the service is inactive.

Feature Control Another way to make changes to a company’s iTeleFusion service settings is to click the Feature Control link:

The Feature Setting screen displays which services are activated.

Page 19: Technical Writing Sample: Software Admin Guide

Master Administration

ITeleFusion Administrator’s Manual Feature Control Version 2.0 11

To make a change in service settings, click the Change button located in the right portion of the screen:

The Edit Sub Domain screen appears:

The following table describes the fields and buttons within the Edit Sub Domain screen.

Field/Button Description

Name of the registered company using iTeleFusion services

Homepage of the registered company using iTeleFusion services

Email address for notifying company using iTeleFusion services

Phone number for notifying company using iTeleFusion services

Drop down menu that controls service; Yes activates sercive, No indicates service is deactivated

Drop down menu that controls service; Yes activates sercive, No indicates service is deactivated

Drop down menu that controls service; Yes activates sercive, No indicates service is deactivated

Drop down menu that controls service; Yes activates sercive, No indicates service is deactivated

Drop down menu that controls service; Yes activates sercive, No indicates service is deactivated

Page 20: Technical Writing Sample: Software Admin Guide

Master Administration

Security ITeleFusion Administrator’s Manual 12 Version 2.0

Field/Button Description

Retains changes made in the Sub Domain screen

Cancels any changes made in the Sub Domain screen

Feature Setting

Changes in service are accessed in the Feature Setting section of the Sub Domain screen. Select which service to activate for a given company.

Yes activates a service. No deactivates a service. Select Save to retain changes. Select Cancel to abort any changes.

If you save any changes, a message appears indicating the service changes were updated:

Security The Security screen enables you to create administrative IDs for use in the Corporate Administrative website.

To create an administrative ID, perform the following:

1. Click the Security link located on the left portion of the screen:

Page 21: Technical Writing Sample: Software Admin Guide

Master Administration

ITeleFusion Administrator’s Manual Security Version 2.0 13

The Sub Domain Security Screen appears:

The Sub Domain Security Screen contains the following information:

▪ A listing of companyCorporate Administrative IDs

▪ The corresponding administrative ID for the company

▪ The corresponding password for the administrative ID

▪ The Edit link

▪ The Delete link

2. Click the Add button. The Register Sub Domain screen appears:

3. Fill in the fields as follows:

� Company/Group ID: Enter the name or group � Admin ID: Enter the name of the

administrative ID � Admin Password Enter the administrator’s

password

Page 22: Technical Writing Sample: Software Admin Guide

Master Administration

Change Password ITeleFusion Administrator’s Manual 14 Version 2.0

4. Click the Registration button:

Once the new company and Administrative ID are created, the Sub Domain Security screen reappears with the new information.

In the following example, the companies Saturn, Neptune and Orion were added, with their respective Admin IDs of Rings37, Ice, and stars.

Change Password To change a Master ID and password, perform the following:

1. From the Log in window, click Change ID & Password.

Page 23: Technical Writing Sample: Software Admin Guide

Master Administration

ITeleFusion Administrator’s Manual Change Password Version 2.0 15

The Change Info window appears:

2. Enter your Company ID.

3. Enter your old Admin ID and password.

4. Enter your new Admin ID and password.

5. Re-enter your new password in the Confirm Password field. If you made a mistake, select the Clear key. All information that was entered is deleted.

6. Click the Change Administrator button.

Page 24: Technical Writing Sample: Software Admin Guide
Page 25: Technical Writing Sample: Software Admin Guide

Corporate Administration

ITeleFusion Administrator’s Manual Log in Version 2.0 17

Chapter 2 - Corporate Administration

The Corporate Administration site enables the management of users and directories for iTeleFusion within a particular corporate domain.

Log in Corporate Administrative access requires a valid Corporate Admin ID and password. To log in:

1. Enter your Corporate ID, Admin ID, and password in the Administrative log in window:

2. Click OK.

The Domain Information screen appears:

Page 26: Technical Writing Sample: Software Admin Guide
Page 27: Technical Writing Sample: Software Admin Guide

ITeleFusion Administrator’s Manual Add New Users Version 2.0 19

Chapter 3 - User Information Management

To use iTeleFusion, a user account is required. This chapter covers how to manage users in the user database.

Add New Users As a company or organization grows, it might become necessary to grant user IDs access to iTeleFusion. This is accomplished through the Administrative website for iTeleFusion.

To add new users:

1. On the left side of the screen, click User Information Management.

2. Click Add from the menu open options that appear underneath User Information Management. The New User Registration window appears:

3. Enter the new user ID:

4. To verify if the new user ID is unique, select the Check ID

button.

Page 28: Technical Writing Sample: Software Admin Guide

User Information Management

Add New Users ITeleFusion Administrator’s Manual 20 Version 2.0

5. The Check ID button is highlighted with an arrow in the following example:

If the user ID is in use, a prompt appears indicating that a different ID must be used. If the user ID is not in use, a prompt appears indicating that the new user ID is valid.

6. Once a unique user ID is chosen, enter the appropriate information in the remaining fields (password, name, last name). The information entered here will appear in iTeleFusion on the user profile screen.

7. When finished, click the Next button:

Page 29: Technical Writing Sample: Software Admin Guide

ITeleFusion Administrator’s Manual Add New Users Version 2.0 21

8. The Add Registration Info screen appears:

9. Fill in the appropriate fields.

10. When all the fields have been filled in, click Add. (Click Clear to clear the fields and start over.) The confirmation screen appears:

11. Click OK.

In the event that creating a new user ID fails, start the process over again by simply navigating back to the registration window.

Page 30: Technical Writing Sample: Software Admin Guide

User Information Management

Edit User Information ITeleFusion Administrator’s Manual 22 Version 2.0

Edit User Information Circumstances will commonly arise when users may request their profile information be changed. To modify user IDs:

1. Under User Information Management, select Edit. The Edit User Information screen appears:

2. Select the user to modify. In the Edit By field, select a criteria

for searching for the user (UserID, nickname, etc.). Then in the second field, type the information corresponding to the category chosen in the Edit By field, and click Search.

3. Click the Edit link next to the user. The Edit User Information

screen appears:

Page 31: Technical Writing Sample: Software Admin Guide

ITeleFusion Administrator’s Manual Delete Users Version 2.0 23

4. Make the desired changes to the appropriate fields.

5. Click Edit. (Click Cancel to ignore changes. Click Reset to reset the fields.) The confirmation screen appears:

6. Click OK.

Delete Users Once a user account is no longer necessary, it can be deleted from iTeleFusion.

1. Under User Information Management, select Delete. The Delete User Information screen appears:

2. Select the user to delete. In the Delete By field, select a

category for searching for the user (UserID, nickname, etc.).

3. In the second field, type the information (UserID, name, etc.) corresponding to the category chosen in the Delete By field, and click Search.

Page 32: Technical Writing Sample: Software Admin Guide

User Information Management

Delete Users ITeleFusion Administrator’s Manual 24 Version 2.0

4. Click the Delete link next the user. A confirmation screen appears:

5. Click OK.

Page 33: Technical Writing Sample: Software Admin Guide

ITeleFusion Administrator’s Manual Add a User to a Directory Version 2.0 25

Chapter 4 - Directory Management

To ease the management of numerous iTeleFusion users, it is convenient to sort them by directories. Directories can be created according to particular corporate needs (region, office, department, etc.). Users can also be moved from one directory to another.

Add a User to a Directory To add a user to a directory:

1. Under Directory Management, click Add.

2. In the Select a Directory area, select the directory. If the

directory is an existing one, click Select from the existing Directories and select a directory from the drop-down menu. If the directory is new, click Make new Directory name and type the name of the directory in the empty field that appears.

3. Select the sub-directory. If the sub-directory is an existing one, click Select from the existing Sub-Directories and select a sub-directory from the drop-down menu. If the sub-directory is new, click Make new group name and type the name of the directory in the empty field that appears.

4. In the Add a user to a directory area, choose whether to select a registered or unregistered user. If the user to be added is unregistered, click Select from the unregistered users and select a User ID from the drop-down menu. If the user to be added is registered, click Select from the registered users and type the User ID in the empty field that appears.

5. Click Add.

6. Click OK.

Page 34: Technical Writing Sample: Software Admin Guide

Directory Management

Rename a Directory ITeleFusion Administrator’s Manual 26 Version 2.0

Rename a Directory Directories can be renamed to accommodate organizational changes. To rename a directory or sub-directory:

1. Under Directory Management, click Rename. The Rename directory screen appears:

2. In the Select a Directory field, select a directory from the drop-

down menu.

3. If the directory is to be renamed, then click the New Name box. An empty field appears. Type the new name and click the Rename button. The directory is renamed.

If a Sub-directory is to be renamed, then continue with step 4.

4. In the Select a Sub-directory, select a Sub-directory from the drop-down menu.

5. Click the New Name box. An empty field appears. Type the new name and click the Rename button. The sub-directory is renamed.

Page 35: Technical Writing Sample: Software Admin Guide

ITeleFusion Administrator’s Manual Delete a User from a Directory Version 2.0 27

Delete a User from a Directory A user can be removed from a directory. To delete a user from a directory:

1. Under Directory Management, click Delete. The Delete Directory screen appears:

2. In the Select a Directory field, select a directory from the drop-

down menu.

3. In the Select a Sub-directory field, select a directory from the drop-down menu.

4. In the Enter User ID to be Deleted field, select a user from the drop-down menu.

5. Click Delete. The User ID is deleted from that directory.

Move a User On occasion it might be necessary to move a User from one directory to another. To move a User to another directory:

1. Under Directory Management, click Move. The Move User screen appears:

2. In the FROM fields, select a directory from the first drop-down

menu, select a sub-directory from the second drop-down menu, and select a User ID from the last drop-down menu.

Page 36: Technical Writing Sample: Software Admin Guide

Directory Management

Move a User ITeleFusion Administrator’s Manual 28 Version 2.0

3. In the TO fields, select a directory from the first drop-down menu and select a sub-directory from the last drop-down menu.

4. Click Move User ID. The User ID is moved from the first directory and sub-directory to the new directory and sub-directory. The User ID is moved.

Page 37: Technical Writing Sample: Software Admin Guide

ITeleFusion Administrator’s Manual Number of Current Users Version 2.0 29

Chapter 5 - User Statistics

The User Statistics screen provides a complete view of every group and its members. Most users must be added to sub-groups. Groups and sub-groups vary, depending on your organization’s configuration.

Number of Current Users The number of current users is displayed on this screen, including the total number of Current Users, the number of Registered Users, and the number of Unregistered Users. Registered Users are those users in the system that are assigned to a particular group and/or subgroup. Unregistered Users are those users in the system that are not assigned to a group.

To see the number of current users, simply click User Statistics in the menu on the left side of the screen.

Page 38: Technical Writing Sample: Software Admin Guide

User Statistics

Number of Users in Directory ITeleFusion Administrator’s Manual 30 Version 2.0

Number of Users in Directory The number of users for each directory and subdirectory can also be shown. To view the number of users in a particular sub directory:

1. In the Select Directory field, select a directory from the drop-down menu:

The number of users is displayed to the right of the Select directory field.

2. In the Select Sub Directory field, select a sub directory from the drop-down menu:

The number of users is displayed to the right of the Select Sub directory field.

Page 39: Technical Writing Sample: Software Admin Guide

ITeleFusion Administrator’s Manual Domain Information Version 2.0 31

Chapter 6 - Domain Information Management

The Domain Information window appears after log in. From here the settings for the Corporate Domain can be viewed, and the Corporate Admin password can be changed.

Domain Information The Domain Information window indicates which services are enabled for a given company or organization. Service changes cannot be initiated; this is an information window only.

Change ID and Password The Change Admin Password screen enables you to change the password used to access the Corporate Admin password.

1. Under Domain Information Management, click Change PW located on the left side of the screen. The Change Admin Password screen appears:

Page 40: Technical Writing Sample: Software Admin Guide

Domain Information Management

Change ID and Password ITeleFusion Administrator’s Manual 32 Version 2.0

2. In the Current Password field, type the current password used to access the corporate domain.

3. In the New Password field, type the new password to be used.

4. In the Confirm Password field, re-type the password entered in the New Password field.

5. Click Change to change the password. (Click Clear to clear the fields to start over.) The confirmation screen appears:

6. Click Ok.

Page 41: Technical Writing Sample: Software Admin Guide

ITeleFusion Administrator’s Manual Change ID and Password Version 2.0 33

Index