Custom Objects

Overview

Custom Objects allow you to collect and store information from your partners and create code-free data customization for your unique business needs. A Custom Object can be considered as a custom information type and you create the fields you want completed for that type. 

For example:

Custom Object = Case Studies

Custom Fields for the Case Studies information type - the Custom Object could include these:

  • Publications - multiselect
  • Customer Name - text
  • Customer Logo - image
  • Customer Consent - checkbox
  • Document Summary - rich text
  • Draft Document - file
  • Sharing Preference - radio
  • Publication Date - date

Forms created for the information type are provided to assist with the collection of the data you want:

  • Portal form - Partners can create and submit their instances of the information (called Submissions). Add the Custom Object Listing feature page to your site navigation, or embed the Custom Object dynamic content widget in a custom page, to present a specific Custom Object in the partner portal as required. 

    You can also have a form for custom information embedded into deals, if you use the Object Type Deal when creating your Custom Object.

  • Admin form - You can create instances of the information on behalf of your partners in Unifyr One Admin.

The forms can be customized to use any of the Custom Fields in place for the Custom Object. You can also make the fields in the form required, or read-only, or specify that they should be displayed under certain conditions.

You can manage as many Custom Objects as you need and decide which fields are collected for the information type.

Permissions for a Custom Object allow you to decide if partners can create, edit, and/or view submissions of its custom information in the portal.

Contents

Click on the + to expand the instructions for the desired task.

Create a Custom Object

  1. Navigate to   > Settings > Forms & Fields .
  2. Choose Custom Objects.
  3. In the Custom Objects list, click Create Object.
  4. Provide the following information for the new Custom Object:

    Parameter Type Description
    Object Name Text The name of the object (information type)
    Url Key Text This is populated automatically from the value you enter in Object Name
    Description Text More information about the object (describe the type of information you want the user to provide, for example Provide a case study to demonstrate how CCOE's solution is helping your customers achieve their goals)
    Object Type Dropdown

    Choose the type of Custom Object to create:

    • Standard (default) - To represent any type of custom information

      Custom Objects of this type can be presented to partners via the Custom Object Listing feature page or the Custom Object dynamic content widget in a custom page

    • Deal - To represent custom information for deals

      Custom Objects of this type will be presented to partners in the deal create/update screen, for deals of any type

    Select both types if you want to have a Custom Object available both in the feature/custom page and in deals.

    Require Approval? Checkbox

    [Optional] Check this option to specify that all instances of information of this type made by partners must be approved by you.

    If set, you can approve/reject the submissions in Partner Management > Custom Objects. For more information, see About Custom Objects and Submissions.

    Note: If this is set, the approval requirement doesn't apply to instances of custom information that you create on behalf of your partners in Unifyr One Admin.

    Note: Custom Objects of type Deal can't be configured to require approval.

    Partner Access Level Checkbox

    Decide how partners can interact with instances of information of this type in the portal.

    • Create and Edit (default) - partners can create their own submissions, and edit and view existing ones
    • Edit Only - partners can edit and view existing submissions
    • View Only

     

    admin_custom_object_create.png

  5. Click Save. The new object is added to the Custom Objects list with the Custom Fields tab active, where you can configure the fields it will include.

    See Add Fields to a Custom Object below for information on how to add Custom Fields to the object.

    In addition, two forms are added to the Forms tab for the object:

    • Custom Object Portal
    • Custom Object Admin

    See Manage a Custom Object's Forms below for more information.

Edit a Custom Object

  1. Navigate to   > Settings > Forms & Fields > Custom Objects.
  2. Click on the Custom Object you’d like to edit.
  3. Click Edit Object.

    admin_custom_object_edit.png

  4. Make changes to any of the available fields, as required.
  5. Click Save to complete the update.

Add Fields to a Custom Object

A Custom Object (custom information type) has fields for adding custom information. For example, for a Custom Object Case Studies, you may want these fields: Customer Consent Received?, Customer Logo, Customer Name, Draft Document, Sharing Preference, Summary, Target Publication Date, and Target Publications.

To add custom fields to a Custom Object and specify the type of data they will hold:

  1. Navigate to   > Settings > Forms & Fields.
  2. Select Custom Objects.
  3. Click on the Custom Object you’d like to edit and go to the Custom Fields tab.
  4. Click Create Field.
  5. Complete the details for the Custom Field - internal and display names, the type of data it will capture (e.g. text or date), tooltip and help text, possible and default values, data validation requirements, etc. as required.

    The Internal Name can only include letters, numbers, spaces, and underscores.

    admin_custom_object_create_field.png

    For more information about the data points for the field, see Custom Fields.

  6. Click Save to add the field to the Custom Object. The field is added to the list on the Custom Fields tab for the object.
  7. Repeat the previous steps to add as many fields as you want for your object.

All the fields configured for the Custom Object are listed in the Custom Fields tab, with the most recent one at the top. They can be added to the forms for the Custom Object, either in their own right or in conjunction with other fields. For example, you might want to add a particular value of one field as the display condition for another field:

Did anyone at SupplierCo assist you with this Deal? (Yes/No)

Show a text input field if the answer is Yes.

For more information about display options in forms, see Form Configuration.

You can also add a relationship between custom fields, so that options presented in one field/menu can be filtered based on the value selected in a previous field or menu. For more information, see Add a Relationship between Custom Fields.

Manage a Custom Object's Forms

When you create a standard Custom Object, two forms are automatically added to its Forms tab:

  • Custom Object Portal - The way in which partner users will be asked to provide information of this type in the partner portal, when the Custom Object is presented to them (via Feature Page or Custom Page, or in deal create/update screens).
  • Custom Object Admin - The way in which your users will be asked to provide the information, when working in Unifyr One Admin.

The forms are available for use once the Custom Object is created.

You can configure the forms individually, to define which of the custom information fields they should contain:

  1. Navigate to   > Settings > Forms & Fields.
  2. Select Custom Objects.
  3. Click on the Custom Object you’d like to edit and go to the Forms tab.
  4. Click on the form you'd like to edit.
  5. Available Fields lists the fields that are available for this Custom Object. Selected Fields shows which of those fields have been selected to appear in the form. Move the fields in the form by selecting them and dragging and dropping to the required position in Selected Fields.

    The Name field is optional in the form. If included, a user can/must provide a name for each submission they make. If it isn't present in the form, each submission will be listed with their submission date/time as the identifier.

    Submission when Name field was included in the form:

    portal_custom_object_submissions_with_name.png

    Submission when Name field was not included/completed in the form:

    portal_custom_object_submissions_no_name.png

  6. You can give a field a different name in the form. You can also check the Required option to confirm that it is mandatory for the user to complete it when submitting the form. Both of these steps are optional.
  7. Click on a field to set additional display options (required, read-only, display conditions) as required. For more information about the options, see Form Configuration.
  8. To remove a field from the form, click the X next to it in Selected Fields.
  9. Click Save to preserve the update, Save and Close to complete it and return to the form list, or Cancel to abandon the update.

Delete a Custom Object

  1. Navigate to   > Settings > Forms & Fields.
  2. Select Custom Objects  to open the Custom Objects list view.
  3. Click on the Custom Object you’d like to edit and go to the Custom Fields tab.
  4. Click Delete Object.
  5. A pop-up asks you to confirm that you’d like to delete this object.
  6. Click Delete.

Add a Custom Object to your Partner Portal

Note

This section doesn't apply to Custom Objects of type Deal. For the steps to present Deal Custom Objects to your partners when they're creating or updating deals, see the Add a Custom Object to Deals section of this article.

Before you can add a Custom Object to the partner portal, you must first have at least one Custom Object with associated forms available. Follow the steps under the Create a Custom Object section above.

If you have configured Custom Objects, add the Custom Object Listing feature page to your site navigation to make them available to your selected partners. Partners can submit custom information there, and view submissions that have already been made. For more information, see Adding Feature Bundles/Pages to a Partner Portal. You can also use the Custom Object dynamic content widget in a custom page, to provide the form for custom information. For more information, see Add Dynamic Content. This process describes how to use the Custom Object Listing feature page. 

Note

You add one Custom Object to a Custom Object Listing feature page. Your partners create submissions of the custom information represented by the Custom Object in the page. The Custom Object is displayed as configured in its Portal form (see Manage a Custom Object's Forms above for more information).

Your partner users can change how their view of the list of submissions is presented to them, using the Configure Columns option:

portal_custom_object_configure_columns_feature_page.png

To add the Custom Object Listing feature page to your partner portal:

  1. Navigate to Partner Portal > Site Configuration.
  2. Click the Partner View where you’d like to add Custom Object Listing.
  3. On the left-hand sidebar, under Feature Pages, find Custom Object Listing.
  4. Drag and drop Custom Object Listing onto your site tree.

    [Optional] You can use the arrows to change the navigation depth, edit the Page Details to rename the page and control the visibility of this page to specific Partner Groups.

  5. Select the Custom Object that will be displayed by the feature page.
  6. Click Save and Close.

This is an example of what a Custom Object Listing page can look like in the partner portal. The name of the page was changed in site navigation to reflect the custom object being represented there (Case Studies).

portal_custom_object_listing.png

If you've given them permission, a partner can click Create in the top left of the page to access the form and submit the requested information.

Permissions for partners to create, edit, and view submissions of custom information are defined for the Custom Object. For more information, see the Create a Custom Object section of this article.

portal_custom_object_listing_form.png

Add a Custom Object to Deals

All Custom Objects of type Deal will be automatically included as information types in all deals created and viewed in your partner portal.

Your partners can add instances of the information represented by the Custom Object, and all instances are retained within the deal. For example, you might provide a Custom Object called Call Log and History for deals, and partners can add an entry for each call they make when prospecting/securing a deal. 

portal_custom_object_deal_listing.png

When a user clicks Add Item, they'll use the Portal form to make submissions of the data requested by the Custom Object. For more information, see the Manage a Custom Object's Forms section above.

 Training

Learn more with our training course:

You will be prompted to log into your CustomerONE account to access the link.

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

Comments

0 comments

Please sign in to leave a comment.