webMethods and Intelligent Business Operations 10.2 | API Portal Administrator's Guide | Configuring API Portal | Configuration Settings
 
Configuration Settings
You can configure the configuration settings tenant-wide from this page. The various configuration parameters are described in the following table.
Parameter
Description
Example for values
LDAP user registration setting
Defines the LDAP user registration setting
STRAIGHT-THROUGH (default)
Delete user registration requests once the approval process is complete
Defines whether a user registration request is deleted, when the approval process is completed.
If this setting is not selected the user registration request is not deleted after it is approved.
selected (default)
User registration approver group
Defines a group of email IDs that form the user registration approver group.
Administrators can choose to have a different group for approving user registration in a third party setup. In this case, the administrator has to create a new group and specify that group name here. From then on, API Portal sends emails to users in the mentioned group for user registration approvals if the user registration is done through approval.
API User Registration Approvers
Time To Live (in minutes) for the activation link in minutes
Defines the time interval in minutes for which the email activation link remains active.
30 (default)
Subject of the e-mail sent to the administrator to inform about a failed user request
Subject of the email that is sent to the administrator in case of a failed user request.
API Portal failure :[@request]
Message of the e-mail sent to the administrator to inform about a failed user request
Text that is sent to the administrator in case of a failed user request.
Hello @recipient.name, A request from user (@requestor.name) could not be processed. The details of the request are as follows - API Portal: @loadbalancer.url/#@tenant/home - Tenant: @tenant - Requesting user: @user - Request: @details - Time stamp: @timeStamp - Further details: @reason Best Regards, API Portal Team*** This notification was sent automatically. Do not reply to this email.***
Subject of the email sent to consumers to inform about a failed user request
Subject of the email that is sent to the consumer in case of a failed user request.
Request could not be processed :[@request]
Message of the e-mail sent to consumers to inform about a failed user request
Text that is sent to the consumer in case of a failed user request.
Hello @recipient.name, Your request could not be processed. The details of the request are as follows - API Portal: @loadbalancer.url/#@tenant/home - Request: @request - Time stamp: @timeStamp Try again after some time.Best Regards, API Portal Team*** This notification was sent automatically. Do not reply to this email.***
Enable analytics for global, user, and API audit
Defines, whether collection of analytics should be enabled for global, user and API audit data.
Selected (default)
Enable 'Audit' function for requesting access tokens
Defines, whether auditing should be enabled for an access token request. A log entry is generated when this is selected.
Selected (default)
Enable 'Audit' function for renewing access tokens
Defines, whether auditing should be enabled for an access token renewal. A log entry is generated when this is selected.
Selected (default)
Enable 'Audit' function for revoking access tokens
Defines, whether auditing should be enabled for an access token revoke. A log entry is generated when this is selected.
Selected (default)
Enable 'Audit' function for publishing/creating APIs
Defines, whether auditing should be enabled for APIs being published. A log entry is generated when this is selected.
Selected (default)
Enable 'Audit' function for republishing/updating APIs
Defines, whether auditing should be enabled for APIs being republished. A log entry is generated when this is selected.
Selected (default)
Enable 'Audit' function for unpublishing/deleting APIs
Defines, whether auditing should be enabled for APIs being deleted. A log entry is generated when this is selected.
Selected (default)
Enable 'Audit' function for purging logs
Defines, whether auditing should be enabled while purging the logs. A log entry is generated when this is selected.
Selected (default)
Subject of the e-mail generated when events occur in API Portal
Subject of the email that is sent for events generated inside portal.
New ${event.type}!!
Message of the e-mail generated when events occur in API Portal
Text of the email that is sent for events generated inside portal.
Hello,
There is a new ${event.type} event received from webMethods API Portal (${event.portalURL}). Details of the caller as follows:
firstname: ${event.executor.firstname}
lastname: ${event.executor.lastname}
id: ${event.executor.id}
email: ${event.executor.email}
Details of the event context as follows: contextual object ref: ${event.source.id} contextual object external ref: ${event.source.externalref}
Details of the other context info as follows: <#list event.contextdata?keys as prop> ${prop} = ${event.contextdata[prop]} </#list>
Best Regards,
API Portal Team
*** This notification was sent automatically. Do not reply to this email.***
Notify consumers of access token generation
Specifies whether the consumer should be notified when an access token is generated.
Not selected (default)
Subject of the e-mail sent to consumers to inform about access token generation
Subject of the email that is sent to the consumer when access token is generated.
Access token '@applicationName' generated
Message of the e-mail sent to consumers to inform about access token generation
Text of the email that is sent to the consumers when access token is generated.
Hello @recipient.name,
Your request for an access token has been processed. The details of the token is as follows
Application name: @applicationName
Application description: @applicationDesc
APIs: @apis
API Key
API access key: @apiKeyString
Expiry date: @APIKey.expiryDate
OAuth2 Credentials
Client ID: @clientId
Client secret: @clientSecret
Best Regards,
API Portal Team
*** This notification was sent automatically. Do not reply to this email.***
Relative endpoint to be notified when new events occur
Defines the relative endpoints for notifying events
Blank (default)
Example: /apimgmt/events
HTTP method to be used to notify events
Defines the HTTP method for notifying events
Blank (default)
Example: POST
Payload to be used to notify events
Defines the payload for notifying events
Blank (default)
Example schema:
{
"firstname" :
"{executor.firstname}",
"name" : "{executor.name}",
"lastname" : "{executor.lastname}",
"email" : "{executor.email}",
"type" : "{type}"
}
Content type to be used to notify events
Defines the content type required for notifying events
Blank (default)
Example: application/json
Plug-ins enabled for publication of external events
Defines the plugins enabled for publishing external events
SMTP (default)
My application usage report template
Template of the email that is being used to generate application usage report.
Example for values:
<html>
<body>
Hello @recipient.name, <br>
<h3>Your Application usage summary
for the portal instance
</h3> @loadbalancer.url/#@tenant.id/
<p>Please find the summary of
your application usage in
the below table</p>

<#assign table = "background:#FFF;">
<#assign table_th = "font-size:16px;
font-weight:400;
color:#fff;text-align:left;
padding:20px;
background-color:#0899CC;">
<#assign table_tr_td =
"font-weight:400;
color:#5f6062;font-size:13px;
padding:20px 20px 20px 20px;
border-bottom:1px solid #e0e0e0;">
<#assign align_center =
"text-align:center;">
<table style="${table}">
<thead style="border-radius(5px);">
<tr>
<th style="${table_th}">Name</th>
<th style="${table_th}">Usage</th>
</tr>
</thead>
<tbody>
<#list response as app>
<tr>
<td style="${table_tr_td}">
${app.name}</td>
<td style="${table_tr_td}
${align_center}">
${app.usage}</td>
</tr>
</#list>
</tbody>
</table>
<br>
<h3>Your Application usage detail</h3>
<#list response as app>
<p>Please find the detailed usage
of application
: <b>${app.name}</b></p>
<table>
<thead>
<tr>
<th style="${table_th}">#</th>
<th style="${table_th}">Date</th>
<th style="${table_th}">API</th>
<th style="${table_th}">Resource</th>
<th style="${table_th}
${align_center}">Usage</th>
</tr>
</thead>
<tbody>
<#list app.details as detail>
<tr>
<td style="${table_tr_td}">
${detail?counter}</td>
<td style="${table_tr_td}">
${detail.key}</td>
<td style="${table_tr_td}">
${detail.api}</td>
<td style="${table_tr_td}">
${detail.resource}</td>
<td style="${table_tr_td}">
${detail.count}</td>
</tr>
</#list>
</tbody>
</table>
<br>
</#list>
Best Regards,<br>
API Portal Team
<br>
*** This notification was
sent automatically.
Do not reply to this email.***
</body>
</html>
API consumption request approver group
Defines which user group is allowed to decide about an API consumption.
API Consumption Approvers
Ignore API Runtime events if API is not available
Ignores the runtime events for an API if that API is not present.
selected (by default)
Ignore API Runtime events if application is not available
Ignores the runtime events for an application if that application is not present.
selected (by default)
Expiration days for events
Defines the time after which the logged events expire
30d (default)
File formats of supported documents
Defines the supporting documents and file formats that can be attached or uploaded.
.pdf,.doc,.zip,.jpg,.jpeg,.docx,.xls,.xlsx,.png,.ppt,.pptx
Maximum file size (in MB) of supported documents
Specifies the maximum file size for the supporting document or file that can be attached or uploaded.
2 MB (by default)

Copyright © 2015- 2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release