truffala plataform documentation

Truffala Plataform DocumentationRelease 1.0.1.7

GeoSynergy Pty Ltd

July 11, 2016

ABOUT TRUFFALA

1 Truffala Platform 31.1 Truffala Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2 Potential of Truffala . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2 Basic Site Navigation 52.1 Entering the Truffala Plataform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52.2 Landing Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92.3 Acessing Redmine on Truffala . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

i

Truffala Plataform Documentation, Release 1.0.1.7

This guide is intended to be a quick but comprehensive guide to the platform and show how it can help your dailywork.

Note: In case you need support, please contact us .

ABOUT TRUFFALA 1

http://geosynergy.com.au/contact-us.html

http://www.geosynergy.com.au


2 ABOUT TRUFFALA

CHAPTER 1

Truffala Platform

Truffala is a spatial enabled project management system, used for:

• Planning and tracking activities, particularly location based activities

• Visualising, analysing and sharing big location data

Important: Truffala isn’t just a web GIS platform - it integrates geospatial and work management together toenable decision making and tracking.

As a platform, it also provides a basis for rapid further development and is the basis for several industry based appli-cations.

Read more about Truffala Details and the Potential of Truffala to solve your problems.

In essence, you’ll work with the website and mobile app.

1.1 Truffala Details

Truffala is a geospatial intelligence platform, that can be used:

• As-is

• With various industry ‘plug-ins’

• KEGS Field Developer

• DroneComply

• UGLStick

• Data Manager

• As the basis for further specialist product development

Truffala integrates several differing capabilities into a single ‘common operating picture’ environment. It provides anauthentication wrapper around various systems, and focus’s on building out its own mapping system.

These capabilities are:

1.1.1 Project Management

A flexible project management web application (Redmine) which includes:

3

http://www.redmine.org


TrackersGantt chartCalendarWikiForumsMultiple roles and groups

Email notification

1.1.2 Web and Mobile Mapping

TODO: Put a phrase about the web and mobile mapping

Online mapping

Sharing

Printing

Anlytics

HeatMap

Rules and Alerts

1.1.3 Mobile App

TODO: A phrase about the Mobile App

‘Offline first’Pluggable widgets and forms

1.2 Potential of Truffala

TODO: Build a diagram showing the thinking processing to solve problems andhow Truffala fits on it

4 Chapter 1. Truffala Platform

CHAPTER 2

Basic Site Navigation

Follow the next sections to get started with the Website of Truffala Plataform:

2.1 Entering the Truffala Plataform

Here you’ll see how to acess the Truffala Plataform.

2.1.1 Log in / Log out

Log in

Acess the site where Truffala Plataform is located and insert your Username and Password. As the follow picture:

Tip: You can check Remember me to save you login information.

After click on Submit you will be redirect to the Landing Page. In case you lost your password, see Forgot Passwordsection and learn how to retrieve it.

Log out

If you are at the Landing Page, click on the Engine and after on Log off, like this:

5

http://www.google.com



Also, if you are currently at Redmine Interface you can Log out by clicking on Sign out:

2.1.2 Forgot Password

In case you have forgotten your password, you’ll need to click on Forgot Password on the login area, as the followimage:

You’ll be redirect to a page on Redmine to insert your e-mail to retrieve your password.

6 Chapter 2. Basic Site Navigation


On your mailbox will be delivery an e-mail with instructions for change your password. The link on the e-mail opena page where you’ll need to insert the New password and a Confirmation of it.

If it has no errors, after click on Save you’ll be able to login on Truffala with your new password.

2.1.3 Change Password

For change the password we need go to the Redmine Interface of Truffala. To achieve it, inside the Project button onthe Landing Page click on a random project.

2.1. Entering the Truffala Plataform 7

http://www.google.com.br



You can check that the Redmine frame for the project you clicked will be displayed.

Note: This Redmine frame have all the needs areas for your daily use of Redmine, but for some administrativesettings and tasks you’ll need open the Redmine on a new tab to make them. This is the case of change password.

See the Redmine Interface of Truffala for more information.

To open the Redmine on a new tab, right click on a random link on the Redmine frame and choose Open Link in NewTab. As the follow picture:

Inside Redmine, click on My account on the top right of the screen.

After, click on Change password, as the follow picture:

On this screen, you’ll need to insert your currently password, your new password and the confirmation.


http://www.google.com.br


If it has no error, after you click apply you receive a message that the Password was successfully update and it willbe your new password for use in Truffala.

Warning: TODO:• Insert link on the Landing Page L22• Insert link on Project L44• Insert link for Redmine Interface o Truffala• Explain about the administrative setting and tasks on Redmine Interface of Truffala

2.2 Landing Page

The Landing Page is a interface that was built to facilitate the daily use of Truffala Plataform.

Note: It’s designed to become like a game console interface, enabling the user to do quick tasks and easily getinformations and reports.

Basicaly, on Landing Page, you’ll work with this four buttons:

2.2.1 Projects

When you click on Projects you area able to see the Projects Tree screen. This interface will help you managing theprojects by provinding a easy interface to acess them.

2.2. Landing Page 9


For example, if we create a project called Sample Project, that is how it will be shown:

Hint: If you don’t have a project created, check How create your first project on Truffala.

If you left click on the project name, it will open a frame showing the Redmine screen of the currently project. Checkthe Redmine Interface of Truffala to get more information.

As you’ll creating subprojects, they are going to be showing as folders here. It has the function of facilitating yournavigation and managing of the projects. For example:



Important: After create a subproject, you’ll need to reload the page for the new subprojects appears on the ProjectsTree.

2.2.2 Maps

Inside Maps you can list and view all the Available Workpacks for all your projects.

Note: Workpack is ... TODO

They will be organized by two columns (ID and Name), as the follow picture:

2.2. Landing Page 11


Important: Every workpack you’ll create must be referenced by a Redmine Project.

You can click on the workpack you want to acess and it will load on your screen with all tools enabled by the projectadministrator. Check the next example showing a workpack:

The Maps button on Landing Page is where you’ll going to create workpacks. If you don’t have a workpack created,check How create your first workpack for more details.

Important: Check the Mapping section to see and understand what you can do with your workpack and how toconfigure it for your project.

With the workpacks you’ll be able to upload geospatial data, automate process and alerts and integrate the geospatialinformation with the project management.



Note: You’ll be able to use a geospatial intelligence plataform (Truffala) in favor of your project.

2.2.3 Dashboard

The Dashboard will help you by summarise all the relevant information contained within the Redmine. It providemanagement summaries, like: activity, amounts of things, charts, stuff, reports.

Waiting #40883 <https://synmine.kegsys.com/issues/40883> .

2.2.4 User Guide

The User Guide button will redirect you for this material that you’are currently reading. This guide is intended to bea quick but comprehensive guide to the plataform and show how it can help your daily work.

If you want to, you are able to download this guide in PDF with the lastest version of Truffala. Do as the followpicture:

2.2. Landing Page 13


Hint: You can use the search box to find what you are looking for faster. For example:



Warning: TODO• Create a How to create your first project• Link the Redmine Interface of Truffala• Complete Dashboard• Do the workpack definition• Make a list for the SRID• Check how the workspace will be handle.• Create a How to create a workpack• Create the Mapping section• Geospatial intelligence link 62

2.3 Acessing Redmine on Truffala

There are two ways you can direct acess Redmine on Truffala Desktop:

• Redmine Frame on Landing Page

• The Entire Redmine Page

Note: For understand more about Redmine and its capabilities check the Project Management section.

2.3.1 Redmine Frame on Landing Page

When you navigate on the Landing Page you can acess your projects trought the Project button. After clicking on theproject you want acess, it will open a Redmine Frame as the follow image:

2.3. Acessing Redmine on Truffala 15


On this frame you’ll be able to do all your daily tasks on the currently project. Examples of tasks could be: cre-ate/report issues, organize and assign tasks, acess the gant, upload data and more.

2.3.2 The Entire Redmine Page

For some administrative tasks you’ll need to open the entire Redmine page. To open the Redmine on a new tab, rightclick on a random link on the Redmine frame and choose Open Link in New Tab. As the follow picture:

You can check that the difference between the Redmine Frame and the Entire Redmine Page is the bar at the top ofthe screen.



Basically the two important links on this bar are Administration and My account. For example you’ll use adminis-tration for create projects, create groups, ability plugins and more. And on My account you’ll be able to change youraccount settings, for example the password.

Note: Check the Project Management section for more information about Redmine.

Warning: TODO:• Project Management section explain about Redmine and its capabilities

App

2.3. Acessing Redmine on Truffala 17

truffala plataform documentation

Documents