all licensing tools user guide-en

7/29/2019 All Licensing Tools User Guide-En

1/53

All Licensing Tools

User Guide

User GuideMy AccountAll Licensing Tools


2/53

2

Table of Contents

1 LICENSING TOOLS - OVERVIEW ................................................................................................................... 3

ALL LICENSING TOOLS .......................................................................................................................................... 5NAVIGATION ......................................................................................................................................................... 6UNDERSTANDING THE SITE ICONS ......................................................................................................................... 6

2 FEATURES ........................................................................................................................................................ 7

DISPLAY HELP INFORMATION................................................................................................................................. 7VIEW NOTES ........................................................................................................................................................ 8EXPORT DATA ...................................................................................................................................................... 9SEARCH DATA .................................................................................................................................................... 10

3 LAUNCH THE VIEW TOOL............................................................................................................................. 13

VIEW LICENSES .................................................................................................................................................. 14ARCHIVE LICENSES............................................................................................................................................. 16UNDOARCHIVE .................................................................................................................................................. 19SEE/HIDE DETAILS ............................................................................................................................................. 21VIEW,ADD,EDIT,DELETE NOTES ....................................................................................................................... 22

VIEWAUDIT TRAIL .............................................................................................................................................. 24

4 LAUNCH THE ALLOCATE TOOL .................................................................................................................. 25

VIEW AND SELECT LICENSES FORALLOCATION .................................................................................................... 26ALLOCATE AND CONFIRM LICENSE FILES ............................................................................................................. 26DOWNLOAD YOUR LICENSES ............................................................................................................................... 28FIND YOUR LICENSES .......................................................................................................................................... 32

5 LAUNCH THE REALLOCATE TOOL ............................................................................................................. 33

SELECT LICENSES TO REALLOCATE..................................................................................................................... 34REALLOCATE AND CONFIRM LICENSE FILES ......................................................................................................... 35

6 SINGLE ALLOCATION ................................................................................................................................... 37

ALLOCATING A SINGLE LICENSE FILE ................................................................................................................... 37

7 LAUNCH THE RETURN TOOL ....................................................................................................................... 38

RETURN LICENSES ............................................................................................................................................. 39REVIEW AND CONFIRM RETURN .......................................................................................................................... 40

8 LAUNCH THE REDOWNLOAD TOOL ........................................................................................................... 43

SELECT AND REDOWNLOAD YOUR LICENSES........................................................................................................ 44SELECTALL ....................................................................................................................................................... 45

9 LAUNCH THE UPGRADE TOOL .................................................................................................................... 48

UPGRADE YOUR LICENSES ................................................................................................................................. 49

10LAUNCH THE RENEW TOOL ........................................................................................................................ 50

RENEW YOUR LICENSES ..................................................................................................................................... 51

11LAUNCH THE HELP TOOL ............................................................................................................................ 52

OBTAIN LICENSE HELP........................................................................................................................................ 53


3/53

3

1 Licensing Tools - Overview

The Licensing Tools provides access to a variety of tools that allow you to manage your licenses. In the pagesthat follow, we will review each of these tools to start the process of managing your licenses and license files.

To access the Licensing Tools:

1. Log into My Account (www.citrix.com/account)
http://www.citrix.com/accounthttp://www.citrix.com/accounthttp://www.citrix.com/accounthttp://www.citrix.com/account


4/53

4

2. Select All Licesnign Tools from the Licensing section


5/53

5

All Licensing Tools

The main menu for the All Licensning Tools provides all of the tools available for managing your licenses.From this main menu, select one of the desired tools below to start managing your licenses.

1. View provides an overall view of licenses (both current and archived), audit trail details, as well as theability to add, edit and delete notes.

2. Allocate providessteps for allocating available licenses to a single or multiple license servers.3. Reallocate provides steps to reassign licenses from one license server to another.4. Single Allocation5. Return provides steps to return allocated licenses and make them available for future allocation.6. Redownload provides steps for downloading and redownloading currently allocated license files and

recently renewed license files.7. Upgrade provides steps for identifying products eligible for upgrades. Upon clicking this tool, you will

be directed to the Upgrade My Products toolbox.

1

3

5

7

9


6/53

6

8. Renew provides steps to renew your product Subscription Advantage. Upon clicking this icon, you willbe directed to the Manage My Renewals toolbox.

9. Help provides steps to view the User Guide and available help tools..

Navigation

Tabs are provided at the top of each page to show your current location. Tabs allow you to easily movebetween the tools without having to return to the All Liceninsg Tools menu.

Breadcrumbs are available in Allocate, Reallocate, Return, and Archive to show you where you are in theprocess of making a selection(s), entering any required information, confirming the selection(s), anddownloading the licenses.

Understanding the Site Icons

The legend below identifies icons used within the All Licensing Tools.

Icon Icon Name What do these icons do?

ArchiveMove licenses between the Archived Licenses and

Current Licenses tabs.Audit Trail Provides a view of past license activity.

Calendar Select a date within Advanced Search.

Export Exports list to .pdf or .csv format.

Help Launches the Licensing Tools User Guide.

Note Icon 1 (Add Note) Add a new note.

Note Icon 2 (New Note)Indicates the note has been added in the past 30days.

Note Icon 3 (Existing Note) Provides the ability to view or edit existing notes.

Search Returns results based on the criteria entered.


7/53

7

2 Features

In this section you will find information about the common features available in all of the tools in All LiceninsTools.

Display Help Information

The Help feature is located above the Advanced Search button within all tools of the Licesning Tools .This feature allows you to access the Licensing Tools User Guide.


8/53

8

View Notes

The Note feature is located within all tools of the All Licensing Tools. The Note feature provides the abilityto capture any information that might be helpful to you about the specific license.

Note: The Add, Edit and Delete features are only available within the View tool.

Click the

Note iconto viewnotes.


9/53

9

Export Data

The Export feature provides the ability to export data in .pdfor.csv file formats. The exported data willmaintain all sort and search information and layout.

Selecdesire

forma

Click theExport

con.


10/53

10

Search Data

There are two search features available within all tools of the All Licensng Tools: standard Search and anAdvanced Search.

1. The standard Search feature allows you to perform searches by keyword.

Enter keywordand click themagnifying glassicon for standardSearch.


11/53

11

2. The Advanced Search feature allows you to perform a more refined search.

From the first drop-down, you can select a product associated with one or more of your licenses

From the second drop-down, you can select a License Access Code/Serial Number associated withone or more of your licenses

From the third drop-down, you can select the Order Number associated with one or more of your

licenses Use the first two calendar icons if you want to restrict your search to a date range in which the order

occurred

Use the second two calendar icons if you want to restrict your search to a date range for expiration

If you have 1000 or more items, the drop-down box will appear as an entry field. The search will match onlike and contains'.

Click hereAdvanced

Search.

Enter thesearch criteand clickSubmit.


12/53

12

3. Clear Search allows you to reset what you are currently viewing.

Clear Seto clear tcurrent sfilter and

all items


13/53

13

3 Launch The View Tool

The View tool provides many features to facilitate license management. From the All Licensing Tools, selectthe View tool to perform the following:

View current and archived licenses

Archive and unarchive licenses

View, Add, Edit, and Delete Notes

View the Audit Trail


14/53

14

View Licenses

The Current Licenses tab provides a view of all your licensing assets.


15/53

15

The Archived Licenses tab provides a view of licenses that you previously archived from the CurrentLicenses tab. When you launch the View tool for the first time, the Archived Licenses tab will be empty.


16/53

16

Archive Licenses

The Archive feature allows you to move licenses from the Current Licenses tab to the Archived Licensestab.

On the View page, select the Archive Licenses icon


17/53

17

You will also see breadcrumbs showing a two-step process: Select licenses to be archived, and thenConfirm your selections.

From the Current Licenses tab, select the licenses toarchive

Click Continue


18/53

18

Click Archive at either the top or the bottom of the page to confirm and proceed to archive yourselection. Click Back to return to the Current Licenses tab.

Upon confirming your selection, the license(s) will be available to view from the Archived Licensestab


19/53

19

Undo Archive

On the View page, select the Archive Licenses icon.


20/53

20

Select the Archived Licenses tab

Select the licenses to move to the Current Licenses tab

Click Continue

Click Undo Archive to move the license(s) to the Current Licenses tab

Upon confirming your selection, the license(s) will be available to view from the Current Licensestab

To make changes, click Back to return to the Archived Licenses tab


21/53

21

See/Hide Details

See Details expands multi-component products to provide additional product information. Minimize byclicking Hide Details.


22/53

22

View, Add, Edit, Delete Notes

The Note feature provides the ability to view, add, edit, or delete notes at the line item level.

1. Notes can only be added and edited within the View tool

ck thete iconviewes.

Click hereo Edit or

Deleteotes.

ick hereSort by

otes.


23/53

23

2. Note text can be entered up to 256 characters. Click Save to close the note.


24/53

24

View Audit Trail

The Audit Trail is available from the View tool of the All Licensing Tools. This feature provides a view ofthe activities performed on licenses.

Step 1Click theAudit Trailicon toview theactivity ofchanges.

Step 2 Adjustthe pagesettings toview additionalactivities in the

Audit Trail.

Step 3 Clichere to clothe AuditTrail.


25/53

25

4 Launch The Allocate Tool

From the All Licensing Tools, select the Allocate tool to allocate licenses to your license server.


26/53

26

View and Select Licenses for Allocation

From the Allocate page, you can view and select licenses for allocation. Breadcrumbs will guide youthrough a four-step process:

1. Select licenses to allocate2. Configure allocation3. Confirm selections4. Download and print your license file(s)

You will see a list of product licenses and quantities available for allocation. Select the specific productsthat you want to allocate and click Continue.

Allocate and Confirm License Files

Upon completing the selection of licenses, enter the required information for each line item.

For applicable products, select the Host ID Type from the drop-down list. Host ID types include:hostname, IP address, MAC address, and fully-qualified domain name (FQDN). Most products allow

only one host ID type. In these cases, the type will not be editable. Enter the Host ID. For example, if the host ID type is IP address, the host ID will be the specific IP

address of your license server.

Enter the quantity you would like to allocate for each line item in the Quantity / Available column(quantity will default to full quantity available).

Click Continue


27/53

27

The Confirm page displays a list of all line items with your inputs allowing you to confirm everything

is correct before proceeding Click Confirm to complete the license allocation orBack to modify information on the previous

screen


28/53

28

Once licenses are allocated, you will be directed to the download page

Click OK to proceed with the downloadorClose to exit the dialog box

Download your Licenses

You are able to view the licenses that have been allocated By Host, By Allocation, or by licenses that havebeen Recently Renewed in the last 30 days.

The By Host tab will give you a view of all allocated licenses by License Server host

The By Allocation tab will give you a view of all allocations by license access code


29/53

29

If you haveallocations that were renewed in the last 30 days, the Recently Renewed tab will

display these allocations


30/53

30

On the tab that best meets your needs, you can either click Select All or use the checkboxes to the left toselect license file(s) and click Download.


31/53

31

Although there is no need to do so, you can click Open to view the actual contents of the licensefile.

Click Save to complete the download. This license file then needs to be installed on your licenseserver. See Installing a Citrix license file in the Citrix eDocs site for instructions.

If you do not want to download your license file, you can click Cancel. In order to download this file

in the future, you will need to launch the Redownload Tool. (For more information onredownloading, please refer to theLaunch the Redownload Tool.

Click Close.


32/53

32

Find your licenses

If you dont see the licenses you wish to allocate, click the Dont see your product? link to search for aspecific license code or web key.


33/53

33

5 Launch The Reallocate Tool

From the All Licensing Tools, select the Reallocate tool to allocate licenses to a different license server.


34/53

34

Select Licenses to Reallocate

From the Reallocate page, you can select licenses to allocate to a new license server by specifying a newhost ID type and host ID value. You are no longer required to return licenses prior to reallocating.Breadcrumbs will guide you through a four-step process:

1. Select licenses to reallocate2. Configure reallocation3. Confirm selections4. Download and print your new license file(s)

Select the licenses you would like to reallocate and click Continue.


35/53

35

Upon completing the selection, enter the information for the new license server and the quantity oflicenses that you are moving.

1. Select the Host ID Type if applicable (for most products this will already be entered)2. Update the Host ID3. If this is a partial reallocation, update the quantity in the Quantity / Available column (quantity will

default to full quantity available).

Click Continue.

Reallocate and Confirm License Files

Click Confirm to complete the reallocation and start downloading. Click Back to make any

modifications on the previous screen.


36/53

36

Click OK to proceed with the download or Close to exit the dialog box.

Note: You must manually remove the old license files from your license server.


37/53

37

6 Single Allocation

From the All Licensing Tools, select the Single Allocation tool to quickly allocate a required single licesnsefile.

Allocating a Single License File

Click Single Allocation, Enter the License code for which the licnse has to be allocated and click

Continue button.

The exact licnese that needs to be allocated for the entered licesnse code is displayed and

selected. Follow the procedure as explained underAllocate and Confirm License Files


38/53

38

7 Launch The Return Tool

From the All Licensing Tools, select the Return tool to return licenses for future allocation


39/53

39

Return Licenses

From the Return page, you can view and select the licenses available for return. Breadcrumbs will guideyou through a four-step process:

1. Select licenses to return2. Configure return3. Confirm selections4. Download and print your license file(s)

Select from the list of available licenses and click Continue.


40/53

40

To return a quantity less than the original allocation, update the quantity in the Quantity / Availablecolumn (quantity will default to full quantity available).

Click Continue

Review and Confirm Return

Click Confirm to return your license(s)


41/53

41

Upon confirming your selection, the returned files will be added to your license pool and can beallocated by launching the Allocate Tool

For partial returns, you will be provided with the option to download the new license file for thequantity of licenses that remain allocated

Click OK to proceed with the downloadorClose to exit the dialog box

Note: Please remember to remove the current license file(s) from your license server. If you did apartial return then you will replace the current file with the one you are downloading.


42/53

42

Click Open to view the file

Click Save to begin downloading your partial return license files to a local folder (For moreinformation on downloading, please refer to All Licesning Tools - Redownload)

Click Cancel to cancel the download


43/53

43

8 Launch the Redownload Tool

From the All Licensing Tools, select the Redownload tool to redownload previously allocated license

files, and to download recently renewed license files.


44/53

44

Select and Redownload your Licenses

You are able to view all the licenses that are currently allocated and redownload them By Host, ByAllocation, or by licenses that have been Recently Renewed in the last 30 days.

The By Host tab will give you a view of all allocated licenses by License Server host

The By Allocation tab will give you a view of all allocations by license access code The Recently Renewed tab will give you a view of all your allocations that were renewed in the last

30 days

There are several ways to select license(s) to download.

Clickelect All

or all itemsn allages

Click theage

Checkboxor all itemsn a singleage

Click anndividual

Checkboxor apecificem


45/53

45

Select All

Select All will prompt you to download all of your licenses.

You are able to Deselect All or remove items individually.


46/53

46

Click Download when ready. You will be prompted to open or save the license file for a single download.

You will be prompted to open or save the license file for a zip file for multiple downloads.


47/53

47


48/53

48

9 Launch The Upgrade Tool

The Upgrade toolprocess provides the ability to identify Citrix products you own that are eligible for a versionupgrade, edition upgrade or Trade-up. Your upgrade history can be viewed from here, and version upgradecertificates can be printed.


49/53


50/53

50

10 Launch The Renew Tool

The Renew tool providesthe ability to manage your Subscription Advantage memberships and hardwarewarranties.


51/53

51

Renew your Licenses


52/53

52

11 Launch The Help Tool

The Help tool provides references to assist with your licensing tasks.


53/53

Obtain License Help

When you click Help, a pop-up displays with links to three resources to assist with your licensing tasks.

1. Select User Guide to receive instructions on using the My Account -All Licensing tools2. Select General Licensing Questions to receive technical help about licensing from the Citrix eDoc

site3. Select Tutorials to watch instructional videos on using the My Account licensing tools on Citrix TV

all licensing tools user guide-en

Documents