App Versioning

Create, edit, and manage App versions.

Table of Contents

1. How does app versioning work?
2. How do I create a new version of my app?
3. How do I change the version ID of an existing app?
4. How do I delete app versions?
5. How do I edit app version information?

How does app versioning work?

During the app development process, the need may arise where you require different app versions. For example:

• You may want to have one app that is strictly a support/testing version, and another that is a production version, or you may want to have variations of your app that utilize different APIs.
• You may want to transfer an app defined on another system to the platform. In this scenario you would use the +Version function on the App Details page to add the app as a version of an app that is already added to the platform and assign a custom App ID and/or Shared Secret.
• You may also want to separate usage monitoring, discussions, and ticket management by app version.

To facilitate this, the My Apps section includes app versioning functionality that allows you to create a new instance (i.e., version) of an existing app.

App Version Composition

When you create your first app (i.e., Version 1.0):

• You define an App Name and a system generated Version ID is assigned.
• A Current Version menu item is displayed on the My Apps title bar.

Create New App Version

After creating your Version 1.0 app, you can then create an app version using the + Version function accessible via the App Details page.

• An App Version name is composed of the Version ID (i.e., App Name).
• The Version ID is accessible via the Current Version menu. You can also assign Version Notes and Tags to further identify the app version definition.
• You can assign a custom App Runtime ID and/or Shared Secret.
• The Version ID can be modified using the Edit function on the App Details page.
• After creating your app version, you can then assign credentials, submit an API Access Request, and perform app management activities.

Note: When the app version is created, the platform also auto-generates an internal App ID. This App ID is what you use in API calls. Refer to the API documentation in the API > Documents section for more information. .

Viewing App Versions

You can navigate to an app version by selecting it on the Current Version menu.

Team Management

In My Apps, Team Member assignments apply to ALL apps versions. A unique set of Team Members cannot be assigned to a specific app version.

App Management

App versions can be managed using a variety of different tools available in the App Details page.

Back to top

How do I create a new version of my app?

To create a new app version:

1. Navigate to My Apps > App Details for the app you would like to create a version for.
2. Select + Version. The Edit App Info page displays. The following information displays:
   
   

   Name	Description
   App Name	A read-only field that displays the descriptive name for your app.
   Version ID	A text box that allows you to specify the app version name. This name will display on the Overview section of the My Apps > Details page.
   Tags	A text box that allows you to enter tags or keywords that can be used to search for posts or tickets in the App or API Boards.
   App Runtime ID	A text box that allows you to enter a custom app identity for the current app definition. If left blank, the app will be randomly assigned an App ID (i.e., identity) in the format <fedmember> - <random-hex>. Note that an App ID cannot be changed after an App ID is assigned. You must create a new app version using the +Version function on the App Details page and issue a custom app identity.
   Shared Secret	A text box that allows you to enter a custom Shared Secret for the current app definition. If left blank, a shared secret is automatically generated and can be viewed using the Show Keys > Click to View function on the App Details page. A Shared Secret can be regenerated for a specific app using the Regenerate Key function on the App Details page.
   Visibility	A radio button that allows you to configure whether you would like your app to be public or private.
   App Description	A read-only field that displays your app description.
   Version Description	A text box that allows you to specify a detailed description of your app version.
   App Website	A text box that allows you to specify a URL for the website associated with the app you are defining.

   
   
3. Specify the Version ID, Tags, App Runtime ID (auto-generated if not specified), Shared Secret (auto-generated if not specified), Visibility (Public/Private), Version Description, and App Website (optional). Click Confirm to commit your changes.

Back to top

How do I change the version ID of an existing app?

The "Version ID" (i.e., name) of the app version can be changed using the Edit function on the App Details page. See How do I edit app version information? for instructions.

Back to top

How do I delete app versions?

Deleting an app version is standard app management task. See How do I delete my app? for details.

Back to top

How do I edit app version information?

App version information can be changed using the Edit function in the App Details page. To do this:

1. Navigate to My Apps and select the app that includes information you would like to update. The App Details page displays.
2. Select the app version from the Current Version drop-down menu.
3. Select Edit. The Edit App Info popup displays.
4. Update the version information (App Name, Version ID, Tags, App Description, Version Description, and App Website). Click Confirm to commit changes.

Back to top