Installation and Configuration Manual

Transcription

1 Installation and Configuration Manual

2 IMPORTANT YOU MUST READ AND AGREE TO THE TERMS AND CONDITIONS OF THE LICENSE BEFORE CONTINUING WITH THIS PROGRAM INSTALL. CIRRUS SOFT LTD End-User License Agreement ("EULA") is a legal agreement between you (either an individual or a single entity) and CIRRUS SOFT LTD. For the CIRRUS SOFT LTD software product(s) identified above which may include associated software components, media, printed materials, and "online" or electronic documentation ("SOFTWARE PRODUCT"). By installing, copying, or otherwise using the SOFTWARE PRODUCT, you agree to be bound by the terms of this EULA. This license agreement represents the entire agreement concerning the program between you and CIRRUS SOFT LTD, (referred to as "licenser"), and it supersedes any prior proposal, representation, or understanding between the parties. If you do not agree to the terms of this EULA, do not install or use the SOFTWARE PRODUCT. The SOFTWARE PRODUCT is protected by copyright laws and international copyright treaties, as well as other intellectual property laws and treaties. The SOFTWARE PRODUCT is licensed, not sold. Page ii

3 Version History Change Record Date Author Version Change reference 2018, January SharePoint Timeline 2018, December SharePoint Timeline Ability to show Timeline for item versions Initial Release for SharePoint. Current Version for SharePoint Online Name Version Approved Compatibility Date SharePoint Timeline SharePoint Timeline Version SharePoint 2013, SharePoint 2016, SharePoint Online / Office , January Page iii

4 Table of Contents Introduction... 1 Timeline Benefits and Features... 2 Timeline Installation... 3 Types of License... 3 Installing Timeline App... 3 How to Use Timeline... 4 Configuration Pane... 5 Preview Pane... 6 Configuration Pane: General Setting... 7 Right Panel: Content Setting Manage Files SharePoint Timeline Support Page iv

5 Introduction SharePoint Timeline is the SharePoint add-in that allows you to easily create beautiful vertical and horizontal Timelines to convey any information chronologically, with the content surfaced from your SharePoint lists. Use Timeline to display News, Version History, Event Sequences, Results and more. The Timeline is created with the Timeline Builder and then added to a designated space on your SharePoint page/s. Once inserted on a page the SharePoint Timeline is dynamic, reading live data, direct from SharePoint lists. Timeline Web Part visit to download the SharePoint Timeline Web Part to display Timelines on SharePoint Pages. *** The SharePoint Timeline add-in works in conjunction with another add-in i.e. The SharePoint Timeline Web Part, which is only available from the SharePoint Timeline Web Site. This requires installation on your environment outside of the Microsoft Office Store processes due the level of required permissions. A tenant administrator will need to deploy this specific add-in to the tenant app catalog site manually, so that it can be installed to your environment. We have added required steps that need to be followed to install the web part add-in package (downloaded from the SharePoint Timeline Web site). When apps are installed outside of the Microsoft Office Store, they may bypass any, and all, safety and security checks provided by Microsoft. You may wish to establish contact with the SharePoint Timeline Support before proceeding with installation. Also, please consider trying this add-in on a separate SharePoint Tenancy before installing it on your primary SharePoint site(s). Page 1

6 Timeline Benefits and Features SharePoint Timeline is the SharePoint add-in that allows you to easily create beautiful vertical and horizontal Timelines to convey any information chronologically, with the content surfaced from your SharePoint lists. The Timeline is created with the Timeline Builder and then added to a designated space on your SharePoint page/s. Once inserted on a page the SharePoint Timeline is dynamic, reading live data, direct from SharePoint Lists. Automatically build a Timeline from a SharePoint List, using Text, Images, and even Videos. Timeline Features: Easy to install, easy to use, no training required. Quick and easy setup. Timeline Builder. Read Timeline Content from any SharePoint list (default list included). Timeline Webpart to include to any page. Dynamic data from lists means the Timeline is always up to date. Creative, progressive & trendy. Over 15 Timeline display styles to choose from. Over 35 Timeline transition styles. Fully Responsive. Excellent UK based support. Page 2

7 Timeline Installation Types of License Timeline is made available from the Office Store (per user licence) and directly from Cirrus Soft (for Site, Site Collection and Farm/Tenant license) Installing Timeline App To add an app from the SharePoint Store 1. Verify that the user account that is performing this procedure is a member of the site Owners group. 2. On the home page, under Get started with your site, click Add lists, libraries, and other apps. 3. If the Get started with your site control does not appear on the home page, click the Settings icon, and click View Site Contents, and then on the Site Contents page, click Add an App. 4. Click SharePoint Store. 5. Browse the SharePoint Store for Timeline. 6. Click the Timeline App. 7. Click Details, and then click Buy It. 8. Follow the steps to log in and purchase the App, if required. 9. In the Grant Permission to an App dialog box, if you trust the App, click Allow Access. 10. The Timeline App is now added and appears in the Apps section of your Site Contents list. *For SharePoint 2013/2016 on premise installations you will be provided with the Timeline.app file to add to the app catalogue for the Content Slider Add-in to be made available within your SharePoint environment. Page 3

8 How to Use Timeline Go to Timeline 1. Click on Open Timeline Builder button to go to Timeline Builder. Timeline Page The Timeline Builder allows you to create Timelines to insert into SharePoint pages with the Timeline Webpart. The Builder includes a live preview pane to selects styles, transition effects and to configure the Timeline with the field contents from any SharePoint List. Page 4

9 Configuration Pane In the Configuration Panel you set the SharePoint list data that the Timeline will surface, the Timeline style and transition effect. Page 5

10 Preview Pane The preview pane will dynamically display any configuration changes that are made whilst you build your Timeline. Page 6

11 Configuration Pane: General Setting General Settings: Here you apply the settings for style, animation effect and the SharePoint list from where to get the Timeline contents. List/Library This will list all lists and libraries from your site. Select the list/library from where you want to get data. Page 7

12 Order By This will sort data based on sort direction and sort field you select. Filter Display content from the selected list based on a filter expression. You can write your filter expression for display. Ref for Expression: Number of Records This value will determine how many Timeline records will display from the SharePoint list. Page 8

13 Set Height/Width This is used to set height and width of the control. The default is set to 100%. (Note: Style 5 requires a set width and height to render) Priority This will define the priority of the contents to render in the Timeline. For example: You set Priority1 as Image, Priority2 as Video and Priority3 as Text. During the Timeline render, if the SharePoint list contains data for each type it will display the content as per the selected Priority. Timeline Style There are several different types of styles for the SharePoint Timeline. When a Style is selected the it will dynamically show in the preview panel. Page 9

14 Style 01 Style 02 Page 10

15 Style 03 Style 04 Page 11

16 Style 05 Style 06 Page 12

17 Style 07 Style 08 Page 13

18 Style 09 Style 10 Page 14

19 Style 11 Style 12 Page 15

20 Style 13 Style 14 Page 16

21 Style 15 Style 15 Page 17

22 Style 16 Style 17 Page 18

23 Background Image Background Image is used to select the background. Either from SharePoint or using a custom URL. If you select From SharePoint than this will show you two more options as below. Image Library is from which library you want to select an Image. Image is used for the Image you want to select as the Background Image. For an Example you can see the below selected Images. Here we select Image Library and Image and can see the Background Image in the preview pane. Page 19

24 Now, if you select From URL than you have to paste a URL in the Image Url and that Image will display as the Background Image in the Preview Pane. Page 20

25 No Background Page 21

26 Background Opacity Background Opacity is used to make the Background image transparent. Background Style You can choose the style of Background. There are two options, Tile and Stretch to Fit. If you select Tile than the Image is repeated in the background as below. Page 22

27 If you select Stretch to Fit than it will extend the image picture to fill the Background. Style Colors For certain Styles you have the option to configure each record colour style. There are 8 pre-default themes available. Each number besides control represents record number. You can set maximum 8 alternative colours. After the 8 records it will restart colour scheme. Timeline Animation Effect Page 23

28 There are 45 different Transition Styles to customise the Timeline. Page 24

29 Right Panel: Content Setting Page 25

30 Content Settings are where you set the Configuration of your Timeline. Enable Version Timeline: This will enable the Timeline to display the different versions of an item in the Timeline. Item: Select the item for which you want the versions to appear in a Timeline. Users will be able to select these items (for which they have permission) via the Timeline Web Part. I Page 26

31 Title: The field contents to display the title in Timeline. Image: The field contents to display the Image in the Timeline. Page 27

32 Strat Date Time: The field contents to display the date in the Timeline. End Date Time: The field contents to display date in Timeline. Page 28

33 Description: The field contents to display Description in the Timeline. Editor: The field contents to display the editor details in the Timeline. Page 29

34 Category: The field contents to display the different categories related to the Timeline. Icon: The field contents to display the Icon on the Timeline. The Icons that are used are from Font Awesome ( use these references as required. The Timeline will use the Font Awesome reference in the SharePoint list and render Icons. Page 30

35 YouTube URL: The field contents to display the YouTube video on the Timeline. Destination Link: The field contents to display and go to the URL when the Timeline item is clicked. Page 31

36 Location: The field contents to display the Location in the Timeline. Page 32

37 Manage Files New Click New to create new Timeline / File. In the Popup enter the name of File. Timeline File Name. Page 33

38 Save You can create multiple Timelines and save, edit and organise these within folders. Once you insert a Timeline into a SharePoint Page with the Timeline WebPart you can select the Timeline from those saved. Any update will reflect on the page. Show/Hide Folder allows you to organise your Timeline files. If you Click on this, it will show you options to Select an existing Folder. To add folders, see the Manage Folders section below. Load To Open an existing Timeline file, click Load. From the Load/Open popup you can select the Timeline file to open (click on the Timeline Name), for editing, or delete existing files. Load > Import The Import feature can be used to import existing Timelines from another site. Page 34

39 Paste the contents of a previous export and click on Import. Load > Export Use Export to download the Timeline file for future Import. Load > Delete The Delete option will delete the Timeline file. Page 35

40 Folder Click Folders if you would like to organise your saved Timelines within a folder structure. Folder > Manage Folders From the Folder popup you can create New folders and Delete existing folders. Folder > Create First Level Folder Use this option to create different level folders. Folder > Create Add the Name of the folder. Once you have set up your folders these will be available to select when saving your Timelines. Page 36

41 SharePoint Timeline Support Thank you for choosing SharePoint Timeline. If you require any further assistance please visit our online Support Centre or Contact Us. Page 37