Documentation
Documentation

Defining content types

When you create a new content type, you define the coding method used to create the content item, as well as register the code with iMIS and add the content item to the Content Gallery. Once the new content item is added to the Content Gallery, it is available to be used again on a content record.

In the Staff site, go to RiSE > Maintenance > Content types. Do one of the following:

  • Create a new content type: Select New > Content Type. When you select to create a new content type, you can choose one of two content item formats: Client-based content items, or ASCX-based content items.
📘

Note

Due to browser incompatibility, Client-based content items will not work with the Advanced Accounting Console.

  • Edit an existing content type: Select an existing content type, then from the toolbar click Edit.
Client-based content types

Client-based content items are uploaded as .zip files through the document system in RiSE. Once the .zip file is extracted, you can then tell the Content Type utility where to find the uploaded content item html files (URL to the html file that is used to display items of this type at runtime and URL to the html file that is used to configure content items of this type fields).

There are limitations to the types of files you can use to build your client-based content items. The Content Item Allowed File Extensions field (Settings > RiSE > Quick setup) specifies the file extensions that can be uploaded through .zip files to the ContentItems folder in the Document system.

📘 Note

You can override the allowed file extension by adding it to the Content Item Forbidden File Extensions field.

Some file extensions will always be forbidden because they are in the default forbidden list, so even if they get added to the Content Item Allowed File Extensions field, they will not be allowed. For more information, see Quick setup.

ASCX-based content types

The class libraries and user controls that you specify must be manually copied to a file path that resolves to the same root-relative URL on all servers that host iMIS RiSE websites.

  • The class libraries must be placed in the bin folder below the root of the physical path for the IIS application or IIS website that hosts your iMIS RiSE websites.

    • 📘 Note

    The class libraries should also be added to the C:\AsiPlatform\Asi.Scheduler_[your instance]\bin folder. If you are not self-hosted, you must contact your host for assistance.
  • The user controls can be placed in any folder below the root of the physical path. When specifying paths to controls, be sure to use forward slashes (/) for the segment delimiters.

For more information about working with both client-based and ASCX-based content items, see the iMIS SDK Developer Guide.

Content Type Properties
  • Name of the Content Type - Specifies the name of the associated content item.
  • Description of the Content Type - Specifies the description of the associated content item.

    📘 Note

    If you are publishing this content item in the Content Gallery, be sure this text is as you want it to appear to users in the Gallery when they select content items for use in content records, and do not duplicate any content item names already appearing in the Gallery.
  • (Client-based only) URL to the html file that is used to display items of this type at runtime - The initial html page for your content item.
  • (Client-based only) URL to the html file that is used to configure a content items of this type - Add some content here.
Advanced Properties (optional)
Advanced Properties for ASCX-based content types only
  • (ASCX-based only) URL to the control or page that is used to display items of this type at runtime - Specifies a relative URL (from the root (~) of the physical path for the IIS application or IIS website that hosts your iMIS RiSE websites) to the web user control that should be used to display instances of the content item associated with this content type. By default, the root corresponds to C:\Program Files (x86)\ASI\iMIS\Net. For example, ~/CustomControls/myUserControl.aspx.

    • If you have not created a custom IContentType class (you entered Asi.Business.ContentManagement.ContentType.ContentTypeBase in the Name of the IContentType class within the assembly field), a declaration to this control is embedded in published pages that use the content item, and the control will be dynamically loaded and inserted into the page when rendering the control (for preview or for search). If you've implemented a custom IContentType class, you can change this behavior to match your own requirements.

  • (ASCX-based only) Name of the .NET assembly that contains the class that implements this content type - Specifies the name of the class library that contains the compiled serializable class.
  • (ASCX-based only) Name of the serializable class within the assembly that implements this content type. Fully qualified name with namespace - Specifies the name of the class that implements the content item in Page Builder (which must inherit the base class Asi.Business.ContentManagement.ContentItem). You must enter the fully qualified class name, including the namespace.
  • (ASCX-based only) Name of the .NET assembly that contains the IContentType class used to publish this content type - Specifies the name of the class library that contains the compiled IContentType class:
    • If you are using the base IContentType class provided with iMIS RiSE for this content type, enter Asi.Business.ContentManagement.
    • If you are using a custom-developed IContentType class, enter the name of the class library that contains the compiled class.
  • (ASCX-based only) Name of the IContentType class within the assembly. Fully qualified name with namespace - Specifies the name of the class that implements the IContentType interface that iMIS RiSE uses to render and publish the content item.
    • To use the default rendering and publishing behavior provided by the base IContentType class provided with iMIS RiSE, enter Asi.Business.ContentManagement.ContentType.ContentTypeBase.
    • To perform custom actions when a content item is published or rendered, you can instead create a custom IContentType class (which must inherit the base class (Asi.Business.ContentManagement.ContentType.ContentTypeBase). You must enter the fully qualified class name, including the namespace.
  • (ASCX-based only) URL to the control or page that is used to collect the properties of a new item of this type - Specifies a relative URL (from the root (~) of the physical path for the IIS application or IIS website that hosts your iMIS RiSE websites) to the web user control that should be used to collect properties when creating new instances of the content item associated with this content type. By default, the root corresponds to C:\Program Files (x86)\ASI\iMIS\Net. For example, ~/CustomControls/myUserControl.aspx.

    • In most cases, you should specify the same control here as for the URL to the control page that is used to edit the properties of an existing item of this type.

    📘 Note

    This control is currently unused in this version of iMIS RiSE. Instead, the control specified in URL to the control page that is used to edit the properties of an existing item of this type is used for collecting the properties for newly created content items and for existing content items that are being edited.

  • (ASCX-based only) URL to the control or page that is used to edit the properties of an existing item of this type. This is often the same as the NewLink - Specifies a relative URL (from the root (~) of the physical path for the IIS application or IIS website that hosts your iMIS RiSE websites) to the web user control that should be used to collect properties when editing the configuration of an existing content item associated with this content type. By default, the root corresponds to C:\Program Files (x86)\ASI\iMIS\Net. For example, ~/CustomControls/myUserControl.aspx.

    • In most cases, you should specify the same control here as for the URL to the control page that is used to collect the properties of a new item of this type.

Advanced Properties for Client-based and ASCX-based content types
  • URL to the control or page that is used to collect parameters for content items of this type - Specifies a relative URL (from the root (~) of the physical path for the IIS application or IIS website that hosts your iMIS RiSE websites) to the web user control that should be used to collect parameter overrides for the content item associated with this content type. By default, the root corresponds to C:\Program Files (x86)\ASI\iMIS\Net. For example, ~/CustomControls/myUserControl.aspx.

    You use this type of control to override the configuration of a content item on a per-navigation-item basis. The parameter overrides can be specified in two different ways in a navigation item, depending on what type of input this control is written to accept:

    • The URL parameters field can pass parameters in an ampersand-delimited string that is appended to the URL, and fetches the associated content record.
    • The Content parameters field can display selected properties from the control that define the configuration page for the associated content item. This is a subset of the properties defined in the control specified in the URL to the control or page that is used to edit the properties of an existing item of this type field.

    Only one of the content types shipped with iMIS RiSE uses this field (ContentTaggedList), and the corresponding control is written to collect parameters from the Content parameters section of a navigation item.

  • URL to the icon graphic that represents items of this type - Specifies a relative URL (from the root (~) of the physical path for the IIS application or IIS website that hosts your iMIS RiSE websites) to an Easy Edit icon image file that is displayed on rendered web pages associated with this content type. By default, the root corresponds to C:\Program Files (x86)\ASI\iMIS\Net. For example, ~/CustomControls/mySurfToEditIcon.gif.

    The image file must be 16x16 pixels in size. If this field is left blank, a default Easy Edit icon is used (~/AsiCommon/icon_con_usercontrol.gif)

  • URL to the configuration help page - Specifies a relative URL (from the root (~) of the physical path for the IIS application or IIS website that hosts your iMIS RiSE websites) to the Configuration Help for the content item associated with this content type. This Help page displays when you click the link when configuring a content item. By default, the root corresponds to C:\Program Files (x86)\ASI\iMIS\Net. For example, ~/iparts/Common/QueryMenu/QueryMenuHelp.htm.

    The visual look and feel of the Help page is based on the iMIS theme you have selected. To be consistent with the rest of iMIS, we recommend that you only use basic HTML and allow iMIS to style the page. However, if needed, you can tailor the page using internal CSS.