Organization-Guide/Project/PROJECT.md

Project Status and Tasks

• Summary
• Milestones
• Todos
• Features
• Bugs
• Drafts, concepts & ideas
• Most recent changelog

Summary

Last update of this file: 11.09.2021

Timeline

Key changes this month

Challenges & problems

Next steps

Continue with milestone task implementation.

Milestones

Based on the pilot candidate with whom the functionality will be implemented.

Deadline	Done	Milestone	Costs	Value
		Replace ticket system from Z*	7,200 EUR	8,000 EUR
		Replace document/contract management from CRM	3,000 EUR	6,000 EUR
		Implement invoice management process	0 EUR	5,000 EUR
		Replace QM from CRM	700 EUR	1,500 EUR
		Replace workflows from CRM	1,000 EUR	3,000 EUR
		Move sales reps from CRM	3,000 EUR	6,000 EUR
		Replace Marketing events, seminars, shop data from CRM	1,500 EUR	2,000 EUR
		Sales analysis (replace D* from G*)	1,000 EUR	2,000 EUR
		Digitalizing human resource Human Resource Management	0 EUR	500 EUR
		Replace billing from G*	15,000 EUR	20,000 EUR
		Replace stock from G*	7,500 EUR	8,000 EUR
		Replace inventory from G*	500 EUR	1,000 EUR
		Replace manufacturing from G* + R&D + Quality control	500 EUR	10,000 EUR
		Replace accounting from G*	10,000 EUR	12,000 EUR
		Replace asset management from G* EUR	500 EUR	500 EUR
		Replace reporting from L*	4,200 EUR	5,000 EUR
			55,600 EUR	90,500 EUR

The annual value is the relative value for the pilot candidate based on the current cost structure.

Cost basis

The estimated annual costs in the milestones are based on the total annual costs from the software from the pilot candidate. These total costs are then subjectively distributed to the different software aspects.

Type	License	Customization	Total
Z*	7,200 EUR		7,200 EUR
G*	26,600 EUR	8,400 EUR	35,000 EUR
L*	4,200 EUR		4,200 EUR
CRM		9,200 EUR	9,200 EUR
Total	38,000 EUR	17,600 EUR	55,600 EUR

Website costs are not included, they can be estimated at another 30,000 EUR per year

Tasks & decisions

Deadline	Done	Task
2021.08.27		Define scope Which modules should be developed first Which features must be part of the modules at the start What is the expected timeline for the different modules
		Navigation Allow to hide navigation elements even if the module is installed. Also disable routing for front end. This way only the functionality is available (API).
		Customer Management Names Address Contact elements Custom fields Contract import from CRM system (maintenance contract)? (SD specific) Add note types (e.g. phone, email, meeting, ...)
		Job Create jobs Manage jobs Create a job which runs exchange scripts
		Exchange (Importer/Exporter) GSD import script for customers (new entries and changed entries) (SD specific) GSD import script for customer addresses (new entries and changed entries) (SD specific) Allow to define exchange scripts as auto-run with a interval
		Permission Better permission handling (only show tickets the user is allowed to see) difficult When returning models (backend and API requests) the permission should be checked (all modules) After completely figuring out permissions every API function needs to be checked if it behaves correctly depending on the different permissions (e.g. user created the model, user who is allowed to access the model but not change it, ...)
		Admin Implement password reset Implement email sending Implement global email server definition [UI] Add user & group settings [UI] Add account/group removal from each other [UI] Add permission removal from accounts/groups [UI] Add permission modification for accounts/groups Create API key permissions Create API key handling Handle logging for API keys Handle "login" for API keys (maybe create dummy account for that?)
		Support (Tickets) Ticket creation Ticket response Status update via email Feedback/rating via email click (using time limited hash) difficult Response from customer via email (using time limited hash) . Requires ticket email address, maybe create one per app?difficult Upload files to random support directory Allow ticket creation from external sources (e.g. website) by using an api key. Allow custom fields as well.
		Media Drag and drop upload Ctrl+C/Ctrl+V upload Move files and directories to subdirectories Bulk actions (move, delete, download, ..) Better file and directory permissions. Similar problem applies to permissions. difficuly due to subdirs Create custom media types (e.g. contract) with l11n text/description Implement download of directory Add password support for directories. > Difficult because of subdirectories Allow to actually replace media files (same DB id but replaced the file on the hard drive) After installing the Media module the admin account directory should be created, this is not done at the moment like other new accounts since the admin account is created before the media module is installed Allow links as media files (e.g. use path). If a link is detected it should forward to that link, this would also allow other modules to create pseudo media elements e.g. helper/editor. Upon clicking on it e.g. the editor is opened. This would mean the editor needs to create this media model whenever the user creates a document. The path needs to be the same as in the moduel itself e.g. Accounts/... or whatever the user defined as path in the module itself. The url should be relative e.g. /editor?id={id} which makes it domain name independent. Allow to create a collection when uploading multiple files Create admin setting for handling media_type specifications
		Contract Management Show contracts after clicking on document list in contract Assign contract to an account Create task/message if a contracts term runs out Create job which informs people about contract end of life Define custom info deadline (global and optionally for a single contract) Setting to change responsible person/group A to B (e.g. person leaves company) Implement directory view for contracts Create a new media type "contract" Contracts can have a different date of expiration and last renewal. (e.g. renewal needs to happen 1 month before contract end) Contracts should be filtered by organization
		System Implement maintenance mode where no one can edit anything. Implement API only mode for modules, which disables UI interaction with a module completely (no navigation, no templates, ...)
		Workflow Individual UI templates incl. styles Script management Allow email message and response (text+time limited links via hash)
		Invoice Management OCR Auto content recognition (supplier, articles, costs, taxes, payment terms) Define approval workflow Allow notes Allow questions to other users (reference tasks and or media messages) Allow to add additional documents Allow PDF modifcation (allow notes on pdf, approval stamps) difficult > This requires a JS live preview for adding this at a specific position (maybe PDFJSAnnotate, maybe customize pdf.js) Job/Schedule which checks unhandled invoices Hooks/Workflows for invoices
		Quality Management Create quality issue (for account, article, other?) Define workflow based on report type? Statistics???? Export list to excel Export based on filter to pdf Expand GSD Exchange importer a lot of work (SD specific)
		Workflow (implement some scripts) Remove article (SD specific). How to handle data (custom database table?) Create article (SD specific). How to handle data (custom database table?)
		Customer Management (SD specific) Expand GSD Exchange importer to also import customer files from CRM (files, emails) Expand GSD Exchange importer to also import customer notes (notes, visitor reports)
		Sales Create easy way to create quick visitor reports (= maybe use notes for this with a type 'visit') Allow to create visitor report on cell phone by using location matching (geolocation) Analyze reports per sales rep (e.g. use filter for export?)
		Item Management Names Base data Media files Expand GSD Exchange importer to also import articles (SD specific)
		Billing (only data for upcoming modules) Basic invoice data (no stock movement) Expand GSD Exchange importer to bills as well (SD specific) Bill expenses such as insurance, freight, etc. also need VAT percentages. Best would be to create cost types, this would allow to add multiple freight expenses and print them below the invoice Show invoice pdf in preview on change Save number-format and the rendered number in the bill, currently only the format is saved and rendered on the fly which is bad for searching and performance. Maybe even ONLY save the number? Save original net value and discounted net value (currently only discounted net value is stored) Save discounts
		Sales Sales rep ranking Individual rep sales analysis (e.g. top customers, sales by product group, lost customers, ...)
		Customer Management Customer sales info/statistics (total sales, invoices, articles, groups) Invoice pdf importer from hard drive (without using the Exchange module) (SD specific) Create a view where you can see all bills of the customer Create a view where you can see all items of the customer
		Sales Sales analysis reports
		Sales Analysis (client sales analysis) Sales + Gross profit Quantity orders + quantity articles Segment sales Top articles Cross selling (bought as well) Amount of invoices Amount of different articles
		Sales Analysis (item sales analysis) Sales + gross profit quantity sales, quantity customers Cross selling Top customers Amount of customers Amount of article sales Amount of new customers Cross selling articles
		Job Create job which can automatically create checklists (e.g. end of month checklists)
		Checklist Create module Checklists can create tasks Allow to define recurring date time
		Marketing Create promotions (incl. basic info) Promotion planned costs Promotion planned earnings Promotion assign to customers Promotion start/end Promotion type (somehow use for cost center) Promotion custom fields Promotion media files Create events (incl. basic info) Event planned costs Event planned earnings Event assign to customers Event speaker Event start/end Event type (somehow use for cost center) Event custom fields Event media files
		Human Resource Management Handle staff information (encrypted) Handle staff positions Manage documents (encrypted) Manage contracts (encrypted) Manage salary (encrypted) List of assets and documents handed over to employees (to be returned on leave)
		Item Management Add an area for markers (e.g. not sold for a x month, not purchased for x month, bad margin... etc.) Similar to an alarm system (maybe green, yellow, red markers?) Consider to use name for attribute identification (currently only used for localization). Is this really required?id might be fine? Add an area for markers (e.g. not sold for a x month, not purchased for x month, bad margin... etc.) Similar to an alarm system (maybe green, yellow, red markers?) Create a second optional list view where the item is shown at the bottom of the list which allows the user to the the item list at the top and the item itself below. Either create a custom view or somehow append an iframe below the list which is loaded based on the selected item
		Human Resource Clocking Basic clocking (browser + hardware) Hardware needs to make web requests for the chip clocking Clocking overview for employees Vacation / absence management for employees Clocking overview/analysis for managers/hr Vacation / absence overview/analysis for managers/hr Vacation approval workflow Clocking change approval Export of clocking times (hr) Export of vacations, sickness, ... (hr)
		Dashboard Drag&Drop element sometimes disappear on drop Create default dashboard templates which can be used by users, changing them copies it for this user Allow people to modify a dashboard and automatically save it / reload it Implement a way for other modules to provide dashboard components (allow modules to register themselves in a database table)
		Billing (additional features) Only create pdf preview if preview is visible? [Analysis] Gross profit (total bill and elements) Show bill relations (on tab which shows all related bills) Create send as email button inside the bill. this opens the send email view where the email is pre-written with the attached pdf In the supplier and client view you should be able to select multiple bills and click print for printing In the supplier and client view you should be able to select multiple bills and click send as email for email sending The send bill as email should have a global settings where you can either define a global email or empty = user specific email Sending emails should have a default email format and a default invoice naming convention, additionally there should be the option to define a user specific email text and pdf naming convention Clients should have a invoice_email address which is stored in the client
		Billing (full implementation) Allow to define re/usable templates (e.g. recurring invoices) Allow to define re/usable texts Automatic email invoice after finishing if user wants to use that Batch print/export invoices based on filter Bill element sorting should have a small bar at the beginning of every element which allows the user to drag/drop the element up or down. Of course the up/down arrows which are currently implemented should remain. Forward bills to sales rep (if bill > X EUR or specific type) Implement approval concept for invoices and invoice elements (e.g. price, tax, margin etc.). The problem is that different changes may require different responsible people to approve this, this means you would need some indication which shows which approval is still outstanding. Of course a less detailed visual indication would be a red, yellow, green marker at the beginning of the invoice/element or background highlight Allow to import existing bills (e.g. order -> invoice, offer -> confirmation -> delivery note ...) Share media files between imported bills for easier searching. Maybe do this by creating a root element which all bills reference and show files of this root bill? Show list for recommended purchase items + type tags e.g. re-order because empty, cross selling, promotion (if promotion already used, don't offer any longer)
		Warehouse Management Implement stock GSD stock importer
		Purchasing Create item list for purchasing
		Accounting Implement GSD accounting importer Print receivable of customer (also allow to do this from the client view in the Client Management)
		Client Management (additional feature implementation) Add list for top articles on profile page... important for customer calls Add list for recommended purchase items + type tags e.g. re-order because empty, cross selling, promotion (if promotion already used, don't offer any longer) Create a simple button to send an email to a customer, this also should have the option to change the mail address (e.g. drop down with all available email addresses and option to manually write it) Add a geo map of the customers location (either on a real map or on the already added SVG maps)
		Client Management (nice to have) Create a map of all customers (maybe as data points or as heat maps) Create a map of sales (maybe as data points or as heat maps) Create default letter Doc (with/without letter head) Make customers only visible/readable to authorized people (e.g. sales rep may only see his own clients) Client view should be customizable since different groups have different interests and read permissions (e.g. sales reps, finance, etc.) Allow to specify the accounting account (e.g. a customer who is a supplier may have the same account)
		Accounting Analysis Create different P&L structures Create different balance structures Create cash analysis structure Create asset/depreciation structure Create comparison feature for the above mentioned structures (budget, IFRS, ...)

Archived

Deadline	Done	Task
	2021.09.06	Admin [ModuleSettings] The module settings should have two tabs/pages. One containing a list of all settings for the module and the other a custom settings page where it's possible to give the impression of a customized setting view. The template itself is individual for the module but in the backend the list is still used. The reason for this customized settings template is that this allows to create a nicer input and form layout (e.g. media selector if a setting references a media file, show a preview output for images, custom input validation, ...)
	2021.09.06	Media Change media_type from string to foreign key and create a media_type table where it's possible to create media types (this should have a localized table for type name). This allows us to upload media types such as contracts. Create a installExternal binding for media_types (currently collections and uploads exist)
	2021.09.18	Legal Pages Create Privacy Policy Create Terms of Use Create Imprint Pages should be handled in the CMS module which becomes a standard module.

Todos

Todos/tasks which are not important enough to be part of the milestones.

Priority	Done	Task
high		Email Continue implementation of email sending and receiving. Especially receiving needs much more work.
high		Search Implement a tag search hook which finds content based on tags Implement module specific search (e.g. :tasks title ...) Implement global search hook (every module performs a search based on the search) Create a api search filter which allows to search in a specific module only (e.g. in the shop app only search the shop, in the QA app only search in QA)
high		UI input In the AdvancedInput, implement predefined values (e.g. predefined/default tags) In the AdvancedInput, implement mandatory predefined values (e.g. tags which cannot be deleted) Implement AdvancedSelect (with auto filtering, none-element, multi-select, default-selects, must-have selects)
high		UI change Find a way to load a different page after a successful form result (e.g. reload account creation page)
high		Table Implement drag sortable table rows (https://htmldom.dev/drag-and-drop-table-row/). Implement the same concept for other elements, maybe abstract it straight away!
high		Table Implement export (local=visible data, external=all data) Implement filtering (local=visible data, external=all data) Highlight filtering of the filtered columns
high		Forms On change highlight the data/element that got changed Invalid API responses should undo the UI changes Removing a form from the DOM should unbind it Adding a template to the DOM should modify its id/generate a custom/random id for the added element Add/bind UI elements after adding them to the DOM Consider to allow multiple/different add buttons which behave a little bit different If a form has unsaved content the browser should ask if the user really wants to change the page or close it ("beforeunload"-Event)
medium		Url format Change the url format in most modules from query parameter to path (e.g. /module/profile?id=Admin to /module/Admin/profile)
medium		Modules Many models would benefit from unit and app association. Sometimes models should only be available/associated with a specific unit (e.g. news article for website, backend, shop etc.)
		DataMapper The ::with() function uses blacklisting it should be changed to whitelisting for relations
medium		DataMapper This is useful for Item profile, Customer profile, Supplier profile etc. Alternatively find a way to implement it in ::withConditionals ?! Or do we need a new function ::withParameters('memberName/columnName?', [options]). Or just a ::with() function which we also need to specify for the future for which relations need to be loaded at all e.g. ::with('files', ['limit' => 5, 'sortBy' => 'createdAt', 'sortOrder' => 'ASC'], [Client::class]) I think the ::with(...) makes the most sense. Maybe this can also be combined with the withConditional. This way we can remove/merge withConditional. There is one problem, maybe we need a ::onlyWith function, because we don't want to load all relations
medium		ActionManager Implement listeners for child elements if the selector is specified
medium		Action Create a action which adds/removes DOM elements Log DOM changes to the user
medium		Unit tests All Modules/**/Models/*, Modules/Controller/*
medium		Modules Find a way to handle optional modules (e.g. comment module in the news module) in the past the Mapper was modified (comments were removed) if the comment module was installed. Somehow this is no longer available but maybe another solution could be a different Mapper which is replaced if the comment module is installed. But instead of replacing a complete file, a diff should be generated between the files and the ADDED lines should be merged. How to handle uninstall because here it doesn't work? I would need to know exactly what to remove.
medium		DataMapper In the DataMapper implement iterable fetch. Currently all models are returned in one go, additionally an iterator should be returned for iterable access in case of MANY results (e.g. Exchange module)
low		Unit tests [phpOMS] ModuleManager->installApplications [phpOMS] StatusAbstract->installRoutes [phpOMS] StatusAbstract->installHooks [phpOMS] StatusAbstract->activateHooks [phpOMS] StatusAbstract->deactivateHooks [phpOMS] StatusAbstract->uninstallHooks [phpOMS] ModuleAbstract->createModels [phpOMS] ModuleAbstract->updateModel [phpOMS] ModuleAbstract->createModel [phpOMS] ModuleAbstract->getLocalization [phpOMS] InstallerAbstract->createTables [phpOMS] InstallerAbstract->reInit [phpOMS] Graph->findAllReachableNodesDFS [phpOMS] Graph->getAllPathsBetweenNodes [phpOMS] Graph->countAllPathsBetweenNodes [phpOMS] Graph->longestPathBetweenNodes [phpOMS] Graph->shortestPathBetweenNodes [phpOMS] Graph->isConnected [phpOMS] Node->getEdgeByNeighbor [Model] CoreSettings->create
low		ER diagrams Checklist Contact DatabaseEditor Draw Messages Monitoring Shop
low		Code cleanup Many modules still have unnecessary getters/setters. This should be replaced with puplic members. Check the Developer-Guide on when to use getters/setters.
low		UI tabs [Template] Fix tab indices's. On many pages the tab indices's are broken (tabs, table/list, links, forms)
low		Surveys Currently the demo (demoSetup/*) only uses one language (en). Generate surveys with multiple langauges similar to other module demos (e.g. Wiki, News). In that case also prefix the text with the language so it's easy to see which language is loaded e.g. EN: (like in the tag module demo) Consider to add a closing paragrah. The description comes at the end, but maybe a paragraph at the end of the survey should be added?!
low		Modules The modules use the module name for identification in many places where the module id should be used for performance reasons
low		Modules/permissions In many places where permissions are used bad and different names are used. Sometimes the term "type" is used, sometimes the term "state" (PermissionState). Both actually represent a superficial category every module can define for permissions. (e.g. a state could be account, task, profile, tag, ...). The term "state" makes no sense since it isn't a state. The term "type" is also bad because in another place it is used to define (read, write, change, ...). Maybe we should simply call it PermissionCategory/category?! (files to change: NavElement, PermissionAbstract, PermissionState)
low		Graph Implement missing functionality: Find cycles using graph coloring Find a negative cycle Find cycles with n length Find cycles with odd length Find islands Check if strongly connected Find longest path Get the girth Get the circuit rank Get the node connectivity Get the edge connectivity Check if bipartite Check if triangle free
low		QueryBuilder Implement missing functions such as sum, count, ...
low		DataMapper Reconsider the order of the get(*) parameters (e.g. depths/fill)
low		General Once read only variables become available many models can remove getter/setter function (e.g. ApplicationAbstract, ConnectionAbstract and various models)
low		DataMapper In the DataMapper when using getQuery() and then making a ->where(...) the where will often fail because the table name is suffixed with an integer e.g. _3. This means you need to know the depth of the query in order to manually write it. The query builder should figure this out by himself. It knows the _INT value from the FROM clause and should just overwrite in the where clause where needed. See the GSD Importer from the exchange module for reference.
low		DataMapper Only update changed relations (e.g. allow coder to tell the DataMapper what changed)
low		DataMapper Implement get() where the coder can tell the DataMapper which fields and relations to fill (this might be solved with a better ::with() function.
low		Grammar Implement schema modification grammar (alter tables)
low		Router, EventManager, Hook Instead of doing 100% regex matching, combine it with a tree search, this should be faster
low		Text search algorithm Implement a decent full text search for files/variables which finds texts that are similar (e.g. similar spelling, only some words in between, maybe different word order, etc.)
low		OAuth2 Implement client Implement server
low		ServiceWorkers Implement caching and responding
low		Code Implement QR code creation Implement QR code reader Implement data matrix creation Implement data matrix reader Implement various bar code readers
low		Speech recognition Remove the speech recognition wrapper once it becomes standard
low		Voice commands Implement table/link navigation
low		Input validation Implement nicer input validation (e.g. show check mark and x in the input fields / optionally)
low		jsOMS Framework Consider to create a library function which finds the nearest element based on a select (horizontal and vertical search, *.nearest() does not work this way)
low		jsOMS UriFactory Consider to parse EVERY URL with the Uri factory. This however might cause double parsing and therefore bugs
low		Tabs The frontend loads the correct tab based on the provided fragment, but it is slow. Doing this in the backend can already fix this but the frontend implementation should be fixed, because this should be the job of the frontend.
low		Build process/website module display Text file with all the module git links Download and install Default inspections/tests (unit tests, info.json, language files used, language files in all languages same content, amount of languages, routes in controller available, dependencies valid, code coverage, phpstan, phpcs) Add to database
low		Logs The "Log" tabs in many models should have a separate permission which hides them. Maybe a user needs to have read permissions of the monitoring module in order to see them? Alternatively it could be a *_MONITOR permission for the specific model in every module. This is a little bit finer but also expands the permission complexity
low		UI sections/portlets sections/portlets with a footer sometimes have problems with floated elements. e.g. a right floated button will break the layout if the left element(s) are too long causing wrapping. > Solution: create flexbox with margin
low		Admin: Settings template In the Settings->Localization->Numeric the number format (decimal, thousands) don't have a spacer in between. Margin left doesn't work.
low		Admin The default Account mapper should not have a password reference, there should be a AccountLoginMapper which is used if anything needs to be done regarding the account password. Alternatively, think about a private field modifier which requires the programmer to specifically request the read/write permission for that field (password field). The reason for this is that otherwise the password hash might be dumped in case of an error
low		Auditor Consider to create foldable/tree view for json logs e.g. https://www.cssscript.com/json-data-tree-view/ Implement blockchain for the auditor. This either requires database locking (slow),modification of audit logs after inserts (slow) or a background process which calculates theblockchain (OK). Create printable reports based on specific changes
low		Database Editor Implement basic functionality / queries in UI
low		Fleet Management
low		Helper Implement direct print instead of opening a new window with document.getElementById('iHelperFrame').contentWindow.print();
low		Investments Approval Comparison/calculations
low		Labeling Create default label layout for items
low		Item Management ItemAttributeTypes should specify which datatype they expect. The ApiController needs to validate if a value can be created for an attribute type (check validation pattern, datatype, is required) Show additional important item information for sales/purchase, currently too controlling/stats focused Define some attributes mandatory (e.g. HC-code/tariff code number)
low		Kanban Implement card status (archive, public, inactive) Implement unread cards/comments notification/highlight Highlight card with new comments (e.g. make comment count background red?) Consider to replace card comments with normal comments from the Comments module
low		Knowledgebase Implement category create/edit view Implement doc create/edit view (similar to news/editor) Add category back/up button when in a subcategory
low		Monitoring Implement integrity check based on installed version and remote hash list (see monitoring-security.tpl.php)
low		Messages Implement email sending/receiving Implement internal message/conversion storage
low		Organigram Create better organigram (better grouping, maybe as SVG) Make the organigram printable Make the organigram versioned/approved (e.g. for ISO)
low		Profile Define a default image for new profiles. However, don't create a new media file whenever a new profile is created but instead define one global image which than is loaded for all profiles which don't have a custom image. This makes it easy to replace the default image for all existing profiles and saves a lot of space.
low		Quality Assurance
low		QA Implement voting Implement accepting answers Implement question create view Add question answer component/like comment in question Make votes contain for who the vote is, this way the vote score sum for accounts is MUCH easier and faster Create different QA Apps (check out WikiApp) Make Questions QA App specific (check out WikiDoc) Create QA app with login
low		Supplier Create a view where you can see all bills of the supplier Create a view where you can see all items of the supplier [Notes] Add note types (e.g. phone, email, meeting, ...) [Doc] Create default letter Doc (with/without letter head) [Payable] Print payable [Analysis] Purchase EUR + gross profit [Analysis] Quantity order, quantity articles [Analysis] Segment purchase [Analysis] Top articles [Analysis] Cross selling Allow to specify the accounting account (e.g. a customer who is a supplier may have the same account)
low		Tasks [Analyzer] Implement analyzing functionality (tasks created, answered, time required to finish task, always in time?) Instead of hiding (or as an additional type) tasks created from other modules (e.g. support) make them link to the UI where it can be handled (e.g. ticket) Make answer box on the right scroll down with the content, this way you can immediately respond without scrolling. Attach custom event, if status is changed (e.g. trigger checklist event). Maybe don't do it, maybe other modules should instead check the status of the task!!! Implement email notification on progress/changes (new task, forwarded, ...) The unread task count is currently not really correct and needs to be fixed Allow batch handling of tasks in the dashboard/overview for faster interaction (e.g. select and close) Create a user calender for tasks which only shows when tasks are due Don't show Tasks in dashboard which are far into the future, maybe create another list for this? Implement has seen and unseen (use system where every task has a seen flag for a user if it is seen)
low		Calendar Load events back to a fixed amount of months (e.g. current month, previous month and next month) Implement event popup in the UI on click Create different interval templates (year, quarter, month, week, day) Allow user to define the start of the week (e.g. Sunday, Monday) Implement gantt chart Create iCal parser/reader and builder Create database, models and mappers
low		CMS Make file content view 100% container height Allow content changes and saving Ideas for applications based on modules (e.g. monitor/log dashboard, sales dashboard, calendar, support/ticket, clocking, Q&A, Wiki, shop) Implement line numbers in code view Implement code formatting / syntax highlighting Allow different content types (e.g. pages, posts, ...) with individual templates
low		Workflow Implement an approval module which only runs a module/user specific action once it is approved. This functionality might be part of the workflow module or at least smoothly interact with this module. Additionally, it should probably make use of the Tasks module. New customer is created (approve) New bill is created (approve, validate) New supplier is created (approve)
low		ReadOnly Find a way to implement a read only setting. This could be helpful for maintenance times.
low		UriFactory Consider to use \urlencode() on every query parameter in the UriFactory.
low		ModuleMapper Implement module description, name, createdAt in the database table and use them. Currently they are available in the model but not yet implemented in the database schema.
low		Templates In some forms there are 2 buttons which a user shouldn't accidentally press (a save and create button or delete button). Position them far apart by using flexbox positioning (e.g. Module->Support->Settings).
low		ModuleMapper Create a ::limit() function which is similar in concept to the existing function ::sortBy(). As a result the limit can be removed from most other functions.
low		ModuleInstaller In most module Installer.php scripts the installExternal() re-implements Api functionality. Instead of creating new functions maybe the installer scripts should mock the API requests? (e.g. CMS is using the API while Media is re-implementing many functions)
low		CMS Make pages editable Make posts editable
low		UI Slider Create a slider element with two elements which the user can slide (optionally also only one slider should be possible)
low		Demo setup - Billing Improve customer order randomization (types, dates) in the demo setup file setupBillingClients.php. Create text lines in bills, currently no text lines are created only entries with items, but sometimes you want to write some text in an invoice
low		Billing Costs such as shipping, insurance etc. should not be hard coded but customizable costs stored in a separate table.
low		Demo setup - Support Use default values for ticket attribute types in some cases instead of always using custom values
low		Update Create update logic for application, resources, modules, ... in the Admin/ApiController (apiCheckForUpdates)
low		Billing Create setting for bill format per bill type (e.g. invoice, order, ...).
low		Biling The bill archive should store the customer/supplier localized version since this is the official document.
low		Billing Customers and suppliers should have default invoice and delivery addresses which should be used if no other address or custom input is used.
low		Editor The tools above should directly insert the markdown into the textarea.
low		Kanban The kanban board currently assumes up to 4 columns, however there should be a layout which allows more than 4 columns. Don't use flexbox but min-width and max-width combined with a horizontal scrollable board content.
low		Media Find a way to allow file edits if the file is not in the database but just in the file directory. At the same time this should not be possible for database files.
low		DataMapperAbstract The SQL query building seems to bee too complicated in some cases including unnecessary joins (e.g. see TagMapper::get())
low		DataMapperAbstract Implement data binding
low		DataMappers Use Mapper::TABLE or string names in the mappers. At the moment both can be found. This is not concise. The Mapper::TABLE name is preferred in case of name changes.
low		Email Find a way to localize some hard coded email content. Pass localization array? Manually overwrite email body if a hard coded/default message should be returned (maybe by checking for a flag/status code)?
low		SettingMapper & CoreSettings Consider to merge? Maybe only use the mapper, maybe let the CoreSettings use the Setting and SettingMapper

Archived

Priority	Done	Task
medium	2021.09.04	Editor Add document type (e.g. phone, meeting, email). Maybe use tags? Or are tags something else?! Not implemented: Such notes should be stored in their own table in the respective module!
medium	2021.09.13	DataMapper The hasMany order should be customizable (ASC/DESC and also the row used for the order e.g. createdAt, ...). Solution: Implemented ::sortBy()
high	2021.09.07	Permissions The admin group permissions cannot be changed No user can remove himself from the admin group
high	2021.09.07	DataMapper Create deleteRelation function as opposite to createRelation. Create ModuleAbstract function deleteModelRelation as opposite to createModelRelation
high	2021.09.09	Table If column is numeric sort numerically, not by character (1,2,3 vs, 1, 10, 11, 2) The table sort is WAY too slow!!! (e.g. editor-list by title).One problem might be a bad algorithm (e.g. get content, and use sort() of js instead, check new order and re-sort the table rows based on the ordered array). Another problem could be that the browser is doing some stupid stuff because of UI calls? If column is datetime sort by datetime, not by character (careful, datetime formats can be different)
medium	2021.09.13	DataMapper Implement hasMany default parameters in mappers (e.g. sortBy, sortOrder). Remove the orderBy functionality from the ::with() function since this is now replaced with the ::sortBy() function
low	2021.09.18	Application Applications should be able to define module dependencies which are installed/checked during the installation process.
low	2021.09.20	Application The application install should be defined in a similar class as the module installation (see StatusAbstract.php which is implemented by Install.php scripts in modules). This means Applications should have their own Install.php script! At the moment the CMS module, Admin Module and ApplicationManager are doing this.
low	2021.09.27	Media Allow to stream large media files also for downloads.

Features

Features to be implemented at a later stage nice to haves.

Tasks & decisions

Priority	Done	Task
medium		Editor Create immediate text preview similar to a rich text editor or Typora.
low		Editor Create special markdown content (calendar, chart, task, news, comment, media, ...) Allow download as markdown, text, PDF, word Implement versioning.
low		Event Management Implement goal definition. Goals could be based on tasks (every completed task represents x%), linear time line (every day represents x%), value based (a calculated value represents x%), manual input based (the user decides the completion %) Add milestones
low		Project Management Implement goal definition. Goals could be based on tasks (every completed task represents x%), linear time line (every day represents x%), value based (a calculated value represents x%), manual input based (the user decides the completion %) Add milestones
low		Promotion Implement goal definition. Goals could be based on tasks (every completed task represents x%), linear time line (every day represents x%), value based (a calculated value represents x%), manual input based (the user decides the completion %)
low		Finance Implement accounting forensics (Benfords Law, cent value distribution analysis, amount of bookings between specific amounts, amount * bookings between specific amounts, etc.)
low		Item Management Item view should be customizable since different groups have different interests and read permissions (e.g. sales reps, finance, etc.) Show different prices on item profile frontpage (e.g. domestic, export, quantity discount)
low		Purchase Consider to add a purchased analysis, used analysis and manufactured analysis (currently only sales focused). Examples items delivered in time, bad quality ratio)
low		Kanban Allow board templates? maybe at least colors? Allow card templates? maybe at least colors?
low		Billing Automatically create recurring bills (invoices, delivery notes, etc.) if a customer wants to receive items automatically
low		Media Create preview option for images (e.g. ctrl+mouse hover or a different "list-view" like in explorer) Validate file size on the frontend before uploading Automatically change the file encoding of text files Enable image interlacing (in the past there was a bug) Implement media encryption/decryption (optionally) Implement media password protection for read (optionally) Implement resumable uploads Implement path changes in the frontend Allow the modification of collections Implement external resources (URLs, dropbox, aws, ...) Allow to edit the breadcrumbs, which replaces them with a text field which can be changed then than automatically loads the new path Implement temporary file storage (very useful for making files downloadable for a limited time). Maybe create a new temp file directory or database collection where a available_until timedate gets defined (must be handled in the database). The biggest problem is how to delete them, this requires a background process/task scheduler. Additionally, these files must have permissions because they may be only for one user or a group of users.
low		Messages Allow to transform a message as task Implement push notification Users may be invited to old conversations
low		Navigation Improve goto command to match based on proximity and only based on visible links Consider to create on navigation language file (same as routing files) during the installation process Create settings page which allows to modify the navigation in the module settings Consider to implement tabs in the side bar Consider to implement child elements on hover (sidebar and content)
low		News Implement email/message notification on create
low		Profile Find a way to hide some contact/address information for some modules. Some information are only meant for specific modules (e.g. private address, phone number e.g. HR module) The reason why this is difficult is that this information should not be part of the model table but in the relation (many-to-many). At the moment the information in the relation table is not used apart from the relations it self. A solution could be to specify a filter in the relation in the mapper. Empty = all relations, filter = only populate the model array with relations which match the filter.
low		Support Allow support/tickets to be transformed to Q&A question and answers Allow Q&A to be transformed to support Create support app with login TicketAttributeTypes should specify which datatype they expect. The ApiController needs to validate if a value can be created for an attribute type (check validation pattern, datatype, is required)
low		Tag Create settings with a set of default colors Create a hook which gets triggered if a group is created. This hook also creates a tag
low		Settings Implement a setting which lets users see all content no matter the content language (e.g. all News)
low		Templates, Controllers, Views and Models Allow custom templates, controllers, views and models, which don't get replaced during updates (e.g. for ItemManagement, CustomerManagement, HR, ...). These should be stored in a directory called Customized in the parent directories Controller, Themes, Views and Models. Whenever a custom controller is uploaded/changed the routes of all the applications need to be checked and adjusted.

Archived

Priority	Done	Task

Bugs

Tasks & decisions

Priority	Done	Task
high		DataMapper In some cases the array is required in the ::withConditional() function. This seems to be the case if a model doesn't have the condition but a sub-model has it. The mapper should simply not use the conditional if it doesn't exist in the mapper (see ItemManagement::BackendController or ClientManagement::BackendController with the BillMapper, this is a stupid fix)
medium		Human Resource Management Fix employee list (see comment at the bottom, query builder bug)
low		FileLogger The logger is somehow sometimes logging in the main directory of OMS. Why? Debug it!
low		KMeans In some weird cases the Cluster test fails. This happens approximately 5 / 100 test runs (invalid center coordinate value)
low		Dashboard Why does admin not have a dashobard? Everyone should have it!
low		Table The table overflow was fixed with putting them in a scrollable container (in the portlet). This broke the .sticky head, since the table no longer knows the head is out of view. Since it's in an overflow container it doesn't know about its changed scroll position. If this cannot be solved don't revert back because overflowing tables are much worse!
low		Rest There is a weird bug where the multipart/form-data cannot use the normal boundary= header to define the boundary. If this correct format is used the server somehow cannot populate the php://input correctly. If we move the = to a different position e.g. bound=ary this works fine. Currently this is solved by not using a = sign but /. This requires further inspections later on and could result in a bug with a different webserver (e.g. nginx).

Archived

Priority	Done	Task
high	2021.09.04	Table Tables overflow on smaller screen resolutions. A fix is necessary!!! Solution: make main overflow-x: auto
low	2021.09.12	Module installation log Not all modules can create a installation log in the auditor since the auditor is only installed afterwards but it seems too many modules don't create a install log. This could be because even if the auditor is installed, the active routes are only changed on the file system but not in memory of the current request (install request). As a result NO audit logs are created during the install process. One solution could be to reload the routes manually in the install script after every module installation.

Details

Joins on same tables

Problem if joins on same tables (e.g. staff-list)

The tabbed join is the problem, the second query is the solution. The problem is that you need a different alias which is hard to created since th alias usually is suffixed with the depths which is a problem in this case since the alias has nothing to do with the depth.

A solution could be to index the joins by depths+join count e.g. account_2_1, account_2_2

SELECT `account_2`.`account_name1` as account_name1_2, `account_2`.`account_name2` as account_name2_2, `account_2`.`account_name3` as account_name3_2
FROM `hr_staff` as hr_staff_4
LEFT JOIN `media` as media_3 ON `hr_staff_4`.`hr_staff_image` = `media_3`.`media_id`
LEFT JOIN `profile_account` as profile_account_3 ON `hr_staff_4`.`hr_staff_profile` = `profile_account_3`.`profile_account_id`
        LEFT JOIN `account` as account_2 ON `media_3`.`media_created_by` = `account_2`.`account_id`
        AND `profile_account_3`.`profile_account_account` = `account_2`.`account_id`
LEFT JOIN `l11n` as l11n_1 ON `account_2`.`account_localization` = `l11n_1`.`l11n_id`
LEFT JOIN `media` as media_2 ON `profile_account_3`.`profile_account_image` = `media_2`.`media_id`
LEFT JOIN `account` as account_1 ON `media_2`.`media_created_by` = `account_1`.`account_id`;

SELECT `account_2`.`account_name1` as account_name1_2, `account_2`.`account_name2` as account_name2_2, `account_2`.`account_name3` as account_name3_2
FROM `hr_staff` as hr_staff_4
LEFT JOIN `media` as media_3 ON `hr_staff_4`.`hr_staff_image` = `media_3`.`media_id`
LEFT JOIN `profile_account` as profile_account_3 ON `hr_staff_4`.`hr_staff_profile` = `profile_account_3`.`profile_account_id`
    LEFT JOIN `account` as account_3 ON `media_3`.`media_created_by` = `account_3`.`account_id`
    LEFT JOIN `account` as account_2 ON `profile_account_3`.`profile_account_account` = `account_2`.`account_id`
LEFT JOIN `l11n` as l11n_1 ON `account_2`.`account_localization` = `l11n_1`.`l11n_id`
LEFT JOIN `media` as media_2 ON `profile_account_3`.`profile_account_image` = `media_2`.`media_id`
LEFT JOIN `account` as account_1 ON `media_2`.`media_created_by` = `account_1`.`account_id`;

The problem is that every object needs to have a unique id so we could do this like _d3_o5 as alias. The problem with that however is that this would work for the getQuery() function but in the populateAbstract we don't know the object id. But maybe we can solve it by also passing the object ID here? This seems like a full weekend test!!! Better focus on other things first.

Drafts, concepts & ideas

Drafts, concepts & ideas which are more complex or require more explanation.

Invoice OCR

Steps:

1. Turn into image if it isn't image
2. Modify image (grayscale, remove noice, thresholding, dilate, erode, opening/morphology, canny, skew correction/deskew, rotate e.g. upside down or slanted)
3. Extract text (maintain layout)
4. Get all suppliers and match against invoice (find name, alternatively try invoice match_code)
5. Has supplier template defined? Find custom areas. Sometimes a page 2 template must be defined if the second page looks different.
6. Match template areas to invoice (consider slanted invoice, longer text etc.), extract partial images.
   1. Template areas should ideally contain a keyword and the actual value.
7. Parse partial images
8. Match according to regex
9. Find item list area from template (recurring elements unless only one element is defined)
   1. Start should be defined by keywords (e.g. table headline)
   2. Create sub definitions such as quantity/unit, single price, total price, ...
   3. How to identify end of list?
   4. How to handle multiline line elements (e.g. detailed article/service description)
   5. How to automatically find account (e.g. article number, description, template definition)?

Software:

1. Tessaract + OpenCV + above mentioned steps
2. Some Api (e.g. gogle vision ai, amazon textract, amazon rekognition)

Database permission handling

Option 1

select ...
from ...
where ...
  (
    account_permission_account = ACCOUNT
    AND (account_permission_unit IS NULL OR account_permission_unit = 'UNIT')
    AND (account_permission_app IS NULL OR account_permission_app = 'APP')
    AND (account_permission_module IS NULL OR account_permission_module = 'MODULE')
    AND (account_permission_type IS NULL OR account_permission_type = 'TYPE')
    AND (account_permission_element IS NULL OR account_permission_element = 'THIS_ID')
    AND (account_permission_component IS NULL OR account_permission_component = 'COMPONENT')
    AND account_permission_permission = ???
  )
  OR
  (
    group_permission_group IN (...)
    AND (group_permission_unit IS NULL OR group_permission_unit = 'UNIT')
    AND (group_permission_app IS NULL OR group_permission_app = 'APP')
    AND (group_permission_module IS NULL OR group_permission_module = 'MODULE')
    AND (group_permission_type IS NULL OR group_permission_type = 'TYPE')
    AND (group_permission_element IS NULL OR group_permission_element = 'THIS_ID')
    AND (group_permission_component IS NULL OR group_permission_component = 'COMPONENT')
    AND group_permission_permission = ???
  )

Option 2

1. Check if general permission exists -> just do query
2. Check for specific element exists -> just do query but with column_id IN (... elements ...)

::with(PermissionAbstractMapper::class, $permissions)
// this will create a where condition generated by the PermissionAbstractMapper::class e.g. call PermissionAbstractMapper::createWith($query)

New DataMapper structure

TestMapper::getAll()
    ->with('profiles', limit: 10, sortBy: 'id', sortOrder: SortOrder::ASC)
    ->with('profils/account')
    ->limit(TestMapper::class, 5)
    ->sortBy('id', SortOrder::ASC)
    ->execute();

TestMapper::getAll()
	->depth(3)
	->execute();

abstract class DataMapperAbstract
{
	protected object $mapper;

	protected static array $cache = [];

	protected int $type = 0;

	protected int $depth = 0;

	public static function clear()
	{
		self::$cache = [];
	}

	public function __construct(object $mapper)
	{
		$this->mapper = $mapper;
	}

	abstract function execute();
}

class ReadMapper extends DataMapperAbstract
{
	private $members = [];

	public function with(string $variable, int $limit = 0, $sortBy = '', $sortOrder = SortOrder::DESC) : self
	{
		// $split = \explode('/', $variable);
		// maybe> $members[$split[0]] = [\implode('/', $split[1..n], $limit, $sortBy, $sortOrder];
	}

	public function get()
	{
		$this->type = MapperType::GET;
	}

	public function execute()
	{
		switch($this->type) {
			case MapperType::GET:
				return $this->executeGet();
				break;
		}
	}
}

abstract class DataMapperFactory
{
	public const COLUMNS = [];

	public static function get()
	{
		return (new ReadMapper(static))->get();
	}

	public static function getAll()
	{
		return (new ReadMapper(static))->getAll();
	}

	public static function update()
	{
		return (new UpdateMapper(static))->update();
	}

	public static function delete()
	{
		return (new DeleteMapper(static))->delete();
	}
}

class TestMapper extends DataMapperFactory
{
	public const COLUMNS = [];
}

Most recent changelog

September 2021

New

Admin

• Module settings can have a custom settings page by defining it in the module routing file. The template file should be stored in \Modules\{Module}\Admin\Settings.
• Settings now can have a regex pattern for validation. If it is not empty, setting changes must meet the pattern.
• Settings can now be installed by providing a Admin.install.json to the Admin module.

Media

• The media_type is now a table for custom media types.
• The media_type has a installExternal binding similar to uploading media files during module installation or collection creation.
• Media files are now streamed to the user.

phpOMS Framework

• Created deleteRelation function as opposite to createRelation
• Created deleteModelRelation as opposite to createModelRelation
• hasMany definitions in mappers can now have an additional component ['sort' => ['orderBy' => 'memberName', 'sortOrder' => 'DESC/ASC']] which allows default ordering behavior for hasMany relations. This is useful if a model expects a specific order most of the time.
• Mappers can have a custom ordering which also overwrites the default mapper ordering behavior introduced in this update. The ordering can be called with ::sortBy($memberName, 'ASC/DESC', ...)

UI

• The table UI sort recognizes ISO 8601 format and sorts them accordingly. Since the template doesn't always output ISO 8601 formatted times, it is recommended to use the data-content attribute to store the ISO 8601 formatted time. This allows localized visualization but correct sorting behavior.

Applications & CMS

• Applications are now installed through the CMS module.
• Applications can have dependencies.
• Applications can provide for other modules.
• Applications can install routes.
• Applications can install navigation elements.
• Applications can install pages.
• Applications can have their own controllers
• Applications have their own install scripts

Bug fixes

UI

• Tables are now overflowing with scroll bars below if the horizontal screen size is smaller than the table.
• Table UI sort performance got improved. The previous sort didn't terminate properly resulting in a infinite loop.
• The table UI sort recognizes pure numeric values and sorts them accordingly instead of alphabetical.

Auditor

• Audit logs are created during module status changes incl. module installation.
• Audit logs are now also created during the installation process.

Other

Admin

• The admin group permissions can no longer get modified, which ensures there is always a admin group with sufficient permissions.
• A user can no longer remove himself from the admin group in order to prevent mistakes.

UI

• The install script has improved highlighting for mandatory input fields.