Reference15r1:Concept App Service Projects: Difference between revisions
(16 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
[[Category:Concept|Apps]] | [[Category:Concept|Apps]] | ||
[[Category:Concept App Service Projects]] | [[Category:Concept App Service Projects]] | ||
Line 7: | Line 6: | ||
Projects uses the Connect Api to post messages automatically at specified events, e.g. task status updates, and integrates the Connect App window to allow user posts. | Projects uses the Connect Api to post messages automatically at specified events, e.g. task status updates, and integrates the Connect App window to allow user posts. | ||
= Projects items = | = General Information = | ||
== Projects items == | |||
Projects items consist of description, status and responsible person like project owner, sprint manager or task handler. | Projects items consist of description, status and responsible person like project owner, sprint manager or task handler. | ||
== Areas == | === Areas === | ||
The highest level items on the hierarchical structure of projects. E.g. to combine all projects of a department. | The highest level items on the hierarchical structure of projects. E.g. to combine all projects of a department. | ||
<br>User access rights to the whole area including all lower level items are defined during area definition. Three access levels are provided: public, user group specific or private areas. | <br>User access rights to the whole area including all lower level items are defined during area definition. Three access levels are provided: public, user group specific or private areas. | ||
Line 16: | Line 16: | ||
<br>Areas may be defined as zones in Connect. | <br>Areas may be defined as zones in Connect. | ||
== Projects == | === Projects === | ||
A project consists of its description, status, the owner information and the area it belongs too. Projects may be filtered on area, project owner and/or attribute. | A project consists of its description, status, the owner information and the area it belongs too. Projects may be filtered on area, project owner and/or attribute. | ||
Projects typically contain several sprints and backlog entries. | Projects typically contain several sprints and backlog entries. | ||
Project tiles provides information about their sprints, backlog entries and tasks and a progress bar estimated on the story points of closed tasks / the story points of all tasks. | Project tiles provides information about their sprints, backlog entries and tasks and a progress bar estimated on the story points of closed tasks / the story points of all tasks. | ||
== Backlog == | === Backlog === | ||
Container for any tasks and ideas to a project which are not in work yet. Backlog entries may be filtered on area, project, backlog entry handler and/or attribute. | Container for any tasks and ideas to a project which are not in work yet. Backlog entries may be filtered on area, project, backlog entry handler and/or attribute. | ||
== Sprints == | === Sprints === | ||
Sprints specify closed units of work which are subdivided typically in several tasks. | Sprints specify closed units of work which are subdivided typically in several tasks. | ||
Line 30: | Line 30: | ||
A sprint consists of its description, status, the manager information and the project it belongs too. Sprints may be filtered on area, project, sprint manager and/or attribute. | A sprint consists of its description, status, the manager information and the project it belongs too. Sprints may be filtered on area, project, sprint manager and/or attribute. | ||
== Tasks == | === Tasks === | ||
Tasks are small units of work which are mostly handled by one person. | Tasks are small units of work which are mostly handled by one person. | ||
A task consists of its description, status, the handler information and the sprint it belongs too. Tasks may be filtered on area, project, sprint, task handler and/or attribute. | A task consists of its description, status, the handler information and the sprint it belongs too. Tasks may be filtered on area, project, sprint, task handler and/or attribute. | ||
= Other items and Projects users = | == Other items and Projects users == | ||
== Attributes == | === Attributes === | ||
Attributes are free defined, area independent flags. They may be assigned to all item types except areas. Attributes may be used as filter criteria. | Attributes are free defined, area independent flags. They may be assigned to all item types except areas. Attributes may be used as filter criteria. | ||
== Templates == | === Templates === | ||
To define sprint and task templates for specific workflows. | To define sprint and task templates for specific workflows. | ||
== Projects users == | === Projects users === | ||
Users are added automatically to projects as soon as they are logged in the first time. Only registered users can be assigned to Projects items. | Users are added automatically to projects as soon as they are logged in the first time. Only registered users can be assigned to Projects items. | ||
= Projects App UI concepts = | == Projects App UI concepts == | ||
The App Projects UI is subdivided into tabs that provide a structure that helps to organize projects, reflecting the Project Items: '''[[#Areas|Areas]]''', '''[[#Projects|Projects]]''', '''[[#Sprints|Sprints]] / [[#Backlog|Backlog]]''' and '''[[#Tasks|Tasks]]'''. | The App Projects UI is subdivided into tabs that provide a structure that helps to organize projects, reflecting the Project Items: '''[[#Areas|Areas]]''', '''[[#Projects|Projects]]''', '''[[#Sprints|Sprints]] / [[#Backlog|Backlog]]''' and '''[[#Tasks|Tasks]]'''. | ||
Line 55: | Line 55: | ||
Projects, Sprints and Tabs each consist of a board organising the '''Backlog''' or '''Planned''', '''Current''' and '''Closed''' items. | Projects, Sprints and Tabs each consist of a board organising the '''Backlog''' or '''Planned''', '''Current''' and '''Closed''' items. | ||
== Filters == | === Filters === | ||
When selecting an item, it works as filter on lower level items. E.g. if an area is selected, only projects of that area are provided. All active filter definitions are shown in the corresponding tabs and may be removed there. | When selecting an item, it works as filter on lower level items. E.g. if an area is selected, only projects of that area are provided. All active filter definitions are shown in the corresponding tabs and may be removed there. | ||
== Item search == | === Item search === | ||
Item title / ID search is provided for projects, sprints, backlog entries and tasks in the corresponding tabs. The item search does not consider user filters. | Item title / ID search is provided for projects, sprints, backlog entries and tasks in the corresponding tabs. The item search does not consider user filters. | ||
= Synchronisation = | == Synchronisation == | ||
Updates on Projects items are synchronized immediately. | Updates on Projects items are synchronized immediately. | ||
= Using Projects App in combination with Connect App = | == Using Projects App in combination with Connect App == | ||
When using Projects combined with Connect App new items defined in Projects or updates on items e.g. status changes are posted to Connect App. <br/> | When using Projects combined with Connect App new items defined in Projects or updates on items e.g. status changes are posted to Connect App. <br/> | ||
The Zone has to be defined in Projects area definition and is used in all lower level items of the area. <br/> | The Zone has to be defined in Projects area definition and is used in all lower level items of the area. <br/> | ||
Line 73: | Line 73: | ||
* Connect App | * Connect App | ||
* The Application Platform must be at least version 120004 | * The Application Platform must be at least version 120004 | ||
* License “App(innovaphone-projects)xx” (order no. 02-00050-014). ''' | * License “App(innovaphone-projects)xx” (order no. 02-00050-014). </br> '''Free version available'''. | ||
= License = | = License = | ||
* This is a user licence. This licence is debited if the function is configured on a user in the PBX - regardless of use. | * This is a user licence. This licence is debited if the function is configured on a user in the PBX - regardless of use. | ||
* The Projects app licence version must be greater than or equal to the PBX software version and app software version in use (see: Licence version). | * The Projects app licence version must be greater than or equal to the PBX software version and app software version in use (see: Licence version). | ||
* The private area is available for every user and can also be used without a licence ( | * The private area is available for every user and can also be used without a licence (free version). | ||
* The Connect app (installation without licences) is required to use all the functions of Projects. | * The Connect app (installation without licences) is required to use all the functions of Projects. | ||
* Only a user licence is required for the Projects app. Further licences such as the port licence are not required! | * Only a user licence is required for the Projects app. Further licences such as the port licence are not required! | ||
== | == Free version == | ||
An unlicensed user can also use Projects, but is restricted to their own area and can only use Projects to manage their own tasks. </br> | |||
However, | However, an unlicensed user cannot see any cross-departmental areas, projects, sprints or tasks. | ||
= Configuration = | = Configuration = | ||
Line 106: | Line 106: | ||
#** (Optional) Assign the Projects-App to an existing Template | #** (Optional) Assign the Projects-App to an existing Template | ||
# Assign the Projects App to authorized users using a Config Template and/or directly on the User Object(s) | # Assign the Projects App to authorized users using a Config Template and/or directly on the User Object(s) | ||
# Assign 'App(innovaphone-project)xx'-licenses to the authorized users (or try the | # Assign 'App(innovaphone-project)xx'-licenses to the authorized users (or try the free version) | ||
== AP Manager/App Store == | == AP Manager/App Store == | ||
Line 131: | Line 131: | ||
#* Via the PBX Advanced UI (see below for settings) | #* Via the PBX Advanced UI (see below for settings) | ||
# Assign the Projects App to authorized users using a Config Template and/or directly on the User Object(s) | # Assign the Projects App to authorized users using a Config Template and/or directly on the User Object(s) | ||
# Assign 'App(innovaphone-project)'-licenses to the authorized users (or try the | # Assign 'App(innovaphone-project)'-licenses to the authorized users (or try the free version) | ||
== Apps == | == Apps == | ||
Line 173: | Line 173: | ||
= Related Articles = | = Related Articles = | ||
* [[ | * [[Reference15r1:Apps/PbxManager/App Projects]] | ||
* [[Reference15r1:Concept App Connect]] |
Latest revision as of 09:58, 25 March 2025
Overview
The App Service Projects provides useful functionality to manage projects. It is built-on an hierarchical structure of areas, projects, backlog, sprints and tasks. Projects uses the Connect Api to post messages automatically at specified events, e.g. task status updates, and integrates the Connect App window to allow user posts.
General Information
Projects items
Projects items consist of description, status and responsible person like project owner, sprint manager or task handler.
Areas
The highest level items on the hierarchical structure of projects. E.g. to combine all projects of a department.
User access rights to the whole area including all lower level items are defined during area definition. Three access levels are provided: public, user group specific or private areas.
User groups are defined in the PBX. Protected areas and all their lower level items are invisible for unauthorized users.
Areas may be defined as zones in Connect.
Projects
A project consists of its description, status, the owner information and the area it belongs too. Projects may be filtered on area, project owner and/or attribute. Projects typically contain several sprints and backlog entries. Project tiles provides information about their sprints, backlog entries and tasks and a progress bar estimated on the story points of closed tasks / the story points of all tasks.
Backlog
Container for any tasks and ideas to a project which are not in work yet. Backlog entries may be filtered on area, project, backlog entry handler and/or attribute.
Sprints
Sprints specify closed units of work which are subdivided typically in several tasks. Sprint tiles provides information about their tasks and a progress bar estimated on the story points of closed tasks / the story points of all tasks. A sprint consists of its description, status, the manager information and the project it belongs too. Sprints may be filtered on area, project, sprint manager and/or attribute.
Tasks
Tasks are small units of work which are mostly handled by one person. A task consists of its description, status, the handler information and the sprint it belongs too. Tasks may be filtered on area, project, sprint, task handler and/or attribute.
Other items and Projects users
Attributes
Attributes are free defined, area independent flags. They may be assigned to all item types except areas. Attributes may be used as filter criteria.
Templates
To define sprint and task templates for specific workflows.
Projects users
Users are added automatically to projects as soon as they are logged in the first time. Only registered users can be assigned to Projects items.
Projects App UI concepts
The App Projects UI is subdivided into tabs that provide a structure that helps to organize projects, reflecting the Project Items: Areas, Projects, Sprints / Backlog and Tasks.
Other extra tabs provide additional functionalities: Attributes, Templates and Users.
The Home-tab gives a quick and useful overview of all Current tasks and pinned Users/Areas/Projects and Sprints.
Projects, Sprints and Tabs each consist of a board organising the Backlog or Planned, Current and Closed items.
Filters
When selecting an item, it works as filter on lower level items. E.g. if an area is selected, only projects of that area are provided. All active filter definitions are shown in the corresponding tabs and may be removed there.
Item search
Item title / ID search is provided for projects, sprints, backlog entries and tasks in the corresponding tabs. The item search does not consider user filters.
Synchronisation
Updates on Projects items are synchronized immediately.
Using Projects App in combination with Connect App
When using Projects combined with Connect App new items defined in Projects or updates on items e.g. status changes are posted to Connect App.
The Zone has to be defined in Projects area definition and is used in all lower level items of the area.
Users are notified about item assignments and will be able to add comments / own posts on items.
Checks when having issues
Requirements
- Connect App
- The Application Platform must be at least version 120004
- License “App(innovaphone-projects)xx” (order no. 02-00050-014).
Free version available.
License
- This is a user licence. This licence is debited if the function is configured on a user in the PBX - regardless of use.
- The Projects app licence version must be greater than or equal to the PBX software version and app software version in use (see: Licence version).
- The private area is available for every user and can also be used without a licence (free version).
- The Connect app (installation without licences) is required to use all the functions of Projects.
- Only a user licence is required for the Projects app. Further licences such as the port licence are not required!
Free version
An unlicensed user can also use Projects, but is restricted to their own area and can only use Projects to manage their own tasks.
However, an unlicensed user cannot see any cross-departmental areas, projects, sprints or tasks.
Configuration
Settings App/App Installer
- Install the Projects App on the App Platform via the 'Settings App/App Installer'-plugin:
- Open the Settings App
- Open the Projects-plugin
- Read and accept the Terms and Conditions of the App Installer (if not done yet)
- Search projects
- Select the Projects-App
- Select the correct version and click Install
- Read and accept the Terms and Conditions of the Projects App and click Install
- Add an App-Object via the Projects-plugin of the Settings App:
- Close and Re-Open the Settings App
- Open the Projects-plugin
- Click on Add an app; Select 'Projects' and complete the form:
- Name: Projects
- SIP: projects
- Connect App: select the correct Connect-App (default connect)
- Connect Admin App: should be updated automatically to the previous Connect App appended with ~admin-service (default connect~admin-service)
- (Optional) Assign the Projects-App to an existing Template
- Assign the Projects App to authorized users using a Config Template and/or directly on the User Object(s)
- Assign 'App(innovaphone-project)xx'-licenses to the authorized users (or try the free version)
AP Manager/App Store
Installing the Project App via the 'Settings App/App Installer'-plugin is the preferred/easier method, but a complete manual install is also possible.
- Install the Projects App on the App Platform via the App Store:
- Open the AP Manager
- Open the App Store
- Read and accept the Terms and Conditions of the App Installer (if not done yet)
- Search projects
- Select the Projects-App
- Select the correct version and click Install
- Read and accept the Terms and Conditions of the Projects App and click Install
- Add an instance of the Projects App on the App Platform:
- Close the App Store
- Open the newly installed Projects App
- Click on '+ Add' to add a new Projects Instances and complete the form:
- Name: projects
- Domain: {System Name} (found under PBX/Config/General)
- Password: {strong password}
- Database password: {strong password}
- Select and Start the instance
- Create a PBX-object:
- Via the Settings App Plugin (see above)
- Via the PBX Advanced UI (see below for settings)
- Assign the Projects App to authorized users using a Config Template and/or directly on the User Object(s)
- Assign 'App(innovaphone-project)'-licenses to the authorized users (or try the free version)
Apps
Only one PBX App object is used and needed.
Parameters of the PBX App object:
URL: https://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-projects
Under tab "App"
To allow posting to Connect App:
- WebSocket
- needed
- Services
- needed
Under tab "Apps"
To allow Projects to maintain Projects zones in Connect:
- connect
- ticked
- connect~admin-service
- ticked
Troubleshooting
Projects-plugin cannot see the Connect Admin Service
- Check that the Connect App has an 'admin-service'-mode configured (modes-field can be found in the 'App'-tab of the object).
Project cannot see the Connect-discussion
Both the Project App and the User using the Project App must be checked for the necessary settings:
Project App object:
- Check that the Project App has 'WebSocket' and 'Services' ticked ('App'-tab).
- Check that the Project App has 'connect' and 'connect~admin-service' ticked ('Apps'-tab)
- Open the Project App/Areas + edit an Area. Check the 'Connect zone setup state':
- Green: connection OK
- Orange: connection not yet established
- Red: connection NOK
User Object using the Project App:
- Check if the User using Projects has 'connect' ticked in the 'Apps'-tab (best deployed via a global Template; e.g. the default 'Config User').
Area Not Connected (Orange/Red)
Check the previous Troubleshoot-item (Project cannot see the Connect-discussion) and edit the Area (via the Pencil-icon).
By editing the area the connection establishment will be restarted.