Posts in Category "Customization"

Importing LiveCycle DSCs using command-line

- Ankush Kumar, Lead Software Engineer @ Adobe

Many a times, we have the requirement to deploy single or group of system or custom DSCs. System DSCs are deployed by LiveCycle Configuration Manager. However, in the case of custom DSCs, we need to manually deploy the component through LiveCycle Workbench. Sometimes, launching Workbench for solely deploying component seems like too much effort. Moreover, it’s not very easy to automate.

You can use the attached sample tool to deploy a DSC using command-line.

  1. Download and extract the tool archive on your machine. It contains a folder libs, a runme.bat file, and an ImportDSC.jar file.
  2. Place <LiveCycle Installation Dir>\sdk\client-libs\thirdparty\*.jar files in libs folder.
  3. Place adobe-usermanager-client.jar and adobe-livecycle-client.jar files in libs folder.
  4. Modify runme.bat accordingly.

The ImportDSC.jar is used in the following way in the runme.bat file (provided classpath is set):

java com.adobe.livecycle.sample.ImportDSC appserver=<websphere|weblogic|jboss> serverhost=<name of machine> port=<port of LC> username=<user to install DSC> password=<password of mentioned user> dscpath=<absolute path till DSC> force=<true|false>

The source code is also included in the archive. Please review it in case of any doubt and modify as per your requirements.

DISCLAIMER: This sample code is not officially delivered or supported as part of Adobe LiveCycle product. One should verify this on a testing environment before employing in production environment.

 

 

VN:F [1.9.22_1171]
Was this helpful? Please rate the content.
Rating: 8.0/10 (1 vote cast)

Adding a custom service in Correspondence Management Solution

- Mayank Gupta, Computer Scientist @ Adobe

Steps to add a custom service in Correspondence Management solution are as follows:

  1. The implementation for this user story involves code changes and rebuilt. So, one is required to setup the development environment via steps mentioned @ Setting up development environment.
  2. Add your sample custom service interface and implementation class in the CorrespondenceManagementSolutionTemplate/Services project for example @ com.adobe.icc package in the source code. See the sample @ http://blogs.adobe.com/LiveCycleHelp/files/2012/06/SampleCustomService1.zip.
  3. Now define your service as a spring bean. For this, add the following entry in your CorrespondenceManagementSolutionTemplate\Services\resources\META-INF\spring\cm\adobe-cm-spring-config.xml file:
    <bean id=”sampleCustomService” class=”com.adobe.icc.SampleCustomServiceImpl” />
  4. Now expose your spring bean as a osgi-service. For this, add the following entry in your CorrespondenceManagementSolutionTemplate\Services\resources\META-INF\spring\osgi-context.xml file:
    <bp:service interface=”com.adobe.icc.SampleCustomService” ref=”sampleCustomService” >
    <bp:service-properties><entry key=”connectors.httpinvoker” value=”true” />
    <entry key=”connectors.httpinvoker.alias” value=”/sampleCustomService” />
    <entry key=”connectors.remoting” value=”true” />
    <entry key=”connectors.remoting.id” value=”sampleCustomService” />
    </bp:service-properties>
    </bp:service>
  5. Rebuild and redeploy the Solution template to view the changes. For information on rebuilding and redeploying, see Building and deploying the Solution Template.

 

VN:F [1.9.22_1171]
Was this helpful? Please rate the content.
Rating: 0.0/10 (0 votes cast)

Adding user images in ICR Solution Interface

This blog post is part of the series on customizing the Adobe Integrated Content Review solution.

***

Any entity of the Integrated Content Review solution like, a campaign, a project, or an asset, includes many participants or team members. The participants at any level in the campaign hierarchy include participants from lower levels. In other words, a campaign includes all the participants of a project. A project, in turn, includes all the participants of the assets within it. Additionally, at any level in the campaign, a participant can be added directly to the team list.

To view/add team members at any level in a campaign, click an entity in the Gantt chart and then click the Resources tab. A newly added team member may not have an avatar image. An instance is shown below:

Newly added user does not have an avatar

Newly added user does not have an avatar

Understanding the naming convention of the image files

The images display only if the image files are named using the canonicalname_domainname convention. To know the value of domain name and canonical name, follow these steps:

  1. Navigate to http://localhost:4502/crx/index.jsp.
  2. Log in using the credentials of the user whose domain name and canonical name is to be determinded.
  3. The UserID is displayed of the format lcu::domainname::canonicalname. Note the domain and canonical names from the string.

For example, for an administrator the name is displayed as lcu::DefaultDom::SuperAdmin. Hence, the domain name is DefaultDom and canonical name is SuperAdmin.

Adding an image

Let us add an image for a newly-added user named Shashank Kapoor.

  1. Navigate to ICR_SOURCE/integratedcontentreview/package_data/content/icr/assets/user-images.
    Note: ICR_SOURCE folder is the folder where you extract the provided source code of the solution interface. Refer to this help page to read more.
  2. Add an image with the file name shakapoo_DefaultDom.jpg.
    Note: To update an existing image, replace the image file with a new image file. The image file is scaled to 45 x 58 pixels in size. The image filenames are case sensitive.
  3. Create a directory named shakapoo_DefaultDom.jpg.dir.
  4. In this directory create a file named .content.xml. Add the following code to it:
    <?xml version=”1.0″ encoding=”UTF-8″ ?>
    <jcr:root xmlns:jcr=”http://www.jcp.org/jcr/1.0″ xmlns:nt=”http://www.jcp.org/jcr/nt/1.0″ jcr:primaryType=”nt:file”>
    <jcr:content jcr:primaryType=”nt:unstructured” />
    </jcr:root>
  5. Save and deploy the customized solution interface. To know more, refer to this article.

After updating the image for the above instance it shows in the solution interface as shown below:

User with an avatar image added

User with an avatar image added

Read more about adding team members here, in the ICR solution guide.

VN:F [1.9.22_1171]
Was this helpful? Please rate the content.
Rating: 0.0/10 (0 votes cast)

Rebranding the ICR email templates

This blog post is part of the series on customizing the Adobe Integrated Content Review solution.

***

Integrated Content Review solution sends out system-generated email notifications to team members and participants, for various events. Templates used for these email can be customized as per your branding requirements.

This customization scenario involves the following top-level steps:

  1. Locating the email template files
  2. Customizing the images in the email template files
  3. Customizing the content in the email template files
  4. Knowledge of all the available variables to customize the content in Step 3

For detailed information about these steps, refer to this (PDF) document.

See also:
This matrix of system-generated email notifications sent to participants.
This page, to know more about ICR solution.

VN:F [1.9.22_1171]
Was this helpful? Please rate the content.
Rating: 0.0/10 (0 votes cast)

Writing pre- and post-stage hooks for Integrated Content Review solution

The Review, Commenting, and Approval building block, part of the Integrated Content Review solution, allows you to inject said functionality or custom Document Services processes at any point in your solutions workflow. You can add functionality or custom processes prior to or after staging, called Pre-stage and Post-stage hooks respectively. See Writing Pre- and Post-Stage Hooks for more information and a quickstart to help you get started.

VN:F [1.9.22_1171]
Was this helpful? Please rate the content.
Rating: 0.0/10 (0 votes cast)

ICR customization to display custom asset attributes in advanced search

This blog post is part of the series on customizing the Adobe Integrated Content Review solution.

***
In the Assets view of the Integrated Content Review solution interface, you can find an asset using either basic or advanced search. You can perform advanced search using search attributes, such as campaign name, manager, state, status, and timeline. Besides these attributes, you can create new search attributes. These custom attributes appear in the advanced search options and search results.

To modify the advanced search parameters, you must update the FML file describing an asset. A few custom attributes for assets are predefined—for example, brand of an asset, asset height, asset width, and so on.

The following steps use a pre-defined, asset-level attribute to modify an asset’s FML file:

  1. Open workItem.fml located at: ICR_SOURCE/integratedcontentreview/package_data/apps/solutions/icr/assetDefinitions/.
  2. Add properties (described below) in the entity for workitem.fml.
  3. Update the solution interface. (Refer to Setting up your development environment to do so.)

Following is an explanation of the properties of the attribute:

  • visible: Marking its value as True makes it visible in the search results.
  • searchable: Marking its value as True makes it visible in the advanced search pane.
  • extendedPropertyPath: Path of this attribute.
  • assetPropertyType: Marking assetPropertyType as “extended” indicates using extendedPropertyPath attribute, instead of searchPath attribute, to search for the brand name.

For example, the following sample can be used to add a new attribute titled Brand in the advanced search pane.

<property name=”brandName” type=”string”>
<annotation name=”DDS”>
<item name=”displayName”>Brand</item>
<item name=”visible”>true</item>
<item name=”searchable”>true</item>
<item name=”searchPath”>WorkItem.attributes.brand</item>
<item name=”columnOrder”>5</item>
<item name=”basicSearchEnabled”>false</item>
<item name=”extendedPropertyPath”>WorkItem.attributes.brand</item>
<item name=”assetPropertyType”>extended</item>
</annotation>
</property>

An instance of the advanced search pane and the search results, as they appear after this customization, are shown below.

Custom attributes in advanced search pane

Custom attributes in advanced search pane

Further references:
This ICR page, to know more about the solution.
The solution guide to get started with the solution.

VN:F [1.9.22_1171]
Was this helpful? Please rate the content.
Rating: 0.0/10 (0 votes cast)

ICR: Update the campaign portal SWF without redeploying the package

This blog post is part of the series on customizing the Adobe Integrated Content Review solution.

***

If you’re working with just the Flex project that ships with Integrated Content Review, you may find it convenient to update the campaign portal SWF directly without redeploying the entire package (template-integratedcontentreview-pkg.zip).

You can generate the SWF in one of the following ways:

  • Clean the solution interface project from within Flash Builder:
    • In Flash Builder, select Project > Clean. The contents of the default project output folder—ICR_SOURCE\integratedcontentreview[CampaignPortal]\bin-debug—are updated.
    • Rename the ICR.swf file in this folder to campaign_portal.swf.
  • Run build.xml:
    • Run the build.xml in the ICR_SOURCE\integratedcontentreview[CampaignPortal] folder. The contents of the ICR_SOURCE\integratedcontentreview[CampaignPortal] folder, which includes campaign_portal.swf, are updated.
Once you have the campaign_portal.swf file available, follow these steps to update it in CRX:
  1. Navigate to http://localhost:4502/crx/index.jsp and log in using admin credentials.
  2. Click Content Loader.
  3. Click Browse and select /content/icr.
  4. Click Choose File and select the campaign_portal.swf file that you just generated.
  5. Click Import.
For background information about setting up the ICR development environment, refer to this earlier blog post.
VN:F [1.9.22_1171]
Was this helpful? Please rate the content.
Rating: 0.0/10 (0 votes cast)

Setting up the ICR development environment

This is the first blog post in the series on customizing the Adobe Integrated Content Review solution.

***

The Integrated Content Review solution ships with a solution interface and building blocks that you can customize as per your organization’s requirements. Before you set out to customize these components, you must first set up your development environment. Setting up the ICR development environment involves the following broad steps:

  1. Set up prerequisites
  2. Locate the solution interface and required dependencies
  3. Understand available projects
  4. Set up available projects in Flash Builder
  5. Set up Java projects in Eclipse
  6. Build and deploy the solution interface

For detailed information about each of these steps, refer to this PDF document (download).

Watch out this space for more customization scenarios for ICR!

VN:F [1.9.22_1171]
Was this helpful? Please rate the content.
Rating: 0.0/10 (0 votes cast)

Configuring email notifications for the Managed Review & Approval Solution Accelerator

The Adobe Managed & Approval Solution Accelerator 9.5 is a wonderful solution for automating reviews for documents in your organization. One of the handy features  of the solution is email updates for automated reviews. For example, emails are automatically sent for these scenarios:

  • When a reviewer completes a review or review stage.
  • When an approver approves a document.
  • When reviewers or approvers are added to or removed from a review.
  • When a review or review stage completes.

This requirement is necessary for organizations that have regulated review and approval workflows. However, in non-regulated environments, this requirement may be a distraction to users because of the number of emails  that can be sent in reviews that involve significant number of people.

Alexandra Phillips has provided an article to describe how to configure  the emails that are sent using the Solution Template provided with the Managed Review & Approval Solution Accelerator. Check out the article here.

VN:F [1.9.22_1171]
Was this helpful? Please rate the content.
Rating: 0.0/10 (0 votes cast)

Hot off the press! Adding tabs to Adobe LiveCycle Workspace ES2

In LiveCycle Workspace ES2 (version 9.0.0.2), tabs are available for you to start new processes, view tasks that are assigned to you, and track tasks and processes. What if you wanted to add your own tab to enhance it? Check out a new article by Nithiyanandam Dharmadass that describes how to add navigation tabs to Workspace here.

VN:F [1.9.22_1171]
Was this helpful? Please rate the content.
Rating: 9.0/10 (2 votes cast)