Documentation

Documentation

  • Documentation
  • Externable.com

›Portal extension

Introduction

  • Introduction to Externable

Setup

  • Registration
  • Creating Subscription
  • Renaming subscription
  • Setup URL
  • Connecting Dynamics
  • Setting up email
  • Provisioning instance
  • Starting and stopping instance
  • Connecting Custom Domain
  • Upgrading
  • Taking Backups
  • Restoring Backups
  • Resetting Instance
  • Changing Billing Address
  • Changing Subscription Plan

Portal Backoffice Basics

  • Login To Backoffice
  • Navigation In Backoffice
  • Adding & Managing Users

Creating Content

  • Creating, Saving and Publishing Content
  • Scheduling Posts
  • Content Versioning
  • Creating Content Templates
  • Restricting Access To Content
  • Creating Media
  • Sensitive Data
  • RichText Editor
  • Content Tree

Dynamics Integration

  • Default Template
  • Presenting Dynamics Data

    • Creating Dynamics Integrated Content
    • Extracting Dynamics Query

    Dynamics Forms

    • How Forms Work
    • Working with Formulas
    • Example - Create a Form

Languages

  • Enabling Languages
  • Creating Translations

Members

  • Creating Members In The Frontend
  • Creating Members in the Backend
  • Linking Members To Dynamics Contacts

Portal extension

  • Document Types
  • Data Types
  • Property Editors
  • Grid Editors
  • Macros
  • Relation Types
  • LogViewer
  • Templates

    • Templates
    • Razor Syntax
    • Rendering Content
    • Rendering Media
    • Rendering CSS & JS
    • Partial Views
    • Partial Macro Views
  • CSS customizations
  • JavaScript
  • Plugins Development

    • Plugins Development
    • MVC Controllers
    • WebAPI Controllers

Notes

  • Open Source Used

Document Types

Externable comes with predefined portal template. This means that all components required to start the portal are ready and in place. All content structure has been configured to use Externable libraries to connect to your configured Dynamics instance and use the standard user interface.

This article is optional only if you want to build custom or extend existing static content structures, but is not required knowledge to use Exetrnable

What is a Document Type?

In its most basic form a Document Type is a form containing fieldsets (or groups) where you can apply rules about where the content can be created, which template(s) are allowed, backoffice icon and so forth. Document Type is a structure of a content, which you can render to end user with Templates.

Properties

Each field on a Document Type is called a property. A property is given a name, an alias (used to output the properties content in a template) and an editor. The editor determines what type of data the property will store and the input method. There are a wide range of editors available out of the box (textstring, Rich text, media picker and so forth) and you can customize and add additional editors.

Some editors require configuration, a configured editor is saved as a Data Type and can be re-used for multiple properties and document types. These can be seen in the Settings section under Data Types.

Creating a Document Type

A Document Type is created in the settings section using the Document Type editor.

Go to the Settings section in the backoffice. On the Document Types node click the menu icon (•••) to bring up the context menu. Here choose Document Type. This will create a new Document Type with a template (can be found under Templates in the Settings sections) that will be assigned as the default template for the document type.

You can also choose to create a Document Type without a template and create folders to organize your Document Types.

You can also use compositions to create a new document type. Compositions allows you to inherit properties from other groups. When using a mixed setup, you can take advantage of nesting and use compositions by visiting the Structure group. A checklist like this should appear:

The grayed out Document Type Composition Master is a parent to the particular Document Type we are looking at. By default, this means that this Document Type will inherit the properties from the Master Document Type and unless we move it to another location, this is how it will stay. The other document type that is checked is the Banner type. This means that the Document will also inherit the properties from the Banner Type into this Document Type.

Defining the node

First we're prompted to give the Document Type a name.

Notice that the alias of the Document Type is automatically generated based on the name. If you want to change the alias click the "lock" icon.

To set an icon for the Document Type click the document icon in the top left corner. This will open the icon select dialog. Search for Home and select the icon. This icon will be used in the content tree, choosing appropriate icons for your content nodes is a good way to give editors a better overview of the content tree.

Go to the Permissions tab and tick or untick the Allow as root toggle and save the Document Type by clicking save in the bottom right corner. It is recommended to use native Externable root node.

IMPORTANT: Technically you can use alternative root nodes to default Externable one, however that means that you will not use Externable and DYnamics/Dataverse integration (unless you adopt all Externable JavaScripts and keep template structure)

Creating the content node

Now go to the Content section, click on the menu icon next to Content and Select your Document Type. Click the Save and Publish button.

As we haven't created our own properties all we can see on the content node is the Properties tab which contains the default properties that are available on all content in Externable.

Let's add some properties of our own.

Groups and properties

Go to the Settings section, expand Document Types by clicking the arrow to the left and select the Home Document Type.

Adding groups

Before we start adding properties to the Document Type we need to create a group to hold the property.

Click Add group and name the group "Content".

If you have multiple groups and/or properties you can order them with drag and drop or by entering a numeric sort order value. This is done by clicking Reorder.

Adding properties

Now that we have created a group we can start adding properties. Let's add a Rich Text editor to the Content group.

Click the Add property link in the Content group. This opens the property settings dialog. Here you can set the meta data for each property (name, alias, description), choose which data type/property editor to use and add validation if needed.

Give the property a name, the name will be shown to the editor so make relevant and understandable. Notice the alias is automatically generated based on the name. We'll name this "Body Text".

Keyboard Shortcuts

Keyboard shortcuts are available when you are working with the Document Type editor. To see which shortcuts are available click ALT + SHIFT + K.

Property editors

Clicking Add editor will open the Select editor dialog. Here you can choose between all the available editors on the Create new tab (this will create a new configuration) or already configured editors in the Use existing tab. To make it easier to find what you need use the search field to filter by typing "Rich". Filtering will display configured properties first (under Use existing) and all available editors under that.

Select the Rich Text editor under Create new.

This will let you configure the editor settings - the Rich Text editor for this property. Notice that the name of the Data Type (Home - Body Text - Rich Text editor) is based on the name of the Document Type, the name of the property and the property editor. Let's rename it to "Basic Rich Text editor" and only select the most necessary options.

  • bold
  • italic
  • alignLeft
  • alignCenter
  • link
  • umbMediaPicker

When you are happy with the settings click Submit.

Ticking the Mandatory toggle makes the property mandatory and the content cannot be saved if no value is entered (into the Richtext editor in this case). You have the option to add additional validation by selecting a predefined validation method under the Custom validation dropdown (such as email, number or URL) or by selecting custom validation and adding a regular expression.

Submit the property and save the Document Type. If you go to the Content section and click on the Home node you will now see the Content group with the Body Text property.

Defining child nodes

Next up we'll create a text page Document Type that will be used for subpages on the site.

Go back to the Settings section and create a new Document Type and name it "Text Page". Add a group called "Content" and this time we'll add two properties. First make a property called summary using the Textarea editor and secondly create a property called "Body Text" and reuse the Basic Rich Text Editor Data Type.

Creating child nodes

Before we can create a Text Page in the Content section, we need to allow the Text Page Document Type to be created as a child node to the Home node. Select the Home Document Type and go to the Permissions group. Click Add child and select Text Page.

Go to the Content section and click the menu icon (•••) next to the Home node and select the Text page Document Type. We'll name the page "About us". We now have a very basic content structure.

Document Types are very flexible and can be used in a myriad of ways from defining a piece of reusable content or an entire page, to acting as a container or repository.

Member Types

Member Types is a simmilar concept to Document Types - it allows you to add custom properties to website end user (Member). Member Types don't have an idea of content node or template, custom properties need to be implemented in signup partial view.

← Linking Members To Dynamics ContactsData Types →
  • What is a Document Type?
    • Properties
  • Creating a Document Type
    • Defining the node
    • Creating the content node
    • Groups and properties
    • Defining child nodes
    • Creating child nodes
  • Member Types
Copyright © 2021