Skip to content
This repository was archived by the owner on Apr 9, 2025. It is now read-only.

Installation

Jump to bottom
Daniel Hazelbaker edited this page Mar 22, 2015 · 1 revision

About

For detailed information about what the Google Maps modules provide, see the Home page for a complete list.

This document describes the installation of HDC Google Maps Version 2.0. Because this package interfaces with multiple existing pages it requires a more manual approach to installation than most packages. I will try to describe as completely as possible how to go about installing the modules on all required pages.

Importing Modules

XML import

If you are using a "Zipfile" release (just a big zipfile with no XML file to import), see below.

To begin installation you need to import the new modules into your Arena system. Go to the Administration section and select the Modules menu item. At the bottom of the page is a place to Import Modules (XML). Select the google maps installation xml that you downloaded from the Files section and click the Upload button. Once this is done you will have four new (or updated) modules to work with, HDC Google Maps Insert, HDC Google Map Viewer, HDC Google Group Locator, and HDC People In Range.

If you are upgrading from a previous version, see the Upgrading section after you finish installing for how to remove the HDC KML Downloader module and other files that are not needed anymore.

Zipfile Release

If you are doing an XML import installation (see above) then skip this step.

In the zip file will be 2 folders and a SQL script.

  • The contents of the bin folder should be copied to your Arena ChMS\Arena\bin folder (this should contain all your DLLs).

  • Next you will need to copy the UserControls folder. I do not recommend simply dragging and dropping it as there is a chance it could wipe out your existing UserControls. Instead create the same path under your Arena installation and copy the files individually, so the final destination should be something like C:\Program Files (x86)\Arena ChMS\Arena\UserControls\Custom\HDC\GoogleMaps.

  • Now you need to create modules in Arena for all those .ascx files. In Arena Administration go to your Modules control and begin creating new modules. Set the names and URLs as indicated:

    • HDC Google Maps Insert -> UserControls/Custom/HDC/GoogleMaps/KMLInsert.ascx
    • HDC Google Map Viewer -> UserControls/Custom/HDC/GoogleMaps/MapViewer.ascx
    • HDC Google Group Locator -> UserControls/Custom/HDC/GoogleMaps/GoogleGroupLocator.ascx
    • HDC People In Range -> UserControls/Custom/HDC/GoogleMaps/PeopleInRange.ascx
    • HDC Google Area Picker -> UserControls/Custom/HDC/GoogleMaps/AreaPicker.ascx
    • HDC Join Small Group -> UserControls/Custom/HDC/GoogleMaps/JoinSmallGroup.ascx

  • The SQL script is for the next step.

SQL

Execute the release_2.0.sql script into your ArenaDB database, this script should be run wether you are doing a new install or an upgrade. This will setup the required structure and data in your database.

Page Setup

There are two steps to setting up the pages. The first is to create a new page for the HDC Map Viewer module to reside on and set it's security appropriately. The second step is to modify some of your existing pages to include the HDC Google Maps Insert module.

Map Viewer Page

Note: If you are upgrading you just need to edit the KML Downloader page you had setup for the previous version and change the module type to the new HDC Map Viewer module.

Go to the Administration section and select the Pages menu item. You will need to pick a place for this module to sit, it will not be visible on the menu so does not really matter but I recommend the Home :: Groups :: Areas page to be its parent. Once you have the parent page active select the Child Pages tab and click the Add Page icon. Enter the following information at a minimum, you can set other fields as you wish:

  • Page Name: Google Maps
  • Display In Nav: Disable When you are finished setting the page options, click the Update button.

Go to the Main Content tab and click the Add Module link to create the module. When the module settings page appears set the following fields:

  • Type of Module: HDC Google Map Viewer
  • Title: Map Viewer When you are finished setting the module options, click the Update button.

Go to the Security tab and set the security the way you want. Please make note of the Security Considerations when deciding who to give access to.

Area Picker

The Area Picker module will display a map showing clickable polygons for the Small Group Areas which have been defined in Arena. When an area is clicked the user is redirected to the Small Group Locator page with the filter automatically set to the selected area. Details about the configuration can be found on the About page, but the only required option to be set is the page to link to when an area is clicked. The normal flow of pages would be:

  1. Area Picker (Optional)
  2. Small Group Locator
  3. Join Small Group
  4. "Thank you" page.

Small Group Locator

This version includes a Small Group Locator module based on the Google Maps API. It provides a cross between the CCV Small Group Locator and the standard Arena Small Group Locator. Installation is easy and strait-forward, simply add it the HDC Google Group Locator to any page you wish (generally a public facing page). The specific settings are detailed in the About page.

Join Small Group

The Join Small Group module can seem confusing at first glance once the settings have been broken down you should be able to configure it for your desired use without much trouble. You have a few basic options for how the module will function:

  1. E-mail small group leader informing them somebody is interested in joining their small group.
  2. E-mail pre-defined address with the same information.
  3. Create a pending registration for the person to the identified small group. (See below)
  4. Directly add the user to the small group as a member. (See below)

Additionally, the module can create a new user record for the person if they are not logged in. For options #3 and #4 to be used either this functionality must be enabled or you must require the user to login before reaching this page (in which case the user's information will be automatically filled in).

Update Existing Pages

Note: You only need to perform this step once. If you are upgrading you do not need to create this page again, though you may need to check the module settings to see if anything new has been added.

Go to the Administration section and select the Pages menu item. You will need to repeat the following steps for each of the pages listed below, assuming you want all of the pages to include the Google Earth export functionality.

  • Home :: Membership :: Public Lists :: Report View
  • Home :: Groups :: Areas :: Area Details
  • Home :: Groups :: Group Trees
  • Home :: Groups :: Group Trees :: Group Details
  • Home :: Tags :: Tag Details

Once you have the specified page active, go to the Main Content tab and make a note of the type of module that already exists on the page. Then click the Add Module icon. Set the module information as specified:

  • Type of Module: HDC Google Maps Insert
  • Title: Google Maps Insert
  • Map Viewer Page: (Set to the page you created for the Map Viewer Page)
  • Module Type: (Set to the existing module type you noted previously) When you are finished setting the module options, click the Update button.

Select the Security tab and set permissions as appropriate for who you want to be able to get to the export options. You may then continue on to configuring the next page.

Organization Settings

You should setup 2 organization settings, these are optional but the defaults are things you probably do not want. When adding the contents of a map to a existing or new tag, a profile source and status must be applied to the new member. By default the first active value of the Profile Source and Tag Member Status are used. If this is not what you want (and probably isn't), you will want to set the values accordingly.

GoogleMaps_ProfileSource - The source to use when adding a person to a new tag from a Google Map view. GoogleMaps_ProfileStatus - New tag members from the Google Map view will have this member status in a tag.

Upgrading

Upgrading from version 1.x to 2.0

Before following these instructions you should follow the normal Installation procedures outlined above. But the jist of what you need to is install the new XML package file in modules, update the KML Downloader page to be a Map Viewer page and then (recommended) clean-up some unused items. The following items can be removed.

Modules

  • HDC KML Downloader

Files

  • UserControls/Custom/HDC/GoogleMaps/KMLDownloader.ascx
  • UserControls/Custom/HDC/GoogleMaps/KMLDownloader.ascx.cs
  • UserControls/Custom/HDC/GoogleMaps/Includes/jqModal.css
  • UserControls/Custom/HDC/GoogleMaps/Includes/jqModal.js
  • UserControls/Custom/HDC/GoogleMaps/Includes/jquery.iphone-switch.js
  • UserControls/Custom/HDC/GoogleMaps/Images/family.png
  • UserControls/Custom/HDC/GoogleMaps/Images/home.png
  • UserControls/Custom/HDC/GoogleMaps/Images/iphone_switch.png
  • UserControls/Custom/HDC/GoogleMaps/Images/iphone_switch_container_off.png
  • UserControls/Custom/HDC/GoogleMaps/Images/iphone_switch_container_on.png
  • UserControls/Custom/HDC/GoogleMaps/Images/person.png
  • UserControls/Custom/HDC/GoogleMaps/Images/title-bg.png

After this you should be all set.

Clone this wiki locally