|
Import and manage applications
In AEM forms, an
application
is a container for
storing assets that are required for implementing a AEM forms solution.
Examples of assets are form designs, form fragments, images, processes,
DDX files, form Guides, HTML pages, and SWF files. During the development
phase of a project, Workbench users can deploy applications directly
from the Applications view in Workbench. Once deployed, these applications
appear in administration console, on the Applications tab on the Application
Management page.
When an application is complete and ready for deployment to a
production server, the Workbench user packages the application into
a
AEM forms application file
(.lca). Then an administrator
uses administration console to import and deploy the application
file, using the Applications tab on the Application Management page.
You can also use thearchives tab on the Application Management
page to import LCAs that were created using workbench 8.x.
Note:
There is a known issue that LCA files from a future release
are not necessarily backward compatible. While it may be possible
to view and import LCA files from a future release of AEM forms
(for example, a preview release), doing so is not supported and
may result in aberrant behavior.
Use the Applications tab to import and manage applications that
were created in Workbench. Application administrators can also export
the runtime configuration for an application. Exporting the runtime
configuration eliminates the need to manually reconfigure settings
in the production environment before starting deployed applications.
The runtime configuration file contains:
-
service configuration settings
-
pool configuration settings
-
endpoint configuration settings
-
security profiles
Import an application or archive
-
In administration console, click Services >
Applications and Services > Application Management.
-
Click Import.
-
Click Browse and select the .lca file to import and click
Preview. The Preview Application page displays information about
the application.
-
(Optional) To see a list of the assets contained in the application,
click View Assets.
-
(Optional) To deploy the assets to the runtime, select Deploy
Assets To Runtime When Import Is Complete. If you do not select
this option, you can deploy the assets later.
-
Click Import. The application appears on the Applications
tab.
-
Log into the CRX repository with administrator credentials.
-
Navigate to content/dam/lcapplications
Note:
The imported
applications display in the lcapplications node.
-
Click on one of the imported applications.
The Properties
tab on the right displays the properties of the selected CRX node.
The
syncState
property
indicates the state of synchronization of data between the AEM forms
server and the CRX repository. As soon as the import process begins
this state is set to 0 (zero). This state indicates the data is currently
not synchronized. When the data is synchronized, the state is set
to 1.
Deploy an application
You can deploy applications that you have imported, or
that Workbench users imported from Workbench.
-
In administration console, click Services > Applications
and Services > Application Management.
-
Select the checkbox next to the application that you want
to deploy and click Deploy.
-
Click OK in the confirmation dialog box that appears.
Undeploy an application
You can undeploy applications from the runtime.
-
In administration console, click Services > Applications
and Services > Application Management.
-
Select the checkbox next to the application that you want
to undeploy and click Undeploy.
-
Click OK in the confirmation dialog box that appears.
Remove an application from the server
Undeploy the application before removing it from the server.
-
In administration console, click Services > Applications
and Services > Application Management.
-
Select the checkbox next to the application that you want
to remove and click Remove.
-
Click OK in the confirmation dialog box that appears.
Import an application’s runtime configuration
If an application administrator exported the runtime configuration
for an application, you can import it into the deployed application.
You can import it using either the administration console or via
scripted LCA deployment.
-
In administration console, click Services > Applications
and Services > Application Management.
-
Click the name of the application.
-
Click Import Runtime Config.
-
Click Browse and select the XML file that contains the runtime
configuration.
-
Click Import.
Export an application’s runtime configuration
You can export the runtime configuration information for
deployed applications.
-
In administration console, click Services > Applications
and Services > Application Management.
-
Click the name of the application.
-
Click Export Runtime Config and save the configuration file
(XML) that is produced.
Scripted deployment of AEM forms applications
You can also use a scripted deployment tool to deploy application
files, including a settings.xml file that specifies the following
settings:
-
service configuration settings
-
pool configuration settings
-
endpoint configuration settings
-
security profiles
Scripted deployment eliminates the need to manually reconfigure
settings in the production environment before starting deployed
applications.
-
From a command prompt, navigate to
[aem-forms root]
/sdk/misc/Foundation/ArchiveManagement.
-
Review the ReadMe.txt file for more detailed instructions.
-
Manually modify the scriptedDeploy.bat and sample-files/sample.xml
files as described in the readme.txt file.
-
Run the scriptedDeploy.bat file. This action deploys the
AEM forms archive file with the override settings.
Import and manage archives
Use the archives
tab to import and manage LCAs that were created in workbench.
Import an archive
-
In administration console, click Services >
Applications and Services > Application Management and click
thearchives tab.
-
Click Import.
-
Click Browse to locate the archive to import, and then click
Preview.
-
Review the list of resources and objects that will be installed
with the archive. Ensure that there are no conflicts with existing
resources, objects, and service configurations because no undo capability
is available.
If you select to import the service configurations,
AEM forms imports all of the process configuration files (endpoints,
security profiles, and service configuration parameters) used by
the processes in the LCA.
-
Click Import.
-
Review the import results and either click Skip Configuration
to finish the import process or click Configure to configure the
archive.
Note:
If you click Skip Configuration,
you can configure the archive later.
-
If you click Configure, the Configure Endpoints page appears,
where you can make any changes that you require:
-
To rename
an endpoint or edit its description, click it.
-
To add a Task Manager endpoint, click Add TaskManager. For
details about the Task Manager settings, see
Configuring Task Manager endpoints
.
-
To add a Watched Folder endpoint, click Add WatchedFolder.
For details about the Watched Folder settings, see
Watched folder endpoint settings
.
-
To add an Email endpoint, click Add Email. For details about
the Email settings, see
Email endpoint settings
.
-
To add an EJB endpoint, click Add EJB and specify a name
and description for the endpoint.
-
To add a SOAP endpoint, click Add SOAP and specify a name
and description for the endpoint.
-
To add a Remoting endpoint, click Add Remoting. For details
about the Remoting settings, see
Remoting endpoint settings
.
-
To add a REST endpoint, click Add REST and specify a name
and description for the endpoint. Note the REST invocation URL displayed
on the Add REST Endpoint page.
-
To remove an endpoint, select the checkbox next to it and
click Remove.
-
Click Next.
-
If a process or service in the LCA has configuration parameters,
a Configure Parameters page appears, where you configure the service
parameters and click Next.
-
On the Configure Security Profile page, make any changes
that you require:
-
Require callers to authenticate:
This
setting indicates whether the service can be invoked with or without
credentials.
If
Callers are currently required to authenticate
is
displayed, the caller of the service must be authenticated and the
user principal for that caller must be authorized to invoke the
service; otherwise, the invocation attempt will be refused. To remove
the need to authenticate, click Allow Unauthenticated Callers.
If
Callers are not required to authenticate
is
displayed, the caller of the service need not be authenticated.
The invocation of the service will always succeed because there
is no authorization check. To require authentication, click Require
Callers to Authenticate.
-
Run As:
Specifies run-time identity used by a service
after it has been invoked. To change this option, click Change.
Choose from the following options:
Unspecified:
The
default behavior is used.
Invoker:
Uses the same identity
as the user who invoked the service.
System:
Runs
the service with full privileges. This is the default setting for long-lived
processes.
Named User:
Enables you to run the service
as a specific user. This is the default setting for short-lived
processes. When you select this option, click Select User to display
the Select Principal page, where you can search for and select the
user.
-
To add a principal to the security profile, click Add Principal
and select the user or group to add as a principal. Click Next and
then select the permissions you want to assign to this principal:
INVOKE_PERM:
To
invoke all operations on the service
MODIFY_CONFIG_PERM:
To
modify the configuration of a service
SUPERVISOR_PERM:
To
view process instance data for a service that is created from a
process
START_STOP_PERM:
To start and stop a service
ADD_REMOVE_ENDPOINTS_PERM:
To
add, remove, and modify endpoints for a service
CREATE_VERSION_PERM:
To
create a new version of the service
DELETE_VERSION_PERM:
To
delete a version of the service
MODIFY_VERSION_PERM:
To
modify a version of the service
READ_PERM:
To view
the service
Click Finished to add the principal to the security
profile.
-
Click Finished to complete the configuration.
Configure the AEM forms that are part of an archive file
-
In administration console, click Services >
Applications and Services > Application Management and click
thearchives tab.
-
On the Archive Management page, select the archive file to
configure.
-
On the View Archive page, select the highlighted archive
resource.
-
Configure the imported process archive file.
Use the configuration wizard to configure the AEM forms that are part of an archive file
-
In administration console, click Services >
Applications and Services > Application Management and click
thearchives tab.
-
Click Configure next to the archive file to configure.
-
The Configure Endpoints page appears, where you can make
any changes that you require:
-
To rename an endpoint
or edit its description, click it.
-
To add a Task Manager endpoint, click Add TaskManager. For
details about the Task Manager settings, see
Configuring Task Manager endpoints
.
-
To add a Watched Folder endpoint, click Add WatchedFolder.
For details about the Watched Folder settings, see
Watched folder endpoint settings
.
-
To add an Email endpoint, click Add Email. For details about
the Email settings, see
Email endpoint settings
.
-
To add an EJB endpoint, click Add EJB and specify a name
and description for the endpoint.
-
To add a SOAP endpoint, click Add SOAP and specify a name
and description for the endpoint.
-
To add a Remoting endpoint, click Add Remoting. For details
about the Remoting settings, see
Remoting endpoint settings
.
-
To add a REST endpoint, click Add REST and specify a name
and description for the endpoint. Note the REST invocation URL displayed
on the Add REST Endpoint page.
-
To remove an endpoint, select the checkbox next to it and
click Remove.
-
Click Next.
-
If a process or service in the LCA has configuration parameters,
a Configure Parameters page appears, where you configure the service
parameters and click Next.
-
On the Configure Security Profile page, you can make any
changes that you require:
-
Require callers to authenticate:
This
setting indicates whether the service can be invoked with or without
credentials.
If
Callers are currently required to authenticate
is
displayed, the caller of the service must be authenticated and the
user principal for that caller must be authorized to invoke the
service; otherwise, the invocation attempt will be refused. To remove
the need to authenticate, click Allow Unauthenticated Callers.
If
Callers are not required to authenticate
is
displayed, the caller of the service may or may not be authenticated.
The invocation of the service will always succeed because there
is no authorization check. To require authentication, click Require
Callers to Authenticate.
-
Run As:
Specifies run-time identity used by a service
after it has been invoked. To change this option, click Change.
Choose from the following options:
Unspecified:
The
default behavior is used.
Invoker:
Uses the same identity
as the user who invoked the service.
System:
Runs
the service with full privileges. This is the default setting for long-lived
processes.
Named User:
Enables you to run the service
as a specific user. This is the default setting for short-lived
processes. When you select this option, click Select User to display
the Select Principal page, where you can search for and select the
user.
-
To add a principal to the security profile, click Add Principal
and select the user or group to add as a principal. Click Next and
then select the permissions you want to assign to this principal:
INVOKE_PERM:
To
invoke all operations on the service
MODIFY_CONFIG_PERM:
To
modify the configuration of a service
SUPERVISOR_PERM:
To
view process instance data for a service that is created from a
process
START_STOP_PERM:
To start and stop a service
ADD_REMOVE_ENDPOINTS_PERM:
To
add, remove, and modify endpoints for a service
CREATE_VERSION_PERM:
To
create a new version of the service
DELETE_VERSION_PERM:
To
delete a version of the service
MODIFY_VERSION_PERM:
To
modify a version of the service
READ_PERM:
To view
the service
Click Finished to add the principal to the security
profile.
Remove an archive
Note:
To remove an archive containing assets
stored in a third-party repository (EMC Documentum Content Server,
IBM FileNet Content Manager, or IBM Content Manager), you must also
delete the asset files from the repository using Workbench.
-
In administration console, click Services > Applications
and Services > Archive Management.
-
On the Archive Management page, select the check box for
the archive to remove and click Remove.
Change the number of items displayed on the Applications and Services pages
On the Preferences page, you can control the number of
services, endpoints, categories, and archives that are displayed
on each of the Applications and Services web pages.
-
In administration console, click Services > Applications
and Services > Preferences.
-
On the Preferences page, type the number of services, endpoints,
categories, and archives that can be displayed on each page, and
then click Save.
|
|
|
