MadCap Central. Server Management & Purchasing Guide

Transcription

1 MadCap Central Server Management & Purchasing Guide

2 Copyright 2017 MadCap Software. All rights reserved. Information in this document is subject to change without notice. The software described in this document is furnished under a license agreement or nondisclosure agreement. The software may be used or copied only in accordance with the terms of those agreements. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or any means electronic or mechanical, including photocopying and recording for any purpose other than the purchaser's personal use without the written permission of MadCap Software. MadCap Software 7777 Fay Avenue La Jolla, California THIS PDF WAS CREATED USING MADCAP FLARE.

3 CONTENTS CHAPTER 1 Changing the License Key Label 5 CHAPTER 2 Changing the License Vanity URL 7 CHAPTER 3 Purchasing User Seats and Storage Space 9 CHAPTER 4 Setting Up Slack Integration 13 APPENDIX PDFs 41

4 iv Server Management & Purchasing Guide

5 CHAPTER 1 Changing the License Key Label The license key label is used internally to identify your MadCap Central license. If you belong to multiple MadCap Central licenses, a unique label ensures that you can distinguish between them in Central. For this activity, you must have the following permission setting: For more information about permissions, see the Central online Help.

6 HOW TO CHANGE THE LICENSE KEY LABEL 1. At the top of Central, click your user name, then click Server Settings. The Server Settings dialog opens. 2. Click the General tab. 3. Below the Key Label field, click Edit. The Change Key Label dialog opens. 4. In the New Key Label field, enter the label you want to use for your license key. 5. Click Save. Your license key label is updated throughout MadCap Central. Note: The original license key label is based on the company name when a Central license is purchased. The same is true for the vanity URL. If your company name has a space in it, that space is automatically removed. You can add the space back when you change your license key label. However, you cannot add a space when changing your vanity URL. Note: Changing the license key changes it for all users. 6 Server Management & Purchasing Guide

7 CHAPTER 2 Changing the License Vanity URL Each license has a vanity URL. The URL consists of your license (e.g., company) name followed by a period, then mcoutput.com (e.g., When you generate a target and set it to Live, a number is auto-generated to represent the target and this is added to the URL, along with the entry file for the output (e.g., Users can see your output by using that final URL. You can change the vanity URL in the Server Settings dialog. This lets you change the prefix of the URL (i.e., you cannot change mcoutput.com, but you can change what comes before it). For this activity, you must have the following permission setting: For more information about permissions, see the Central online Help.

8 HOW TO CHANGE THE LICENSE VANITY URL 1. At the top of Central, click your user name, then click Server Settings. The Server Settings dialog opens. 2. Click the General tab. 3. Below the Vanity URL field, click Edit. The Change Vanity URL dialog opens. 4. In the New Prefix field, enter the prefix you want to use for your vanity URL (only alpha characters and numbers are allowed). A preview of your vanity URL ([prefix].mcoutput.com) appears below the field. 5. Click Save. Important: Use caution when changing your license vanity URL. It is generally best to do this when your Central license is new and before you have set builds to Live. If you have already published outputs and then decide to change the vanity URL, any links to the older URL will be broken. Important: When changing your license vanity URL, keep in mind that MadCap Software is not responsible for other companies claiming a particular name before you are able to. Note: The original license key label is based on the company name when a Central license is purchased. The same is true for the vanity URL. If your company name has a space in it, that space is automatically removed. You can add the space back when you change your license key label. However, you cannot add a space when changing your vanity URL. Note: If you have an older URL that you need to continue to use in order to maintain consistency with your company and prevent older links from breaking, you can create a redirect from that URL to your new vanity URL. Ask the web administrator in your company for assistance with this. Note: You can also set vanity URLs for targets and individual builds. 8 Server Management & Purchasing Guide

9 CHAPTER 3 Purchasing User Seats and Storage Space When you run out of user seats or storage space in Central, you can purchase more. You do not need to contact MadCap Software to do this; instead, you can purchase user seats and storage space directly from the Central interface. For this activity, you must have the following permission setting: For more information about permissions, see the Central online Help.

10 HOW TO PURCHASE USER SEATS OR STORAGE SPACE 1. Do one of the following, depending on the part of the user interface you are using: Server Settings Dialog At the top of Central, click your user name, then click Server Settings. The Server Settings dialog opens. Click the General tab. Click Buy Seats or Buy Space. Storage and Usage Widget If you ve added the Storage and Usage widget, click open the Home page. In the widget, click Buy Seats or Buy Space. to The Purchase dialog opens. Note: If you are working in trial mode, you will also see a link to Purchase. This lets you buy a Central subscription (annual or monthly). Once the purchase is made, you will no longer be in trial mode, but rather full mode. 2. In the Seats field, select the number of user seats you want to add to your license. Note: If you are working in trial mode, you are granted an unlimited number of seats for that period. When you purchase the license, your number of seats in the Purchase dialog must be at least as high as the number you already added to the license in trial mode. If you do not want to purchase that many seats, you must first delete some users from the license before continuing with the purchase. 3. In the Space field, select the amount of storage space (in GB) that you want to add to your license. Note: If you are working in trial mode, you are granted an unlimited amount of storage space for that period. When you purchase the license, the amount of space selected in the Purchase dialog must be at least as much as the amount you re already using in trial mode. If you do not want to purchase that much space, you must first clean up your existing space (e.g., delete builds, projects, or other data taking up unnecessary space) before continuing with the purchase. 10 Server Management & Purchasing Guide

11 Central calculates the total cost and displays it below. 4. (Optional) If you have a credit card on file, the card information is displayed. If you do not have a credit card on file, no card information is displayed. To add a new card, or to edit or delete your saved card, click Change Card. The Billing Information dialog opens. HOW TO ADD A NEW CREDIT CARD a. At the bottom of the Billing Information dialog, click Add. The Add a Payment Method dialog opens. b. In the fields, enter your credit card and address information. Mandatory fields are marked with an asterisk. c. Click Save and Finish. HOW TO EDIT YOUR CREDIT CARD INFORMATION a. At the bottom of the Billing Information dialog, click Edit. The Edit Payment Method dialog opens. b. The fields in the dialog are already populated with your saved credit card information. In the fields, edit your credit card and address information as necessary. Mandatory fields are marked with an asterisk. Note: Your saved card information is masked when shown in the dialog. c. Click Save and Finish. Note: If you do not have a saved credit card, this option is disabled. HOW TO DELETE YOUR SAVED CREDIT CARD INFORMATION a. At the bottom of the Billing Information dialog, click Delete. A confirmation message appears. b. Click Delete. CHAPTER 3 Purchasing User Seats and Storage Space 11

12 Note: If you do not have a saved credit card, this option is disabled. 5. In the Billing Information dialog, click Continue. 6. In the Purchase dialog, click Continue. The Confirm Purchase dialog opens. A message shows you the number of user seats and/or the amount of storage space you are purchasing, as well as the total amount of the purchase. 7. Click Complete Purchase. Your card will be charged. Note: If you need to renew your annual subscription, please contact MadCap Software Sales. Note: If you need to cancel your subscription, you can simply delete your credit card information from the system, as described above. 12 Server Management & Purchasing Guide

13 CHAPTER 4 Setting Up Slack Integration If you have a Slack account, you can integrate it with Central s notification system. By doing this, all types of activity alerts (e.g., builds completed, tasks edited or moved, projects deleted) can be fed directly to your Slack channels, making it easier for you to remain informed and communicate with others when certain events take place in Central. Most of the steps for this integration take place in Central. For this activity, you must have the following permission setting: For more information about permissions, see the Central online Help.

14 HOW TO SET UP SLACK INTEGRATION 1. In Slack, make sure you have set up a Slack account and created channels that you want to integrate with Central. 2. At the top of Central, click your name and select Server Settings. The Server Settings dialog opens. 3. Select the Slack tab. 4. In the Channels section, click. 14 Server Management & Purchasing Guide

15 Slack opens in your browser. 5. Choose your Slack team. And then in the Post to field, select a channel that you want to integrate. 6. Click Authorize. 7. Back in Central, a message indicates that addition was successful. Click OK. The channel is now shown in the grid. 8. Repeat these steps if you want to add more of your Slack channels to the grid. CHAPTER 4 Setting Up Slack Integration 15

16 9. With your channel added to the tab, you re ready to connect it to any of Central s notifications. In the bottom area of the tab, click. The Add Channel Notification dialog opens. 16 Server Management & Purchasing Guide

17 10. In the Name field, provide a name for the channel notification. It can be the same name as the Slack channel you want to hook it to, but this isn t necessary. 11. From the Channel field, select the Slack channel that you want to associate with the notifications. CHAPTER 4 Setting Up Slack Integration 17

18 12. From the Activity Type field, select one of the alert categories Builds, Checklists, Projects, Tasks, Teams, Users. Notice that these are the same groups available when you set up personal notifications in your user settings. 18 Server Management & Purchasing Guide

19 13. Depending on the activity type you choose, additional fields are displayed in the area below. Complete the fields as necessary to choose the type of notifications you want to be associated with the Slack channel. BUILDS a. From the Project field, select either All Projects or choose a specific Flare project whose builds you want to integrate. CHAPTER 4 Setting Up Slack Integration 19

20 b. (Optional) If you chose a specific project, you can make a selection in the Target field. Select either All Targets or choose a specific target whose builds you want to integrate. 20 Server Management & Purchasing Guide

21 c. From the Activity field, select any of the build activities to include in the integration. CHAPTER 4 Setting Up Slack Integration 21

22 Field Completed Set as Live Started Stopped Description Receive a notification if a target from a project is finished building, regardless of whether the build finishes successfully, fails, or contains errors. This notification is sent to all members of the project, except for the person who started (and completed) the build. Receive a notification if a target from a project is set as Live (i.e., published for public viewing). This notification is sent to all members of the project, except for the person who set the build as Live. Receive a notification if a target from a project is generated (manual, scheduled start, or rebuild). This notification is off by default. If enabled, it is sent to all members of the project, except for the person who started the build. Receive a notification if a target from a project is stopped (canceled) during compilation. This notification is off by default. If enabled, it is sent to all members of the project, except for the person who stopped the build. d. Click OK. 22 Server Management & Purchasing Guide

23 CHECKLISTS a. From the Project field, select either All Projects or choose a specific Flare project you want to integrate. CHAPTER 4 Setting Up Slack Integration 23

24 b. From the Activity field, select any of the checklist activities to include in the integration. 24 Server Management & Purchasing Guide

25 Field Checklist Created Checklist Deleted Checklist Updated Description Receive a notification if a project checklist is created. This notification is sent to all members of the project, except the person who created the checklist. Receive a notification if a project checklist is deleted. This notification is sent to all members of the project, except the person who deleted the checklist. Receive a notification if a project checklist is edited (i.e., name, type, rows, columns; not status of items). This notification is sent to all members of the project, except the person who edited the checklist. c. Click OK. CHAPTER 4 Setting Up Slack Integration 25

26 PROJECTS a. From the Project field, select either All Projects or choose a specific Flare project you want to integrate. 26 Server Management & Purchasing Guide

27 b. From the Activity field, select any of the project activities to include in the integration. CHAPTER 4 Setting Up Slack Integration 27

28 Field Deleted Profile Changed Status Changed Description Receive a notification if a project is deleted. This notification is sent to all members of the project, except the person who deleted the project. Receive a notification if a project profile is changed. This notification is sent to all members of the project, except the person who changed the profile. Receive a notification if a project s status (i.e., Activated, Locked, Archived) is changed. This notification is sent to all members of the project, except the person who changed the project's status. c. Click OK. 28 Server Management & Purchasing Guide

29 TASKS a. From the Tasks field, select either a specific task or choose one of the following: All Tasks All Tasks WITHOUT a Project All Tasks for a Specific Project CHAPTER 4 Setting Up Slack Integration 29

30 b. (Optional) If you selected All Tasks for a Specific Project, click in the Project field and choose the project with related tasks that you want to integrate. 30 Server Management & Purchasing Guide

31 c. From the Activity field, select any of the tasks activities to include in the integration. CHAPTER 4 Setting Up Slack Integration 31

32 Field Comments or File Actions Deleted Edited New/Assigned Status Changed (Moved) Description Receive a notification if comments or files are added to a task. If a comment is left on a task, the task owner (i.e., the user who created the task) and the user assigned to the task will receive the notification. If someone replies to a comment, the task owner, assignee, original commenter, and all repliers will receive the notification. Receive a notification if a task is deleted. The task owner and the user assigned to the task will receive the notification. However, if the task owner makes the change, only the user assigned to the task will receive the notification. Receive a notification if a task is edited. This includes details of the task, such as its title, description, priority, hours, and more. The task owner and the user assigned to the task will receive the notification. However, if the task owner makes the change, only the user assigned to the task will receive the notification. Receive a notification when a task has been assigned to you. Receive a notification if the status for a task is changed (i.e., To Do, In Progress, Completed, Archived, Backlogged). The task owner and the user assigned to the task will receive the notification. However, if the task owner makes the change, only the user assigned to the task will receive the notification. d. Click OK. 32 Server Management & Purchasing Guide

33 TEAMS a. From the Team field, select either All Teams or choose a specific team you want to integrate. CHAPTER 4 Setting Up Slack Integration 33

34 b. From the Activity field, select any of the team activities to include in the integration. 34 Server Management & Purchasing Guide

35 Field Added/Removed from a Project Deleted Edited Description Receive a notification if a team is added to a project or removed from one. This notification is sent to the user who has been added or removed from the project. Receive a notification if a team is deleted. This notification is sent to all team members, except the user who made the change. Receive a notification if a team is edited. This notification is sent to all team members except the user who made the change. c. Click OK. CHAPTER 4 Setting Up Slack Integration 35

36 USERS a. From the User field, select either All Users or choose a specific user you want to integrate. 36 Server Management & Purchasing Guide

37 b. From the Activity field, select any of the user activities to include in the integration. Field Added/Removed from a Project Added/Removed from a Team Permissions Changed Description Receive a notification if you have been added to or removed from a project. Receive a notification if you have been added to or removed from a team. Receive a notification if your permissions have changed. c. Click OK. CHAPTER 4 Setting Up Slack Integration 37

38 14. In the Server Settings dialog, a row is added for the new channel notification. 15. Click OK. 16. (Optional) You can perform an action in Central that you have integrated with the Slack channel (e.g., build a target). You should see the notification added to your Slack channel. 38 Server Management & Purchasing Guide

39 Note: Keep in mind that the notification UI in Central is unique to each user. On the other hand, when you set up Slack integration, it is created for the entire license; therefore, other users can tap in to that channel notification to receive the same alerts via Slack. Note: If you encounter problems or need help with your Slack integration, please contact support. See CHAPTER 4 Setting Up Slack Integration 39

40 40 Server Management & Purchasing Guide

41 APPENDIX PDFs The following PDFs are available for download from the online Help. Getting Started Guide Projects and Builds Guide Security Whitepaper Server Management and Purchasing Guide Tasks Guide Users and Teams Guide Widgets Guide