Configuring Approvals for Updating Application

Edit online

About this task

You have to configure the approval settings, to enforce approval for modifying an existing application in API Gateway. The subscription usage is counted against the existing plan and package combination until an approver approves the change of plan or package request. Once an approver approves the change request, quota is reset.

To configure approvals for updating an application

Procedure

  1. Expand the menu options icon , in the title bar, and select Administration.
  2. Select General > Approval configuration > Update application.
  3. Set the Enable toggle button to the on position to enable approval configuration to take effect.
  4. Select the team of approvers from the Approvers drop-down list.
  5. Select Anyone from the Approved by drop-down list.
    This implies that, any one user associated with the selected team can approve or reject the requests. The requester need not wait for the approval of each approver in the approvers group.
    Note: If a user is associated with the team, then the user can approve or reject a pending request.
  6. Select the Team approvers option to allow the team approvers to approve the pending requests of applications that the team is associated with.
    You can specify the users and user groups (Team approvers) in the Approvers section when creating or editing the team details. The Team approvers list will also include the users and user groups specified in the Team Administrators section, if the Include team administrators as approvers option is selected.
  7. Select the Disable auto-approval of the requestor option to specify that applications cannot be automatically approved when they are created by users who have the privilege to approve application creation requests.
    If you do not select this option, then the applications created by users who have the required privileges are automatically approved.
  8. Select Configure approval initiate request mail template to be sent to approver.
    This is to configure the email template to be sent to the approver for approving the request of modifying an existing application.
  9. Provide the following information in the Configure approval initiate request mail template to be sent to approver section:
    Field Description
    Send notification To send an email notification to the approver to approve the request for modifying an existing application.
    Subject The subject line of the email to be sent.
    Content By default, the template appears. You can customize the email content.
    Note: The @ character acts as a place holder and the values are automatically generated by the system. For example, Hello @approver.name appears as Hello Joe in the email sent, where Joe is the approvers login ID.
    Note: The email notifications are sent only to the local API Gateway users.
  10. Select Configure request approved mail template to be sent to requester.
    This is to configure the email template to be sent to the requester to notify that the request for modifying an existing application is approved.
  11. Provide the following information in the Configure request approved mail template to be sent to requester section:
    Field Description
    Send notification To send an email notification to the requester that the request for modifying an existing application is approved by the approver.
    Subject The subject line of the email to be sent.
    Content By default, the template appears. You can customize the email content.
    Note: The @ character acts as a place holder and the values are automatically generated by the system. For example, Approval of @event.type appears as Approval of Update Application in the email sent, where Update Application is the event.type.
  12. Select Configure rejection mail template to be sent to requester.
    This is to configure the email template to be sent to the requester to notify that the request for modifying an existing application is rejected.
  13. Provide the following information in the Configure rejection mail template to be sent to requester section:
    Field Description
    Send notification To send an email notification to the requester that the request for modifying an existing application is rejected by the approver.
    Subject The subject line of the email to be sent.
    Content By default, the template appears. You can customize the email content.
    Note: The @ character acts as a place holder and the values are automatically generated by the system. For example, Approval of @event.type appears as Approval of Update Application in the email sent, where Update Application is the event.type.
  14. Click Cancel to revert to the last saved changes or to abandon all the changes if the values are not saved.
  15. Click Save.