Altova CbC Reporting Solution. Installation Guide

Transcription

1 Installation Guide

2 Installation Guide All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Published: 2017

3 Table of Contents 1 Introduction 5 2 Installation VMware... Player The... Virtual Machine MobileTogether... Server License Start... CbC Reporting Solution Important... Information 14 Index 17 3

4

5 Introduction 5 1 Introduction Altova's CbC Reporting Solution enables you (i) to import and edit, or directly enter, your CbC Reporting data in a standard browser interface, and (ii) to generate XML output that is compliant with the OECD CbC Reporting XML Schema definition. The CbC Reporting Solution is deployed to a special server Altova's MobileTogether Server which you can install on a machine on your network. From here, the solution can be served to a client browser. When the solution is opened in a browser, it can be used to edit and generate your CbC report. The various components of the system are shown in the diagram below.

6 6 Installation 2 Installation The is available as a Virtual Machine (VM) named cbc-reporting. All the program components that are necessary to run the CbC Reporting Solution are preinstalled on the VM (see diagram below). All that you need to do is to download the VM to a computer on your network and license the pre-installed Altova MobileTogether Server. After doing this, you can start the VM, then open the CbC Reporting Solution in a browser and immediately begin working with it. Installation steps Carry out the following steps to install the CbC Reporting Solution as a virtual machine: 1. Install VMware Workstation Player. 2. In the player, open the virtual machine that you have downloaded from the Altova website, and configure it. 3. Obtain a license for Altova MobileTogether Server. 4. Open Altova LicenseServer (pre-installed on the VM) in a web browser and assign the MobileTogether Server license to MobileTogether Server (pre-installed on the VM). See 10 MobileTogether Server License. 5. Open the CbC Reporting Solution in a web browser and start work on your project. Each of these steps is explained in the rest of this chapter.

7 Installation VMware Player VMware Player In order to run the virtual machine (VM) that contains the CbC Reporting Solution, you will need to install VMware Workstation Player. You can download the latest VMware Workstation Player from the Downloads page of the VMware.com website. Install VMware Workstation Player on any suitable machine on your network. On opening the player, you will see a screen like the one shown in the screenshot below. In the player, you can create new VMs and open existing VMs. Any VM you create or open is listed in the library, which is shown in the left pane of the player window (see screenshot above). After you download the VM that contains Altova's CbC Reporting Solution, open the VM in the player. The VM will be added to your player library. Location of the VMware Workstation Player After the VM has been opened and is running in the player, the CbC Reporting Solution that is contained in the VM can be accessed by typing in the solution's URL in a browser. Work scenarios anywhere between the two listed below are possible: The user of the solution accesses the player, manages the VM library, and works with the solution via a web browser. An administrator manages the VM library. The user works with the solution via a web browser, but is not involved in the management of the VM library. Depending upon the working environment, suitable access and security permissions must be set for the location where the VMware Workststion Player is located.

8 8 Installation The Virtual Machine 2.2 The Virtual Machine The CbC Reporting Solution is available as a Virtual Machine (VM), named cbc-reporting, that can be opened in VMware Workstation Player. The VM contains the following program components: Altova LicenseServer, which is is installed on the VM and is required to license Altova MobileTogether Server Altova MobileTogether Server, which is installed on the VM and is registered with the LicenseServer that is installed on the VM. is pre-deployed on MobileTogether Server and is ready to be accessed MobileTogether Server serves the CbC Reporting Solution to web browsers and is used for processing actions that a user executes in the solution. Note: Although MobileTogether Server is registered with Altova LicenseServer, you must still purchase a license for MobileTogether Server and license it. How to do this is described 10 in the next section of this chapter, MobileTogether Server License. Obtaining the VM The VM that contains (CbCR VM) can be downloaded from: here. Save the VM to a location that has suitable access and security permissions. To log in to the VM, a username and password is required. These are: username: cbc-reporting password: cbc-reporting

9 Installation The Virtual Machine 9 Configuring the VM Configure the VM as follows: 1. Start VMware Workstation Player. 2. Select Player File Open. Browse for the VM's configuration (.vmx) file, and click Open. The VM appears in the library (see screenshot below). 3. Select the VM in the library and select Player Power Power On. Alternatively, you can double-click the VM in the library. 4. After the VM has been opened, enter the login username and password when prompted. 5. Select Player Manage Virtual Machine Settings. The Virtual Machine Settings dialog (screenshot below) appears. 6. For the Network Adapter device in the Hardware tab (see screenshot), make sure that the Bridged network connection is selected. 7. Click OK.

10 10 Installation MobileTogether Server License 2.3 MobileTogether Server License The CbC Reporting Solution is deployed to and runs on MobileTogether Server, to use which a license is required. This section describes how to obtain a MobileTogether Server license and assign it from the Altova LicenseServer that is pre-installed on your virtual machine (VM). Obtaining a MobileTogether Server license You can obtain either: a free 30-day MobileTogether Server evaluation license (via Altova LicenseServer; procedure described below), or a paid MobileTogether Server license via the Altova Online Shop (in case of questions, contact sales@altova.com) After obtaining a license, the license must be uploaded to Altova LicenseServer and assigned from the LicenseServer's administrator interface to MobileTogether Server. Assigning a MobileTogether Server license This section describes (i) how you can obtain a free 30-day MobileTogether Server evaluation license via Altova LicenseServer, (ii) how to upload the license to the license pool of Altova LicenseServer, and (iii) how to assign the license to MobileTogether Server. The uploading and assigning of a paid license is done in the same way as for the evaluation license. After you have started the virtual machine, do the following to obtain an evaluation license and assign it: 1. In a web browser window, open the web interface of the Altova LicenseServer that is installed on your VM by entering the following URL: The LicenseServer login page is displayed (screenshot below). 2. Enter the initial password default to log in. (You can change the password later in the Settings tab.) 3. Go to the Client Management tab (screenshot below). You will see that MobileTogether Server is registered with LicenseServer, but that it is not licensed.

11 Installation MobileTogether Server License In the right-hand pane click Request evaluation licenses for server products. The Request Evaluation Licenses dialog (screenshot below) appears. 5. Enter the requested information and click Request Evaluation Licenses. 6. A MobileTogether Server license will be sent to the address you entered. Save the license to a file location. 7. In the LicenseServer interface (see first two screenshots of this section), go to the License Pool tab. 8. At the bottom of the License Pool tab, click the Browse button of the Upload License File field, then browse and select the MobileTogether Server license file that you received by and click Upload. The license will now be available in the License Pool. 9. Go to the Client Management tab. Click the client in the left pane to display the MobileTogether Server that is registered for this client.

12 12 Installation MobileTogether Server License 10. In the right-hand pane, click Edit Assigned Licenses (marked in red in the screenshot below). 11. In the Edit Assigned Licenses dialog that appears (screenshot below), select the license (that was uploaded to the license pool) and click Apply Changes. The license will be assigned, and you can now start using the CbC Reporting Solution solution that is pre-deployed to the MobileTogether Server on your VM. Note: For detailed information about using and configuring LicenseServer, click Help in the LicenseServer interface.

13 Installation Start CbC Reporting Solution Start CbC Reporting Solution In order to open the CbC Reporting Solution, the virtual machine (VM) must be powered on. If the VM has not yet been started, then start it in VMware Workstation Player as follows: 1. Start VMware Workstation Player. 2. Double-click the VM in the player's library (see screenshot below). See The Virtual Machine To log in, enter the username and password of the VM (see Important Information 14 ). URL of the CbC Reporting Solution solution After the VM has been started, you can open the CbC Reporting Solution in any one of the following two ways: Directly in a web browser In a web browser type this URL: Via the Work flows tab of the MobileTogether Server client interface This way enables you to avoid typing the entire URL given above.. 1. In a web browser, type this URL to open the MobileTogether Server client interface: If prompted for login credentials, enter them (see Important Information ). 3. Click the public container. 4. Click the URL of the CbC Reporting Solution (in the Run in Browser column).

14 14 Installation Important Information 2.5 Important Information Virtual machine (VM) To log in to the VM: username: cbc-reporting password: cbc-reporting To find the IP address (for example ) and hostname (for example cbc-reporting), after logging in, run these commands at the VM command line: For the IP address: ifconfig For the hostname: hostname Start services If no license is installed, then you need to start services from time to time Start Altova LicenseServer: sudo systemctl start licenseserver Start MobileTogether Server: sudo systemctl start mobiletogetherserver Altova LicenseServer Required in order to license MobileTogether Server. Altova LicenseServer web interface: Altova LicenseServer initial password: default Note: The initial password can be changed in the Settings tab of LicenseServer. MobileTogether Server administrator interface Provides access to MobileTogether Server settings. URL: Default user: root Default password: root Note: To be able to log in to the administrator interface of MobileTogether Server, the username must be one that has administrative rights. A user named root is pre-defined and has administrator rights. So you can log in with administrator rights for the first time as root. You can change the password of root in the Users and Roles tab of the administrator interface. In this tab, you can also create additional users with different privileges.

15 Installation Important Information 15 MobileTogether Server client interface CbC Reporting Solution Replace <host> with the IP address or hostname of your VM Login with user=root and password=root

16

17 Index 17 Index A, as a virtual machine, 6 as VM, see Virtual machine (VM), 8 installation, 6 overview of, 5 starting on VM, 13 URL of, 14 URL on VM, 13 Altova LicenseServer, see LicenseServer, 14 B Bridged network connection, 8 C CbC Reporting Solution, see, 5 cbc-reporting, 8 H hostname command, 14 I initial password of, 14 starting as service, 14 web interface URL of, 14 M MobileTogether Server, administrator interface URL, 14 client interface URL, 14 default user and password, 14 starting as service, 14 MobileTogether Server licensing, 10 O OECD CbC Reporting, XML SChema for, 5 V Virtual machine (VM), adding to player library, 8 bridged network connection, 8 configuring, 8 finding hostname of, 14 finding IP address of, 14 login information, 8, 14 obtaining from Altova as download, 8 starting/powering-on, 8 VM, see Virtual machine, 8 VMware Workstation Player, installation, 7 library of, 8 uasge, 7 ifconfig command, 14 L LicenseServer,

18