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 edit app version information?
5. How do I delete an app version?
6. How do I delete an app?
7. How do I export an app?
8. What are the contents of the app export file?
9. How do I import an app from an export file?

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. Depending on platform settings, the shared secret might be encrypted when displayed. A Shared Secret can be regenerated for a specific app using the Regenerate Key function on the App Details page.
   Visibility	Your app's visibility setting: Public, Private, or Registered Users.
   App Description	A detailed description of your app.
   Version Description	A detailed description of your app version.
   App Website	A URL for the website associated with the app.

   
   
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 edit app version information?

You can change app version information using the Edit function in the App Details page.

To modify app version information:

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

How do I delete an app version?

You can delete an app version on the App Details page.

Note: If you want to delete an old version and add a new version, add the new version first. If you delete the only version, the app is deleted. If you add the new version, you can then delete the older version.

To delete an app version

1. Navigate to My Apps.
2. From the Version menu at the top right of the page, choose the version you want to delete.
3. Click Delete Version.
4. At the confirmation message, click OK. The app version is deleted.

Back to top

How do I delete an app?

When there is only one version of an app, and you delete it, the entire app is deleted. If there is more than one version, and you want to delete the app, you must delete each version separately.

Note: In some cases, the platform might be set up so that deleting an app requires Business Admin approval. If this is the case, and you attempt to delete the app, you will see a message that the deletion request has been sent for approval. The app is inactivated pending approval; at this point, only the Business Admin can make changes. When the Business Admin approves the request, the app is fully deleted. If for any reason the Business Admin denies the request, the app is restored to normal operation.

To delete an app

1. Follow the instructions in To delete an app version above.
2. The confirmation message warns you that deleting the last version deletes the app. Click OK to confirm. The app is deleted.

Back to top

How do I export an app?

You can export information about an app to an external file. You can then import that file to another instance of the platform. One use of this feature is to move data from one environment to another, such as from a development environment to a testing or production environment.

You can choose to export information about a single app version or all app versions. You can also choose whether or not to export additional data associated with the app.

To export an app:

1. Navigate to the Details page for the app (My Apps > choose the app).
2. Click Export.
3. In the Export overlay, choose export versions (current version or all versions) and choose export options. If you want to export all information about the app, check all boxes. You can choose to export the following additional data associated with the app:
   • Export App PKI
   • Export API Contracts
   • Export App Team Members
     Note: the relationship of the user as an app team member is exported, but the user is not exported. The user must exist in the target environment. If the user does not exist when the information is imported, the app is created without that team member. From there, either a) the user can sign up and be invited to be an app team member, b) the user can sign up and the app data can be reimported, c) another individual can be designated as an app team member.
4. Click Export.
5. Choose to save or open the export file. By default, the export package file is named application-export.zip and is saved to your default downloads folder.

Back to top

What are the contents of the app export file?

The app export file includes all the core information about the app, as well as any of the optional additional information you specified.

The file has a very specific structure. It will generally include the following files at root level:

• objectgraph.xml: An XML file that shows the relationships between resources.
• objectdata.xml: An XML-based summary of all the data in the export file.
• exportproperties.properties: a properties file showing which options were included in the export file.

If PKI information was chosen to be exported, it is stored in a separate pki subfolder.

Back to top

How do I import an app from an export file?

Any member of the app team, or a Business Admin, can export information about an app to an external file. However, only a Business Admin can import.

If you need help with import functions, contact your Business Admin.

If you are a Business Admin, refer to How do I import site, app, or API information from an export file? for instructions.

Back to top