Groups

Create and manage an API Group or independent group on the platform.

Table of Contents

  1. What is a group?
  2. What types of groups does the platform support?
  3. What are the components of the Groups page?
  4. How do I access Independent or Private API Groups?
Create Group:
  1. How do I create a group?
Group Roles:
  1. What are the group roles?
  2. How does the Leader role work?
Invite Members:
  1. How do I invite someone to a group?
  2. Can I invite non-members to a group?
  3. How do I accept an invitation to a group?
  4. How do I decline an invitation to a group?
  5. After I become a group member can I invite developers to the group?
Group Maintenance:
  1. How do I edit group information?
  2. How do I remove a group member?
  3. How do I resend a group invitation?
  4. How do I delete a group?
Review:
  1. Where can I find review information for each group?
  2. How do I rate a group and write a review?
  3. How do I edit a group review?
  4. How do I delete a group review?

What is a Group?

Group functionality provides a method of creating common interest groups around specific APIs. The creator of a group is the Group Administrator. Member invitations are sent and managed by the group Administrator or designated group leaders. Only Group Administrators and designated group leaders can create Groups.

After a group is established and members have accepted invitations, members can be promoted to a leader status. A leader is indicated on a group member account with an orange Leader status. Leaders can send out additional invitations and manage memberships within their specific group. Group members can collaborate on the group Board that is only visible to group members. Group members can obtain a view-only summary of members in their group on the Group Details page.

Group members can provide feedback on the group by providing a Peer Rating that uses a star rating system to record positive feedback, or Peer Review where you can write and post a review about the group.

The platform supports both Independent and Private API Groups. See What types of groups does the platform support?

Independent and Private API Groups have different access methods in the UI, but their functionality is essentially the same (except where noted). See How do I access Independent or Private API Groups? for access methods.

Back to top

What types of groups does the platform support?

The platform supports the following group types:

Back to top

What are the components of the Groups page?

The APIs section includes a Groups page that allows API Administrators to create Private API Groups and send out invitations to developers. Group members can also be promoted to a Leader status and send out invitations and manage memberships within their specific group.

Create a Group

API Administrators can create a group for the current API and send out invitations to developers to join the group. The first time you select APIs > Visibility > Groups, the Groups page displays the "This API does not have any groups" message along with the Create a Group button. After creating a group, you can select Invite More to send out invitations to developers to join the API group.

Edit Group Info

The Edit Group Info function allows you to edit the Group Name, Description, and Federation Member.

Invite More

The Invite More function allows API Administrators to send invitations to individuals that you would like to be part of your Private API Group.

Note that invitees must be platform members to except an invitation. After sending the invitation, an invitation email is issued. The recipient (if already a platform member), can log into the platform and accept the invitation via their Dashboard. If the recipient is not currently a platform member, they must sign up, and then log in to accept the invitation via their Dashboard.

Manage

After sending out your first group invitation:

Group Board

The Group Board provides a collaboration tool where group members can discuss key topics and exchange ideas. The Group Board is available through the independent group interface only (i.e., Add a New Group from the Plus menu).

Followers

The Followers page allows users to subscribe to groups they are interested in by clicking the Follow button. Subscribing to a group allows users to receive news or updates relating to the group on their personal Dashboard.

Back to top

Create Group:

How do I access Independent or Private API Groups?

To access an Independent Group:
  1. Click the My Groups search filter in the top navigation. The Group Summary page displays.
To access a Private API Group:
  1. Click My APIs > API Name > Visibility > Groups. The Group Summary page displays.

Back to top

How do I create a group?

To add a group:
  1. Navigate to the Groups page. See How do I access Independent or Private API Groups?
  2. To create a group, click Create a Group. The Start Your New Group page displays. The Start Your New Group page allows you specify a Group Name and Group Description, select a Federation, and assign a Group Icon.
  3. Enter the following information:

    Field Name Description
    Group Name A text box that allows you to specify a descriptive name for your group.
    Group Description A text box that allows you to specify a detailed description of your group.
    Tags A text box that allows you to enter tags or keywords that can be used to search for posts or tickets in the Group Board.
    Visibility A radio button that allows you to set the visibility value for your group.

  4. In the Group Icon section, you can upload an icon for your group. See How do I upload and crop icons? for details on configuring your Group Icon.
  5. Click Save. The group is defined and displays in the summary listing.

Back to top

Group Roles:

What are the group roles?

The group function supports the following roles, functions, and visibility.

Group Role Functions / Visibility
Group Administrator Functions:
View in My Groups
View APIs > Visibility > Groups section (for Private APIs)
Create a Group
Invite members
Assign members Leader status with Make Leader
Unassign Leader status with Make Member
Resend invitation
Remove members

Visibility:
Can view APIs > Visibility > Groups page (Private API), and My Groups page including Create a Group, Make Leader, Make Member, Invite More, Remove, and Resend. All Groups and members for all groups are visible.
Leader Functions:
View in My Groups
View APIs > Visibility > Groups section (for Private APIs)
Invite members
Assign members Leader status with Make Leader
Unassign Leader status with Make Member
Resend invitation
Remove personally invited members

Visibility:
Can view APIs > Visibility > Groups page (Private API), and My Groups page but Create a Group, and Group members not personally invited are not visible. Invite More is available, and Make Leader, Make Member, Remove and Resend are available to manage personally invited members. Only Groups that the Leader belongs to are visible.
Members Functions:
View in My Groups
View APIs > Visibility > Groups section (for Private APIs)

Visibility:
A read-only summary listing of group members is visible on the APIs > Visibility > Group page to Members/ Non-Leaders and My Groups page.

Back to top

How does the Leader role work?

API Administrators can make group members administrators by assigning them a Leader role. A Leader can send and manage their personal invitees. When a group member is initially added they are a Member and the Leader identifier is white.

To assign the Leader role:
  1. Navigate to the Groups page. See How do I access Independent or Private API Groups?
  2. Click the name of the group you would like to manage. The Group Details page displays.
  3. Click Members in the left navigation. The Members page displays.
  4. To assign the Leader role, click Make Leader. The following message displays: You are assigning the role of group leader to <group member name>. Are you sure you want to go ahead?
  5. Click Confirm to complete the assignment. The identifier label changes from Member to Leader.
To unassign the Leader role:
  1. Navigate to the Groups page. See How do I access Independent or Private API Groups?
  2. Click the name of the group you would like to manage. The Group Details page displays.
  3. Click Members in the left navigation. The Members page displays.
  4. To unassign the Leader role, click the Make Member. The following message displays: You are removing group leader <group member name>. Are you sure you want to go ahead?
  5. Click Confirm to unassign the Leader role. The identifier label changes from Leader to Member.

Back to top

Invite Members:

How do I invite someone to a group?

If you have been assigned a Leader role by the Admin Team, you can use the Invite function to send invitations to developers or individuals you would like to invite to a group. If you are not currently assigned a Leader role, contact the Admin Team by sending us an email from the form provided on the Support page.

After a Group Administrator adds a group using the Create a Group function in APIs > Visibility > Groups or My Groups > Members, the Invite function displays next to the Group Name on the Members page. Group Administrators and Leaders can use the Invite function to invite individuals to the group.

To invite someone to a group:
  1. Navigate to the Groups page. See How do I access Independent or Private API Groups?
  2. Click the name of the group you would like to invite members to. Click Members. The Members page displays.
  3. Click Invite. The Invite Group Members page displays.
  4. In the "Email" text box, enter the email address of individuals you would like to invite to the API group. Each email address must be comma separated. Note: Invitees that are not platform members must sign up prior to accepting the group invitation.
  5. After you have specified your invitees, you can customize an invitation message in the "Add a Brief Message" text box.
  6. Click Send Invite.
  7. After the invitation is submitted:
    • The Group Summary page for the group associated with the request displays a "Pending" status.
    • An invitation email is issued to the specified email addresses.
    • If the invitee is a platform member, an "Invite Request" ticket is issued and a notification is posted to the Dashboard of the invitee that says "You have been invited to the <group name> group."
    • If the invitee is not a platform member, they must first sign up, then accept the Private API group request via the invitation email.
    • A request is also posted to the API Administrator's Board.
    • The platform member can manage the group Invite by accepting or declining it via their Dashboard, and can also post a comment.
    • The platform member's notification and the ticket in the API Administrator's Board is then updated with the status (Membership Accepted or Membership Declined).
    • After accepting an invitation, the group member can then participate in the API Board.

Back to top

Can I invite non-members to a group?

You can invite individuals who are not platform members to an Independent or Private API groups, but non-members must sign up before they can accept the group request via their personal Dashboard page.

Back to top

How do I accept an invitation to a group?

You can accept an invitation to join an independent group or a Private API Group by approving the notification in your personal Dashboard.

To accept an invitation to a group:
  1. Log in to the platform (you can click the link in the invitation email) and go to your Dashboard page.
  2. Find the group invitation notification.
  3. Click Accept. Enter a comment if you want to, and then click Confirm.

Back to top

How do I decline an invitation to a group?

You can decline a group invitation by selecting the Decline option in the notification in your personal Dashboard.

To decline an invitation to a group:
  1. Log in to the platform (you can click the link in the invitation email) and go to your Dashboard page.
  2. View the group access notification.
  3. Click Decline. Enter a comment if you want to, and then click Confirm.

Back to top

after_i_become_a_group_member_can_i_invite_developers_to_the_group

After I become a group member can I invite developers to the group?

If you have been assigned a Leader role by the Group Administrator, you can use the Invite function to send invitations to developers. If you are not currently assigned a Leader role, you can request a role change by submitting a trouble ticket to the Group Administrator via the My Groups > Board or API Board.

Back to top

Group Maintenance:

How do I edit group information?

To edit group information:
  1. Navigate to the Groups page. See How do I access Independent or Private API Groups?
  2. Click the group name that includes a group you would like to update group information for, the Details page displays.
  3. Click Edit. The Edit Group Info page displays.
  4. The Edit Group Info page allows you to update the Group Name and Description.

    Field Name Description
    Group Name A text box that allows you to specify a descriptive name for your group.
    Group Description A text box that allows you to specify a detailed description of your group.
    Tags A text box that allows you to enter tags or keywords that can be used to search for posts or tickets in the Group Board.
    Visibility A radio button that allows you to set the visibility value for your group.
  5. Update the Group Name, Group Description. Tags, and Visibility then click Save. The group information is saved and posted to the Groups page.
  6. To exit this operation, click Cancel.

Back to top

How do I remove a group member?

API Administrators can remove a group member. Leaders can remove group members they have personally invited.

To remove a group member:
  1. Navigate to the Groups page. See How do I access Independent or Private API Groups?
  2. Click the group name that includes a member you would like to remove. The Details page displays.
  3. Click Members. The Members page displays.
  4. Target the group that includes a member you would like to remove.
  5. To remove the member, click Remove.

Back to top

How do I resend a group invitation?

It certain situations it may become necessary to resend a group invitation.

To resend an invitation for group membership:
  1. Navigate to the Groups page. See How do I access Independent or Private API Groups?
  2. Click the group name that includes a member whose invitation you would like to resend. The Details page displays.
  3. Click Members. The Members page displays.
  4. To resend the group invitation, target invitation in the list and click Resend.

Back to top

How do I delete a group?

You can delete a group in My Groups or in the APIs > Visibility > Groups section as follows:

To delete a group via My Groups:
  1. Click the My Groups quick filter in the top navigation. The Group Summary page.
  2. Choose a group from the listing and click Delete Group. The confirmation message "Do you really want to delete this group?" displays. Click OK. Your group is deleted.
To delete a group via APIs > Visibility > Groups:
  1. Navigate to APIs > Visibility > Groups. The Group Summary page displays.
  2. Click the group name of a group you would like to delete. The Group Details page displays.
  3. Click - Delete. The confirmation message "Do you really want to delete this group?" displays. Click OK. Your group is deleted.

Back to top

Where can I find review information for each group?

Each Group includes rating and review information submitted by platform community members. The information is available on the Group Details page as follows:

Back to top

How do I rate a group and write a review?

You can rate and write a review for a group on the Group Details page as follows:

To rate a group:
  1. Navigate to the Groups page. See How do I access Independent or Private API Groups?
  2. Click the group name you would like to rate. The Group Details page displays.
  3. Go to Rate this Group in the Peer Rating section and click the star that represents the level of positive feedback you would like to submit for the current group. The rating counter increments by one next to the star rating you selected and the star rating turns red.
  4. You can change your rating by selecting another star.
To write a review for a group:
  1. Navigate to the Groups page. See How do I access Independent or Private API Groups?
  2. Click the group name you would like to review. The Group Details page displays.
  3. Go to the Write a Review section.
  4. In the "Title" text box, enter a title for the API review.
  5. In the "Review" text box enter the review contents.
  6. After writing your review click Save. Your review is posted.
  7. Community members can now read your review and rate whether it was helpful.

Back to top

How do I edit a group review?

If you've added a group review and would like to change the content, you can edit the review on the Group Details page as follows:

To edit a group review:
  1. Navigate to the Groups page. See How do I access Independent or Private API Groups?
  2. Click the name of the group that includes the review you would like to edit. The Group Details page displays.
  3. In the Write a Review section, click into the text box that says Update review. The title and content of your review displays. Edit the content as needed, and click Save.

Back to top

How do I delete a group review?

You can delete a group review on the Group Details page.

To delete a group review:
  1. Navigate to the Groups page. See How do I access Independent or Private API Groups?
  2. Click the name of the group that includes the review you would like to delete. The Group Details page displays.
  3. In the Write a Review section, click into the text box that says Update review. The title and content of your review displays.
  4. Below the "Review" text box, click Delete your review. The confirmation message "Are you sure?" displays. Click OK. Your review is deleted.

Back to top