MotionBoard Agent Usage Guidelines

Transcription

1 MotionBoard Agent Usage Guidelines (MotionBoard Cloud Version) Ver.1.3 WingArc1st Inc. 1

2 Table of Contents About This Document... 3 License Agreement... 3 How to Log in to MBA... 4 Item Types That Can be Used in MBA... 5 File Types that Can be Used in MBA... 6 Notes on Upgrading MBA... 7 Notes on Auto Upload Settings... 8 Notes on Using a Proxy Server When Data Cannot be Uploaded From the MBA

3 About This Document This document contains Notes on using MotionBoard Agent (hereinafter referred to as MBA) in MotionBoard Cloud. For usage, see "MotionBoard Agent Operation Guide" in the online manual. License Agreement The software covered by this License Agreement is intellectual property of WingArc1st, Ltd. and is protected by copyright law. MBA installation is limited to one license per company. 3

4 How to Log in to MBA 1. On the login screen to MBA, enter the following information. Tenant ID: Tenant ID written on delivery note User ID: User ID written on delivery note Password: Password written on delivery note Server URL: 2. Click the Log in button. 4

5 Item Types That Can be Used in MBA Three types of items can be uploaded to/downloaded from MBA. 1. Private Item (file storage) File size per file should be 100 MB or less and the number of records should be one million or less. 2. Shared Item (file storage) File size per file should be 100 MB or less and the number of records should be one million or less. 3. Data Storage Maximum file size per file is 2 GB or less. * Uploading a file to data storage may not be possible even if the file is 2 GB or less if the cardinality of the data in the file (the number of types of values) is large. 5

6 File Types that Can be Used in MBA Three types of files can be uploaded to/downloaded from MBA. 1. CSV file *.csv, *.tsv, *.txt 2. Excel file *.xls, *.xlsx 3. Image file *.jpg, *.gif, *.png 6

7 Notes on Upgrading MBA In order to upgrade the MBA, it is necessary to stop the existing MBA service, terminate the resident application, uninstall the existing version, and then install it with the latest installer. [Procedure to uninstall existing MBA] 1. From the control panel, open Administrative Tools - Services, right click on "MotionBoard Agent xx" and select Stop. 2. Right-click the resident application on the task tray and click Exit. 3. Uninstall "MotionBoard Agent xx" from Programs and Features in the control panel. 7

8 Notes on Auto Upload Settings MBA uses the task function in MotionBoard when uploading files. When operating under the auto upload settings, MBA must be running at all the time due to the nature of MBA. In this case, we recommend installing it on a server PC instead of each terminal PC. The number of simultaneous tasks such as data import and chart distribution is one per tenant. Please do not overlap the task execution such as MBA's upload timing and task distribution of the chart. Execute at 2AM Execute at 2AM Changed to 4AM MotionBoard Agent Example: If both tasks are executed at 2AM, the tasks will be overlapping, so one should be executed at 4AM (The MBA's time is changed in the figure). 8

9 For auto upload settings, in both cases for schedule setting and file update monitoring setting, it is necessary to consider the timing of the task settings of the server side and the impact range in operation. To check if the MBA is running, click System and Security - Administrative Tool - Services from the control panel and check the "Status" for "MotionBoard Agent xx" on the following screen. When you open the MBA screen and minimize it, the "MotionBoard Agent" icon is displayed in the task tray of the screen as shown below. For auto upload settings by schedule, upload will be tried only the first time, and even if upload fails, it will not retry and second attempt and thereafter will not be made. For auto upload settings by file update monitoring, even if the upload fails, as long as the updated file exists, upload will continue retrying. In this case, all the files updated after the end of previous MBA session up to the beginning of the current MBA session will be uploaded. Therefore, please do not overlap auto upload task using MBA schedule with other task such as chart distribution. 9

10 Notes on Using a Proxy Server In an environment connecting to the Internet via a proxy server, after MBA installation, you need to configure the config file. [Setting procedure of config file] 1. Open the following file in the folder where MBA is installed with a text editor. <Installation_folder> data conf config.xml 2. Enter proxy server information in the file. Host name: Behind <entry key="proxyhost"> tag Port number: Behind <entry key="proxyport"> tag User ID: Behind <entry key="proxyuserid"> tag Password: Behind <entry key="proxyuserpass"> tag [Setting example] (Text in red) <MotionBoardAgentConfig version="1.0"> <properties> <entry key="asyncwaittime">30</entry> <entry key="asyncwaitmaxretry">5</entry> <entry key="lockcheckwaittime">30</entry> <entry key="lockcheckmaxretry">5</entry> <entry key="uploadgatewaycontexturl"> <entry key="proxyhost">proxyserver</entry> <entry key="proxyport">80</entry> <entry key="proxyuserid">user</entry> <entry key="proxyuserpass">password</entry> </properties> </MotionBoardAgentConfig> * Specify the user ID and password only when it is necessary for authentication to the proxy server, leave it blank if it is not necessary. 3. Save the file and close it. 4. Restart the MBA service. 10

11 When Data Cannot be Uploaded From the MBA Please check the followings. Is the MBA service started? See page 9 in this document for how to check the service status. When the service is started Please click "MotionBoard Agent xx" and Restart. When the service is stopped (if "Status" field is blank) Click "MotionBoard Agent xx" and Start. Is the MBA version correct? You can download the correct MBA version for your environment by doing the following steps: 1. Login to MotionBoard Cloud (for Salesforce). 2. Go to [Management] and click [MotionBoard Agent Download]. 3. Specify a save location for the installer. Note: Make sure the user has the necessary permission to download the MB Agent. Is the text encoding the same as the encoding when data storage was created/defined for the first time? (For example: If the initial file is in "Shift-JIS" format, upload files in the "Shift-JIS" format as well) Does the CSV file contain a header line? Is the number of items in the CSV file correct? Is the delimiter in the CSV file "comma (,)"? Are the quotation marks "none" or "double quotations (")"? Does the data type of the data storage item match with the type of the data you are adding? (Example: Adding text data to numeric type item results in an error) You can set the item type of data storage when creating/defining data storage for the 11

12 first time, but it cannot be changed once created/defined. If you want to change the type of an item, you need to create and define a new data storage. Is the date type format "YYYY/MM/DD"? Are the paths to the shared folder and board, etc. correct? They have not been changed? Is the file size uploaded to the board private CSV or shared CSV less than 100 MB (upper limit)? Is the file size of the CSV uploaded to the detail data storage less than 2GB (upper limit)? *If you need to upload files exceeding the upper limit, contact us in advance. *If the number of types of data values in the file is large, uploading may not be possible even if the file is under the upper limit. Is the Do not overwrite when last modified by someone else checkbox cleared? If the Do not overwrite when last modified by someone else checkbox is selected in Home - Settings, uploading may fail. Isn't the execution time of task (mail distribution, addition to data storage etc.) overlapped? Execute upload from MBA after processing of another task currently being executed. Check the task execution status in Management - System Settings - Information - Task on the upper right of the board screen. 12