Groups

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

API Platform Version: 8.1 and later

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 API context groups?
Create Group:
  1. How do I add an independent group?
  2. How do I add an API context group?
Group Roles:
  1. What are the group roles?
  2. How does the Group Leader role work?
  3. How does the Group Admin 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?
Reviews:
  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?
  5. Related Topics

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.

There are three tiers of group membership: Administrator, Leader, and Member.

The user who creates the group becomes the first Administrator. Another user invited to the group for the first time becomes a Member. Once a user is a group Member, an Administrator can change the member's status to Leader or Administrator.

Leaders can send out additional invitations and manage memberships within their specific group. Group members can collaborate on the group Forum 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 API Context Groups. See What types of groups does the platform support?

Independent and API Context 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 API Context Groups? for access methods.

Back to top

What types of groups does the platform support?

The platform supports the following group types:

  • Independent Group—This group type allows you to create and manage special interest groups. You can set the visibility of the group as Public, Registered Users, or Private. You can create an independent group in one of two ways:
    • Use the Add a New Group function via the Plus menu to create an independent group. See How do I add an independent group?
    • In the context of an API, create a group, and click the independently managed? checkbox.
  • API Context Group—This type of group is exclusively related to the API it's associated with. If the API is deleted, the group is automatically deleted. To create an API context group:
    • Choose My APIs > API name > Visibility> Groups, then click Create Group as shown below. For Independently managed? click No. Provide values and save.

      API Context Groups

Note: If the Create Group button is not available, you do not have permission to add a group. If this occurs and you need to add a group, contact the Site Admin.

Back to top

What are the components of the Groups page?

The APIs section includes a Groups page that allows API Administrators to create API Context Groups and send out invitations to developers. Group members can also be promoted to 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, you'll see a message that the API doesn't have any groups. You can click Invite Group to invite one or more groups to the API. To add a new group for the API, you must first create it via the Plus Menu and then invite the group to the API.

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 API Context Group.

Note: An invitee must sign up to the platform to accept 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:

  • The invitee receives a request in their Dashboard. Here the invitee can Accept or Decline the invitation.
  • API Administrators can assign or unassign a member a "Leader" role and Leaders can assign or unassign a member they have personally invited a "Leader" role.
  • On the Members page, API Administrators or Leaders can view a summary of information for group members including username, email address, and invitation status.
  • Administrators or Leaders can reissue an invitation using the Resend function.
  • Administrators can remove a member and Leaders can remove a member they have personally invited.

Group Forum

The Group Forum provides a collaboration tool where group members can discuss key topics and exchange ideas. The Group Forum is available through the independent group interface only (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

How do I access Independent or API Context Groups?

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

Back to top

Create Group:

How do I add an independent group?

To add an independent group:
  1. In the top navigation bar, click the Plus icon and choose Add a New Group.
  2. In the Start Your New Group page, 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 Forum.
    Visibility A radio button that allows you to set the visibility value for your group.

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

Back to top

How do I add an API context group?

You can invite an existing group to have visibility of the API.

Note: you can only add an API context group if you are an Admin for the API. Also, the feature must be enabled in the platform.

To add an API context group
  1. Log in as the API Admin and go to the My APIs page.
  2. Choose the API and then, from the left menu bar, click Visibility > Groups.
  3. Click Invite Group.
  4. On the Groups List, find the group that you want to invite, and then click OK.

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 or unassign Admin status for other members
Assign or unassign Leader status for other members
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 or unassign Leader status for other members
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 > Groups page to Members/ Non-Leaders and My Groups page.

Back to top

How does the Group Leader role work?

A group Administrator or Leader can assign the Leader role to an existing group member. A Leader can send and manage their personal invitees. A group member being added for the first time becomes a Member. After that point, a Leader can make that member a Leader; an Admin can make the member a Leader or Admin.

If you have the Leader role you can:

  • Invite group members.
  • Make an existing member a Leader, or make an existing Leader a member.
To assign or unassign the Leader role:
  1. Navigate to the Groups page. See How do I access Independent or API Context Groups?
  2. Click the name of the group. The Group Details page displays.
  3. In the left navigation bar, click Members. The Members page displays.
  4. Click Make Leader or Make Member.
  5. At the confirmation message, click Confirm.

Back to top

How does the Group Admin role work?

A group Administrator can make another group member or Leader an Administrator. Administrators have full rights for the group. They can:

  • A Leader can send and manage their personal invitees.
  • When a group member is initially added they are assigned the Member role and the Leader identifier is white.
  • Members with the Leader role can assign the Leader role to members that they personally invite.
To assign the Admin role:
  1. Navigate to the Groups page. See How do I access Independent or API Context Groups?
  2. Click the name of the group. The Group Details page displays.
  3. In the left navigation bar, click Members.
  4. Find the user on the list, and click Make Admin.
  5. At the confirmation message, click Confirm.
To unassign the Admin role:
  1. Navigate to the Groups page. See How do I access Independent or API Context Groups?
  2. Click the name of the group. The Group Details page displays.
  3. In the left navigation bar, click Admins.
  4. Find the user on the list, and click Make Member or Make Leader.
  5. At the confirmation message, click Confirm.

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 API Context 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 one or more email address of individuals you would like to invite to the API group. Use a comma separator between multiple email addresses. Note: Invitees who are not platform members must sign up before 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 API Context Group request via the invitation email.
    • A request is also posted to the API Administrator's Forum.
    • 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 Forum is then updated with the status (Membership Accepted or Membership Declined).
    • After accepting an invitation, the group member can then participate in the API Forum.

Back to top

Can I invite non-members to a group?

You can invite individuals who are not platform members to an Independent or API Context 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 an API Context 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?

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 > Forum or API Forum.

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 API Context 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. Update the Group Name, Group Description. Tags, and Visibility, as needed. A summary of fields is shown below.

    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 Forum.
    Visibility A radio button that allows you to set the visibility value for your group.
  5. Click Save.

Back to top

How do I remove a group member?

An API Admin can remove a group member or leader. A leader can remove a group member.

To remove a group member:
  1. Navigate to the Groups page. See How do I access Independent or API Context Groups?
  2. Click the group name. The Details page displays.
  3. Click Members. The Members page displays.
  4. Find the member's name on the list, and 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 API Context 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

Reviews:

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:

  • Peer Rating—This section uses a star rating system to record positive feedback. A rating counter displays feedback for each rating number (1-5 stars), and displays an average rating.
  • Peer Review—This section provides a list of written reviews submitted by the platform community for the current Group. You can browse the reviews and filter information by Most Recent, Most Popular, Current or All versions, or enter a Search tag. You can also give the review a thumbs up in the "Was this review helpful?" section.

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 API Context 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.
To write a review for a group:
  1. Navigate to the Groups page. See How do I access Independent or API Context 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. 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 API Context 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 API Context 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. At the confirmation message, click OK. The review is deleted.

Back to top