AgileApps Support Wiki Pre Release

Difference between revisions of "Tenant Capabilities"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(92 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Service Provider URL}}<br>
'''Tenant Management System > Tenants > {Tenant} > Quick Links > Manage Tenant Capabilities'''
'''Tenant Management System > Tenants > {Tenant} > Quick Links > Manage Tenant Capabilities'''


Available to [[Service Provider]]s, this option provides the ability to configure platform options for service subscribers.
Available to [[Service Provider]]s, this option provides the ability to configure platform options for service subscribers.


{{permission|
==About Tenant Management==
*[[ISV]] users in [[Roles]] with ''[[Proxy Login Access]]'' permission rights can grant/revoke options for Tenants/MSPs
This feature enables real-time management of [[tenants]] in the {{Enterprisebrand}}, providing [[Service Provider]]s ([[ISV]]s) with the ability to:
*[[MSP]] users in [[Roles]] with ''[[Proxy Login Access]]'' permission rights can grant/revoke options for Tenants}}
 
:*Analyze accounts, set up custom branding, and act as tiered support for clients
:*Set up client capabilities, proxy login to customer accounts (for support, setup or management control), and provides a full view of managed tenants
:*Create branding for email templates and messaging, login pages, headers and footers


;Considerations:
;Considerations:
:* Due to the specialized nature of these features and the associated resource commitments, consider deploying only the options that are necessary to each tenant.
:* Due to the specialized nature of these features and the associated resource commitments, consider deploying only the options that are necessary to each tenant.


==Managing Tenant Capabilities==
{{permission|
[[ISV]] users in [[Roles]] with ''[[Proxy Login Access]]'' permission can grant/revoke options for Tenants
}}
===Logging In===
To administer the features in your instance of the {{enterprisebrand}}, you need to log in as a user with administration privileges.
The initial login account is: <tt>admin@longjump.com</tt>
(Additional users may also be assigned [[Roles]] that have been granted administration privileges.)
===Deactivating a Tenant===
#Visit the  {{Service Provider URL}}.
#In the sidebar under '''Workspace''', click '''Tenants'''
#Navigate to the tenant (customer) of interest.
#In the Quick Links section, click the ''Manage Tenant Capabilities'' link.
#Click '''[Edit]'''
#Under '''Billing Information''' turn off the '''Active''' checkbox.
#Click '''[Save]'''
===Configuring Tenants===
;To enable/change Tenant Configuration Options:
;To enable/change Tenant Configuration Options:
#Open the Tenant object
#Visit the {{Service Provider URL}}.
#Navigate to the tenant (customer) of interest
#In the sidebar under '''Workspace''', click '''Tenants'''
#In the Quick Links section, click the ''Manage Tenant Capabilities'' link
#Navigate to the tenant (customer) of interest.
#Click the [Edit] button to change the elements available to this customer
#In the Quick Links section, click the ''Manage Tenant Capabilities'' link.
#Click '''[Edit]'''
#Change the features available to this customer.
#Click '''[Save]'''
#Click '''[Save]'''
__TOC__
==Configuration Options==
Use the checkboxes to enable tenant configuration options:
*If checked, the option is enabled
*If unchecked, the option is disabled


::[[File:Managetenantcapabilities.gif|none|thumb]]
===Tenant Capabilities===
 
See the pages below for more information on the available options:
:{| border="0" cellpadding="5" cellspacing="0"
:{| border="0" cellpadding="5" cellspacing="0"
|-valign="top"
|-valign="top"
|
|
*[[Create Objects]]
* [[Create Objects]]
*[[Custom Access Criteria]]
* [[Custom Access Criteria]]
*[[Mass Deployment of Packages to Tenants]]
* [[Manage Sites]]
*[[Object Inheritance]]
* [[Multiple Languages]]
*[[Package System-Generated Objects]]
* [[Overwrite Previous Package]]
*[[Install Package from File]]
* [[Install Package from File]]
*[[Field Encryption]]
* [[Single Sign-On]]
*[[Mobile Access]]
* [[Sandboxes]]
* [[Session Management]]


|
|
*[[Create Application]]
* [[Create Application]]
*[[Develop Tools]]
* [[Developer Tools]]
*[[Manage Sites]]
* [[Mass Deployment of Packages to Tenants]]
*[[Multiple Languages]]
* [[Object Inheritance]]
*[[Overwrite Previous Package]]
* [[Publish Package]]
*[[Publish Package]]
* Synchronous [[Rollup Summary Fields]]
*[[Rollup Summary Fields|Synchronous Rollup Summary Fields]]
* [[Mobile Access]]
*[[Single Sign-On]]
* [[Record Level Visibility]]
|}
<blockquote>
====Default Settings for Tenant Capabilities====
This table summarizes the default settings for new tenants in On-Premise installations and in the cloud.
(Settings that are off by default tend to be features that are little-used, which introduce a significant performance overhead.)
:{|border="1" cellpadding="5" cellspacing="0"
! align="left" rowspan="2"|<br>Option !! colspan="2"| Default !! rowspan="2" valign="bottom"|Notes
|-
! On-Premise !! Cloud
|-
| Create Application                    || off || On  ||
|-
| Create Objects                        ||  On || On  ||
|-
| Custom Access Criteria                || off || On  ||
|-
| Developer Tools                        ||  On || On  ||
|-
| Install Package from File              || off || On  ||
|-
| Manage Sites                          || off || On  ||
|-
| Mass Deployment of Packages to Tenants || off || off || Usually needed only in a [[Service Provider]] tenant.
|-
| Mobile Access                          ||  On || On  ||
|- 
| Multiple Languages                    || off || off || Takes up space, adds overhead.
|-
| Object Inheritance                    || off || On  ||
|-
| Overwrite Previous Package            || off || off || Often needed by application development tenant.
|-
| Publish Package                        || off || On  ||
|-
| Record Level Visibility                || off || off || Rarely needed. Adds performance overhead and takes up space in the UI.
|-
| (Synchronous) Rollup Summary Fields   || off || off || Adds performance overhead.
|-
| Sandboxes                              || off || off || Creates additional tenants, which increase costs.
|-
| Single Sign-On                         || off || On  ||
|-
| Delete User                            || off || off || Enable this option to add the delete user functionality for a tenant. This configuration is available only if you have enabled '''User Configuration''' options for deleting a user in the '''Configure Service Settings''' page.
|-
| SAG Cloud                          || Off || Off || By default, this is disabled. If a user subscribes for AgileApps using Software AG Cloud portal, then this field is enabled automatically by the system.
|-
| Enable CSRF Protection                || On || On || By default, for a new tenant this '''Enable CSRF Protection''' check box is enabled. For an existing tenant, this check box is disabled. If enabled, the tenant opts for CSRF (Cross-Site Request Forgery) protection and CSRF token is validated for POST,PUT, and DELETE request and is skipped for the GET request. If any security violations related to CSRF occurs, that session is invalidated. <br>A sample code to enable the CSRF support in AgileApps through form submissions and REST APIs is available at [[AJAX and REST]].
|}
|}
</blockquote>
====Execution Limits====
:;Maximum number of Rollup Summary Fields: The maximum number of [[Rollup Summary Fields]] allowed in the platform. (Each carries out operations in the background to keep the value up-to-date across the database, increasing the load on the system.)
:;Max. Job Count: The maximum number of scheduled jobs that can be executed per day. (This value only affects legacy customers enrolled in old billing plans. It is ignored for newer customers for whom Block Pricing is in force.)
:;Rest API bulk operation max limit: The maximum number of records that can be in included in one call to the [[REST API:bulk record Resource]]. Default is 25.


==Execution Limits==
:;Active: Determines whether the tenancy is active. Unchecking this box prevents that tenant's users from logging in.


==Java Code Governors==
====Java Code Governors====


:;Apply governors in Java code?: Turns tenant-level Governance ON or OFF. The default is '''ON'''. If unchecked, tenant has effectively unlimited use of Java resources. (Protections against runaway code are still in place, but the ceiling is very high.)
:;Apply governors in Java code?: Turns tenant-level Governance ON or OFF. The default is '''ON'''.  
::* If unchecked, tenant has effectively unlimited use of Java resources. (Protections against runaway code are still in place, but the ceiling is very high.)
::* These governors apply to each ''execution request''--a request for platform execution resources that begins when tenant code executes (Java code in a Data Policy, Java code in a JSP page, or JavaScript code in an HTML page), and ends when that code terminates.


:;Use custom values for this tenant: Used to set individual limits for the tenant. The default is '''OFF'''. When off, global settings are used. When on, values can be specified for:
:;Apply custom limits for tenant: Used to set individual limits for the tenant. The default is '''OFF'''. When off, global settings are used. When on, values can be specified for:
::* '''Tenant level String Size''' -  
::* '''Tenant level string size''' - The total size of all strings allocated in the Java heap space during an execution request.
::* '''Tenant level Statement Count''' -  
::* '''Tenant level statement count''' - The maximum number of Java code statements that can be run during an execution request.
::* '''Tenant level CPU Time''' -  
::* '''Tenant level CPU time''' - The maximum number of CPU milliseconds that can be consumed during an execution request.


''Learn more:'' [[tbd]]
:''Learn more:'' [[Governors on Java Code]]


==Setting up a Development Environment==
===Setting up a Development Environment===
These options are typically enabled together to set up a development environment:
These options are typically enabled together to set up a development environment:
:{| border="0" cellpadding="5" cellspacing="0"
:{| border="0" cellpadding="5" cellspacing="0"
Line 68: Line 148:
*[[Overwrite Previous Package]]
*[[Overwrite Previous Package]]
*[[Publish Package]]
*[[Publish Package]]
*[[Develop Tools]]
*[[Developer Tools]]
*[[Manage Sites]]
*[[Manage Sites]]
|
|
*[[Multiple Languages]]
*[[Multiple Languages]]
*[[Object Inheritance]]
*[[Object Inheritance]]
*[[Package System-Generated Objects]]
*[[Install Package from File]]
*[[Install Package from File]]
|}
|}
<noinclude>
<noinclude>


[[Category:{{cloud}}]]
[[Category:Tenant Management]]
[[Category:Sys Admin Guide]]
</noinclude>
</noinclude>

Latest revision as of 09:13, 27 August 2021

Service Provider URL: http://{yourDomain}/networking/Service?t=1&targetpage=ViewPort.jsp
Tenant Management System > Tenants > {Tenant} > Quick Links > Manage Tenant Capabilities

Available to Service Providers, this option provides the ability to configure platform options for service subscribers.

About Tenant Management

This feature enables real-time management of tenants in the AgileApps Cloud platform, providing Service Providers (ISVs) with the ability to:

  • Analyze accounts, set up custom branding, and act as tiered support for clients
  • Set up client capabilities, proxy login to customer accounts (for support, setup or management control), and provides a full view of managed tenants
  • Create branding for email templates and messaging, login pages, headers and footers
Considerations
  • Due to the specialized nature of these features and the associated resource commitments, consider deploying only the options that are necessary to each tenant.

Managing Tenant Capabilities

Lock-tiny.gif

ISV users in Roles with Proxy Login Access permission can grant/revoke options for Tenants  

Logging In

To administer the features in your instance of the AgileApps Cloud platform, you need to log in as a user with administration privileges.

The initial login account is: admin@longjump.com

(Additional users may also be assigned Roles that have been granted administration privileges.)

Deactivating a Tenant

  1. Visit the Service Provider URL: http://{yourDomain}/networking/Service?t=1&targetpage=ViewPort.jsp.
  2. In the sidebar under Workspace, click Tenants
  3. Navigate to the tenant (customer) of interest.
  4. In the Quick Links section, click the Manage Tenant Capabilities link.
  5. Click [Edit]
  6. Under Billing Information turn off the Active checkbox.
  7. Click [Save]

Configuring Tenants

To enable/change Tenant Configuration Options
  1. Visit the Service Provider URL: http://{yourDomain}/networking/Service?t=1&targetpage=ViewPort.jsp.
  2. In the sidebar under Workspace, click Tenants
  3. Navigate to the tenant (customer) of interest.
  4. In the Quick Links section, click the Manage Tenant Capabilities link.
  5. Click [Edit]
  6. Change the features available to this customer.
  7. Click [Save]

Tenant Capabilities

Default Settings for Tenant Capabilities

This table summarizes the default settings for new tenants in On-Premise installations and in the cloud. (Settings that are off by default tend to be features that are little-used, which introduce a significant performance overhead.)


Option
Default Notes
On-Premise Cloud
Create Application off On
Create Objects On On
Custom Access Criteria off On
Developer Tools On On
Install Package from File off On
Manage Sites off On
Mass Deployment of Packages to Tenants off off Usually needed only in a Service Provider tenant.
Mobile Access On On
Multiple Languages off off Takes up space, adds overhead.
Object Inheritance off On
Overwrite Previous Package off off Often needed by application development tenant.
Publish Package off On
Record Level Visibility off off Rarely needed. Adds performance overhead and takes up space in the UI.
(Synchronous) Rollup Summary Fields off off Adds performance overhead.
Sandboxes off off Creates additional tenants, which increase costs.
Single Sign-On off On
Delete User off off Enable this option to add the delete user functionality for a tenant. This configuration is available only if you have enabled User Configuration options for deleting a user in the Configure Service Settings page.
SAG Cloud Off Off By default, this is disabled. If a user subscribes for AgileApps using Software AG Cloud portal, then this field is enabled automatically by the system.
Enable CSRF Protection On On By default, for a new tenant this Enable CSRF Protection check box is enabled. For an existing tenant, this check box is disabled. If enabled, the tenant opts for CSRF (Cross-Site Request Forgery) protection and CSRF token is validated for POST,PUT, and DELETE request and is skipped for the GET request. If any security violations related to CSRF occurs, that session is invalidated.
A sample code to enable the CSRF support in AgileApps through form submissions and REST APIs is available at AJAX and REST.

Execution Limits

Maximum number of Rollup Summary Fields
The maximum number of Rollup Summary Fields allowed in the platform. (Each carries out operations in the background to keep the value up-to-date across the database, increasing the load on the system.)
Max. Job Count
The maximum number of scheduled jobs that can be executed per day. (This value only affects legacy customers enrolled in old billing plans. It is ignored for newer customers for whom Block Pricing is in force.)
Rest API bulk operation max limit
The maximum number of records that can be in included in one call to the REST API:bulk record Resource. Default is 25.
Active
Determines whether the tenancy is active. Unchecking this box prevents that tenant's users from logging in.

Java Code Governors

Apply governors in Java code?
Turns tenant-level Governance ON or OFF. The default is ON.
  • If unchecked, tenant has effectively unlimited use of Java resources. (Protections against runaway code are still in place, but the ceiling is very high.)
  • These governors apply to each execution request--a request for platform execution resources that begins when tenant code executes (Java code in a Data Policy, Java code in a JSP page, or JavaScript code in an HTML page), and ends when that code terminates.
Apply custom limits for tenant
Used to set individual limits for the tenant. The default is OFF. When off, global settings are used. When on, values can be specified for:
  • Tenant level string size - The total size of all strings allocated in the Java heap space during an execution request.
  • Tenant level statement count - The maximum number of Java code statements that can be run during an execution request.
  • Tenant level CPU time - The maximum number of CPU milliseconds that can be consumed during an execution request.
Learn more: Governors on Java Code

Setting up a Development Environment

These options are typically enabled together to set up a development environment: