Using custom data attributes

Custom data attributes allow you to collect information about events, event participants, and on-demand labs that you can access in Skytap environment metadata, Course Manager reporting, and optionally, in a customer relationship management system such as Salesforce.

Contents

About custom data attributes

  • Custom data attributes are configured separately for events, event participants, and on-demand labs in your account settings.

    Notes

    • Only Course Manager administrators can access account settings.
    • As a best practice, configure custom data attributes in your account settings before you schedule instructor-led training events or request on-demand labs.
    • If you delete a custom data attribute in your account settings, you can no longer view the attribute on Course Manager pages or edit existing values for the attribute, but existing attribute values still display in Course Manager reporting.
  • Depending on the properties of an attribute, custom data attribute values may display:
    • In Skytap environment metadata.
    • In Course Manager reporting.
    • On the event details page (for event and event participant custom data attributes only).

      Event participant custom data attributes only display in the Basic view of the event details page.

    • On the lab details page (for on-demand lab custom data attributes only).
    • On the Events page (for event custom data attributes only).
    • On the Labs page (for on-demand lab custom data attributes only). For more information about using the Labs page, see Managing labs and Using the request portal.

      The term Lab in the Course Manager interface is configurable for your account and may be replaced by another term such as Demo.

    • In the event participant roster (for event participant custom data attributes only).
    • In a customer relationship management system such as Salesforce (for on-demand lab custom data attributes when Course Manager is integrated with the customer relationship management system only).
  • Event and on-demand lab custom data attributes can be inserted as placeholders in course Manuals and confirmation emails sent by Course Manager.
  • Depending on the properties of an attribute, you may enter a value for a custom data attribute:
  • Custom data attributes can be accessed through the Course Manager API.

Properties of custom data attributes

Main attribute properties

When you add a custom data attribute in your account settings, configure the following attribute properties:

  • Attribute key – The attribute name that is used in the Course Manager API, Skytap metadata, reports, and placeholders.
  • Label – The attribute display name that is used on pages in Course Manager.
  • Form input type – The input type for the attribute data field in forms to create or edit events, event participants, or on-demand labs. Select from Text, Multi-line text, Select, Button (on-demand lab custom data attributes only), and Number input types.

    Notes

    • If Form input type is Select, you must add at least one item in the Select options section.
    • If Form input type is Button, you must enter a Trigger (the action triggered when the button is clicked). Work with the Course Manager team to configure a Button attribute.
    • If Form input type is Button, the attribute doesn't display on the Labs or lab details pages, or in Skytap metadata, Course Manager reporting, or placeholder lists.
  • (Optional) Default value – The default value for the attribute.

    If Form input type is Select and you enter a Default value, the value must be one of the Select options.

  • Integration filter (on-demand lab custom data attributes only) – Limit the attribute to a specific integration or select All to use it for all integrations.

    For more information about integrations, see Creating a lab.

  • Hidden? – Hide the attribute data field in forms to create or edit events, event participants, or on-demand labs, but allow Course Manager to assign a value to the attribute.

    If you set the Hidden? property to Yes, Course Manager assigns the Default value (or a blank value if Default value is blank) to the attribute when an event, event participant, or on-demand lab is created.

  • Required? (event and on-demand lab custom data attributes only) – Require a value for the attribute.
  • Disabled? – Don’t allow the attribute value to be modified in forms to create or edit events, event participants, or on-demand labs, and don’t allow Course Manager to assign a value to the attribute.

    In most cases, when you create a custom data attribute, you should set the Disabled? property to No.

  • Read only? – Don’t allow the attribute value to be modified in forms to create or edit events, event participants, or on-demand labs, but allow Course Manager to assign a value to the attribute.

    If you set the Read only? property to Yes, Course Manager assigns the Default value (or a blank value if Default value is blank) to the attribute when an event, event participant, or on-demand lab is created.

  • Editable? (event and on-demand lab custom data attributes only) – Don’t allow the attribute value to be modified after the event or on-demand lab is created.
  • Show on Events? (event custom data attributes only) – Show the attribute on the Events page.

    If the Hidden? or Disabled? property is set to Yes, the attribute doesn’t display on the Events or event details pages.

  • Show on event details? (event participant custom data attributes only) – Show the attribute on the event details page.

    If the Hidden? or Disabled? property is set to Yes, the attribute doesn’t display on the event details page or event roster.

  • Show on All Labs and My Labs? (on-demand lab custom data attributes only) – Show the attribute on the Labs page.

    If the Hidden? or Disabled? property is set to Yes, the attribute doesn’t display on the Labs or lab details pages.

Additional properties for conditional properties

For the Hidden?, Required?, Disabled?, and Read only? attribute properties, you can select No, Yes, or Conditionally. If you select Conditionally, configure the following additional properties:

  • Conditional attribute – The Attribute key for the attribute that the conditional property depends on.
  • Comparison – Either Equals or Not equals.
  • (Optional) Conditional value – The value that the Conditional attribute must equal or not equal for the conditional property to be true.

For example, you create the CustomerName on-demand lab custom data attribute and set the Hidden? property to Conditionally. You then set the Conditional attribute to LabPurpose, the Comparison to Not equals, and the Conditional value to Customer Demo. This means that if you create or edit an on-demand lab, the CustomerName attribute data field will be hidden in the form if LabPurpose isn’t Customer Demo.