Install alfresco on windows

As your batches flow through your Kofax Capture system, they will be routed from module to module. The modules that are used to process a batch, and the order that processing occurs, are specified as part of the batch class definition for the batch. The Kofax Capture Release module will process batches based on the settings of the associated batch classes.

This module is responsible for releasing documents, as well as index data using the attributes defined during release setup. The Kofax Capture Release module usually runs as an unattended module on a Windows workstation, periodically polling the module for available batches.

Once your batch is released, it will be removed from Kofax Capture. If any documents or pages are rejected, the batch will be routed to the Kofax Capture Quality Control module. The Release script can be configured to limit this list to only show only those values that are applicable to your use case.

A web script configuration file is used to define the items to be displayed. The Release script configuration file uses a structure similar to that used by the model definitions themselves. See the sample configuration provided for examples. Locate the releasesetup. For Tomcat this will be located at:. Note: This is the default location used by the Tomcat application server. The location of the file can vary depending on the application server used by your installation. Rename releasesetup.

This will now only allow selection of types, aspects, and properties as defined in the configuration file. If an aspect exists with properties and these properties are to be mapped from Kofax to Alfresco Content Services, then all properties for this aspect must be populated in the batch process.

If certain properties are omitted from the mapping within the release script set up, then when documents are released, the unmapped properties are overwritten with empty strings. For example, you have an aspect with properties assigned to the default content model and have a document with this aspect assigned. When using Kofax integration, when the document exists version option is set, all aspect properties must be mapped and populated in the batch process, otherwise all unmapped properties are overwritten with empty strings blanked out.

The following steps describe how to remove the Kofax Release script from your Kofax installation. Right-click the applicable document class. Expand the batch class item to select associated document classes. To remove the installation files, manually delete the following files from your Kofax Capture bin directory.

This is a generic Kofax error. The most likely cause is that an invalid working folder has been specified when setting up the release. Ensure that you have entered a valid folder path in the Working Folder field on the General tab. Other causes of this error include missing dependencies in the installation. Check that you have installed all the required files the bin directory. This feature allows you to edit Office documents in Alfresco Share and to modify Office files without checking them in and out.

Share locks the file while it is being modified and releases the lock when the file is saved and closed. Alfresco Outlook Integration is an extension to Alfresco Content Services and Microsoft Outlook, that allows you to save and file your emails to Alfresco Content Services in Microsoft Outlook, in a centralized and structured way. You can drag and drop emails in and out of the repository, and add metadata automatically when an email is filed.

Other features include leveraging Alfresco Content Services in-built workflow processing and filtered search capabilities. You can apply a sorted view to the repository in Microsoft Outlook , and page through a folder or site if it contains a large number of files.

The Document Transformation Engine is a stable, fast, and scalable solution for high-quality transformations of Microsoft Office documents. It is an enterprise alternative to LibreOffice. This guarantees the handling of all Office files and pixel-perfect transformations, and it corrects previous layout issues in the Share preview feature.

This is a useful feature in conjunction with the Outlook Plugin. If Microsoft Office can open and transform your document, then so can the Document Transformation Engine. Robust error handling will take care of corrupt and encrypted documents.

A Web Console shows you a detailed report if there is a problem during transformation, allowing you to correct documents. The Document Transformation Engine is two to three times faster when transforming multi-megabyte Office documents when compared with LibreOffice on the same hardware.

The Document Transformation Engine consists of two software modules: the standalone Document Transformation Engine and the Alfresco Transformation client. The Document Transformation Engine is sold as an Alfresco Content Services module that is enabled with a license key:. When multiple Word conversions occur in parallel, performance can suffer heavily from poor random read and write speeds.

The standalone Document Transformation Engine requires prerequisite software components to be installed and available on the same machine. See Supported Platforms for details of the correct prerequisite software. The following points are important to note before you install the Document Transformation Engine:.

Install only the English versions of MS Windows Server R2, and MS Office or Office 32 bit because other languages cause encoding issues resulting in unpredictable behavior. Note: Although the engine must be configured in English, this has no impact on the transformation language used for documents. Use this information to install all the components required for the Document Transformation Engine.

Note: When upgrading the Document Transformation Engine, the previous installation must be uninstalled first. If your old version of the Document Transformation Engine is earlier than 1. If your old version of the Document Transformation Engine is 1. When the uninstall is complete, you can run the MSI package again to install the new version. There is no need to manually remove anything. The package ships a keystore that is used by the Tomcat SSL connector. This keystore is shipped for demonstration purposes only and should not be used in production environments.

Remember to change the attributes, keystoreFile and keystorePass. Make sure you install both these tools manually. For more information, see Installing GhostScript and pdf2swf. Select an installation folder or accept the default folder, and then click Next. The default values are HTTP and HTTPS but you can also use the standard ports 80 and or any other port if this fits better into your network infrastructure.

You see a progress bar and a command line window during the installation. The installer will show a confirmation when the installation is finished. Locate the new service called Document Transformation Engine , and check that it is Started. Note: Each time a file is transformed in Alfresco Content Services, the.

Depending on the access that the Document Transformation Engine has to the Internet when transforming a file, this check can delay the operation for up to two minutes, and will therefore, delay transformation of the file. To prevent this, use the Windows server firewall to block internet access for all office binaries. Copy alfresco-documenttransformationserver-repo You will see successful log entries about the license installation and the installation of the Alfresco Module Package depending on the configuration of your log level.

This is an executable jar file with all dependencies that works as a command line client. The executable class is com. An API usage example is available at com. You can copy, modify, and use this code in your own product. A list of the most important file formats is available at mimetypes. These file formats have their mime type auto-detected by the file extension.

Note that this is not the full list of supported formats. Update the img. If GhostScript and pdf2swf are not installed properly or the configured path does not match the installation path, the following message will be displayed on startup of the Document Transformation Engine:.

Alfresco Content Services 5. It is required by Alfresco One 5. If the administrator does not provide a link to a valid instance of pdf2swf, the warning will continue to appear in the log file. Also, the following property has been added to determine how often the temporary files are cleaned:. Configuring the Document Transformation Engine consists of two parts: configuring the standalone Transformation Engine using the Web Console, and configuring the Alfresco Transformation client using a properties file or JMX.

Use this information to configure the standalone Document Transformation Engine. You need only to change the password of the transformation service. By default, the login name is set to alfresco , and the password is set to alfresco.

The login name alfresco cannot be changed. See Managing Alfresco keystores for information about keystores. These are the defaults:. This means that with the default settings, Alfresco Content Services stops processing after seconds, where the Document Transformation Engine attempts to transform a document for up to seconds and any results returned after seconds are ignored.

You configure the Alfresco Transformation client by adding the relevant properties to the global properties file. In a normal setup, you will always overwrite the transformserver. If you want to use SSL encryption with the default certificate of the transformation engine, make sure that you set transformserver.

Administrators can view information about the engine and transformation errors using the Web Console. Use the Document Transformation Engine Web Console to view information about the engine and transformation errors. The console provides the status of the engine, a historical view of all the transformations completed, and the number of successful and failed transformations.

The Server Status view shows an overview of the health and the memory use of the Document Transformation Engine. Ensure that you have the flash plug-in to see the Active Threads and Memory Usage graphics. Alternatively, you can go directly to the History view by opening a browser, and then navigating to the following URL:.

The History view shows the details of the document transformations. It provides a number of search functions that allow administrators to find transformation problems for specific documents. To investigate errors, set the Outcome field to Error. Hover over the warning sign to view an indication of the problem with the file.

Alternatively, you can go directly to the Statistics view by opening a browser, and then navigating to the following URL:. The Statistics view indicates the number of transformations, and the success or failed ratio. This call is also used by the Alfresco Transformation client to test availability. It checks the transformation service is up and responding.

This can be used for more in-depth monitoring. Web Quick Start is an easy-to-install package that provides developers with a strong starting point for their Alfresco Content Services implementations. A web application that, when deployed to a servlet container such as Tomcat, delivers a fictional financial news website.

As well as dynamically building the website from data held in the repository, Web Quick Start also provides examples of user generated content whereby content is sent from the web application back to the repository. Web Quick Start is a set of website design templates and sample architecture, built on the Alfresco Share content management and collaboration framework.

With Quick Start, developers can rapidly build customized and dynamic web applications with powerful content management features for the business users without having to start from scratch. Using standard development tools developers can quickly deploy the comprehensive content management capabilities of Alfresco Content Services to build new and innovative web applications.

Developed using the Spring framework with Surf, the Web Quick Start allows developers to easily extend Alfresco Content Services to add new features to support the demands of the business. When you run the setup wizard, you can choose to install a number of components. Web Quick Start is provided as a component but it not selected by default.

If you have an existing Alfresco Content Services installation and prefer to install Web Quick Start manually, you can apply the relevant AMP files to your application. This method is suitable for customized or integrated installations. Copy the alfresco-wcmqs-share Copy the Web Editor file awe.

An Alfresco Share dashlet is provided, from which you can import the sample data. When you initially add the Web Quick Start dashlet into the site dashboard, the dashlet displays a link that enables you to import the Web Quick Start demo data.

Both samples are identical in functionality but contain different images and section headings. The samples provide an example of how developers can package and import their own sample site data.

By default, Web Quick Start is configured to be accessed at localhost on port If these settings are relevant for your installation and the wcmqs. To change the server host name, port, or web application context from the default values, refer to Configuring Web Quick Start.

After you have imported the Web Quick Start website data, when you have refreshed Share, or the next time you log on, you can access the Web Quick Start site for configuration.

Use this information to change the host name, port, and context for the Web Quick Start web application. The Web Quick Start installation assumes that the web application has been deployed to localhost on port , using the context of wcmqs. If wcmqs. Also, use the port that Tomcat is listening on.

A Web Quick Start installation with two projects, such as an editorial site and a live site, cannot use the same combination of host, port, and context. This is controlled by the isEditorial flag on the Quick Start Editorial metadata. This also when complete dictates what can be viewed by using the live web application with regards to publishing go live and expiry dates.

The default configuration sets the host address to You configure the API in the wcmqs-api. The file is located in the clientapi JAR file in the alfresco folder. You can override this location by adding a file with the same name on the classpath before the clientapi JAR. It is recommended that this is changed. To override individual properties, place them in a file named wqsapi-custom.

You can specify these additional properties in this file:. The time the API will wait between checks for the repository being available. This mechanism ensures that the webapp can be started before the repository. The webapp will connect when the repository becomes available. The default value is milliseconds. The time the API caches section objects before reloading them from the repository. The default value is 60 seconds. The time the API caches website objects before reloading them from the repository.

The default value is seconds. The Alfresco Web Editor is a Surf-based web application that provides in-context editing capabilities for repository content.

The editor provides a mechanism for non-technical users to make edits to content directly within a web page. The Web Editor is packaged as a stand-alone WAR file so that it can be deployed to web applications that are in the sample instance, or remote, to the server.

By default, it assumes that you have JavaScript enabled but it can also run without JavaScript. The following diagram shows an example Web Editor deployment in the same application server as the repository.

The Web Editor is a Surf-based application, therefore it is also possible to deploy it in a different application server instance from the repository. If your repository is not located here, you can use custom configuration to tell the AWE where to find your repository. Provides the ability to mark areas of the page as editable.

The areas marked can represent any property or content from the repository. The client-side JavaScript framework on which the Web Editor is built. It is built using YUI and can be extended easily. New tabs and buttons can be packaged and dropped into the framework.

This provides the core product features, and also provides the ability to build additional custom plugins. When the Web Editor is enabled, the WEF renders the tool bar and basic in-context editing buttons and functionality.

If the WEF is deployed as standalone, the default blank tool bar is rendered. The Web Editor distribution consists of a single zip file named alfresco-webeditor Copy the alfresco-webeditor-taglib. To include the tag library in your application, add the following tag library declaration to your JSP page:.

Once the tag library is declared, you can use the startTemplate , endTemplate and markContent tags within your application. The Web Editor distribution also includes all the files required to provide the functionality within an existing Surf application. The remaining alfresco-form-client and alfresco-webeditor-plugin JAR files provide the Web Editor functionality.

If you do not provide the filter, the tags will be ignored. The following filter configuration is required:. No further configuration is required as all the necessary Spring context files and configuration files are contained within the JAR files.

However, there is no default hook point for custom form configuration but this can be located anywhere within your application. The startTemplate tag bootstraps the WEF using a script element that executes a web script. Place this tag in the head section of your page. Controls the initial location of the tool bar. The valid values are: top , left , and right. The default is top. The tag renders an edit icon that, when clicked, displays a form for editing the corresponding content and properties, or both.

The mandatory title attribute defines a descriptive title for the editable area being marked. This is an optional attribute that specifies which form will be used when the marked area is edited. This is an optional attribute, which defines whether the editable area is nested within another HTML tag that represents the content being edited. If it is set to true, the whole parent element is highlighted when the area is selected in the quick edit menu.

The endTemplate tag initializes the Web Editor with details of all the marked content areas on the page. It also renders a script element that executes the WEF resources web script, which starts the process of downloading all the assets required to render and display the tool bar and all configured plugins. Place this tag just before the closing body element. The startTemplate , markContent , and endTemplate tags will only render their output if they detect the presence of the Web Editor servlet filter.

The tags can remain in the JSP page in production and have no effect until the servlet filter configuration is added to the web. By default, the form displayed will contain the cm:title , cm:description , and cm:content fields.

An alternative form can be used by providing the markContent tag with a formId attribute. Out of the box, only two other forms are configured: a form with an identifier of title , and one with an identifier of description. As the identifiers indicate, the forms display a single property: cm:title and cm:description , respectively.

The node type is presumed to be cm:content. If you have custom types or wish to specify other properties, you can use the forms configuration techniques. Place any custom form definitions in this file. This sample must not be used in a production environment and is not supported. A sample customer tag library is provided, which includes two tags. These tags are included as a demonstration sample and should never be used in a production environment. Allows content to be pulled from a repository and sends output to a JSP page.

The content tag requires one mandatory attribute called nodeRef. Allows properties to be pulled from a repository and sends output to a JSP page. The property tag requires two mandatory attributes: nodeRef and property. The sample customer application consists of several, simple JSP pages that display the content and properties of two nodes from the repository. These values can be supplied using context-param values in the web.

Google Docs Integration allows you to use Google Docs to edit document content stored in Alfresco Content Services, as an alternative to the online and offline editing capabilities in Alfresco Share.

When you use the setup wizards to install Alfresco Content Services, the Google Docs Integration feature is applied and enabled for supported content in an installation. If you install manually, you need to apply the Google Docs AMP files separately to enable the feature.

Google Docs Integration is installed by default when you install Alfresco Content Services using the setup wizards. If you are installing manually, use these steps to install Google Docs Integration. Browse to the Support Portal , and download the following files:. Change into the root of the Alfresco Content Services installation directory. Move the alfresco-googledocs-repo Move the alfresco-googledocs-share There are two ways to configure the Google Docs Integration: modify the properties in alfresco-global.

Enterprise-only releases: For advanced configuration, you can customize how Google accounts are authenticated. The following properties can be configured for Google Docs Integration in the alfresco-global. Enables the Google Docs functionality.

By default, this property is set to true. If you set this option to false, the Edit in Google Docs action will not be available. Documents that are currently being edited will still be available using the Resume editing in Google Docs action until they are saved or discarded.

Sets the idle time threshold in seconds. The period is measured from the time when the user last made a change to the document. When saving documents back to Alfresco Content Services, or discarding changes, you must confirm that you want to disconnect any non-idle users before the action completes. Note: Enterprise-only releases: You can also set these properties in the Admin Console. Place google-auth-return. Click Configure consent screen , complete the required fields, and then select Save.

The following table shows the file format restrictions for content that integrates with Google Docs. Google places further restrictions on the size and complexity of documents that can be edited in Google Docs.

Google also prevents editing of other documents that exceed their published limits. See the published Google size limits. In: content-services In: All docs. Alfresco Content Services. Reference Tutorials Supported Platforms. Alfresco Content Services ships with three installers: Alfresco Content Services Installer: this is appropriate for the majority of users, and installs everything you require to run Alfresco Content Services.

It corresponds to the installer used in previous versions. Alfresco Content Services Platform Installer: this installs the repository, all required third party components for example, ImageMagick , and links to a variety of developer and admin resources. If you have a clustered environment, you might want to use the Platform installer across these servers. Depending on your system, you can install Alfresco Content Services using one of the following methods: Using a setup wizard, which contains the required software and components you need for evaluating Alfresco Using a standard WAR file to deploy in a production environment Install guide You can install Alfresco Content Services as a single instance and also in a distributed and clustered environment.

Installing using setup wizards Use these methods to install Alfresco Content Services using the setup wizards. Installing manually Use this information to manually install Alfresco Content Services.

Testing the installation Installation testing checks that Alfresco Content Services is successfully installed and it is working as expected after installation.

Installing integrations Use this information to install any components or modules that integrate Alfresco Content Services to other applications. Install guide You can install Alfresco Content Services as a single instance and also in a distributed and clustered environment. Installing as a single instance Follow these steps to install a single instance of Alfresco Content Services.

Installing in a distributed environment Use these steps for installing Alfresco Content Services in a distributed environment. To get started quickly with installing in a distributed environment, follow the process shown. Click on each task to learn more about it. Cluster-specific configuration If you have a distributed environment and want to implement clustering to improve the availability and performance of various services, you should enable clustering.

Installing in an unattended mode Alfresco Content Services distributes binary all-in-one installers which include a setup wizard built with Bitrock technology. Installing on Linux using the Alfresco Content Services Installer The setup wizard for Linux installs all the software and components that you require for running Alfresco Content Services. Download the installation file: alfresco-content-services-installer This setup wizard is for bit Linux systems.

Execute the downloaded file using the following commands: chmod alfresco-content-services-installer Select the language that you wish to use for the installation.

This sets the language to be used for the setup wizard. On the Setup window, click Next. Read and accept the license agreement. On the Installation Type window, choose how you want to use the setup wizard. There are two types of installation in the setup wizard: Easy Easy type installs using the default options and configuration.

This install type requires you to enter information in only two fields: the install location and the administrator password. Choose this route to install with the default environment. Note: If you have previously installed Alfresco Content Services and the server is running, when you run this setup wizard again, you might be prompted to enter alternative port numbers for the components and services that you install, for example, for the Tomcat application server, FTP port, and the RMI port.

Advanced Advanced type installs but lets you configure the server ports and service properties. You can also choose which additional components to install. To complete the Easy setup wizard: Select Easy , and then click Next. On the Installation Folder window, click Next to accept the default location.

On the Admin Password window, enter a password for the Administrator user admin. Click Next through the remaining windows in the setup wizard. Click Finish to complete the installation. Follow the remaining steps in this task. On the Database Server Parameters window, enter a port number for your database. Enter a suitable port number or click Next to accept the default of Tomcat Server Port For example, the default is Tomcat Shutdown Port For example, the default is This sets the password for the Alfresco administrator user account admin.

On the Warning window, review the list of environment notifications for your installation. On the Ready to Install window, click Next. The Installing window displays, showing the progress of the installation. On the Completing the Setup Wizard window, click Finish.

Click OK to close the Readme. The server starts and then Alfresco Share launches in your default browser. This service comprises the following individual services: postgresql Tomcat Server If you did not automatically start Alfresco Content Services at the end of the setup wizard, to start now you need to start all the services.

If LibreOffice does not start up normally with Alfresco Content Services, test manually; for example, by running this startup script: start ex. Download the following installation file: alfresco-content-services-platform-installer Execute the downloaded file using the following commands: chmod alfresco-content-services-platform-installer On the Setup - Platform window, click Next. The server starts and then the platform launches in your default browser.

This service comprises the following individual services: postgresql Tomcat Server To access resources such as the Admin Console, log on as the admin user.

Download the following installation file: alfresco-content-services-share-installer Execute the downloaded file using the following commands: chmod alfresco-content-services-share-installer On the Setup - Alfresco Share window, click Next.

There are two types of installation in the setup wizard: Easy Easy type installs Share using the default options and configuration.

This install type requires you to enter locations for where you want to install, and which repository you want to connect to. Note: If you have previously installed and the server is running, when you run this setup wizard again, you might be prompted to enter alternative port numbers for the components and services that you install, for example, for the Tomcat application server, FTP port, and the RMI port.

Advanced Advanced type installs but asks you to specify the components that you want to install, and the Tomcat configuration parameters that you require.

Java is the only option available to select or deselect. When you have finished selecting the components, click Next. On the Tomcat Port Configuration window, enter the following Tomcat configuration parameters: Note: The Alfresco Share Installer provides its own Tomcat server to run Share, so if you have your repository on the same machine as your Share installation, you must specify alternative Tomcat ports for the Tomcat server.

Web Server Domain For example, the default is Tomcat port For example, the default is Tomcat Shutdown port For example, the default is Important: If you do not apply the Share Services AMP to the repository, Share will not work correctly, and when you start up Share, you will see the message: Alfresco is running without Share Services. Check for error messages as you open Share. Installing on Windows using the Alfresco Content Services installer The setup wizard for Microsoft Windows installs all the software and components that you require for running Alfresco Content Services.

Download the following installation file: alfresco-content-services-installer The setup wizard is for bit Windows systems. Double-click the downloaded file. This install type requires only two fields: install location and administrator password. If you select a virtual Windows drive, and you have selected additional components in step 6, you might receive an error message during installation: An IO error was encountered during deployment of the AMP into the WAR The installation will complete, but additional components will not be added to the installation.

For guidance, see Create and use a Virtual Hard Disk. Enter the Web Server domain number. For example, the default is Enter the port number for the Tomcat web application. Enter the Tomcat Shutdown port number. Enter the Tomcat SSL port number.

The services that will be running for an install using the default options are: alfrescoPostgreSQL alfrescoTomcat If you did not automatically start Alfresco Content Services at the end of the setup wizard, to start now you need to start all the services. The server starts and then platform launches in your default browser. On the Installation type window, choose how you want to use the setup wizard. On the Tomcat Port Configuration window, enter the following Tomcat configuration parameters: Note: The Alfresco Share Installer provides its own Tomcat server to run Share, so if you have your Alfresco repository on the same machine as your Share installation, you must specify alternative Tomcat ports for the Tomcat server.

Default is none. Default is 2. Default is gtk. Options are gtk , xwindow , text , unattended. Default is en. Default is org. Default is demand. No install required. Guten Tag! Sie sind auf unserer englischen Website gelandet, aber es sieht so aus, als ob Sie normalerweise deutsche Seiten bevorzugen.

Sei arrivato sul nostro sito in inglese, ma sembra che preferisci navigare in siti in italiano. Se desideri utilizzare il nostro sito in inglese, fai clic qui per impostarlo come predefinito o fai clic qui per visitare alfresco. You've arrived on our English site, but it looks like you prefer browsing sites in [language-name]. Table of contents Install with zip This page describes how to manually install Content Services using the distribution zip.

Install overview Use this section to get an overview of the main stages for installing Content Services using the distribution zip. Download the distribution zip file by accessing the Support Portal. Generate certificates for mutual TLS. Download Tomcat and review the installation steps required. Set up Tomcat. Install and configure Content Services. Set up ActiveMQ. Install third-party software used by Content Services. Review and test your setup to check that all the installation steps are complete: Start and configure your database.

Start and configure ActiveMQ. Start the repository. See the Supported platforms for more. File Description alfresco-content-services-distribution Alfresco WAR files in distribution zip for a manual install into an existing Tomcat application server.