Showing posts with label Workbench. Show all posts
Showing posts with label Workbench. Show all posts

Saturday, 12 August 2017

Endeca | Removing Endeca application from Workbench

Issue : In the case when you try to remove Endeca application using runcommand (runcommand --remove-app). If workbench is down at that point of time. Then this application won't be removed from workbench.

In this case runcommand throws below exception.

=============================================================================
Caused by org.apache.http.conn.HttpHostConnectException
org.apache.http.impl.conn.HttpClientConnectionOperator connect - Connect to JagdevSingh-PC:8006 [JagdevSingh-PC/127.0.0.1] failed: Connection refused: connect
Caused by java.net.ConnectException
java.net.DualStackPlainSocketImpl connect0 - Connection refused: connect

=============================================================================

In this case if you start workbench your application site will display there.

Endeca Application
Endeca Application

Solution : Shutdown workbench, clean workbench workspace folder and restart it.

Endeca Application Removed
Endeca Application Removed

Sunday, 18 June 2017

Endeca | Workbench configure keyword redirects

You can add keyword redirects to your application in the Keyword Redirects page in Workbench.
 
Steps to create a keyword redirect :

1. Log in to Workbench.
2. Select Keyword Redirects.
3. Click Add Redirect.The Add Keyword Redirect panel appears.

Keyword Redirect Pop Up
Keyword Redirect Pop Up

4. Enter an absolute or relative link in the Redirect Link field.
5. Enter a search term or terms in the User Search Terms field.
6. Select a match mode from the drop-down :
 
Match Phrase - Default. A search query triggers a redirect if the search terms match in the specified
trigger terms in the same order. The search query may include additional terms before or after the
trigger terms.
Match All - A search query triggers a redirect if the search terms include all of the specified trigger
terms, but not necessarily in the same order.
Match Exact - A search query triggers a redirect only if the search terms exactly match the specified
trigger terms, in the same order, with no additional terms.
7. (Optional) Click the Add Another button and repeat Steps 5-6 to create additional search term triggers for the specified URI.
Keyword Redirect Pop Up
Keyword Redirect Pop Up

8. Click Save.

Each search term trigger appears in its own row in the Keyword Redirects table.

Keyword Page
Keyword Page
You can configure multiple keywords that trigger a redirect to the same location.

Sunday, 11 June 2017

Check Endeca Workbench publishing activities status

Whenever you publish changes to an application using Workbench tools such as Experience Manager, Keyword Redirects. You can check the status of these changes using Publishing Status console.

An update can have a status of Running, Success, or Failure.

Steps to open the Publishing Status console :

1. On any page in Workbench, click the status bar at the bottom of the page.The Publishing Status console appears.
2. In the Choose Application field, click a specific application or All Applications.This selection shows the status when an administrator runs the promote_content script to promote content from the authoring to the live environment.
4. Click a status line in the console to show details about the publishing action that triggered the status.
5. To toggle between ascending and descending order for the contents of that column, click a column
heading.
Publishing Status Console
Publishing Status Console

Saturday, 8 April 2017

Workbench | Export import workbench users

Sometimes you need to create similar (same set) workbench users on multiple environments (staging and production). Creating same set of users  manually on multiple environments is long process. 

You can these steps to speed up user creation process.

1. Create users manually in one environment : For example in below screen shot I added two users in workbench.

Workbench User Creation
Workbench User Created
 
2. Export users using below command.

========================================================================
export_users.bat --config ..\conf\export_users.properties --output users.json
========================================================================

3. Import these exported users on destination environment.

========================================================================
 import_users.bat --input users.json --config ..\conf\import_users.properties
========================================================================

Before Import






After Import
Note :  These scripts are available at ENDECA_TOOLS_ROOT\admin\bin

Sunday, 26 March 2017

Workbench | Configure the user inactivity logout

Use below steps to set how much time that Workbench users must be inactive before they are automatically logged out.

1. Stop the Endeca Tools Service.
2. Navigate to $ENDECA_TOOLS_CONF/conf.
3. Open the webstudio.properties file, and locate the com.endeca.webstudio.timeout.warning property.
# The warning for impending auto-logout
com.endeca.webstudio.timeout.warning=3300
 
4. Change the value to the number of seconds of inactivity that you want to elapse before an impending
automatic logout warning appears to an inactive user.
5. Locate the com.endeca.webstudio.timeout.logout property.
# The time where a user will be automatically logged out due to inactivity
com.endeca.webstudio.timeout.logout=3600
 
6. Change the value to the number of seconds of inactivity that you want to elapse before an inactive user is logged out of Workbench.
7. Save and close the file.
8. Start the Endeca Tools Service.

Note : Here time out value specified in seconds.

Application displays below pop up after warning timeout. Here on click on OK user can continue the session without login.

Timeout pop up
Timeout warning Pop up
 
Application display below pop up after session time out time. Here on click on OK, it redirects user to login window.

Session Expire pop  up
Session Expire Pop up

Sunday, 25 December 2016

Endeca | Add a new site to an existing application

You can easily add new site to existing endeca application by following below steps.

Nature

1. Export the application you want to modify (Add a site).
   a. Navigate to application control directory.
   b. Invoke this command to export application.
        runcommand.<bat|sh> IFCR exportApplication <destination directory>
   c.  Navigate to destination directory and unzip the exported zip file.

2. Add the default site ID, site node and site definition for you new site.
  a. Navigate to the pages node(directory) of your unzipped exported application. 
  b. Open the _.json file in an editor and add a default site ID.
      For example:
      {
         "defaultSiteId": "/TestStoreDE",
         "ecr:type": "page-root"
      }
  c) Navigate to the <export directory>\pages directory. Note that the application already has an
      existing site. For example, the Store application has an existing site with TestStoreUS as the
      site_ID.
  d) Create a folder for your new site parallel to the existing site. The name that you provide for the folder
       becomes the site_ID, for example
TestStoreDE.
  e) Navigate to the existing site in your application, for example pages\
TestStoreUS.
  f) Copy the site definition file, _.json, from the folder and paste it into your new site folder, for example
      pages\
TestStoreDE\_.json.
  g) Use a text editor to update the site definition with unique information appropriate for your new site. For example, the following new site has been updated with a unique URL pattern, display name, and
      description.
      {
          "ecr:type": "site-home",
          "urlPattern" : "/
TestStoreDE",
          "displayName" : "German Store",
          "description" : "This is German Store",
      }

  h) If you want the site to have its own unique icon to identify it in Experience Manager, you can replace
      the default site icon with one of your own by copying an image to the same directory as the site's
      JSON file.The image must be 16 by 16 pixels, and be named siteIcon.<extension>, for example
      pages\TestStoreDE\siteIcon.png. The supported formats are JPG, JPEG, PNG, GIF, and TIF.         Oracle recommends using the PNG format.
  i) Save and close the file.

3. If you want your site to filter a subset of relevant records, you need to add a site-based filter to your site.
    a) Navigate to the new site directory pages/<new site_ID>, for example pages/TestStoreDE.
    b) Create an XML file and name it filterState.xml. The following file filters records so that only those
         records in the furniture category can appear in the site.
          <Item class="com.endeca.infront.navigation.model.FilterState"
                     xmlns="http://endeca.com/schema/xavia/2010">
                   <Property name="recordFilters">
                     <List>
                          <String>product.category:furniture</String>
                     </List>
                   </Property>
          </Item>
   c) Save and close the file.
4. A site needs at least one page in order to display so copy and paste pages that you want from your original site to your new site.
For example, you could copy the browse or account folder from pages/TestStoreUS to pages/TestStoreDE.
5. Import the content with the new site information.
   a. Navigate to application control directory.
   b. Invoke this command to import updated application.
       runcommand.<bat/sh> IFCR importContent pages <path to source>.

Wednesday, 14 September 2016

Resolved | Workbench Error org.apache.sling.api.SlingException

Today while accessing Oracle Commerce Workbench got below exception on browser.
=========================================================================
The requested URL /ifcr/sites/Store.html resulted in an error in /apps/endeca/site/html.jsp. Exception: org.apache.sling.api.SlingException: at org.apache.sling.scripting.jsp.jasper.servlet.JspServletWrapper.handleJspExceptionIntern al (JspServletWrapper.java:560) atorg.apache.sling.scripting.jsp.jasper.servlet.JspServletWrapper.handleJspException (JspServletWrapper.java:496)
=========================================================================

Solution : Restart the Endeca ToolsAndFrameworks

Friday, 22 January 2016

Endeca SEVERE: Unauthorized (401): Unauthorized access to workbench

Endeca application initialization failed with below error.

=======================================================================
[01.23.16 10:12:03] SEVERE: Unauthorized (401): Unauthorized access to workbench. Please check your credentials.
Occurred while executing line 3 of valid BeanShell script:
[[

1|
2|
3|   IFCR.provisionSite();
4|   CAS.importDimensionValueIdMappings("MyStore-dimension-value-id-manager",
5|                   InitialSetup.getWorkingDir() + "/test_data/initial_dval_id_mappings.csv");
6|

]]

[01.23.16 10:12:03] SEVERE: Caught an exception while invoking method 'run' on object 'InitialSetup'. Releasing locks.

Caused by java.lang.reflect.InvocationTargetException
sun.reflect.NativeMethodAccessorImpl invoke0 - null
Caused by com.endeca.soleng.eac.toolkit.exception.AppControlException
com.endeca.soleng.eac.toolkit.script.Script runBeanShellScript - Error executing valid BeanShell script.
Caused by com.endeca.soleng.eac.toolkit.utility.IFCRUtility$HttpStatusException
com.endeca.soleng.eac.toolkit.utility.IFCRUtility execute - Unauthorized (401): Unauthorized access to workbench. Please check your credentials.
 
=======================================================================

Root Cause : This happened due to ToolsAndFramework installed with password [admin@1234] other then admin.

Update ToolsAndFramework password to admin using below steps.

C:\Endeca\ToolsAndFrameworks\11.1.0\credential_store\bin> manage_credentials.bat add --key ifcr --user admin

Enter password for user admin :

Re-enter password to confirm :

Credential of type [password] already exists for this key.

Do you want to replace it [yes/no] ?yes

23 Jan 2016 10:27:23,954  INFO CSFHandler:146 - Credential successfully updated for map : endecaToolsAndFrameworks.

C:\Endeca\ToolsAndFrameworks\11.1.0\credential_store\bin>


Saturday, 23 August 2014

Configure Users and Groups in Endeca Workbench

Here are the steps to configure Users and Groups for Endeca Workbench.
  1. Login into to Endeca Workbench as admin user.
  2. On first drop down menu (application selection menu), select Administrative Tools.
  3. Go to User Management section.
  4. Here you will see two tabs.
                 1.  Users
                 2.  Group.

1. User Configuration.

To create user click on Add User link on Users tab.

Workbench Users Tab
Workbench Users Tab
Create User pop up will display.

Create User Pop Up
Create User Pop Up
Enter the user details, here you can associate user with existing group.Then click on permissions tab select the permissions for user.

2. Group Configuration.

To create a group click on click on Group Tab on User Management page.

Now click on Add Groups button on this tab.

Workbench Group Tab
Workbench Group Tab

Create Group pop up will display.Enter the group details,click on permission tab to enter the permissions.Click on membership tab to select a sub group or user.

Group Detail Pop Up
Group Detail Pop Up