Home

Welcome to the Serenity wiki!

This wiki is a community-driven project to assist in the shared knowledge of the Serenity Platform. Here you can find just about any information you would like to, from friendly how-tos to a list of items that can be found in the platform. Keep in mind that this wiki is still in the early stages of creation so not all information can be found here.

Please note that this wiki is not the official documentation for this project. For official documentation please visit https://serenity.is/docs/.

If you have something you would like to share feel free to create a page and share it with the community!

Getting Started

• FieldFlags Enumeration
• Serenity Attributes
• Editor Types
• Form and Dialog
• Lookups
• How to fix Javascript Intellisense in cshtml
• FAQ
• Tips & Tricks
• Troubleshooting
• Blank Login Page after publishing to Web Server

Issue Reporting Guide

Confused or lost? You can ask help by filing an issue: to get effective results, first check out the following:

• Issue Guidelines
• You can also seek guidance in Slack team: https://serenityplatform.slack.com. Get your self-invite here.
• All of "How do I?" and "I got this error, why?" questions can be posted on stackoverflow with "serenity-platform" tag. https://stackoverflow.com/tags/serenity-platform

Contribution Guide

When creating a tutorial or how-to, kindly include as many of the following info as possible:

• Compatible Serenity/Serene Version/s
• Modules/Filenames Concerned
• Instructions/Step-by-step
• Warnings/Important Notes
• Examples (Code snippets)
• Sources/Referenced Issues/Credits

Note on Wiki page titles

Per Github's documentation, please don't use the following characters in wiki pages titles: \ / : * ? " < > |. It can cause file name issues when editing the wiki locally.

How to's - (contributions and tutorials)

• [Security] Preventing CSRF attacks (Implementing AntiForgery)
• One application with different database per customer
• Excel
  • Adding Excel Export
  • Add Excel Import column mapping & import field type handling
• Audit Log for Insert, Update and Delete using Single Table
  • How to add details to the Auditing Example found in this WIKI
• Group notifications with SignalR (by marcobisio)
• A simple notification with SignalR in Serene/StartSharp (.NET Core version) by @wezmag
• LinkingSetRelation Explanation by jsbUSMC
• Loading default data in a PropertyPanel with form
• Optimistic locking support for MS SQL Server by hannesb
• Header and Footer in wkhtmltopdf reports
• SlickGrid
  • SlickGrid Column Picker (by marcobisio)
  • SlickGrid AutoColumn resize
  • SlickGrid Formatters
• UI
  • Customizing the Login Screen
  • User image at login (by edson)
  • Split button dropdowns in toolbar grid
  • Bootstrap Switch plugin (by marcobisio)
  • Bootstrap Material Switch Editor
  • Create Lookup Editor for code description tables
  • Add dynamic navigation items (by Thanh Nguyen)
  • Create Bootstrap Color Picker editor
  • HtmlCodeEditor using CodeMirror by @wezmag
  • SignatureEditor using SignaturePad by @wezmag
  • SignaturePad 100% TypeScript
  • Server Side Cache Invalidate
  • Update XYZEditor field with value from database based on select2 dropdown value change
  • HowTo Dialog: add "copy link" and "open in a new tab" buttons(by marcobisio)
  • How To: Remove EditLinks from editor on a condition. (by Stixoffire)