Difference between revisions of "Developer References"

Revision as of 22:13, 12 April 2016

This section contains technical information that describes how to use the Contensive framework to develop applications.

Technical References

This section includes guides to typical technical tasks needed to host Contensive applications.

Extending Contensive

Contensive can be extended through two mechanisms, script programming on the hosting page and through Add-ons. Each has its advantages and drawbacks. Generally, using add-ons is the easiest and most versatile but in those cases where the add-on framework does not provide enough flexibility, writing scripts is always a fall-back.

Scripting the Host Page

Contensive does not run directly from the web server, but is instantiated from a framework running on the server, such as php. This way it can easily interface to any windows server platform, and be developed on top of any scripting system going forward. We currently use PHP, but ASP and ASPX are also supported.

Contensive creates the website document requested within the Contensive API, so the script page that initiates Contensive is used for the entire site, no matter what URL or content is requested. We call this the host page.

The easiest way to add functionality to the site through a host page script is to use replacement strings. Create an add-on that just leaves a unique string in the content, then in the host page, detect the unique string, run your functionality and replace it in.

Extending Contensive with Add-ons

An Add-on is a group of html, css, JavaScript, programming code, etc that when worked together, provide content or functionality for the site.

More Information

Developer Tutorials

Tutorials to provide a easy path for developers at Contensive and our clients to begin using our server framework.

Contensive Installation and Setup

Contensive SMS Architectural Overview

An overview of the system that include more a in-depth discussion of the available features.

Contensive API

Javascript API

Creating a custom login

Custom Editors

Creating Add-ons

Admin Framework API

Metadata (Content Definitions)

Creating Forms with Multiple Select Fields

Data Sources

Data is stored with a meta data construct called Content Definitions, which is a thin layer backed by the site's database.

Content Definitions

A content definition (cdef) describes a database table. It includes fields which map to each database table field.

To create a new content definition, use the Create Content Definition tool on the Tools navigator menu. To edit a definition, use the Manager Admin Edit tool in the Tools menu. When a content definition is created, the appropriate database fields are created to hold data for it. You can you then use admin site to add, delete and modify records for the content definition.

All content definitions automatically include a core set of fields. The primary key is always and integer named Id.

Child Content Definitions are definitions that are be subordinate to other Definitions. A child inherits the fields of parent. Child definitions are useful to help segmenting records. For instance, you could create a child of Page Content called Meetings Page Content, and assigned editing for this definition to a group. People in that group could edit those pages, but no others.

Content Definition Field Types

Content definition fields must be one of the following types

• Auto Increment
• Boolean
• css file
• Currency
• Date
• File
• Float
• Html
• Html File
• Image
• Integer
• javascript File
• Link
• Long Text
• Lookup
• Many To Many Select
• Member Select
• Redirect
• Resource Link
• Text
• Text File
• Xml File

Basic Content Definition Fields

These fields are included in all Content Definitions

• Active
• ccGuid
• ContentCategoryId
• ContentControlId
• CreatedBy
• CreateKey
• DateAdded
• EditArchive
• EditBlank
• EditSourceid
• Id
• ModifiedBy
• ModifiedDate
• name
• SortOrder

Core Content Definitions

The following is a list of the Content Definitions considered core data and installed when the application is created.

Data Sources 

• ConnString

Tables 

• DataSourceID

Content 

• ContentTableID
• AuthoringTableID
• AllowAdd
• AllowDelete
• AllowWorkflowAuthoring
• AllowContentTracking
• AllowTopicRules
• AllowContentChildTool
• AllowMetaContent
• DeveloperOnly
• AdminOnly
• ParentID
• DefaultSortMethodID
• DropDownFieldList
• EditorGroupID
• Field Definitions
• IconLink
• IconWidth
• IconHeight
• IconSprites
• IsBaseContent
• InstalledByCollectionID

Content Fields 

• ContentID
• Type
• Caption
• ReadOnly
• NotEditable
• LookupContentID
• RedirectContentID
• RedirectPath
• RedirectID
• UniqueName
• TextBuffered
• DefaultValue
• Required
• Password
• Scramble
• HTMLContent
• IndexColumn
• IndexWidth
• Authorable
• IndexSortPriority
• IndexSortDirection
• EditSortPriority
• EditTab
• AdminOnly
• DeveloperOnly
• ManyToManyContentID
• ManyToManyRuleContentID
• ManyToManyRulePrimaryField
• ManyToManyRuleSecondaryField
• MemberSelectGroupID
• RSSTitleField
• RSSDescriptionField
• LookupList
• IsBaseField
• editorAddonID
• InstalledByCollectionID
• createResourceFilesOnRoot
• prefixForRootResourceFiles

Content Field Help 

• FieldID
• HelpDefault
• HelpCustom

Content Field Types 

• EditorAddonId

Add-on Content Field Type Rules 

• addonID
• contentFieldTypeID

Sort Methods 

• OrderByClause

Content Categories=====

Visit Summary 

• DateNumber
• TimeNumber
• TimeDuration
• AveTimeOnSite
• Visits
• PagesViewed
• NewVisitorVisits
• SinglePageVisits
• AuthenticatedVisits
• MobileVisits
• BotVisits
• NoCookieVisits

Page View Summary 

• DateNumber
• TimeNumber
• TimeDuration
• PageTitle
• PageID
• PageViews
• AuthenticatedPageViews
• MobilePageViews
• BotPageViews
• NoCookiePageViews

Visitors 

• MemberID
• OrderID
• ForceBrowserMobile

Visits 

• StartTime
• StartDateValue
• LastVisitTime
• StopTime
• TimeToLastHit
• VisitorID
• VisitorNew
• MemberID
• MemberNew
• REMOTE_ADDR
• RemoteName
• Browser
• HTTP_VIA
• HTTP_FROM
• HTTP_REFERER
• RefererPathPage
• PageVisits
• CookieSupport
• LoginAttempts
• VerboseReporting
• VisitAuthenticated
• ExcludeFromAnalytics
• Mobile
• Bot

Viewings 

• VisitID
• VisitorID
• MemberID
• Host
• Path
• Page
• QueryString
• Form
• StateOK
• Referer
• PageTime
• RecordID
• ExcludeFromAnalytics
• PageTitle

Admin Menuing 

• AdminOnly
• DeveloperOnly
• ParentID
• NewWindow
• ContentID
• AddonID
• HelpAddonID
• HelpCollectionID
• LinkPage
• NavIconType
• NavIconTitle
• InstalledByCollectionID

Menu Entries 

• ParentID
• NavIconType
• NavIconTitle

Navigator Entries 

• ParentID

Report Rules 

• Browser
• Address

Trap Log 

• Host
• Path
• Page
• CopyFilename
• Resolved
• Resolution

Site Properties 

• FieldValue

Admin Site Properties=====

Topics 

• PublicJoin
• AllowBulkEmail
• Pages

Topic Rules 

• TopicID
• ContentID
• RecordID
• ContentRecordKey

Page Content Topic Rules 

• TopicID
• PageID

Member Topic Rules 

• TopicID
• MemberID

Topic Habits 

• MemberID
• TopicID
• VisitID
• Score
• ContentRecordKey

Languages 

• HTTP_Accept_Language

People 

The people table holds records that represent users. It has by default one child content definition, Members. :

FirstName 

Text: The first name of the user. Typically the record's name is saved as firstName + lastName.

LastName 

Text: The last name of the user. Typically the record's name is saved as firstName + lastName.

Company 

Text: A text field that can be used for the user's company. Note there is also an OrganizationId which typically is a foreign key to the organizations table.

Title 

Text: The user's title

Address 

Text: The first line of the user's address

Address2 

Text: The second line of the user's address

City 

Text: The city of the user's address

State 

Text: The state of the user's address. There is a States content definition that can be used, but to provide the most flexibility, the field is denormalized so states and provinces from other countries can be entered.

Zip 

Text: The zip code / postal code of the user's address

Country 

Text: The country of the user's address. There is a Countries content definition that can be used, but to provide the most flexibility, the field is denormalized so other countries can be entered.

Email 

Text: The primary email contact information for the user

Phone 

Text: The primary phone contact information for the user

Fax 

Text: The primary fax contact information for the user

ImageFilename 

File: An image for the user

ThumbnailFilename 

File: An smaller thumbnail, avatar for user. Typically 100px square

NotesFilename 

Text File: A text file that can be used for notes about the user.

ResumeFilename 

Text File: A text file that can be used as a background or resume for the user.

OrganizationID 

Lookup to Countries: A lookup to the Organizations definition. Typically this is the organization for which the user is associated.

BillName 

Text: If this user is used as a billing contact, this is the notification name.

BillEmail 

Text: If this user is used as a billing contact, this is the notification email.

BillPhone 

Text: If this user is used as a billing contact, this is the notification phone.

BillFax 

Text: If this user is used as a billing contact, this is the notification fax.

BillCompany 

Text: If this user is used as a billing contact, this is the notification company.

BillAddress 

Text: If this user is used as a billing contact, this is the notification address line 1.

BillAddress2 

Text: If this user is used as a billing contact, this is the notification address line 2.

BillCity 

Text: If this user is used as a billing contact, this is the notification city.

BillState 

Text: If this user is used as a billing contact, this is the notification state. There is a States content definition that can be used, but to provide the most flexibility, the field is denormalized so other countries can be entered.

BillZip 

Text: If this user is used as a billing contact, this is the notification zip.

BillCountry 

Text: If this user is used as a billing contact, this is the notification country. There is a Countries content definition that can be used, but to provide the most flexibility, the field is denormalized so other countries can be entered.

ShipName 

Text: If this user has a separate shipping contact, this is the address name.

ShipCompany 

Text: If this user has a separate shipping contact, this is the address company.

ShipAddress 

Text: If this user has a separate shipping contact, this is the address line 1.

ShipAddress2 

Text: If this user has a separate shipping contact, this is the address line 2.

ShipCity 

Text: If this user has a separate shipping contact, this is the address city.

ShipState 

Text: If this user has a separate shipping contact, this is the address state. There is a States content definition that can be used, but to provide the most flexibility, the field is denormalized so other countries can be entered.

ShipZip 

Text: If this user has a separate shipping contact, this is the address zip code / postal code.

ShipCountry 

Text: If this user has a separate shipping contact, this is the address country. There is a Countries content definition that can be used, but to provide the most flexibility, the field is denormalized so other countries can be entered.

ShipPhone 

Text: If this user has a separate shipping contact, this is the phone.

Username 

Text: The user's login username, when authentication is configured to use a username,

Password 

Text: The user's login password.

AllowBulkEmail 

Boolean: When true, email can be sent to this user. Set false to block email.

Admin 

Boolean: When true, this user assumes the Administrator role. Administrators can edit any content and are not effected by page blocking.

Developer 

Boolean: When true, this user assumes the Developer role. Developers assume all Administrator rights, and can access content definitions, admin features and addons marked developer only.

DateExpires 

Date: When not empty, this user's authentication method is only valid before this date.

AutoLogin 

Boolean: When true, and enabled in site properties, this user can be automatically authenticated based only on a persistent cookie.

AllowToolsPanel 

Boolean: When true, and this user is a content editor, they see the edit tool panel.

ExcludeFromAnalytics 

Boolean: When true, visits from this user are excluded from visit analytics.

Visits 

read-only, Integer: The number of times a user has authenticated with this record.

LastVisit 

Read-only Date: The time and date of the last time a user authenticated with this record.

CreatedByVisit 

Read-only Boolean: true if this user record was created by a visit.

LanguageID 

Lookup to languages: The language set by the user's browser during the user's last visit.

BirthdayDay 

Integer: The day of the month of the user's birthday, 1...31.

BirthdayMonth 

Integer: The month of the user's birthday, 1...12.

BirthdayYear 

Integer: The year of the user's birthday.

StyleFilename 

Css file: Styles that will be added to everypage of the site when this user is authenticated.

Topics 

Many to Many: A list of the topics from pages visited by this user.

nickName 

a short name used by some addons.

Members 

Members is a child content of People.

Groups 

Groups a collections of people, like a mailing list, or a committee.

Caption 

Text: The name of the group used on the public website.

CopyFilename 

Text File: A description for the group that may be displayed on the public site.

AllowBulkEmail 

Boolean: When true, this group can be sent group email.

PublicJoin 

Boolean: When true, this group can be joined by anyone on the public site.

MembershipReference 

Read-only Redirect: A link to Group Rules, a list of poeple in this group.

Group Rules 

Group rules are records that create editing rights for a groups. When a rule is created, users in the selected group can edit records in the selected content.

GroupID 

Lookup to Groups: The group associated to this rule.

ContentID 

Lookup to Content: The content definition that this group can edit.

AllowAdd 

Boolean: When true, users in this group can add new records to the content.

AllowDelete 

Boolean: When true, users in this group can delete records from the content.

Member Rules 

Records that indicate if a user is in a group.

MemberID 

Readonly Lookup into people: The user that is in the group.

GroupID 

Readonly Lookup into groups: The group in which the user belongs.

DateExpires 

Date: if not empty, membership in the group is invalid after this date.

Organizations 

The organizations table represents a list of companies with which users may be associated.

CopyFilename 

Text File: A description for the organiation that may be displayed publically.

BriefFilename 

Text File: A shorter description that may be used in a list of organizations.

ContactMemberID 

Lookup into Members: The primary contact in the people definition.

Address1 

Text: Line 1 of the primary organization address.

Address2 

Text: Line 2 of the primary organization address.

City 

Text: The City of the primary organization address.

State 

Text: The State of the primary organization address.

Country 

Text: The Country of the primary organization address.

Zip 

Text: The zip code or postal code of the primary organization address.

Phone 

Text: The primary phone for the organization, not otherwise associated to a user, like the front desk.

Fax 

Text: The primary fax for the organization, not otherwise associated to a user.

Web 

Text: The organization's website.

Email 

Text: The primary email for the organization, not otherwise associated to a user.

Link 

Text: If provided, the url that should be used for links to the website.

Viewings 

Read-only Integer: If this organization is displayed in a directory-style list, this integer can be used to count how often the organization details were viewed.

Clicks 

Read-only Integer: If this organization is displayed in a directory-style list, this integer can be used to count how often the organization's website or link was clicked.

ImageFilename 

image: The primary image for the record.

ThumbNailFilename 

Image: A secondary smaller image for the record.

Page Content 

• Headline
• Copyfilename
• ContentPadding
• ContactMemberID
• IsSecure
• TemplateID
• AllowHitNotification
• AllowReturnLinkDisplay
• AllowMetaContentNoFollow
• AllowSeeAlso
• AllowFeedback
• AllowMoreInfo
• AllowPrinterVersion
• AllowEmailPage
• AllowLastModifiedFooter
• AllowMessageFooter
• AllowReviewedFooter
• DateReviewed
• ReviewedBy
• Viewings
• PubDate
• DateExpires
• DateArchive
• ArchiveParentID
• TriggerConditionID
• TriggerConditionGroupID
• TriggerSendSystemEmailID
• TriggerAddGroupID
• TriggerRemoveGroupID
• LinkLabel
• AllowInMenus
• AllowInChildLists
• AllowChildListDisplay
• ChildListSortMethodID
• MenuHeadline
• AllowBrief
• BriefFilename
• Link
• Clicks
• ParentID
• ParentListName
• ChildPagesFound
• ChildListInstanceOptions
• PageLink
• BlockContent
• BlockPage
• BlockGroups
• BlockSourceID
• CustomBlockMessage
• RegistrationGroupID
• JSOnLoad
• JSHead
• JSFilename
• JSEndBody
• LinkAlias
• Topics

Page Content Block Rules 

• GroupID
• RecordID

Email 

• Subject
• FromAddress
• TestMemberID
• EmailTemplateID
• CopyFilename
• ConditionID
• ConditionPeriod
• ScheduleDate
• ConditionExpireDate
• ToAll
• AddLinkEID
• AllowSpamFooter
• Submitted
• Sent
• DateAdded
• InlineStyles
• EmailWizardID
• LastSendTestDate
• sharedStylesId
• StylesFilename
• BlockSiteStyles

Email Style Rules 

• emailId
• sharedStylesId

Group Email 

• Submitted
• Sent
• ConditionID
• ConditionPeriod
• ConditionExpireDate

System Email 

• ConditionID
• ConditionPeriod
• ScheduleDate
• ConditionExpireDate
• ToAll
• Submitted
• Sent

Conditional Email 

• ToAll
• Submitted
• Sent

Email Groups 

• EmailID
• GroupID

Email Topics 

• EmailID
• TopicID

Email Drops 

• DateAdded
• EmailID

Email Log 

• LogType
• SendStatus
• ToAddress
• FromAddress
• Subject
• DateAdded
• EmailID
• EmailDropID
• MemberID
• VisitID
• DateBlockExpires

Email Templates 

• Link
• Source
• BodyHTML

Email Wizards 

• EmailTypeID
• IncludeTemplateForm
• DefaultTemplateID
• TemplateFormInstructions
• IncludeContentForm
• DefaultContent
• ContentFormInstructions
• IncludeGroupForm
• GroupFormInstructions
• IncludeSchedule
• AllowSpamFooterDefault
• IncludeAllowSpamFooter
• LinkAuthenticationDefault
• IncludeLinkAuthentication
• IncludeConditionPeriod
• DefaultConditionPeriod

Content Watch 

• Contentid
• Recordid
• Link
• LinkLabel
• Clicks
• AllowWhatsNew
• WhatsNewDateExpires
• ContentRecordKey

Content Watch Lists 

• AllowRSS
• RSSFilename
• RSSTitle
• RSSDescription
• RSSLink
• RSSDateUpdated

Content Watch List Rules 

• ContentWatchID
• ContentWatchListID

See Also 

• ContentID
• RecordID
• Link
• Brief

Paths=====

Path Rules 

• GroupID
• PathID

Notes 

• MemberID
• FromEmail
• FromName
• FromMemberID
• FromVisitID
• CopyFilename
• NoteRead
• ReadDate
• ReadVisitID
• DateExpires

States 

• Abbreviation
• SalesTax
• CountryID
• FIPSState
• StateRegionID

Countries 

• Abbreviation
• DomesticShipping

Images 

• ImageFilename
• Width
• Height
• Caption
• Align
• ThumbnailFilename
• ThumbnailWidth
• ThumbnailHeight
• Link
• DateExpires
• LastViewDate
• Clicks
• ClicksMax
• Viewings
• ViewingsMax
• NewWindow

Properties 

• TypeID
• KeyID
• FieldValue

Alerts 

• MemberID
• ToMemberID
• EmailOnVisit
• RemoteMonitor

Authoring Controls 

• ContentID
• RecordID
• ControlType
• DateExpires
• ContentRecordKey

Search Keywords 

• Count
• VisitID

Shared Styles Include Rules 

• StyleID
• IncludedStyleID

Shared Styles 

• StyleFilename
• AlwaysInclude
• Prefix
• Suffix
• Add-ons
• Layouts
• Templates
• SharedStyles

Shared Styles Add-on Rules 

• AddonID
• StyleID

Scripting Modules 

• Code

Scripting Languages=====

Add-on Scripting Module Rules 

• AddonID
• ScriptingModuleID

Add-on Include Rules 

• AddonID
• IncludedAddonID

Add-on Content Trigger Rules 

• AddonID
• ContentID

Add-on Events=====

Add-on Event Throwers 

• eventId
• collectionId

Add-on Event Catchers 

• addonId
• eventId

Add-ons 

• OnPageStartEvent
• BlockDefaultStyles
• DateAdded
• IconHeight
• IconWidth
• CustomStylesFilename
• IconSprites
• JavaScriptBodyEnd
• OnNewVisitEvent
• RemoteMethod
• CopyText
• SharedStyles
• StylesFilename
• OtherHeadTags
• MetaKeywordList
• OnPageEndEvent
• PageTitle
• IconFilename
• JavaScriptInHead
• JavaScriptOnLoad
• Admin
• Content
• Template
• Email
• HelpLink
• NavTypeID
• Help
• Description
• MetaDescription
• EditBlank
• ScriptingCode
• ScriptingTimeout
• inlineScript
• CollectionID
• OnBodyStart
• fieldTypeEditor
• IsInline
• DotNetClass
• Copy
• ArgumentList
• Link
• NavIconType
• OnBodyEnd
• ObjectProgramID
• JSFilename
• RobotsTxt
• IncludedAddons
• FormXML
• InFrame
• Filter
• ScriptingLanguageID
• RemoteAssetLink
• BlockEditTools
• AsAjax
• ProcessServerKey
• Process
• ProcessInterval
• ProcessRunOnce
• ProcessNextRun
• ProcessContentTriggers
• DotNetClassLibrary
• ScriptingEntryPoint
• ScriptingModules
• Events

Aggregate Functions=====

Aggregate Function Scripts 

• ObjectProgramID
• Copy

Aggregate Function Objects 

• Link
• Copy

Aggregate Function Replacements 

• ObjectProgramID
• Link

Add-on Collection Parent Rules 

• ParentID
• ChildID

Add-on Collection CDef Rules 

• ContentID
• CollectionID

Add-on Collection Module Rules 

• ScriptingModuleID
• CollectionID

Add-on Collections 

• System
• Updatable
• blockNavigatorNode
• helpLink
• Help
• InstallFile
• LastChangeDate
• ChildCollections
• ContentDefinitions
• ScriptingModules
• OtherXML
• wwwFileList
• ContentFileList
• ExecFileList
• DataRecordList
• Events

Portals=====

Portal Add-on Rules 

• PortalID
• AddonID

Library Folders 

• Description
• ParentID

Library Folder Rules 

• FolderID
• GroupID

Library Files 

• FileTypeID
• Description
• Filename
• FileSize
• FolderID
• Clicks
• Width
• Height
• AltSizeList
• DateExpires
• AltText

Library File Types 

• ExtensionList
• IconFilename
• IsImage
• IsVideo
• IsFlash
• MediaIconFilename
• IsDownload
• DownloadIconFilename

Library File Log 

• FileID
• VisitID
• MemberID

Link Forwards 

• SourceLink
• DestinationLink
• Viewings
• GroupID

Link Aliases 

• Link
• PageID
• QueryStringSuffix

Domains 

• TypeID
• RootPageID
• DefaultTemplateId
• PageNotFoundPageID
• forwardDomainId
• ForwardURL
• NoFollow
• Visited
• allowCrossLogin

Page Templates 

• BodyHTML
• BodyTag
• IsSecure
• Link
• StylesFilename
• SharedStyles
• OtherHeadTags
• MobileBodyHTML
• JSOnLoad
• JSHead
• JSFilename
• JSEndBody
• Source
• Domains

Template Domain Rules 

• templateId
• domainId

Shared Styles Template Rules 

• TemplateID
• StyleID

Site Sections 

• Caption
• TemplateID
• RootPageID
• ContentID
• MenuImageFilename
• MenuImageOverFilename
• HideMenu
• BlockSection
• JSOnLoad
• JSHead
• JSFilename
• JSEndBody

Section Block Rules 

• GroupID
• SectionID

Meta Content 

• MetaDescription
• MetaKeywordList
• OtherHeadTags
• ContentID
• RecordID

Meta Keywords=====

Meta Keyword Rules 

• MetaContentID
• MetaKeywordID

Aggregate Access 

• Link

Copy Content 

• Copy

User Form Response 

• Copy
• DateAdded
• VisitID

Tasks 

• Command
• DataSource
• SQLQuery
• Filename
• NotifyEmail
• ImportMapFilename
• DateStarted
• DateCompleted
• ResultMessage

Dynamic Menus 

• Depth
• Layout
• FlyoutOnHover
• Delimiter
• FlyoutDirection
• StylePrefix
• StylesFilename

Dynamic Menu Section Rules 

• DynamicMenuID
• SectionID

Custom Reports 

• SQLQuery

Form Pages 

• Instructions
• Body

Remote Queries 

• RemoteKey
• QueryTypeID
• DataSourceID
• SQLQuery
• ContentID
• Criteria
• SortFieldList
• AllowInactiveRecords
• SelectFieldList
• MaxRows
• DateExpires
• VisitID

Wrappers 

• copytext
• targetstring
• javascriptonload
• javascriptinhead
• JSFilename
• javascriptbodyend
• stylesfilename
• OtherHeadTags

Activity Log 

• MemberID
• OrganizationID
• Message
• Link
• VisitorID
• VisitID

Layouts 

• Layout
• StylesFilename
• SharedStyles

Shared Styles Layout Rules 

• LayoutID
• StyleID

Site Warnings 

• shortDescription
• location
• PageID
• description
• count
• DateLastReported
• generalKey
• specificKey