How to use Operations?
Initializing Table Of Contents...This chapter introduces the notion of operations and briefly describes sections dedicated to operations as well as operation specificities.
Introduction to Operations
All actions performed on entities of the AirVantage Operating Portal generate operations.
Once it has been generated, an operation enters process phases characterized by proper statuses:
| Status | Description |
|---|---|
| INITIALIZING | The different tasks of the operation are being created. |
| SCHEDULED | The operation has been created with a scheduled process date and time. |
| IN PROGRESS | The operation is being processed. An operation is processed immediately after initialization. |
| FINISHED | The operation has been processed. Can end either in failure, in success, or in aborted, or in a mix of those 3, if the operation includes several tasks. |
Indication of Launch, Success, Failure, Abort
Immediately after an operation has been launched, and also when the status changes, a block rises at the bottom right of the page to confirm the change of status of the operation:
Operation Launched
Operation Successful
Operation Failed
Operation Aborted
How to know the state of an operation?
Operations can be reviewed in details in three dedicated Operations sections of the Inventory, Monitor and Develop activities, depending on whether they relate to an activity or another.
Operations are listed in similar tables for each activity (here, the Monitor activity), with their Type, Progress (i.e, status), Start time, End time and Creator:
Operations can be filtered using different criteria such as Type, Date, Entity, System, etc…
Operation details can be reviewed by clicking on an operation in the list. The content of the operation details is split into two parts: a first part containing all the general information relevant to the Operation itself, and a second part including information specific to each entity (System, Gateway, Subscription, Application, Alert, …) involved in the Operation.
A progress bar and a filter capability are also present in case of multi – entities operations, to give high level progress information. The filter allows you to easily spot an entity by searching in the search field, or filtering all entities for which an operation failed or succeeded using State entry.
Clicking on the entity of interest in the list of involved entities will reveal additional details about progress of the operation for this selected entity. Details can be an ERROR, a WARNING or an INFO message.
Operation details are accessible from an URL formatted as: https://na.airvantage.net/operation?uid=
. If an operation is set to send an email upon completion, this link is displayed in the body of the notification mail. This is useful to quickly check the operation status.
How to schedule an operation (at a given date, before a date, …)?
As Advanced settings, operations can be scheduled to be processed either:
- At Next connection (i.e., next heartbeat, see ETA in system monitoring details),
- After a given date and time (illustrated below, to be set in the schedule),
- or following a Request connection, depending on whether the server should try to connect to the device instead of waiting for next connection.
Operations can also be set with a Timeout:
- if a timeout is set, its value is used
- otherwise, timeout = 7 days by default (except for Apply Workflow and Preconfiguration operations, which have a default of 1 year, and Post-registration Activation [if the activation switch is on] which has a default timeout of 1 year for ALMS+Connectivity accounts, and 7 days for other accounts)
During communication with a device, the AirVantage waits for a reply from the device for a certain amount of time, usually few minutes (exact value depends on the type of the operation and on the protocol). In case there is no reply from the device, the operation ends in a “timeout” error.
How to apply a label based on the operation result?
Labels can be applied on systems / subscriptions / applications or gateways via the operation results.
- Click on any operation (finished or still in progress) in the Latest Operations widget (systems details page) or in any other operation list. The operation details are displayed.
- Click on the Apply Label command.
- The label can be applied for operations on success , failure/cancel or both. A default label is proposed and can be changed to a label of choice.
How to be notified when an operation completes?
Before completing an action that will generate an operation (for example, change a label on the screenshot below), you can choose to be notified upon operation completion by checking the Send notification when operation completed checkbox at the bottom of operation dialog boxes:
If you decide to be notified of the operation result, you will receive an email including all operation details.
How to abort an operation?
Only operations in status Initializing, Scheduled or In Progress can be aborted. To be noted that for connectivity management, aborting an operation In Progress, will only abort the tasks that are Pending. Tasks In Progress will not be aborted as already submitted to the remote operator provisioning system.
- Click on an operation in progress in the Latest Operations widget (systems details page) or in any other operation list. The operation details are displayed.
- Click on the Abort command.
- Click Yes to confirm. An operation abortion is launched. The operation progress bar turns grey when aborted.
For operations implying communication with a remote system like the device, the abort of an operation may occur while the remote system is processing the request. In that case, the operation will still appear as cancelled, while the device will continue to process the requested task.
How to retry a failed operation
An operation has failed and after a quick check you want to give it another chance? From the operation details screen, it is possible to retry an operation. The retry will be launched on all entities for which the previous operation has failed or been aborted. The parameters taken as entry will be the same as the previous operation. Same functionality is also available from the operations grid or operations notification popups.
How to manage pending Request Notifications
Operations such as transfer gateway generate a request to partners or other users of the company, either as an email or as a pending request notification, which is accessible from anywhere in the AirVantage Management Service:
Only users with the proper profile and rights can view pending request notifications.
Accepting or rejecting a request is quite simple. Just click on the mail icon at the top of any page, then on Accept or Reject. In some cases, you can also be asked to set parameters and/or send a reply to the request initiator (for instance in a request partnership operation):
