GO-GLOBAL Gateway API Sample Version 4.8.2
COPYRIGHT AND TRADEMARK NOTICE Copyright 1997-2015 GraphOn Corporation. All Rights Reserved. This document, as well as the software described in it, is a proprietary product of GraphOn, protected by the copyright laws of the United States and international copyright treaties. Any reproduction of this publication in whole or in part is strictly prohibited without the written consent of GraphOn. Except as otherwise expressly provided, GraphOn grants no express or implied right under any GraphOn patents, copyrights, trademarks or other intellectual property rights. Information in this document is subject to change without notice. GraphOn, the GraphOn logo, and GO-Global and the GO logo are trademarks or registered trademarks of GraphOn Corporation in the US and other countries. Microsoft, Windows, Windows NT, Internet Explorer, and Terminal Server are trademarks of Microsoft Corporation in the United States and/or other countries. Linux is a registered trademark of Linus Torvalds. UNIX is a registered trademark of The Open Group. Red Hat is a trademark or registered trademark of Red Hat, Inc. in the United States and other countries. Adobe, Acrobat, AIR, Flash, and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Firefox is a registered trademark of the Mozilla Foundation. Mac, Mac OS, and Safari are trademarks of Apple Inc., registered in the U.S. and other countries. Portions copyright 1998-2000 The OpenSSL Project. All rights reserved. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (www.openssl.org). Portions copyright 1995-1998 Eric Young (eay@cryptsoft.com). All rights reserved. This product includes software written by Eric Young (eay@cryptsoft.com). This product includes software written by Tim Hudson (tjh@cryptsoft.com). All other brand and product names are trademarks of their respective companies or organizations. Printed in the United States of America. 1 P a g e
CONTENTS 1 Introduction... 2 2 Setup... 2 3 Running the Gateway API Sample... 5 1 P a g e
1 INTRODUCTION This document describes a series of GO-Global Gateway API methods that can be used to programmatically perform operations on GO-Global hosts. Supported operations include authenticating users on hosts, starting applications, listing folder contents, and managing and editing files. The sample.html file deployed with the gateway exercises the Gateway API. Each button in sample.html calls an API method which is described in more detail in the GO-Global Gateway API document. The buttons are grouped by REST resource: portal, host, workspace, folder, and file. 2 SETUP Before running the Gateway API Sample, you must install the GO-Global gateway, host, and client. 2.1 Install the Gateway To install the gateway, run the gateway setup program. (On 32-bit systems, run go-global.windows_x86.exe; on 64-bit systems, run go-global.windows_x64.exe). The setup program will prompt you to enter a password. This is the password for the gateway s admin account. It is also the password that the gateway uses to connect to its database. 2.2 Install the Host To use the GO-Global Gateway API, at least one host must be connected to the gateway. You can install the host on the same computer as the gateway or on a different computer. To install the host, run the host setup program. (On 32-bit systems, run gg-host.windows_x86.exe; on 64-bit systems, run gg-host.windows_x64.exe). After accepting the terms in the license agreement, click Install the Gateway Connector. Restart the computer when prompted. 2 P a g e
2.3 Connect the Host to the Gateway To connect a host to the gateway 1. At the end of the host setup process, when the Gateway Connector opens after restarting the computer, click Yes to connect the host to a gateway. Alternatively, if you are connecting a host to a gateway at a later time, run the Gateway Connector from the Start menu: On Windows Server 2003, click Start All Programs GraphOn GO-Global 4 Tools Gateway Connector. On Windows Server 2008, click Start All Programs GraphOn GO-Global 4 Tools Gateway Connector Run as administrator. 2. If the User Account Control dialog is displayed, click Continue. 3. In the Connection dialog, type the network address (e.g., wilson.graphon.com) of the gateway you are connecting to in the Address box. Click Connect. 4. In the Sign in dialog, type the user name and password of a gateway administrator. This may be the account you used when you installed the gateway, an account that is a member of the Domain Admins group, or an account that you added to the iwa-ldap-authentication.xml file described above. Click Sign In. 5. In the Name Your Computer dialog, type a name for the computer in the Name box. This name is displayed in the gateway. Type the computer's hostname (e.g., wilson.graphon.com) in the Address box. The full domain address is required when the gateway and host are on different domains. 6. Click Ok. An icon for the host will appear in the window. Initially, the icon is gray, indicating that the host is offline. Within about 30 seconds, the icon will turn blue, indicating that it is now online and can be accessed from GO-Global Gateway. 3 P a g e
2.4 Publishing Hosts to Users or Groups In addition to publishing applications and documents to users, you can publish hosts to users and groups. You can do this, for example, when you want users to have access to all of the applications on a host. To publish a host to users or groups 1. Sign in to the gateway as a gateway administrator. 2. Double-click the host to start a session. 3. Click the Toggle navigation pane button on the toolbar. 4. Select the host from the Content Pane or the Navigation Pane. 5. Click the Edit Properties button on the toolbar. 6. Click the Security tab. 7. From the list on the left, select the user(s) and/or group(s) you would like to grant access to. Search for users or groups by typing all or part of the group or user's name in the Search box, then clicking the Search button. 8. Select the users/groups, and click Add. 9. Click Save. When an authorized user signs in to the gateway, the host will be displayed and the user can connect to the host by double-clicking it. 2.5 Install the GO-Global Client The GO-Global Gateway API can be accessed from any computer that has either a Flash-enabled browser or a GO-Global Client. For best results, install the GO-Global Client. On Windows computers, run gg-gateway-client.exe. 4 P a g e
INTRODUCTION NTRODUCTION 3 RUNNING THE GATEWAY API SAMPLE The Gateway API sample can be accessed from a browser using the following URL: http://[gateway_address]:8080/go-global/api/sample.html The sample.html page contains buttons, controls and embedded JavaScript code that illustrate how to call the API s methods. The following sections describe how to exercise the Gateway API using the sample.html page. 3.1 Sign in to the Gateway To sign in to the gateway 1. In the UserName field to the right of the Sign in button, type the user name for a domain account. 2. In the Password field, type the password for the account. 3. Click Sign in. The Result column will display a unique user instance id that will be used in subsequent API calls. This value will be automatically copied into the UserInstanceId field to the right of the Authenticate to Host button. 3.2 List Available Hosts To list available hosts, click Get Items. If the host is not listed in the Result column on the right, make sure you successfully signed in to the gateway and that the user has been granted the right to access the host. 3.3 Sign in to the Host To sign in to the Host 1. Copy the host id from the result of step 3.2 into the Host ID field to the right of the Authenticate to Host button. 2. In the UserName field, type the name of a Host user account. 3. In the Password field, type the password of the Host user account. 4. In the Domain field, type the name of the domain on which the Host user account exists. If the account is a local account, type the name of the Host computer. 5. Click Authenticate to Host. If successful, a session ID and the value started=true will be displayed in the Result column. 5 P a g e
3.4 View the Contents of Folders on the Host 3.4.1 To view the contents of the public Desktop folder 1. Type PublicDesktop into the Location field to the right of the Get Folder button. 2. Leave the other fields blank. 3. Click Get Folder. 3.4.2 To view the contents of the user s private Desktop folder 1. Type PrivateDesktop into the Location field. 2. In the Workspace Name field, type the name of the workspace. Typically, this is the name of the user account specified in step 3.3. 3. Leave Folder Path Name blank. 4. Click Get Folder. 3.4.3 To view the contents of the user s Documents folder 1. Type documents into the Location field. 2. In the Workspace Name field, type the name of the workspace. 3. Leave Folder Path Name blank. 4. Click Get Folder. To view the contents of subfolders of any of the above folders, enter a relative pathname in the Folder Path Name field. For example, to view the contents of a folder called "test" which is a subdirectory of the public Desktop folder, enter location="publicdesktop", workspace name=empty and Folder Path Name = "test". 3.5 Create a File on the Host To create a file on the Host 1. Enter some text into the File Data field to the right of the Put File button. 2. Type the location of the file (e.g., documents) into the Location field. 3. Enter the name of the workspace in the Workspace Name field. 4. In the File Path Name field, type test.txt. 5. Click Put File. If successful, the word Success will appear in the Result column and a file, test.txt, will be created in the user s Documents folder on the Host. This can be verified using the Get Folder option with location = "documents". Note: The file s data can come from any source. For example, it can come from a file on the client computer or from a file in a document management system. 6 P a g e
3.6 Retrieve a File from the Host To retrieve a file from the Host 1. Type the location of the file (e.g., documents) into the Location field to the right of the Get File button. 2. Enter the name of the workspace in the Workspace Name field. 3. In the File Path Name field, type test.txt. 4. Click Get File. If successful, the contents of the file will appear in the Result column. 3.7 Launch an Application or File The Launch File command can be used to open applications, documents or files on the Host. In the sample.html page, the Launch File command reads its parameters from the fields next to the Get File button. 3.7.1 To open the test.txt file created in 3.5 1. Click Launch File. A browser window will appear, and then Notepad will open with test.txt loaded. 2. Edit the file and save it. 3. Click Get File. The updated content will be displayed in the Result column. 3.7.2 To open an application from a shortcut on the Public Desktop 1. Type PublicDesktop in the Location field to the right of the Get File button. 2. Enter the name of the workspace in the Workspace Name field. 3. In the File Path Name field, type the name of the shortcut (e.g., Notepad.lnk). 4. Click Launch File. The application will open. 7 P a g e