Howto:Billboard - Wecom - Partner App: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
No edit summary
Tag: 2017 source edit
→‎Functions: Users adjusted and Admins finished. Images added, step by step complete
Tag: 2017 source edit
Line 46: Line 46:


== Functions ==
== Functions ==
<!-- Section in development. -->
<!-- Section in analysis. -->
=== Users App ===
=== Users App ===
The Users App is the interface where users access, read, create, and manage department posts, based on their permissions (viewer or editor). Each user sees only the groups they are part of.


==== 1. Accessing a Group ====
==== 1. Accessing a Group ====


# On the main page, you can see all the groups you are part of.
# Upon opening the Users App, the main screen lists all groups (departments) the user belongs to.
# To enter a group, simply click on the desired group.
# To enter a group, simply click on the desired group.<blockquote>Groups are color-coded and may display badges for new or unseen posts.</blockquote>[[File:Billboard Users Groups Page.png|none|thumb|450x450px|Users App main page with every group you are on]]
[[File:Billboard Users Groups Page.png|none|thumb|450x450px|Users App main page with every group you are on]]
 
==== 2. Creating a Group (Admins only) ====
 
# Only users assigned with the "create department" permission (via Admin App) will see the '''Add+''' button on the main screen.[[File:4. Billboard Users Groups Page Button Outlined.png|none|thumb|450x450px|Groups page with "+ Add" button outlined]]
# Click '''Add+''' to open the group creation modal.
# Fill in:
#* Enter the '''Department Name'''
#* Select the color using the color picker
#* Assign users to roles:
#** '''Editor''' – Can manage posts, see group's history and edit the department.
#** '''Viewer''' – Can only view posts.
#* Clicking "Viewer" name label selects all users as viewers.[[File:5. Billboard Group Creation Modal.png|none|thumb|450x450px|Group creation modal with roles selection, color picking and name input]]


==== 2. Viewing a Post ====
==== 3. Viewing a Post ====


# Inside a group, posts are displayed as cards.[[File:2. Billboard Posts Page (of a Group).png|none|thumb|450x450px|Posts inside a group]]
# Inside a group, posts are displayed as cards.[[File:2. Billboard Posts Page (of a Group).png|none|thumb|450x450px|Posts inside a group]]
Line 67: Line 80:
#* Start and end dates of visibility
#* Start and end dates of visibility
# To close the post, click the '''X''' button in the top right corner.
# To close the post, click the '''X''' button in the top right corner.
==== 3. Creating a Group (Admins only) ====
# If you have admin privileges in the Users App, you will see an '''Add+''' button on the group screen.[[File:4. Billboard Users Groups Page Button Outlined.png|none|thumb|450x450px|Groups page with "+ Add" button outlined]]
# Click '''Add+''' to open the group creation modal.
# Fill in:
#* '''Name of the Department'''
#* Select users and define their roles:
#** '''Viewer''' – Can access the group and read posts.
#** '''Editor''' – Can view, create, edit, and delete posts, and see view history.
# Select a color (optional).
# Click '''Insert''' to create the group.[[File:5. Billboard Group Creation Modal.png|none|thumb|450x450px|Group creation modal with roles selection, color picking and name input]]


==== 4. Creating a Post ====
==== 4. Creating a Post ====


# You must be an '''Editor''' in a group to create a post, you will see an '''+ Add''' button on the screen of a group.[[File:6. Billboard Posts Page with Add Card.png|none|thumb|450x450px|Posts on a group with Editor view, with "+ Add" card]]
# Editors will see an '''Add+''' card within the department page.[[File:6. Billboard Posts Page with Add Card.png|none|thumb|450x450px|Posts on a group with Editor view, with "Add+" card]]
# Inside the group, click the '''+Add''' button to open the post creation modal.
# Click it to open the post creation modal.
# Fill in the following:
# Fill in the following:
#* '''Title''' (top input)
#* '''Title''' (top input)
Line 94: Line 95:
==== 5. Editing or Deleting a Post ====
==== 5. Editing or Deleting a Post ====


* If you are the creator or an editor of the group:
# If you are the creator or an editor of the group:
# Click on the post.
#* Click the pencil icon to edit – the modal opens pre-filled with existing data.
# On the right, you'll see icons to:
#* Click the trash icon to delete – the post is removed immediately.[[File:8. Billboard Post View as Editor Actions Outlined.png|none|thumb|400x400px|Post view as Editor with actions outlined]]
#* Edit: opens the same modal with pre-filled data.
#* Delete: immediately removes the post.[[File:8. Billboard Post View as Editor Actions Outlined.png|none|thumb|400x400px|Post view as Editor with actions outlined]]


==== 6. Viewing Post History ====
==== 6. Viewing Post History ====


# On the open post, click on the "clock" icon to view who accessed each post and when.
# Inside the post, click the '''Clock''' icon to view who has accessed it.
#* This info is shown in the post view and the icon is replaced with an arrow icon to go back to the main information.[[File:9. Billboard Post History.png|none|thumb|350x350px|Post history of who has viewed and when]]
#* The view shows user names and access timestamps.
#* A back arrow icon replaces the clock to return to the post details.[[File:9. Billboard Post History.png|none|thumb|350x350px|Post history of who has viewed and when]]


==== 7. Managing Groups (Editor role) ====
==== 7. Managing Groups (Editor role) ====


* If you are an editor in a group, the bottom menu will have extended options.[[File:10. Billboard Posts Page with Bottom Menu Outlined.png|none|thumb|Posts on a group as an Editor with bottom menu outlined]]
* Editors see extra options in the bottom menu of the department page.[[File:10. Billboard Posts Page with Bottom Menu Outlined.png|none|thumb|Posts on a group as an Editor with bottom menu outlined]]
# Click the trash icon to delete the group.
# Click the trash icon to delete the group.
# Click the clock icon to access post history.
# Click the clock icon to access post history.
Line 118: Line 118:


=== Admin App ===
=== Admin App ===
<!-- Section in development. -->
Administrators can:
* Assign who can create groups.
* View and edit all posts and groups.
* Monitor licensing.


==== Admin Post Management ====
The Admin App provides global management functionalities for users, groups (departments), and posts. Only users marked as administrators via this panel will have access to it.
All posts (including deleted) can be edited:
 
==== 1. Granting Administrator Access ====
 
# Access the Admin App – it will open on the '''Users Page''' by default.
# Use the '''search bar''' at the top to find the user you wish to promote.
# Locate the user in the list below.
# Click the checkbox next to their name to grant administrator privileges.
<blockquote>Only an existing admin can assign admin rights to another user.</blockquote>
[[File:A1. Billboard Admin Users Page.png|none|thumb|450x450px|Users Page with search bar and checkboxes for admin privileges]]
 
==== 2. Managing the Billboard License ====
 
# In the Admin App sidebar, click on the '''Licensing''' tab.
# Review the license information displayed on the page.
# If activating a license:
## Enter the provided '''License Key'''.
## Click on the '''Ok''' activation button on the bottom-right corner to validate and enable the license.
 
* '''System Token''': Unique identifier required to validate the license.
* '''License Key''': Provided by Wecom for unlocking the application.
* '''Active License''': Displays whether the license is valid and how many users are supported.
* '''Temporary License Expiration''': Shows when the 30-day trial period ends.
* '''Installation Date''': Indicates when the active license was installed.
* '''Licenses in Use''': Number of users currently connected to the Billboard Users App.
[[File:A2, Billboard Admin License Page.png|none|thumb|450x450px|Licensing page showing all license details and activation fields]]
 
==== 3. Managing Departments ====
 
# In the Admin App sidebar, click on the '''Departments''' tab.
# Browse the list of all departments created in the system.
# Scroll to locate the department you wish to edit.
# Click on the '''color circle''' next to the department to open the editing modal.
# In the modal:
## Update the department's name.
## Change its color using the color picker.
## Add or remove users as '''Editors''' or '''Viewers'''.
## Save the changes to apply them.
[[File:A3.1. Billboard Admin Group Management.png|none|thumb|450x450px|Group management modal]]
 
* The list includes all departments, including those marked as deleted.
* Deleted departments are labeled with their deletion date.
* Each department entry shows:
** Department name
** Assigned color
** Creator's name
** Status (active or deleted)
[[File:A3. Billboard Admin Departments Page.png|none|thumb|450x450px|Departments list with edit modal access]]
 
==== 4. Managing Posts ====
 
# Click on the '''Posts''' tab in the Admin App sidebar.
# Browse the full list of posts created across all departments.
# Scroll to locate a specific post.
# Click the '''edit icon''' next to a post to open the editing modal.
# In the modal:
## Modify the title, description, color, type, and visibility period.
## Save the changes to update the post.
[[File:A4.1. ABillboard Admin Post Management.png|none|thumb|450x450px|Post management modal]]
 
* The post list includes:
** Active posts
** Expired posts
** Deleted posts (showing the deletion date)
* Each post displays:
** Title
** Department (group) association
** Type: Internal or External
** Start and end dates (visibility period)
** Creator's name
** Current status: active, expired, or deleted
[[File:A4. Billboard Admin Posts Page.png|none|thumb|450x450px|All posts view with status, creator, and edit access]]
 
==== 5. Accessing Public Posts ====


* Title, content, date range, color.
# In the sidebar, click on the '''Public Posts''' tab.
# A modal will appear, redirecting you to the Billboard '''Users App''' to view a list of posts.
# Click on any post from this list.


==== Group Management ====
* Only posts with the "External" type selected during creation appear here.
Admins can:
* This page is read-only and used for quick access to public content.
* View all groups (even deleted ones).
[[File:A5. Billboard Admin Public Posts Modal.png|none|thumb|450x450px|Public posts modal with redirect to Users App]]
* Edit names, colors, users, and their roles.


== Component Diagram ==
== Component Diagram ==

Revision as of 21:22, 27 June 2025

FIXME: Work in progress, still incomplete
Partner App Info
Billboard Icon
Name Billboard
Company Wecom
Version 1.0
License Via Innovaphone Pricelist
Languages Czech, English, Estonian, French,
German, Italian, Polish, Portuguese,
Slovenian, Spanish

Product Name

Billboard Link

Certification Status

Space dedicated to Billboard certification information.

Category

Space dedicated to Billboard category information.

Vendor

Wecom's logo

Wecom

Description

Billboard is a Partner App developed by Wecom to modernize internal communications by digitizing traditional bulletin boards. Through a user-friendly interface integrated into Innovaphone’s myApps workspace, departments (referred to as "groups" within the app) can publish announcements with scheduled validity, targeted visibility, and interaction tracking.

Main components:

  • Users App – For general users to access and interact with department posts.
  • Admin App – For administrators to manage groups, posts, and licensing.

Functions

Users App

The Users App is the interface where users access, read, create, and manage department posts, based on their permissions (viewer or editor). Each user sees only the groups they are part of.

1. Accessing a Group

  1. Upon opening the Users App, the main screen lists all groups (departments) the user belongs to.
  2. To enter a group, simply click on the desired group.

    Groups are color-coded and may display badges for new or unseen posts.

    Users App main page with every group you are on

2. Creating a Group (Admins only)

  1. Only users assigned with the "create department" permission (via Admin App) will see the Add+ button on the main screen.
    Groups page with "+ Add" button outlined
  2. Click Add+ to open the group creation modal.
  3. Fill in:
    • Enter the Department Name
    • Select the color using the color picker
    • Assign users to roles:
      • Editor – Can manage posts, see group's history and edit the department.
      • Viewer – Can only view posts.
    • Clicking "Viewer" name label selects all users as viewers.
      Group creation modal with roles selection, color picking and name input

3. Viewing a Post

  1. Inside a group, posts are displayed as cards.
    Posts inside a group
    • If you are an Editor, the post will also show the visibility period on the bottom of the card.
    • Unread posts display a red NEW label in the top-left corner of the card.
      • The label disappears as soon as the post is opened.
        New post with visibility period
  2. Click on a post to open its details.
    Open post with information and description
  3. The post view shows:
    • Type (External or Internal)
    • Creator's name
    • Start and end dates of visibility
  4. To close the post, click the X button in the top right corner.

4. Creating a Post

  1. Editors will see an Add+ card within the department page.
    Posts on a group with Editor view, with "Add+" card
  2. Click it to open the post creation modal.
  3. Fill in the following:
    • Title (top input)
    • Description (main text area)
    • Start and end dates
      Post start and end date time picking
    • Type (Internal or External)
      Type drop down selection
    • Color (default is black if not selected)
      Post and group color picker
  4. Click Insert to save or Close to cancel.
    Post creation and editing modal

5. Editing or Deleting a Post

  1. If you are the creator or an editor of the group:
    • Click the pencil icon to edit – the modal opens pre-filled with existing data.
    • Click the trash icon to delete – the post is removed immediately.
      Post view as Editor with actions outlined

6. Viewing Post History

  1. Inside the post, click the Clock icon to view who has accessed it.
    • The view shows user names and access timestamps.
    • A back arrow icon replaces the clock to return to the post details.
      Post history of who has viewed and when

7. Managing Groups (Editor role)

  • Editors see extra options in the bottom menu of the department page.
    Posts on a group as an Editor with bottom menu outlined
  1. Click the trash icon to delete the group.
  2. Click the clock icon to access post history.
    • You can filter posts:
      • By time period (Today, Last 7 days, Custom...)
      • By deleted or active status
        Group's posts history drop down time filter
        Group's posts history time filter with custom period time picking
  3. Click the gear icon to edit group settings:
    • Change the name or color
    • Modify members and their roles
      Group editing modal with users and their roles that were previous selected

Admin App

The Admin App provides global management functionalities for users, groups (departments), and posts. Only users marked as administrators via this panel will have access to it.

1. Granting Administrator Access

  1. Access the Admin App – it will open on the Users Page by default.
  2. Use the search bar at the top to find the user you wish to promote.
  3. Locate the user in the list below.
  4. Click the checkbox next to their name to grant administrator privileges.

Only an existing admin can assign admin rights to another user.

Users Page with search bar and checkboxes for admin privileges

2. Managing the Billboard License

  1. In the Admin App sidebar, click on the Licensing tab.
  2. Review the license information displayed on the page.
  3. If activating a license:
    1. Enter the provided License Key.
    2. Click on the Ok activation button on the bottom-right corner to validate and enable the license.
  • System Token: Unique identifier required to validate the license.
  • License Key: Provided by Wecom for unlocking the application.
  • Active License: Displays whether the license is valid and how many users are supported.
  • Temporary License Expiration: Shows when the 30-day trial period ends.
  • Installation Date: Indicates when the active license was installed.
  • Licenses in Use: Number of users currently connected to the Billboard Users App.
Licensing page showing all license details and activation fields

3. Managing Departments

  1. In the Admin App sidebar, click on the Departments tab.
  2. Browse the list of all departments created in the system.
  3. Scroll to locate the department you wish to edit.
  4. Click on the color circle next to the department to open the editing modal.
  5. In the modal:
    1. Update the department's name.
    2. Change its color using the color picker.
    3. Add or remove users as Editors or Viewers.
    4. Save the changes to apply them.
Group management modal
  • The list includes all departments, including those marked as deleted.
  • Deleted departments are labeled with their deletion date.
  • Each department entry shows:
    • Department name
    • Assigned color
    • Creator's name
    • Status (active or deleted)
Departments list with edit modal access

4. Managing Posts

  1. Click on the Posts tab in the Admin App sidebar.
  2. Browse the full list of posts created across all departments.
  3. Scroll to locate a specific post.
  4. Click the edit icon next to a post to open the editing modal.
  5. In the modal:
    1. Modify the title, description, color, type, and visibility period.
    2. Save the changes to update the post.
Post management modal
  • The post list includes:
    • Active posts
    • Expired posts
    • Deleted posts (showing the deletion date)
  • Each post displays:
    • Title
    • Department (group) association
    • Type: Internal or External
    • Start and end dates (visibility period)
    • Creator's name
    • Current status: active, expired, or deleted
All posts view with status, creator, and edit access

5. Accessing Public Posts

  1. In the sidebar, click on the Public Posts tab.
  2. A modal will appear, redirecting you to the Billboard Users App to view a list of posts.
  3. Click on any post from this list.
  • Only posts with the "External" type selected during creation appear here.
  • This page is read-only and used for quick access to public content.
Public posts modal with redirect to Users App

Component Diagram

The diagrams below illustrate the architecture of the Billboard application and its interaction with the Innovaphone platform, as well as the various components involved.

User and Admin Interaction Flow

Flow Overview:

  • ADMIN: The administrator has the ability to manage groups and posts across the system, including controlling visibility and user access.
  • DEPARTMENT (Group): Represents different groups (like IT and HR), each having specific announcements and user interactions.
  • NOTES: Each group can have specific notes (e.g., IT or HR), which are shown to relevant users.
  • USERS: Users from various groups (IT, HR, and General) can access posts that are published within their allowed groups.

Application Architecture

Flow Overview:

  • PBX Platform: Interacts with the Billboard App, managing internal communication and service integration.
  • APP Platform: Hosts the Billboard Service, which manages posts and user interactions, and communicates with the database.
  • Service DWC: Responsible for managing the backend services for the Billboard app, providing routes to interact with both the database and the PBX platform.

This architecture shows how the components integrate within the Innovaphone ecosystem, allowing for seamless communication between groups and users through the Billboard app.

Licensing

Billboard is licensed via the Innovaphone Pricelist.

License type: Innovaphone Pricelist License model: One license per user Trial: 30 days temporary license available after installation

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

Prerequisites

System Requirements

  • Innovaphone firmware: 14r1 or later
  • Innovaphone App Platform with myApps
  • PBX Manager for app registration

Licensing Activation

  • Requires license token and file provided by Wecom
  • Insert into Admin interface for activation

Versions

  • Current version: 1.0
  • Latest release: 1010 final
  • Release date: November 11, 2024
  • Innovaphone compatibility: Yes
  • Architectures supported: arm, x86_64, arm64

Installation

Option 1: App Store

  1. Open AP Manager
  2. Click the yellow App Store button
  3. Search and install "Billboard"

Option 2: Manual Upload

  1. Download package from Wecom
  2. Upload via "App Upload" in AP Manager

Register in PBX Manager

  1. Open PBX Manager
  2. Go to "Apps"
  3. Add and configure:
  • Billboard Users App
  • Billboard Admin App

Copyright

Space dedicated to Flowe 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:Billboard_-_Wecom_-_Partner_App&oldid=77179"