Howto:Gcalendar - Wecom - Partner App

From innovaphone wiki
Revision as of 13:47, 16 July 2025 by Pablo.montiel (talk | contribs) (→‎Vendor: Wecom's logo change)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
FIXME: Work in progress, still incomplete
Partner App Info
Gcalendar Icon
Name Gcalendar
Company Wecom
Version 1.0
Compatibility Innovaphone XML Schema
License Via Innovaphone Pricelist
Languages Portuguese, English, Spanish, German

Product Name

Gcalendar Link

Certification Status

Space dedicated to Gcalendar certification information.

Category

Computer Telephony Integration and Unified Messaging / Unified Communication

Vendor

Wecom's logo

Wecom

Description

Gcalendar is a Partner App developed by Wecom to integrate Google Calendar events with the Innovaphone presence system.

The app operates through two components:

  • Users App – Where the users initiate their account linking process via Google login.
  • Admin App – Allows configuration of the integration with editable fields for Google Client ID and Client Secret, along with a dedicated OAuth authorization URL.

This setup enables real-time status synchronization and supports four languages: Portuguese, English, Spanish, and German.

Functions

This section provides an overview of each core part of the Gcalendar application. It highlights what actions can be performed, and how to navigate through the available features. Additionally, this section provides step-by-step explanations for each functionality.

Users App

The Users App is the interface used by users to link their Google Calendar account to the Innovaphone presence system. It focuses only on enabling the connection between the user and their calendar through Google authentication.

Users app interface with google account pop-up

Connecting with Google account

  1. Open the Gcalendar Users App.
  2. Click the Connect button.
  3. A Google login popup will appear.
    • This popup allows users to choose or log into a Google account.
  4. After selecting an account, the integration process will begin automatically.
    • Once completed, the account will be linked to the Innovaphone system.
Connect button

⇒ Note: Before starting the connection process, ensure you're already logged into the correct Google account in your browser. This helps avoid selecting the wrong account and ensures the integration is completed with the intended calendar.

Disconnecting from Google account

  1. Open the Gcalendar Users App.
  2. If a Google account is already connected, the Connect button will be replaced by a Disconnect button.
  3. Click the Disconnect button to unlink your current Google Calendar account from the Innovaphone presence system.
  4. Once disconnected, presence synchronization will be disabled for that user.
Disconnect button

Admin App

The Admin App provides configuration options required to authorize and manage the Google integration. It is intended for system administrators and enables control over OAuth credentials used for user authentication.

Admin app interface

Updating Google OAuth Credentials

To enable or update the integration between Gcalendar and Google Calendar, you’ll need to provide the correct Client ID and Client Secret obtained from your Google Cloud project.

  1. Open the Gcalendar Admin App.
  2. Locate the fields labeled Google Client ID and Client Secret.
  3. Paste the values copied from your Google OAuth Credentials into the respective fields.
  4. Click the Update button next to each field to save the changes.

⇒ Notes:

  • Ensure both values are correctly copied and properly formatted.
  • Incorrect credentials will prevent users from authenticating.
  • The Client Secret is sensitive—never share or expose it publicly.
Google Client ID input and update button
Client Secret input and update button

Licensing

The Gcalendar application is licensed via the Innovaphone Pricelist.

Currently, it is not yet listed on the official Innovaphone Partner App Licenses page, but it is expected to be included in future updates.

License type: Innovaphone Pricelist

License model: One license per user

Listed at: https://www.innovaphone.com/en/services/licenses/partner-apps.html?app=Gcalendar&type=license#gcalendar

Prerequisites

Before installing and using Gcalendar, ensure your environment meets the following requirements:

System Requirements

  • Innovaphone firmware: Version 14r1 or later
  • App platform: Innovaphone myApps system with App Platform active
  • PBX Manager: Required to register and configure the Users and Admin Apps

OAuth Setup

  • A Google Cloud Project with valid OAuth 2.0 credentials (Client ID and Client Secret)
  • The following URIs must be configured in the Google project:
    • Authorized JavaScript origins: https://app_platform
    • Authorized redirect URI: https://app_platform/domain/app_name/newToken

Versions

The Gcalendar application follows the release versioning aligned with the Innovaphone platform.

  • Initial release version: 14r1
  • Latest available version: 2002 final (as of June 17, 2025)
  • Build number:14A1149 dvl
  • Supported architectures: arm, x86_64, arm64

⇒ New versions are published and made available through the Wecom App Store.

Configuration

Google OAuth Setup (Admin Only)

To enable account linking between the Innovaphone presence system and Google Calendar, administrators must configure OAuth 2.0 credentials using the Google Cloud Platform beforehand.

  1. Go to Google Cloud Console.
  2. Select or create a Google Cloud Project.

    ◇ This project will host the credentials used by Gcalendar to access the Google Calendar API. We recommend creating a dedicated project for better control and security.

    Google Cloud Console welcome page with select project button outlined (here the project is already selected)

    Clicking the "Select Project" button will open a modal where you can choose or create a project.

    Project selection modal

    If a project already exists, click on its name from the list to open it. If not, click "New Project" in the top-right corner to create one.

    New project creation page
  3. In the top-left corner, click the hamburger menu icon (☰) to expand the left navigation menu.
    • Before continuing to the OAuth configuration, you need to make sure the Google Calendar API is enabled.
  4. From the sidebar, go to APIs & Services > Enabled APIs & services.
    Opening the APIs & Services section to enable the Calendar API
  5. At the top of the page, click + Enable APIs and services.

    Once enabled, it will appear in the list of active APIs under Enabled APIs & Services.If the Google Calendar API is already enabled, you may skip the steps below and proceed directly to the OAuth configuration.

    Enabling API button and viewing the enabled Google Calendar API
  6. In the API Library, search for: calendar.
    • From the results, click on Google Calendar API.
      Searching for the Google Calendar API in the API Library
  7. On the API page, click the blue Enable button to activate it.
    Enabling the Google Calendar API
  8. Now click the hamburger menu icon (☰) again to return to the sidebar.
  9. Navigate to API & Services > OAuth consent screen.
    Left menu: APIs & service -> OAuth consent screen
    • If it's your first time, configure the consent screen with basic app details (organization name, app name, email, etc.).
    • Once configured, you'll be redirected to the Google Auth Platform / Overview page.
  10. Click Clients in the left menu and then click "+ Create client".
    Creating client option in Clients page
  11. Choose Application Type: Web Application.
  12. Enter a recognizable name (e.g., Gcalendar Integration).
  13. Add the following values:
    • Authorized JavaScript origins
      • https://app_platform
    • Authorized redirect URIs
      • https://app_platform/domain/app_name/newToken
        Create OAuth client ID inputs
  14. After creation, copy the generated:
    • Client ID
    • Client Secret
      Client credentials available after creating
  15. Open the Gcalendar Admin App and insert the values in the respective fields and click Update (see Update Google OAuth Credentials section above).

    ▷ This links the Google authentication flow to the presence system, allowing users to authorize their calendars.

  16. On the left menu, go to Data Access under the Google Auth Platform section.

    ◇ This section lists the sensitive scopes (permissions) your app is requesting during OAuth authorization. These are required for accessing user calendars.

    Click "Add or remove scopes" to open the scope selection menu
  17. Click the blue Add or remove scopes button.

    ◇ A sidebar will open listing all available scopes from enabled APIs. You can search and select the necessary calendar-related scopes for your application.

  18. In the sidebar that appears, search for and select the following calendar scopes:
    • ../auth/calendar.readonly – View and download calendar data.
    • ../auth/calendar.calendars.readonly – View calendar metadata.
    • ../auth/calendar.events – View and edit calendar events.
    • ../auth/calendar.events.owned – Modify events on owned calendars.
    • ../auth/calendar.events.owned.readonly – Read-only access to events on owned calendars.
    • ../auth/calendar.events.readonly – View events only.
      Data Access section showing added calendar scopes

      ▷ These scopes must be added to your app for Google to allow access to calendar data through the API. Make sure they match the level of access your app requires.

Installation

Follow the steps below to install the Gcalendar application in your Innovaphone environment.

Option 1: Installing via AP Manager App Store (Recommended)

You can install Gcalendar directly through the App Platform Manager (AP Manager) by accessing the App Store:

  1. Open the AP Manager.
  2. Click the yellow App Store button in the top-right corner.
  3. Search for Gcalendar in the list.
  4. Select the latest version and confirm the download.
  5. The app will be automatically installed and ready to configure.

🛈 This is the easiest and fastest way to deploy the app.

AppStore Button in AP Manager outlined
AP Manager Appstore interface

Option 2: Manual Installation via Upload

If the app is not yet listed in the App Store, follow the steps below:

Step 1: Download the App Package

  1. Visit the official Wecom myApps Downloads Portal.
  2. Find the Gcalendar app.
  3. Download the latest available version compatible with your system architecture.
Gcalendar on MyApps' Wecom's App Store

Step 2: Upload to AP Manager

  1. In AP Manager, click App upload (top right).
  2. Select the .app package you downloaded from the portal.
  3. After successful upload, the app will appear in your list and show as Running.
App Upload button on AP Manager outlined
Gcalendar on AP Manager

Step 3: Add Application Instance

  1. After uploading the app, click the yellow + Add button to create an instance of the application.
  2. Fill in the required fields:
    • Name: A recognizable name for the instance.
    • Domain: The domain for the PBX.
    • Password: A secure admin password for the app instance.
    • Webserver path: Optional path (or leave blank).
    • Database host: Leave empty for local DB or specify IP/DNS if external.
    • Database name and Database user: Use consistent values for your environment.
    • Database password: Corresponding DB password.
  3. When all values are filled, click Save.
Example of instance creation screen in AP Manager

Final Step: Registering the App in PBX Manager

  1. Open the PBX Manager.
  2. Go to the Apps section.
  3. Click Add App and register:
    • A Users App
    • An Admin App
  4. Assign access rights as needed.
PBX Manager Add an App select the app
PBX Manager Add an App configurations
Gcalendar on PBX Manager configured

⇒ After registration, both apps will appear in MyApps and are ready for use.

Copyright

Copyright information.

Contact

  • PORTO ALEGRE - RS

Av. Carlos Gomes, 466 / 401

Boa Vista - CEP 90480-000

Tel: +55 51 3079.5000

  • FLORIANÓPOLIS - SC

SC 401, 8600 - Room 7

Corporate Park - Block 2

Santo Antônio de Lisboa

CEP 88050-001

Tel: +55 48 3112.6200

Mail: comercial@wecom.com.br

Support: suporte@wecom.com.br

Website: wecom.com.br

For any questions please refer to our contact page.

Retrieved from "https://wiki.innovaphone.com/index.php?title=Howto:Gcalendar_-_Wecom_-_Partner_App&oldid=77327"