outfielddigital/konstrukt-documentation

Documentation for Konstrukt, the back office UI builder for Umbraco v9+

description
Documentation for Konstrukt, the back office UI builder for Umbraco.

Konstrukt Documentation

Konstrukt is the Umbraco v10+ back office UI builder for custom data structures configured via a fluent API.

If you have a custom data store that you’d like to be able to content manage from within Umbraco then Konstrukt will allow you to quickly configure a custom administration UI, reusing many core components and with a consistent look and feel, in just a few lines of code.

With Konstrukt, custom back office integrations can now take a matter of minutes, rather than days.

Using These Docs

These docs are aimed at developers who have at least a basic understanding of Umbraco, as well as C# / MVC principals.

If you are new to Konstrukt, you may want to start by taking a look at the Getting Started section for details on how to install Konstrukt and any system requirements.

If you have Konstrukt installed and are wondering "what next?" then you'll want to take a look at the Guides section for some quick-start examples of how to configure Konstrukt.

To dive deeper into Konstrukt and get to know all of it's features in detail, use the main menu to jump to the specific topic you are interested in to find out more.

Finally, for all other resources / useful information you can head over to the Extras section.

Getting Help

If you require further assistance, or if you are having a particular issue you can't find an answer to, you can get community support via our support forum over on the Umbraco developer portal.

konstrukt-documentation's Issues

Support forum link is out of date

Hi Matt,

Looking at using another one of your awesome Umbraco projects.

Was looking here: https://github.com/outfielddigital/konstrukt

And noticed that the link for the support forum goes to here: https://our.umbraco.com/packages/website-utilities/konstrukt/konstrukt-support/

Rather than here: https://our.umbraco.com/packages/backoffice-extensions/konstrukt/konstrukt-support/

Just thought I'd let you know.

Cheers!

Tom

the 'delete' menu action results in a 'section cannot be null' console error

hi matt,

we've been trying to set up a new menu item and along the way we've noticed that the 'delete' action is throwing a console error.

clicking the delete button logs section cannot be null and the entity isn't deleted:

we get the same issue with the menu item we're attempting to set up:

deleting at the list view level works:

however the following is logged in the console:

XML Parsing Error: no element found
Location: https://localhost:44369/umbraco/backoffice/konstrukt/konstruktapi/DeleteEntity?collectionAlias=person&id=1
Line Number 1, Column 1:

this is happening with v1.0.1 and the v1.0.2-beta0004 versions that we've been using.

we're using konstrukt in umbraco v9.3.1, could this be a backoffice update issue? if you could let us know on the above, that'd be grand 👍

is the '[PrimaryKeyColumn]' attribute needed in pocos?

hey there matt,

we wanted to check if the [PrimaryKeyColumn] is needed required in pocos?

from the docos, the 'id' column has the attribute:

https://docs.getkonstrukt.net/guides/creating-your-first-integration#set-up-your-model

using NPoco;
using Umbraco.Cms.Infrastructure.Persistence.DatabaseAnnotations;

[TableName("Person")]
[PrimaryKey("Id")]
public class Person
{
    [PrimaryKeyColumn]
    public int Id { get; set; }
    public string Name { get; set; }
    public string JobTitle { get; set; }
    public string Email { get; set; }
    public string Telephone { get; set; }
    public int Age { get; set; }
    public string Avatar { get; set; }
}

the attribute comes from the umbraco core Umbraco.Cms.Infrastructure.Persistence.DatabaseAnnotations.

the reason we ask is that we'll be using these pocos in other areas of our project that doesn't use umbraco...

we've experimented with removing the attribute and it doesn't appear to cause any issues with crud opperations...

if you could let us know if it's needed, that'd be great 👍