HPCI CMS for Information Sharing User Manual Ver. 1

Size: px

Start display at page:

Download "HPCI CMS for Information Sharing User Manual Ver. 1"

Theodora Douglas
5 years ago
Views:

1 Document ID:HPCI-OF01-003E-01 HPCI CMS for Information Sharing User Manual Ver /10/1 HPCI Operating Office

2 Revision History Date Revision Contents 2015/10/1 First edition 1

3 Table of contents Revision History Introduction Purpose of this document Precautions Terminologies Environment Reference information Function Overview Structure of HPCI CMS for Information Sharing Available spaces Login Viewing Contents Navigating from the top page of HPCI CMS for Information Sharing Navigating to the top page of HPCI CMS for Information Sharing Search Content Editing Viewing top page of a project space Creating a new page and editing Viewing a newly created page Editing an existing page Quick Reference How to use HPCI CMS for Information Sharing (Common Parts) Updating a Page Updating a Blog Space Export File formats for space export How to export a space Encoding of the attached text file

4 1. Introduction 1.1 Purpose of this document This document describes how members of a project can perform the following tasks by using HPCI CMS for Information Sharing.! Browse information (public information, etc.) shared by HPCI Operation Office and HPCI System Providers.! Share information among members of the HPCI project by using Wiki, etc. 1.2 Precautions In this manual we included screenshots taken from the test environment. In the production environment it might be different. In this system we use Zen Foundation plugin as a screen design tool. It is possible to change a design theme of a space with this tool. So, there are cases to feel a different look for some spaces. 1.3 Terminologies! Organizations " HPCI Operating Office It serves as a common contact for using HPCI " HPCI System Providers Provide computational, storage, and other resources to HPCI users (e.g., National Supercomputing Centers and National Research Labs).! ID and Account " HPCI-ID An HPCI-ID is a unique ID that is assigned to each HPCI user. A set of 10 characters started with hpci. " HPCI Account An HPCI account permits access to web applications on the HPCI infrastructure. User name is the HPCI-ID. Using at the time of signing in HPCI CMS for Information Sharing. " Project ID A project ID identifies a project. As of December 2014, it starts with hp or jh and contains 8 characters.! HPCI CMS for Information Sharing " Space Spaces are the place to keep documents, available for each project, HPCI System Providers and computational resources. Access control is carried out on each space. 3

5 1.4 Environment Supported web browsers as of September 2015 are shown in table 1-2. Table 1-1 Supported web browsers Web browser Version OS Internet Explorer 9, 10, 11 Windows Firefox 41 Windows Safari 8 Mac OS 1.5 Reference information HPCI CMS for Information Sharing is built on Confluence of Atlassian. Please also refer to Confluence manual for creating a basic content. The following information will be helpful for creating a page, blog and comment. Confluence 5.8 Document (English) Japanese Document (Contains some English) In addition, Zen Foundation of Brikit is used for designing the screen. Please refer to the following product specification. Brikit Zen Foundation (English) 4

2. Function Overview HPCI project members can use HPCI CMS for Information Sharing like a wiki for sharing information with the members of a project.

6 2. Function Overview HPCI project members can use HPCI CMS for Information Sharing like a wiki for sharing information with the members of a project. Also they can view the information shared by HPCI Operating Office and HPCI System Providers. Below, we are explaining entire structure of HPCI CMS for Information Sharing in section 2.1. After that we will explain about the available spaces (A group of web pages with related content) in section Structure of HPCI CMS for Information Sharing Figure 2-1 Configuration of the Space and Content In case of content to be managed and shared with HPCI CMS for Information Sharing, major items related to project members can be illustrated as figure 2-1.! New information and each Space links will be placed at the top page of HPCI CMS for Information Sharing. Generally this is the page that a user access in the beginning. Login page links are also placed here, but not included in Figure 2-1.! Independent spaces are allocated to each HPCI System Provider and computing resource respectively. Each Space has a top page and if you open a Space link, the top page of that Space will be appeared. All users can view the top page of HPCI System Providers Space. On the other hand, top page of computational resources Space is viewable only to the user of that computational resource. 5

7 ! You can view a page just as you open a link to see a page on the web. In addition, you can find a page by using the search box. However, only those pages you have permission to view will be displayed.! Independent spaces are allocated to each project too. Project members not only can view but they can create and edit a page in their project Space. However, non-members of a project space cannot view and edit a page. Page editing can be done in a similar way as you use a word processor. 2.2 Available spaces Following spaces and pages are available for the project members.! Top page of the HPCI CMS for Information Sharing " You can view the page without logging in. However, links of the new information and spaces will not be appeared unless there is no viewing restriction on the linked pages. Therefore, you must be logged in to see links of the computational resources and your project s space. " You cannot edit the page.! Public information space for HPCI users " You can see after logging in. " You cannot edit the page.! HPCI system providers space " In general you can view the pages without logging in, but some pages also restricted to view. " You cannot edit the page.! Computational resources space " In case of registered as a user of computational resources, you can view the contents once you logged in. However, some pages also restricted to view. " You cannot edit the page.! Project space " Member of a project can view and edit the space details once you log in. 6

3. Login In order to use HPCI CMS for Information Sharing, please access the URL below. https://www.hpci-office.

8 3. Login In order to use HPCI CMS for Information Sharing, please access the URL below. Top page of the HPCI CMS for Information Sharing will be displayed when you access this URL Figure 3-1 Top page of the HPCI CMS for Information Sharing 7

Since HPCI CMS for Sharing Information is ready for single sign-on (SSO), however, you can skip this chapter if you have already been authenticated with your HPCI account.

9 Since HPCI CMS for Sharing Information is ready for single sign-on (SSO), however, you can skip this chapter if you have already been authenticated with your HPCI account. In order to login to the HPCI CMS for Sharing Information with your HPCI account, you can click on 'People who have an HPCI account click here' link (Figure 3-1 2) or click on Login link in toolbar (Figure 3-1 1). Once you click the link, you will see the primary center selection page (Figure 3-2). It should be noted that you will not see 'People who have an HPCI account' box, if you already completed authentication request with your HPCI account. Figure 3-2 Primary Center Selection Page At the primary center selection screen, you should select your primary center that specified as your primary center at the time of issuing HPCI-ID. Once you selected it, you will see the login page of that primary center (Figure 3-3). Here, please login with your HPCI account. Figure 3-3 Primary Center Login Page 8

10 Once you successfully login, you will get to the top page of the HPCI CMS for Information Sharing. If you click on Login with your local account click here link (Figure 3-1 3), you will see the login page (Figure 3-4) that not supported the HPCI account. If you come to this page by a mistake, please click on For HPCI account holders, please go and login here link (Figure 3-4 1). 1 Figure 3-4 Login page that does not support HPCI account 9

11 4. Viewing Contents Information such as public information, etc. shared by HPCI operating office and HPCI system providers, or information shared with the project members can be viewed in the following manner.! By opening a link at the top page of HPCI CMS for Information Sharing from System providers space.! By opening a new information link from announcement and operational information sections at the top page of HPCI CMS for Information Sharing.! Perform a search We will describe these methods in this chapter. 4.1 Navigating from the top page of HPCI CMS for Information Sharing Links to the system providers space and public information appear at the top page of HPCI CMS for Information Sharing ( (Figure 4-1). By opening these links, you will be able to view the top page of each space and public information page. The process of visiting to these links is the same as browsing the web Figure 4-1 Links at the top page of HPCI CMS for Information Sharing 10

12 ! Links to the system providers' space appear in the system providers space block (Figure 4-1 1). By opening these links you can view the top page of each space.! In Announcement (Figure 4-1 2) and Operational Information (Figure 4-1 3) section you will find the links to the new information shared by HPCI operating office and HPCI system providers with view permission. By opening these links you can view each shared information. Here you see only 3 links of the latest information, but you can see more by clicking on 'see more' link (Figure 4-14). At a time 3 additional links will be displayed (Figure 4-2 and 4-3). In case of logging in, new information from all spaces may be increased. Figure 4-2 Before clicking see more link in Announcement section Figure 4-3 After clicking once see more link in Announcement section 4.2 Navigating to the top page of HPCI CMS for Information Sharing Immediately you can return to the top page from any page by clicking on the HPCI CMS for Information Sharing logo (Figure 4-4) located at the left corner in menu bar Figure 4-4 HPCI CMS for Information Sharing Logo 11

13 4.3 Search There is a search field (Figure 4-5, Figure 4-6) at the right corner in menu bar of HPCI CMS for Information Sharing. Here, enter a keyword to perform a search to view contents viewable with permission. Figure 4-5 Search Field (Without Zen design) Figure 4-6 Search Field (With Zen design) In figure 4-7, you can see the search results of the keyword Tokyo. If a link of the desired content displayed here, please open that link. Further you can narrow down your search, if required enter a new keyword (Figure 4-7 1) or please specify the space to be searched in, content type and last revision time (Figure 4-7 2). 1 2 Figure 4-7 Search Results 12

5. Content Editing Each project member can create, edit and delete a page in a project space. In this chapter, we will briefly describe how to add and edit a page. 5.

Here, in order to make top page of a project space as a parent page, first start by viewing the top page.

14 5. Content Editing Each project member can create, edit and delete a page in a project space. In this chapter, we will briefly describe how to add and edit a page. 5.1 Viewing top page of a project space When you create a new page in a project space, you will need a parent page of that page. Here, in order to make top page of a project space as a parent page, first start by viewing the top page. Log in as described in Chapter 3 Login, access to the top page of HPCI CMS for Information Sharing, click here as mentioned in (Figure 5-1) Here are the restricted project space links of the current fiscal year. Figure 5-1 Project space link You can view top page of a project space by opening the link displayed in the project space list (Figure 5-2). Figure 5-2 Project Space List 13

15 5.2 Creating a new page and editing To create a new child page under a top page of a project space, first click on create button (Figure 5-3) in the top menu while viewing the top page. Select Blank page (Figure 5-4) and click on Create button. Figure 5-3 Top Menu (Create) Figure 5-4 Create a new page Then, a new page editor will be displayed. You can perform the following editing task just like you use a word processor.! Add a page title here 1.! Add body text of the page here 3. By using the editor toolbar 2, you can specify text format as bold, italic, or you can add bullets, links, tables, etc.! Press Save button 4 for saving your page Figure 5-5 Page edit screen 14

16 5.3 Viewing a newly created page A page link will be created automatically in the sidebar (Figure 5-6), after creating a new page as described in section 5.2 Creating a new page and editing. Also, you can view a page by searching as described in section 4.3 Search. Figure 5-6 A link of the newly created page 5.4 Editing an existing page In case of editing an existing page, first view that page and click on the edit icon (Figure 5-7). Then, you will see a page editing screen as figure 5-5. You can perform the page editing as described in section 5.2 Creating a new page and editing. Figure 5-7 Edit Icon 15

17 6. Quick Reference In this chapter, we will briefly introduce each button and menu item we use in HPCI CMS for Information Sharing. 6.1 How to use HPCI CMS for Information Sharing (Common Parts) Explaining operating procedure of the common parts in HPCI CMS for Information Sharing Figure 6-1 Operating Procedure (Common Parts) 1 System Logo Link to the top page of CMS 2 Space drop-down list Figure 6-2 Space Drop-down list " Recent Spaces Displays a list of recently viewed pages of spaces " Space Directory Link to the Space directory screen Displays a category list of all spaces 16

18 3 Create Link to the Create Page screen You can choose a page template that you intend to use. Figure 6-3 Create Page 4 Search Perform a quick search. Displays the search result screen. Figure 6-4 Search Results 17

5 Help Drop-down list Displays the links such as information, specification of Confluence. Figure 6-5 Online Help " Online Help Displays the Confluence information page of Atlassian company.

19 5 Help Drop-down list Displays the links such as information, specification of Confluence. Figure 6-5 Online Help " Online Help Displays the Confluence information page of Atlassian company. " Keyboard Shortcuts Displays a list of keyboard shortcuts available for HPCI CMS for Information Sharing. " Feed Builder Displays the RSS feed builder screen. You can create a customized RSS feed. " Available Gadgets Displays a list of gadgets available for this system. " About Confluence Displays the version and license information of Confluence. 18

20 6 User Drop-down list Figure 6-6 User Menu " Update Status To set or update your status (What are you working on?). " Recently Viewed Displays recently viewed content in a popup window. " Profile Displays user s profile. You can also change your avatar. " Tasks Displays a list of the tasks, created by you or assigned to you. " Favorites Displays the pages you have marked as favorites. " Watches Displays a list of the pages and spaces you are currently watching. " Drafts Displays a list of the unsaved or unpublished contents. " Status updates Displays your history of status updates. " Network Displays the recent activity of users you are following. " Settings Displays the user information settings window. You can edit your language, time zone, etc. " Atlassian Marketplace Non-administrator cannot use it. " Log Out Logout functionality. 19

21 7 Edit Edit your current content. For editing a page please refer to section 6.2 Updating a Page or editing a blog please refer to section 6.3 Updating a Blog. In case of viewing a page that is restricted to edit, this option will not be displayed in the menu. 8 Watch Start to receive notifications for changes to the pages. 9 Share You can use the Share option to current page link to users of HPCI CMS for Information Sharing or to anyone with an address. Figure 6-7 Share 20

10 Tools Choose an option from the following list to apply an operation to the current content. Figure 6-8 Tools Menu " Attachments You can attach a file to the current content.

22 10 Tools Choose an option from the following list to apply an operation to the current content. Figure 6-8 Tools Menu " Attachments You can attach a file to the current content. " Restrictions (Page only) You can restrict either viewing or editing of the current page. Figure 6-9 Page Restrictions " Favorite The current page will be marked as a favorite. 21

23 " Page Information Displays the properties of the current page. Figure 6-3 Page Information " Resolved comments Displays the resolved inline comment. " Link to this Page Displays the link (URL) of the current content. Figure 6-4 Link to this Page 22

24 " Viewing Hierarchy (only Pages) Displays the current page hierarchy tree of parent child relation. Figure 6-5 Viewing Hierarchy of the Pages " View Source Displays the format used for current content within the editor panel in a separate window. " Export to PDF (Page only) Exporting the current content into PDF format. " Export to a Word document (Page only) Exporting the current content into Word document (Word format). " Import a Word document (Page only) Importing a Word document (*.doc, *.docx) as a page. Figure 6-6 Import a Word document 23

25 " Copy (Page only) It will open a copy of the current page s content in the editor. " Move (Page only) Moving the current page to a new space. Figure 6-7 Move " Delete Deleting the current page. Figure 6-8 Delete 11 Sidebar Displays the menu on space management window, you can change the space logo and name. You can also create space related links and set the tree view of the contents. 12 Links (Space, Content) Clicking on a link that contains a space name, will open a home page of that space. In case of clicking a link that contains a content name, will open that content. 24

26 6.2 Updating a Page Explaining about how to update a page Figure 6-9 Updating a Page 1 Title Add your page title. 2 Editor toolbar A page editor toolbar. 3 Page body Add body text into your page. 4 Restriction setting Set viewing and editing page restriction rights to a group or individuals. 5 Labels Add labels to the page. You cannot use the following characters in labels. Half-width space,!, #, &, (, ), *,,,., :, ;, <, [, ], ^ 6 Changes to content Add a change comment. 7 Notify watcher Send a notification to people watching the page at the time of publishing a page. 8 Preview Preview will show you how it will appear edited content on your page. 9 Save Save updated page. 10 Close Cancel editing and close page Page has a hierarchical relationship. If you add a page while viewing an existing page, the new page will be created as a child page of that existing page. 25

27 6.3 Updating a Blog Explaining about how to update a blog Figure 6-10 Updating a Blog 1 Title Add your blog title. 2 Editor toolbar A blog editor toolbar. 3 Blog body Add body text into your blog. 4 Restriction setting Set viewing and editing blog restriction rights to a group or individuals. 5 Labels Add labels to the blog. You cannot use the following characters in labels. Half-width space,!, #, &, (, ), *,,,., :, ;, <, [, ], ^ 6 Changes to content Add a change comment. 7 Notify watcher Send a notification to people watching the page at the time of publishing a page. 8 Preview Preview will show you how it will appear edited content on your blog. 9 Publish Save and publish the edited blog. 10 Close Cancel editing and close blog. 26

28 6.4 Space Export Explaining how to export a space. You will need Export Space permission for exporting a space File formats for space export 1 PDF Format Combine all of the pages which you have permission to view into a single PDF file. Only paste attached images that have been inserted onto a page. PDF export causes a high load on the server, please do not use it. 2 HTML Format It will export the space in a format suitable to view in a web browser. HTML files, stylesheets and attachments will be compressed to zip format. Page name will be the name of the HTML file. In case of a Japanese or other characters takes more than 2 bytes will be encoded in URL. Top page will be index.html and links to each page will be created. Attachments will be placed in the Attachments folder with the name as File ID in Confluence +.Extension. 3 XML Format It will export the space in a format suitable for importing back into Confluence. XML files and attachments will be compressed to zip format. Exported data can be used as a space-backup and can be imported into a separate confluence. (Confluence version compatibility should match). Entities.xml, an xml file containing the collectively output of all pages data. Attachments will be placed in a directory created as File ID in Confluence under Attachments folder. The file name will be the version number of each page. 27

29 6.4.2 How to export a space 1 Choose Content Tools from the Space tools menu on the sidebar, then choose Export (Figure ). However, it will not appeared in the menu in case of space export permission not granted to you Figure 6-11 Export 2 Select the export format type (Figure ), and then click on the Next button. 28

30 3 Choose export option, and then click on the Export button. Full Export (Figure ) Choose when you want to export all of the pages and attachments. Custom Export (Figure ) Choose when you don't want to include comments and just want to export some selected pages. 1 2 Figure 6-12 Export Options 4 Download Export File When the export process has finished a file download link (Download here) will be appeared. Download and save the file. Figure 6-20 Export complete. (Download) 29

31 6.5 Encoding of the attached text file When you open an attached text file in a browser, it always displays in default UTF-8 character encoding. For this reason, if you open a text file that created in a different character encoding, does not appear correctly as encoding type does not match with your default setting. (Example: Figure 6-21) In this section, explaining how to open an attached file which encoding type does not match. Figure 6-13 Viewing a file that was created with Shift_JIS encoding (Firefox) 1 Change encoding setting in your browser according to encoding type of an attachment file such as Shift_JIS, EUC-JP, etc. Figure 6-14 Character encoding type was changed in the browser (Firefox: UTF-8 Shift_JIS) 2 Temporarily download the file and open it in your text editor. Please use a text editor that can display the encoding type of a text file. 30

HPCI Help Desk System User Manual Ver. 5

Document ID:HPCI-OF01-002E-05 HPCI Help Desk System User Manual Ver. 5 2017/6/7 HPCI Operating Office Revision History Date issued Ver. Descriptions 2012/3/30 1 2013/9/30 2 A full-fledged revision is made