1. What does this page cover?
Learn about the Clients section and how to distribute your applications privately with your clients through the Zoho Developer Console.
2. Availability
- The super admin can create applications, add clients, and manage the distribution process within the Developer Console.
- The developers can send updates of the distributed applications with the clients if the relevant permission has been provided by the super admin.
3. Steps to create and distribute an app
3.1 Creating an app
Note: Only the super admin of an account can create an application and add clients to distribute the application with. A developer can only send updates of an application to a client, if the distribute access has been provided by the super admin.
You can start creating applications in Zoho Developer Console by following the steps mentioned on the
Creating and Managing apps page. Once the app is created, you can continue to add developers to your account to assist with its development. When the application is ready to be distributed privately with your clients, you can follow the steps below.
3.2 Adding Clients & distributing Applications
1. Navigate to Clients under the DEPLOY section in the left pane of your Developer Console account. Click the Add Client button.
2. Enter the client's email address in the popup that follows. An invitation will be sent to the client. Once they accept, you can begin distributing your applications with them.
Note: The invitation to be a client expires after 15 days. You can still resend the invitation to the clients.
Note:
- In order to add a client to the account, they must have a Zoho Creator account with a super admin profile in the same DC.
- If your client hasn't accepted the invitation, you can resend the invitation by clicking Resend Invitation from the horizontal ellipsis.
3. Click the horizontal ellipsis next to a client and select
Share Application.
4. Choose the application name and the version that you would like to distribute. An installation link will be sent to the client.
Once the installation link is sent to the client, they can accept the invitation sent to their email, then install the application in their Creator account.
Note: To delete a client, click the Delete option under the horizontal ellipsis. This can only be done if the client has not yet installed the application.
3.3 Manage Client applications and updates
As the super admin or developer, you can manage the applications distributed with your clients to send an application installation link, an updated version of your application, or a mandatory update.
1. Navigate to Clients under the DEPLOY section in the left pane of your Developer Console account.
2. Click on a client, and a slider with a list of the applications distributed with that client will appear.
3. To send an update, click the Send Update button to send an updated version of the application. A popup will appear.
Note: This button will only be available when a new or updated version of the application is available for the client.
4. Choose the version that you want to distribute with your clients in the popup. Click Send Update.
Note: The client email, application name, and the current version will be auto-selected. Once the update is sent, the client can update the application from their Zoho Creator account.
Once the installation link or update is sent, the status will reflect one of the outcomes described in the table below, depending on whether the update is successful, fails, or requires further action.
Status
|
Explanation
|
Invitation sent
|
An invite was successfully sent to the client for a version of an application on a specific date, allowing them to install the app.
|
Installation failed
|
The attempt to install the version was unsuccessful, possibly due to technical issues or client-side errors. Try sending the latest version to be installed again.
|
Update sent
|
A new version was sent to the client on a specific date, making the latest improvements and features available.
|
Update failed
|
The update to the new version encountered an error on the client's side, leaving the client with an outdated version. Click the View button next to the application status to see the error details.
Note: Failure in updating will not affect the client application. They can still continue using the app.
|
Mandatory update
|
A compulsory update for a version was dispatched on a specific date, ensuring all clients must update to this version within 30 days.
Note: Only 30 active versions are allowed at a time. A mandatory update can be sent only to clients using a deprecated version. If a mandatory update is not sent to these clients, publishing to the Stage environment for the app will be blocked until the update is issued.
|
Mandatory update failed
|
The update to the mandatory version encountered an error on the client's side, leaving the client with an outdated version. Click the View button next to the application's status to see the error details.
|
3.4 Filtering Applications by Version
To manage the distribution of applications to your clients efficiently, you can apply filters based on the application version. This filter feature allows you to quickly manage and monitor which clients have the desired version of your application and target specific clients for updates or support.
1. Click the Filter button present in the top right corner of the page.
2. Choose the application from the dropdown list for which you want to filter the clients.
3. In the filter panel, select the Operator that specifies how the application version should be filtered. You can select from the following operators:
- greater than: Displays clients who have a version greater than the specified one.
- less than: Shows clients with versions lower than the selected version.
- equal to: Shows clients with versions equal to the selected version.
- is active: Displays clients who are using an active version of the selected application.
- is deprecated: Displays clients who are using a deprecated version of the selected application.
4. Choose the operator and select the Version Number you wish to filter from the available list. You'll only need to specify the version number if the operator you've chosen is greater than, less than, or equal to.
5. Click the Filter button to see a refined list of clients based on the criteria you have chosen.
- Understanding Developer Console
- Understanding environments
- Understanding private distributions of apps
Previous step
Make sure you understand what is
private distribution to ensure a smooth deployment process for your privately distributed applications.