Follow

15. Client Instructions for Using Custom Web Elements - Ecommerce (copied)

Outside of the portal web elements that we've already discussed, a savvy user can also create their own customized Web Elements to serve specific functions that the portal doesn't already provide. These tools leverage Cobalt's existing Application functionality to create individual Web Elements for many different kinds of tracking and Ecommerce needs. Here we will discuss how to do so.

Web Element Type

The web element type record allows you to create custom elements that can work like membership/certification applications. The type is highly customizable to allow for the creation of unique records after successful completion. The example above demonstrates a Web Element for ordering a membership card.

  • Name - Name of the web element type.
  • Form - Lookup to a form for custom questions if applicable.
  • Order Source - Lookup to a custom order source to enforce payment rules if applicable.
  • Publish to Portal - Yes to show this web element type on the portal. No and it will not display.
  • Mapped Entity Name - Map this Web Element Type to a specific Entity for creating new data in an entity. For example, create a membership record or case record upon completing a web element type submission.  (Must be schema name of the entity)
  • Mapped Entity Customer ID Field - If creating a record from this submission use this to create a link to the contact from the submission to match the contact on the new record. (Must be schema name of the contact field on the target entity)
  • Description - A detailed description about the web element type that will display on the portal.

This record also contains subgrids for three related entities: Web Element Fees, Web Element Requirements and Web Element Submissions.

Web Element Fee

This record, like a Membership application fee or an event registration fee, defines which product is purchased for this Web Element and if questions on a form must be answered.

  • Name - Name for the fee.
  • Web Element Type - Lookup to the related web element type the fee is for.
  • Product - Lookup to the product that will be used to determine the amount for the fee. This can use a $0 product.
  • Form - If choosing this fee means you want to collect additional information, a lookup to a custom form can be added here.
  • Sort Order - Select a specific order in which to display multiple fees if desired.

Web Element Requirement

This record, like with Member Type records, defines what requirements must be met for the submission of this Web Element to be completed

  • Name - Name of the requirement.
  • Mode - Mode for requirement completion.
    • Manual - requirement will need to be deactivated by staff. Usually used for confirming completed application documentation or other details.
    • Query - Queried requirements allow you to query the system for other conditions to be met. For example, a query can make sure the person has a completed class.
    • Order Paid - This requirement will be completed when the order tied to the web element type is fulfilled/paid.
    • Command Text -This is an advanced requirement that allows you to enter T-SQL statements to define the condition(s) that must be met when the standard query requirement is not sufficient. These requirements should either be setup by Cobalt or a technical staff person with advanced knowledge of T-SQL statements.
    • Audit - This works like a manual requirement in that it will be reviewed and deactivated by staff.
  • Web Element Type - Look up to the associated web element type.
  • Description - Internal notes about the requirement type.

Web Element Submission

This record acts as a monitor of a submission for a particular web element, tracking what requirements have yet to be met, which fee was chosen, and when it was submitted.

  • Name - Automatically populates with the contact and the web element type name to create a unique submission name.
  • Contact - Look up to the contact related to the web element submission.
  • Web Element Type - Look up to the web element type related to the submission.
  • Web Element Fee - Look up to the fee selected for this submission.
  • Fee Form Response - If a form was attached to the web element fee then a form response record will be linked here so you can review the answers.
  • Type Form Response - If a form was attached to the web element type then a form response record will be linked here so you can review the answers.
  • Date Submitted - The date the submission was submitted.
  • Order Total - Total amount paid (if applicable)
  • Requirements Subgrid - Note that the subgrid, by default, only shows active requirements. Completed requirements will not display here, but can be reviewed in related record views.

Association of College Unions International (ACUI) Job Board

Let's discuss a real-world example of this. ACUI, a cobalt client, used this functionality to create an online job board where college unions may pay to post job openings and where potential applicants can find those jobs.

To accommodate this, they created this Web Element Type, which would generate a Job Post record and set the Posted By field of that record to the contact that submitted the job:

They created and associated a Web Element Fee which is itself associated with a form (for Job Details) and a product with different pricing for Members or non-members who were posting a job:

They created a Web Element Requirement of Order Paid:

With all of this complete, that Web Element Type was then available in the Web Element Designer, under the Custom Elements -> Custom Ecommerce tab where they could make any styling changes using the Web Element Generator before copying the code and embedding the web element on their website:

As contacts submit postings using this Web Element, Web Element Submissions are created and associated with the Web Element Type:

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk