Bixby Developer Center

Guides
References

Developer Console

With the Developer Console, you can manage your teams and their members, register new capsules, administer your capsules and collaborators, and view analytics for published capsules. This guide walks through how to use the Console to manage your teams and capsules.

Opening the Developer Console

Click the Developer Console link in the Bixby Developer Center's sidebar to open the Console in a new tab or window. If you belong to at least one team, the Console's front page opens with your team (or first team) selected and a list of the team's capsule(s) for which you have read access.

Opening screen of the Developer Console

From the front page, you can:

If you do not belong to a team yet, you must create one to continue.

You can always return to the Console's front page by clicking Developer Console or the Bixby logo in the upper left corner of the Console window.

Create a Team

If you're not a member of a team yet (and you aren't following an invitation email to join an existing one), you will be prompted to register one. If you already belong to at least one team, you can create a new team by clicking on your account icon in the upper right corner of the Developer Console, clicking on the current team name to switch teams, and selecting Create new team.

Form for registering a new team

Note

You're currently limited to creating three teams. If you need more than three teams, please contact Bixby support.

To register a team, provide:

  • A Team Name. This should be a human-readable name, such as the name of your organization or company division, like "Bixby Developers".
  • A namespace. Capsules in Bixby are uniquely identified by an ID composed of an organizational namespace and the capsule name separated by a dot (.) character. If you specify a namespace of rutabaga, then a capsule named shirt will have a capsule ID of rutabaga.shirt. This ID will be used in your capsule.bxb file.
  • In addition, you can specify an email address, a web site, and a description for your team.

A unique namespace is required to submit capsules to the Bixby Marketplace. Namespaces can only include lowercase letters, numbers, and underscore characters. Additionally, the namespace must comply with our Terms and Conditions, including section 2.4(h), which prohibits choosing a name for any Licensee Services that is substantially similar to the name of a Samsung or third-party application in a way that creates consumer confusion, or "squatting" on application names to prevent legitimate Samsung or third-party use of the name.

If you aren't a team admin, you might be invited through email to join an existing team. In this case, you won't need to register the team through the Developer Console.

If you are just starting and you want to execute and debug your capsule using the Simulator or with stories, you can use the playground namespace. Another special namespace is example, which is used for sample capsules. However, you cannot submit capsules that use these special namespaces. Once you have tested your capsule using these special namespaces, and you are ready to submit your capsule, you should follow the normal process here to create a team, register a capsule, and update your capsule ID in your capsule.bxb file.

Note

Your team's ability to execute capsules in Bixby Developer Studio, view submissions and submission details, or submit capsules depends on whether you have the correct permissions. Therefore, ensure that you register a namespace, your capsules are registered under that namespace, and the appropriate team members are collaborators for those capsules.

Keep in mind that once a namespace has been created, it cannot be changed for that team! You can update other team information, but namespaces are permanent.

Edit Profile Info

Regardless of your permissions, you can edit your profile to add a display name and profile picture. This allows fellow team members to better identify you.

  1. Select Manage Account from the drop-down menu in the upper-right corner of the screen.
  2. Select Edit Profile.
  3. Edit your display name and profile image.
  4. Click Update.

Edit Profile Info

Note

To edit Samsung Account information, visit the Samsung Account page.

Manage Team

To edit team information and add or remove team members, click Manage team > on the Console's front page, or click on your account icon in the upper right corner of the Developer Console and select *Manage Team in the drop-down menu.

Invite Members

If you are an admin of an existing team, you can invite others, as members or admins, using their email address. From the Manage Team page, click + Invite Members.

Invite Members form

  1. Click the + Invite Members button on the Manage Teams page.
  2. Type one or more email addresses of members to invite. If you're inviting more than one person, type the addresses on separate lines, or separate them with commas.
  3. Choose Member or Admin as the role for the invited members. If you need to invite members of both role types, invite the members and the admins separately.
  4. Click Submit.

Managing Members

The Manage Team page will list both members and pending invitations.

Register Capsule

You can make any team member an admin by hovering the mouse pointer over their info card and clicking the Make Admin button that appears.

Invitations that have not been accepted will show as "Invite Pending." You can cancel an invitation by hovering the mouse pointer over their info card and clicking the Cancel Invite button that appears.

Edit Team Info

If you are a team admin, you can update team information, such as the team name, website, or team logo.

Edit Team Info

  1. Click the Team Info tab in the sidebar on the Manage Teams page.
  2. Edit the information you wish to change. (Note that you cannot change the team's namespace.)
  3. Click Update.

Managing Capsules

Your team's front page is where you register new capsules and manage the release cycle of existing capsules.

Register a Capsule

As a team admin, you can register a capsule, which allows any collaborator to submit it.

Register Capsule

  1. On the Console's front page, click the + Register new Capsule button.
  2. Type the capsule ID.
  3. Click Submit.
Note

You can only use letters, numbers, and underscores for a capsule ID. The capsule name must start with a lowercase letter and be at least three letters long.

You must use the fully-qualified name of the capsule within your capsule.bxb file. This is your team organization name, a dot, and the capsule's name), such as doctest.newcapsule.

Manage Collaborators

Once you've added team members and capsules, you can manage collaborators on each capsule. Being a collaborator allows a member to edit capsule code, submit capsules, and view capsule submissions.

Manage collaborators

  1. On the front page, click the capsule for which you wish to manage collaborators.
  2. Click the Settings tab for that capsule in the top menu bar.
  3. A list of all your team members will appear. Team members who are collaborators on the current capsule will be badged with MEMBER or ADMIN. (Note that "ADMIN" here refers to being an admin for this capsule, not the team as a whole. See Permissions, below.)
  4. Hover the mouse pointer over the member whose status you wish to change; click Add Member, Remove Member, Make Admin, or Demote Admin as appropriate.

Manage collaborators

In addition to adding collaborators, you can also remove them from a capsule.

Managing Configuration Properties

The Settings tab for each capsule also lets you set property keys and values stored on Bixby's servers rather than in your capsule code, making it easier to change configuration values dynamically and keep secret values like API keys and passwords secure. Read about setting Config & Secrets values in the Capsule Configuration reference guide.

Permissions

Here is a summary of the permissions you have depending on whether you are a team member, or capsule collaborator, or team admin.

AbilityCollaboratorCapsule AdminTeam MemberTeam Admin
View capsules and related submissionsYesYesYesYes
Add/remove capsule membersNoYesNoYes
Add/remove team members--NoYes
Make capsule submissionsYesYesNoNo
Register capsules--NoYes
Edit team information--NoYes
Edit Config & SecretsNoYesNoNo†
Execute a capsuleYesYesNoYes
Nominate capsule for releaseNoYesNoYes

† Even for Team Admins, this permission requires you to assign yourself the additional Capsule Admin permission.

Note

You must first be added to a team as a member or admin before you can become a capsule collaborator or capsule admin. Permissions are not mutually exclusive, which means, for example, you could be both a team member and a capsule collaborator.

If your team has any issues while working on a capsule, you can check the Troubleshooting Common Issues with Permissions and Submissions guide. ]

Capsule Analytics

To help you better understand how users interact with your capsule, the Developer Console provides charts showing capsule usage. You can filter these charts to see data specific to targets and time ranges.

Note

Capsule analytics do not provide personally identifiable information about users.

To access capsule analytics:

  1. Open the Developer Console.
  2. Select the team your capsule belongs to, if it is not already selected.
  3. Click on the capsule in the list of capsules.
  4. Click on the Analytics tab.

Capsule analytics include these three charts:

  • Unique Active Users: This chart includes the number of unique users who have used the capsule within a specified amount of time. You can use the two drop-down menus to determine what information to show. The first drop-down determines the time increments shown, ranging from Daily to Monthly. The second drop-down determines how many days to look back upon, ranging from 7 days to 90 days.
  • Total Utterances: This chart includes the number of utterances that your capsule received. It includes the same drop-down menus as Unique Active Users.
  • Top Goals: This chart shows the top 10 training goals that users have reached for this capsule within the last 30 days.
Note

To get information on specific capsule metrics, you can filter both of the charts by choosing specific regions (locales) and devices.