Howto:Flowe - Wecom - Partner App

FIXME: Work in progress, still incomplete

Partner App Info
Flowe's logo
Name	Flowe
Company	Wecom
Version	1.0
Compatibility	Innovaphone XML Schema
License	Via Innovaphone Pricelist
Languages	Portuguese, English, German

Product Name

Flowe Link

Certification Status

Space dedicated to Flowe certification information.

Category

VoIP system management products

Vendor

Wecom's logo

Wecom

• www.wecom.com.br

Description

Flowe is a Partner App developed by Wecom for the Innovaphone MyApps platform. It is designed to simplify the creation, edition, and management of XML scripts and Voicemail Objects within the PBX.

With a user-friendly and responsive interface optimized for mobile and desktop use, Flowe allows administrators to:

• Create and edit XML scripts visually
• Import and export script files
• Create and assign scripts to IVRs (Interactive Voice Response systems)
• Manage multi-language content (Portuguese, English, German)

Flowe enhances productivity by abstracting technical complexity and aligning with Innovaphone’s native schema definitions.

Functions

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

Scripts - Initial Page

Scripts' initial page with outlined features

The Scripts Initial Page section is the main entry point of the Flowe application. Upon launching the app, users are presented with an overview of all existing XML scripts that have been created or imported into the system where users can quickly access, search for and manage scripts.

The interface is divided into a search bar, a list of scripts, and two main action buttons: Add and Import. Each script listed displays essential information such as its filename, creation date, last modification date, file size and a unique identifier.

Additionally, each script entry offers three direct action buttons:

• Download – allows the user to download the XML file locally.
• Edit – redirects the user to the Script Management page, where the script can be fully edited.
• Delete – opens a confirmation modal for script deletion.

1. Searching for script

1. Write in the "Type to search..." input area.
2. The results will automatically appear in the list below as you type.

Script list search bar

2. Adding new script

• Click the Add button next to the search bar.
  • You will be redirected to the Scripts Management Page to create a new script.

Add script button

3. Importing script

1. Click the Import button next to the search bar.
   • An Import Script modal will appear.
2. Select the file by clicking the Select File button.
   • This will open your computer’s file selection window.
3. Click the Import button in the modal.
   • The imported script will appear in the list automatically.

Import script button

Import script modal

⇒ Note: Only XML script files will be accepted.

4. Downloading script

• Click the Download icon on the right side of the script’s information card.
  • The download will start immediately once clicked.

Download script button

5. Editing script

• Click the Edit icon on the right side of the script’s information card.
  • You will be redirected to the Scripts Management Page, where you can edit the script.

Edit script button

⇒ Note: All current script data will be loaded automatically into the management page for editing.

6. Deleting script

1. Click the Delete (trash icon) icon on the right side of the script’s information card.
   • A Delete Confirmation confirmation modal will appear.
2. To confirm deletion, click the Delete button on the right.
   • The script will be permanently deleted and removed from the list.
3. If you misclicked or decide not to delete, click the Cancel button on the left.
   • The modal will close promptly without any changes.

Delete script button

Delete script confirmation modal

⇒ Note: Deletion is permanent and cannot be undone. Make sure to confirm before deleting a script.

Scripts - Management Page

The Scripts Management Page is the core interface for creating and editing XML scripts within the Flowe application. This page is designed to provide users with a intuitive interactive editor where scripts can be built from scratch or modified as needed.

New script management page with outlined features

Script management page with added functions and outlined features

The interface is divided into the following key areas:

• Script Name Input – Located at the top of the page, filling this input field in is mandatory. Users must define a unique name for the script before they can save it.
• Elements List – Positioned on the left side, this section contains all available XML elements, each with a brief description, that can be inserted into the script.
• Search Bar for Elements – A search bar above the elements list allows users to search through using keywords that match either the element name or its description.
• Script Body – The main workspace is located on the right side and displays the full structure of the script as collapsed blocks. Each script begins with a pre-created Main Function (automatically provided when starting a new script), the following functions and, inside each function, users can dynamically insert and manage elements.
• Add New Function – Below the script body, an input field and button allow users to sequentially create new named functions.
• Action Buttons:
  • Save – Saves the current script, either as a new file or as an update to an existing one.
  • Cancel – Aborts the script creation or editing process and returns the user to the Initial Scripts Page.

Elements are based on the official Innovaphone XML Schema.

Pre-existing script management page with collapsed functions

1. Elements List

The Elements List contains all XML components available for building scripts in the Flowe application. These elements are based on the official Innovaphone XML Schema, used for managing the script structure and logic within the XML file.

Add element

Assign element

If element with collapsing button

• How to use the elements: Users can insert elements inside functions and fill out the required fields according to their purpose and the Innovaphone documentation. Each element should be configured with the necessary data to achieve the expected behavior within the script logic.
• Nested elements: Some elements allow other elements to be placed inside them, supporting nested structures. For example, you can insert a Switch block inside an If condition, and within that Switch, you can have additional If conditions, and so on. These elements are collapsible, with a collapsing button next to the element's name.
• Custom element – "Comment": In addition to the standard Innovaphone elements, Flowe provides a new custom element named Comment (as of now, shown as "Comentário"). This element is designed purely for documentation purposes and allows users to insert comments directly into the XML code. These comments have no effect on script execution and serve only as notes or explanations within the file.

Comment element

• In the examples shown in the images:
  • Add element: one can write two values and the output.
  • Assign element: one can assign a value to a variable
  • If element: one can define the condition and nest an element inside. The else if and else elements are not automatically created.
  • Comment element: with a text input, one can add a comment to the script in the position where the element was added.

2. Searching for element

• Type your query into the "Search elements..." input field.
  • Use keywords that match either the element name or its description.

Elements list search bar

Element search example

3. Changing script name

1. Enter the desired name into the "Enter the script name" input field.
   • The name is required to create or edit a script.
2. Click the Save button to save your changes once you're done managing the script.
   • If the name is already in use, the input field will highlight in red and the Save button will be disabled.
   • If you attempt to save without a name, an alert modal will appear.

⇒ Note: The script requires a unique name that is not already in use. If the name is duplicated, the Save button will be disabled; if missing, an alert will appear.

Script name input

"A script with this name already exists; (...)" tooltip alert

Name requirement alert modal

4. Canceling script management

• Click the Cancel button located between the script name input and the Save button.
  • The page will redirect back to the initial Scripts area, and any unsaved progress will be lost.

Cancel script management button

5. Saving script

• Click the Save button beside the Cancel button.
  • The page will redirect back to the Scripts initial page.
    • The script will be updated on or added to your list.

Save script button

⇒ Note: The script can only be saved if it has a unique name that is not already in use.

6. Adding function to script

1. Type in the "New function name" input area;
2. Click the Add button on the right.
   • New functions will be added sequentially below the previous ones.

Add new function input and button

⇒ Note: A valid name is mandatory to create a new function. Without it, the function won’t be added.

7. Changing function name

1. Click the Edit (pencil icon) button next to the red trash icon.
2. Edit the name in the input field.
3. Click outside the input field to save.
   • The new name will be saved automatically.

Change function name

⇒ Note: The Main function’s name is fixed and cannot be changed.

8. Removing function from script

• Click the red Delete (trash icon) in the top-right corner of the function block
  • The entire function will be deleted immediately.

Remove function button

9. Adding element to function

1. Click the + dotted area where you want to add an element.
   • The area will be highlighted when selected.
2. Click on the desired element from the elements list.
   • You can search for elements using the search bar and simply click to add.
   • Elements can be added before, after, in between elements.
   • Elements can also be nested within other elements using the same process.

Add first element (in the highlighted dotted area)

Add more elements (in the dotted areas)

Add nested elements (in the dotted areas)

⇒ Note: If no insertion point is selected, the element will be added at the end of the function. If there are no existing elements in the function and no insertion point is selected, the element will not be added.

10. Filling element information

• Enter the required details in the element’s input fields.
  • Each element has its own specific required inputs, based on the Innovaphone XML Schema.

Add element inputs

11. Removing element from function

• Click the red Delete (trash icon) in the top-right corner of the element block.
  • The entire element will be deleted immediately.

Remove element button

IVRs

The IVRs Page is the main interface for managing IVR entries within the Flowe application. It allows users to create, edit, and organize IVRs that are associated with existing XML scripts.

IVR page with outlined features

The interface is divided into the following key areas:

• IVR Search Bar – Positioned at the top of the page, this input allows users to search through existing IVRs using keywords and numbers that match either the title, the internal number or SIP.
• Add IVR Button – Located to the right of the search bar, this button opens a modal window to create a new IVR entry. Every information is required to create the new IVR.
• IVRs List – Displays all IVRs in a card-based format. Each card contains the following details:
  • Title – The unique name identifying the IVR.
  • Internal Number – The internal extension assigned to the IVR.
  • SIP Number – The SIP number configured for the IVR.
  • Script – The XML script that is linked to the IVR.

• Action Buttons on Each IVR:
  • Edit – Opens the same modal used for creation, pre-filled with the IVR’s current data for editing.
  • Delete – Removes the IVR after confirmation.

IVRs are fully integrated with the Scripts module, ensuring that each IVR is functional only if a valid script is associated with it.

1. Searching for IVR

• Type your search query into the "Type to search..." input field.
  • You can use keywords that match the IVR’s title, internal number, or SIP address.

IVR search bar

2. Adding a New IVR

1. Click the Add button next to the IVR List search bar;
   • A Create a new IVR modal will appear;
2. Fill in all required fields:
   • Type the name of the IVR;
   • Enter the internal number;
   • Enter the SIP address;
   • Select a pre-existing script to associate with the IVR;
3. Click the Save button in the bottom-right corner to create the IVR;
4. To cancel the creation process, click the Cancel button in the bottom-left corner.

Add new IVR button

Create a new IVR modal

⇒ Note: All fields are mandatory to successfully add a new IVR. Once saved, the new IVR will appear in the list automatically, and the modal will close.

3. Editing an IVR

1. Click the Edit icon on the bottom-right of the IVR card.
   • An Update the IVR modal will appear with the current information pre-filled.
2. Update any of the fields as needed:
   • Enter a new IVR name, internal number, and/or SIP address.
   • Select a different existing script to associate with the IVR.
3. Click the Save button in the bottom-right corner to apply the changes.
4. To cancel the editing process, click the Cancel button in the bottom-left corner.

Edit IVR button

Update the IVR modal

⇒ Note: All fields remain mandatory when editing an IVR. Once saved, the updated IVR will replace the old information in the list, and the modal will close.

4. Deleting IVR

1. Click the Delete (trash icon) on the bottom-right of the IVR card.
   • A Delete IVR confirmation modal displaying the name of the selected IVR will appear.
2. To confirm deletion, click the Delete button on the right.
   • The IVR will be permanently deleted and removed from the list.
3. If you misclicked or decide not to delete, click the Cancel button on the left.
   • The modal will close promptly without any changes.

Delete IVR button

Delete IVR confirmation modal

⇒ Note: Deletion is permanent and cannot be undone. Make sure to confirm before deleting a script.

Additional Functions

Navigation Tab

The navigation tab on the top provides direct access to the main sections of the Flowe application: Scripts initial page, IVRs page, and Licensing information page. Users can quickly navigate between these sections by clicking the corresponding tab. The currently active section is highlighted to indicate the page in view.

The navigation tab remains visible at all times, ensuring easy switching between functionalities within the app.

Navigation tab

Licensing Page

The Licensing page displays essential licensing information related to the Flowe application. This page is purely informational and does not contain interactive elements. It typically shows a message with contact details for inquiries or further licensing procedures.

Licensing page

Language Configuration

The language selector is always visible within the application's interface, allowing users to seamlessly switch between Portuguese, English, and German at any time. This ensures that the application is accessible and user-friendly across different language preferences, with all texts dynamically updated upon selection.

Language selection

Component Diagram

The diagram below illustrates the architecture of the Flowe application and how its components interact with the Innovaphone PBX, the App Platform and external services.

Flowe's component diagram

Component Flow Overview

• Flowe: stores and manages XML-based scripts that define the call flow logic.
• Files: holds audio files that can be used by scripts during execution.
• PBX Objects: are linked to scripts created in Flowe. When a call reaches a PBX object, it triggers the associated script.
• Webserver Routepoint: handles HTTP/HTTPS requests from Flowe:
  • It interacts with external services (e.g. APIs) and returns the response in the expected format.
  • It also stores audio files referenced by the scripts.

Licensing

The Flowe 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.

The license model is based on the number of created scripts: each script requires one license.

License type: Innovaphone Pricelist

License model: One license per script

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

Prerequisites

Before using Flowe, make sure your environment meets the following requirements:

System Requirements

• Innovaphone firmware: Version 14r1 or later
• App Platform: Must be enabled and running in your myApps environment
• PBX Access: Access to the Admin UI to manage PBX Voicemail Objects
• Browser access: myApps Web or myApps Windows/Mobile
• Network access: Outbound access to the App and PBX services

Functional Requirements

• Must have rights to create/edit/delete Voicemail Objects in the PBX
• Must have access to manage XML script files through the app interface
• Users must have login permissions in the App Platform

Versions

• Current version: 1.0
• Latest release: 2001 final
• Release date: May 22, 2025
• Innovaphone compatibility: Yes (Voicemail XML Schema)
• Architectures supported: arm, x86_64, arm64

Configuration

Once installed, the Flowe app provides a structured and intuitive interface within MyApps for managing Voicemail Objects and their corresponding XML-based call flows. The configuration process is divided into two main areas: using the Flowe editor and linking the flow to the PBX via PBX Manager.

To apply a script to a PBX Voicemail Object and activate it in the Innovaphone system:

1. Open the Devices app in MyApps and go to the Devices tab.
2. Locate your PBX and click Admin UI.
3. In the Admin UI interface, go to the PBX tab and select Objects.
4. In the drop-down menu, choose Voicemail, then click new.
5. Fill in the necessary fields:
   • Name, Number, Display Name, and Password
   • Under the Voicemail tab, provide:
     • Script URL (e.g., the script created in Flowe)
6. Click Apply to save the object.

PBX Manager flow to configure voicemail objects

PBX voicemail object general configuration

PBX voicemail object voicemail configuration with buttons

Installation

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

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

You can install Flowe 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 Flowe 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 you prefer installing manually, follow the steps below:

Step 1: Download the App Package

1. Visit the official Wecom myApps Downloads Portal.
2. Find the Flowe app.
3. Download the latest available version compatible with your system architecture.

Flowe 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

Flowe 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

Flowe on PBX Manager configured

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

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.