Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
Info

A ‘User/Member Attribute’ is a Form Question which has been flagged as an attribute. All custom fields are added to the database as questions on forms. Once a question has been flagged as an attribute, it will be available for display and filtering in other parts of myClubhouse.

How to Create a Custom Field (Form Question)

Custom fields come from Forms. To create a custom field you need to add it as a Question in a Form.

  1. Sign in as a user that has permission to create and edit forms.

  2. Go to Forms > Forms Manager

  3. Click the yellow Edit button next to an existing Form (or you can click the green ‘Add New …’ button to create a new Form).

  4. Scroll to the bottom of the Form Editor and click the green ‘Add Question’ button (or you can click the green ‘Insert Questions Before’ button to place the question higher up in the form).

  5. Type the question text and give is a ‘Short Name’; the Short Name will be used as a column header in the Member Directory and other table views.

  6. Select the question type from the blue buttons beneath the question text. The types are:

    1. Text - if the answer is to be entered by the user as free text

    2. YesNo - the user may only select “Yes” or “No” to answer the question

    3. YesNoMaybe - the user must select either “Yes”, “No” or “Maybe” to answer the question

    4. Option - the user must select only one option from a list (supplied by you)

    5. List - the user may select multiple options from a list (supplied by you)

    6. Integer - the answer must be entered as a whole number

    7. Date - the answer must be entered as a valid date (a calendar tool will be supplied)

    8. Currency - the answer must be entered in a valid currency format

    9. Double - the answer must be a number and can contain a decimal point

    10. User - the answer must be a user selected from the myClubhouse database

  7. If ‘Option’ or ‘List’ is selected:

    1. You must add some options for the user to select from. You can save these options for future questions by clicking ‘Save options for re-use’. If you do this you can also add multiple options at once using a text box (one option per line).

    2. You can select ‘Allow “Other” answer’ and the user will be able to select “Other” and then enter an answer using a text box.

  8. If the question is compulsory to answer, you must click the asterisk button so that it is filled in blue (click again to switch off).

  9. Advanced Options:
    Click “Options +” beneath the question type

    1. Visible/Hidden: by default the question is visible to the user, click this button to make it hidden (only visible to administrators and form owners) i.e. it is for admin use only. Click again to switch back to visible.

    2. Editable/Read-only: by default the question is editable by the user, i.e. the user can answer the question themself. Click to make the question read-only, i.e. the user can see the question and answer but only an administrator can change the answer. Click again to switch back to editable.

    3. Depends on Question: this question will only appear if the user selects “Yes” in answer to another question. Select the primary question (with a Yes/No answer type) from the drop-down list.

  10. To make a question obsolete, click the “Obsolete” button. This can be toggled on and off. The question will not appear in the form if it is obsolete.

  11. To delete a quetion, click the red “X” button. A question can only be deleted if it has not been answered. Otherwise, it can be made obsolete instead.

  12. Once your question is ready, click the blue “Save” button at the bottom of the form editor. You will be taken back to the Forms Administraton Page.

How to Make a Form Question into a User Attribute

  1. From the main menu, select Forms > Set up Attribute Questions.

  2. Click the green ‘+ Add’ button.

  3. Form: select the form on which the attribute question resides.

  4. Question: select the attribute question.

  5. Code: select a short, unique code for this attribute.

  6. Caption: Enter a caption to be displayed with the attribute. This will be displayed as a column heading in the Member Directory and on the member’s Profile page.

  7. Description: optional, add a description of the attribute.

  8. Visible in Profile to Other Members: select this flag if you would like all members to be able to view this attribute for other members in the Member Directory or on the member’s Profile Page. If not selected, the attribute will only be visible to administrators.

Once you have created your attribute, it will be available in the Member Directory, Member Profile Page and can be used for filtering on Member ListsAttributes are a way to define custom fields for your club or organisation. Attributes can be for different aspects within myClubhouse including Members, Horses, Vehicles, and Subscription Resources. Attributes are divided into different Sets, similar to a Form, to make it easier to control the Entitlements for groups of Attributes, as well as arrange them into logical groups for easier management.

As part of the 6.1 “Kreacher” release, Forms and Attributes have been separated to make them more intuitive and easier to manage as separate entities. Despite this, Attributes still operate in a very similar way to previous versions.

Table of Contents

Creating a New Attribute Set

  1. Navigate to Forms > Forms Manager.

  2. Select the type of Attribute you want to create:

    1. Member Attributes: Custom fields relating to members/users.

    2. Horse Attributes: Custom fields relating to horses. Equestrian module only.

    3. Vehicle Attributes: Custom fields relating to vehicles. Vehicles module only.

    4. Bookable Asset Attributes: Custom fields relating to bookable assets, such as tennis courts or football pitches. Bookings module only. COMING SOON

    5. Event Attributes: Custom fields for certain types of Events. COMING SOON

    6. Subscription Resource Attributes: Custom fields for certain types of Subscription Resources, e.g. lockers.

  3. Click the green “Create Attribute Set” button.

    CreateAttributeSet.pngImage Added
  4. Details: Enter the details about the Attributes Set. “Restrict to Member List” in step e will only be shown for Member Attributes.

    Details.pngImage Added
    1. Name: The name of the Attribute Set.

    2. Description: A short description of the Attribute Set, including the nature of the questions it is asking.

    3. Owner: The owner of the Attribute Set.

    4. Member Access: Select the level of access members can have to Attributes in this Set and their answers.

      1. Changeable: Members can enter their own Attributes, view them, and edit them later.

      2. Settable: Members can enter their own answers and view them, but can’t edit them later.

      3. Read-only: Members can view the answers but only admins can enter or edit them.

      4. Hidden: Only admins can view, enter, or edit the answers in this Attribute Set.

    5. Restrict to Member List: If set, Attributes in this Attribute Set will only apply to users in the selected Member List.

    6. Notifications: Select the settings for emails surrounding this Attribute Set.

      1. On form completion: If checked, the Owner (set above) will be sent an email every time a user completes the Attribute Set.

      2. On form edit: If checked, the Owner (set above) will be sent an email every time a user changes an answer to an Attribute in the Attribute Set.

  5. Entitlements: Set the Entitlements for this form. If nothing is changed, the site defaults will be used.

    Entitlements.pngImage Added
    1. Print Blanks: These users will be able to print a blank copy of the form to be filled out on paper

    2. View All: These users will be able to view all users' answers to this form.

    3. Enter All: These users will be able to enter or change answers to this form on behalf of any user.

    4. Administer: These users will be able to make changes to this form including adding and removing questions.

    5. Analyse: These users will be able to perform analysis on the answers to this form. See more about Analysing Forms in the “Other Functions” section.

  6. Introductory Text: This text will appear at the top of the Form. This can be a short description of the Form or instructions on how to complete it.

    IntroText.pngImage Added
  7. Add: Click to add a new Attribute.

    AddAttribute.pngImage Added
  8. Attributes: Set all the attributes for the Set.

    AttributeEditor.pngImage Added
    1. Name: A short name for the Attribute that can be used to identify it easily.

    2. Question/Help Text: The main body of the Attribute.

    3. Type: Select the answer type for the Attribute:

      1. Text: The user can type any text.

        TypeText.pngImage Added
        1. Sub-Type: Select the sub-type of Text for the Attribute.

          1. Free Text: Any text can be written for the Attribute.

          2. Email Address: The Attribute must be a valid email address.

          3. Phone Number: The Attribute must be a phone number i.e. no letters.

          4. URL: The Attribute must be a valid URL.

          5. Calculated: The Attribute can be calculated based on another Attribute. You can refer to another Attribute by placing its name between two % symbols. To refer to an Attribute in this way, it must come before the current Attribute in the Set, e.g. the third Attribute in a Set can refer to the first or second, but not the fourth.

        2. Single/Multi-line: Select whether the answer box will be a single line or a multi-line field. This will normally be dependent on the nature of the answer and the expected length.

        3. Max. Text Length: If you select “Single Line” above, you can set the maximum number of characters that the user can use. Note that anything above 255 will automatically change it to “Multi-line”.

      2. Yes/No: The user can select yes or no.

      3. Yes/No/Maybe: The user can select yes, no, or maybe.

        MaybeLabel.pngImage Added
        1. 'Maybe' Label: If you want the “Maybe” option to be named something else, set it here.

      4. Single Select: The user can select a single option from a pre-defined list.

        Image Added
        1. Edit Options: Click this to add options individually or in bulk.

        2. Allow Other: If set to “Yes”, members will be given an “Other” option at the end of the list so that they can enter an answer that doesn’t appear in the list.

      5. Multi Select: The user can select multiple options from a pre-defined list.

        Image Added
        1. Edit Options: Click this to add options individually or in bulk.

        2. Allow Other: If set to “Yes”, members will be given an “Other” option at the end of the list so that they can enter an answer that doesn’t appear in the list.

      6. Integer: A text box into which the user can type any whole number.

        TypeInteger.pngImage Added
        1. Sub-Type: Select the sub-type of Integer for the answer.

          1. Integer: The Attribute must be a whole number.

          2. Calculated: The Attribute can be calculated based on another Attribute. You can refer to another Attribute by placing its name between two % symbols. To refer to an Attribute in this way, it must come before the current Attribute in the Set, e.g. the third Attribute in a Set can refer to the first or second, but not the fourth.

      7. Date: A calendar from which the user can select a single date.

      8. Currency: A text box into which the user can type any valid monetary amount.

        TypeCurrency.pngImage Added
        1. Sub-Type: Select the sub-type of Currency for the Attribute.

          1. Currency: The Attribute must be a monetary amount with exactly 2 decimal places.

          2. Calculated: The Attribute can be calculated based on another Attribute. You can refer to another Attribute by placing its name between two % symbols. To refer to an Attribute in this way, it must come before the current Attribute in the Set, e.g. the third Attribute in a Set can refer to the first or second, but not the fourth.

      9. Decimal: A text box into which the user can type any decimal number.

        TypeDecimal.pngImage Added
        1. Sub-Type: Select the sub-type of Decimal for the Attribute.

          1. Decimal: The Attribute can be any number with any number of decimal places.

          2. Calculated: The Attribute can be calculated based on another Attribute. You can refer to another Attribute by placing its name between two % symbols. To refer to an Attribute in this way, it must come before the current Attribute in the Set, e.g. the third Attribute in a Set can refer to the first or second, but not the fourth.

      10. Member: An auto-complete text box from which the user can select a member. Note: Anyone filling out this Attribute will have to have the appropriate Entitlements to look up members. If the public will be filling out this Attribute Set, they won’t be able to look up users, regardless of the settings in Entitlements.

      11. Document: The user can upload a document to be submitted as the Attribute.

    4. Mandatory: Set whether this Attribute is optional or must be completed.

    5. Member Access: Select the level of access members have to this Attribute and its answer.

      1. Editable: Members can see and answer this Attribute.

      2. Read-only: Members can read the Attribute but not answer it. Admins can answer it.

      3. Hidden: Only admins can read and answer the Attribute for a member.

    6. Depends on: You can make this a sub-Attribute of another Attribute. This only works for Yes/No type Attribute and this Attribute will then appear if the answer to the original question is “Yes”. For example, you could ask “Would you like to play for one of our league teams?”, if the user answers yes, they will then be asked, “When are you usually available for matches?”.

    7. Attribute Code: A unique code to identify the Attribute so it can be used when sending Emails. Click “Re-generate” if you change the Name of the Attribute to update the code. This is only shown for Member Attributes.

    8. Show to Members: If set to “Yes”, current members will be able to see this Attribute in the Member Directory and when looking at a member’s profile. If set to “No”, the Attribute will only be visible to admins.

    9. Hide Editor: Click to hide the editor, making the page easier to navigate when looking at all the Attributes in the Set. When the editor is hidden, the following options become available: Show Editor, Copy Attribute, Delete Attribute, and Obsolete.

...

  1. Show Editor: Click to show the main editor to make changes to the Attribute.

  2. Copy Attribute: If you want to create a similar Attribute, click “Copy Attribute” and then edit your new Attribute.

  3. Delete Attribute: Click to delete this Attribute. Note: The Attribute won’t be fully deleted until the Attribute Set has been saved.

  4. Obsolete: If this Attribute is no longer required, but has been answered, you can make it obsolete which means it will still exist but not be shown to users when they fill out the Attribute Set.

  5. Re-order: Click to drag the list of Attributes into the desired order. Click “OK” to save the new order.

    Re-order.pngImage Added
  6. Save: When you have finished working on the Attribute Set, click this to save the Attribute Set and return to the Attributes page.

    Save.pngImage Added
  7. Repeat these steps to make all Attribute Sets.

Other Functions

Next to each Attribute, there are a series of functions:

...

  1. Edit Attribute Set: Make changes to this Attribute Set e.g. add new Attributes or change Entitlements.

  2. Delete Attribute Set: Click to delete the Attribute Set. If any of the Attributes have been answered, a warning symbol will be shown next to the option, as in the screenshot above. If it has been answered, ALL answers will be deleted and cannot be reinstated so only do this if you are certain.

  3. Action: Click for further actions/functions.

    1. Amend Answers: Amending Answers allows administrators to edit or set answers for multiple users in an editable table format.

      1. All users are shown in the table, regardless of whether they have completed the form already.

      2. Locate the user for whom you want to change their answers, possibly using the search bar.

      3. Change the answer in place, from the table.

      You can save a view of certain searches/filters to come back to at a later date. Help on views can be found here: Views

    2. Copy: If you want to create a similar Attribute Set, you can click “Copy” to have a starting point when creating your next Attribute Set.

    3. Edit: Make changes to this Attribute Set e.g. add new Attributes or change Entitlements.

    4. Move Questions: Attributes can be moved from one Attribute Set to another.

      1. Complete the wizard:

        MoveQuestion.pngImage Added
        1. Target Form: Select the Form/Attribute Set to which you are moving the questions.

        2. Questions: Select which questions you are moving. If a question is dependent on another question’s answer or another question is dependent on it, that question must be moved too.

        3. OK: Once happy, click “OK” to move the selected questions to the new Form/Attribute Set.

      2. Repeat the steps to move all Attributes.

    5. Delete: Click to delete the Attribute Set. If any of the Attributes have been answered, a warning symbol will be shown next to the option, as in the screenshot above. If it has been answered, ALL answers will be deleted and cannot be reinstated so only do this if you are certain.

    6. Answer Table: The Answer Table allows you to view all Attribute completions in a table format. You can select which Attributes (columns) you want to display, reorganise the columns, sort, filter, and export.

      You can save a view of certain searches/filters to come back to at a later date. Help on Views can be found here: Views

    7. Charts: Charts can be a very easy way to visually see how users have answered Attributes in a Set. A Chart will be shown for each Yes/No, Yes/No/Maybe, Single Select, and Multi Select Attribute in the selected Attribute Set.

      You can save a view of certain searches/filters to come back to at a later date. Help on Views can be found here: Views

    8. Queries: You can create Queries to find users who answered Attributes in particular ways. This guide will help you create Form Queries: Form Queries

    9. Print Forms: You can print all the completed versions of an Attribute Set if you want a PDF or hard copy.

      1. If desired, filter the completed Forms using the search bar, and filters.

      2. Right-click on the page and select “Print”.

      3. Follow your browser instructions to print.

Using Attributes

Once you have created your Attribute, it will be available in a variety of places, depending on the type:

  1. Member Attributes: You can find these on Member’s profiles and in the Member Directory.

  2. Horse Attributes: You can find these on Horse’s profiles and in the Horse Directory. Equestrian module only.

  3. Vehicle Attributes: Add these in Vehicle Types, and view on the Vehicle’s profile pages and in Browse Vehicles. Vehicles module only.

  4. Subscription Resource Attributes: Add to a Resource Set, and view on each Resource page.

How to Display an Attribute in the Member Directory

...

  1. Navigate to Information > Member Directory.

  2. Click on the light blue “Columns” button at the top-right of the directory table.

  3. Select your

...

  1. Attribute, usually near the bottom, sorted by Attribute Set.

  2. The column will be displayed at the right-hand end of the table.

  3. Drag the column heading to reposition to column.

  4. Click the column heading to sort the column in ascending order, and click again to sort in descending order.

How to Filter a Member List by a User Attribute

...

Go to Email > Member List Manager

...

Click Edit or Add New

...

Scroll down to Design

...

Click Select Property and scroll down to the third section “Attributes”

...

Select an attribute on which to filter your member list

...

Build your filter e.g. if your attribute is “Health Issues” you may have one of the following:

  1. “Health Issues” contains “asthma”

  2. “Health Issues” “is not null or empty”

  3. “Health Issues” does not equal “none”

...

The instructions are virtually the same for similar Attributes in the Horse Directory, Browse Vehicles, and when looking at Resource Sets.

Info

Learn more about Vehicles in this guide: Vehicles

Info

Learn more about Resources in this guide: Resources

Using an Attribute in a Member List

Attributes can be used as criteria in Member Lists. Learn more about Member Lists in this guide: Member Lists

Related articles

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@76ab5187
showSpacefalse
sortmodified
typepage
reversetrue
labelskb-how-to-article
cqllabel = "kb-how-to-article" and type = "page" and space = "CLUBSD"
Page Properties
hiddentrue

Related issues