Oracle Akeneo Connector – User Guide

The Oracle Akeneo Connector facilitates the user to export various data on the Oracle database with the help of multiple export jobs.

Users can create various jobs and export them on the Oracle database. They can also remove stored data from the Oracle database.

• This module works with Akeneo 7.0.x. Download Akeneo from here
• This module is compatible with the Akeneo community and Enterprise(Flexibility) edition.
• If you want to use this extension on Akeneo EE Serenity mode, please contact us.
• For the Akeneo installation, your Akeneo server should meet these system requirements.

• Export Association types from Akeneo to Oracle Database.
• The admin can export Attribute Group, Attributes, and Family from Akeneo to the Oracle Database.
• Export Channel, Locale, and Currencies from Akeneo to Oracle Database.
• They can also export Categories from Akeneo to Oracle Database.
• Export Products from Akeneo to Oracle Database.
• Remove data from the Oracle database.

Note – If you want to back up your Akeneo database and assets you can use the Akeneo backup Management extension.

Two different types of module installation processes are available for the module.

1. Composer Installation
2. Manual Installation

Installation using Composer

Read This Blog

Before beginning the composer installation

1: Get the ACCESS KEYS [Create a support ticket]
2: In Akeneo composer.json, add our repository as well as the installation script.

For Akeneo 6.x  and 7.x

```
{
  "scripts": {
        "post-update-cmd": [
           "vendor/webkul/akeneooraclebundle/src/Webkul/AkeneoOracleBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-install-cmd": [
           "vendor/webkul/akeneooraclebundle/src/Webkul/AkeneoOracleBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-create-project-cmd": [
          "vendor/webkul/akeneooraclebundle/src/Webkul/AkeneoOracleBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

Step 3: Install the extension using Composer.

composer require webkul/akeneooraclebundle

Step4: Fill in the authentication.

Step 5: Success Message

Step 6: Clear Browser cache

Manual Installation: Version 7.x and 6.x

• Unzip the respective extension zip and then merge “src” folder into akeneo project

• Run the below command over the NO-DOCKER Instance from the PIM directory

./src/Webkul/AkeneoOracleBundle/install/config.sh COMPOSER=false NO_DOCKER=true

• Run the below command over the docker Instance from the PIM directory

./src/Webkul/AkeneoOracleBundle/install/config.sh COMPOSER=false NO_DOCKER=false

Version 5.x

• Unzip the respective extension zip and then merge the “src” folder into the akeneo project. Goto app/Bundles.php and add line

Webkul\AkeneoOracleBundle\AkeneoOracleBundle::class => ['all' => true],

• Copy to the “config” folder into the akeneo project root directory for routing.

• Run this command after SSH to your akeneo server by terminal

For non-docker instance:

rm -rf var/cache && php bin/console ca:warmup && php bin/console wk_oracle:setup:install

For docker instance:

    alias docker_php='docker-compose run -u www-data --rm php php';
    alias docker_yarn='docker-compose run -u node --rm node yarn';
    docker_php bin/console cache:clear --env=prod;
    docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
    docker_php bin/console d:s:u --force;
    docker_yarn run webpack;
    docker_yarn run update-extensions;
    docker_yarn run less;

Uninstall Module: Version 7.x

Run the below command over the NO-DOCKER Instance from the PIM directory.

./src/Webkul/AkeneoOracleBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true

Run the below command over the DOCKER Instance from the PIM directory.

./src/Webkul/AkeneoOracleBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false

To generate the API credentials please follow the mentioned steps below:

1. Create a Role and Privilege: You need to navigate to SQL Workshop > RESTful Services. From the left side of the tree, click on “Roles.” Create a new Role, e.g., “WebkulRole.”

From the left side of the tree, click on “Privileges.”

Create a new Privilege with the following details:
Name: “WebkulAccess”
Title: “WebkulAccess”
Roles: “WebkulRole”
Protected Modules: “Akeneo”

2. Test the Web Service Method:

After setting up the Privilege, test one of the methods of your web service. It should return a 401 Unauthorized response, indicating that the access is protected.

3. Create a New Client: Execute the following script to create a new client with client_credentials grant type. Path: SQL workshop > SQL Commands.

BEGIN
OAUTH.create_client(
p_name => 'Webkul Access Client',
p_grant_type => 'client_credentials',
p_owner => 'OracleExampleWebkul',
p_description => 'An example client created for my blog.',
p_support_email => '[email protected]',
p_privilege_names => 'WebkulAccess'
);
COMMIT;
END;

4. Grant Client to Role: Execute the following script to grant the newly created client to the “WebkulRole” role:

BEGIN
oauth.grant_client_role(p_client_name => 'Webkul Access Client', p_role_name => 'WebkulRole');
COMMIT;
END;

5. Check Client ID and Secret: Use the following query to check if a record is created for the Client ID and Secret:

SELECT id, client_id, client_secret FROM user_ords_clients WHERE name = 'Webkul Access Client';

With these steps, your Oracle APEX application’s RESTful APIs will be secured using OAuth2. You will need to obtain an access token using the client_credentials grant type and include it in the Authorization header of their requests to access the protected resources. The access token can be obtained by making an OAuth2 token request using the Client ID and Secret you created earlier.

Configure the module-

• Open the ORDS_REST_WKSP_WEBKUL_Akeneo.sql file change p_schema with your schema and p_url_mapping_pattern with your Workspace name and save the file.
• p_schema => ‘schema-name’,
• p_url_mapping_pattern => ‘schema-alias’,

Where: schema-name is the database schema name in all-uppercase.

schema-alias is an alias for the schema name that will appear in the URL the user will use to access Database Actions.

Configure the Module SQL file:

• Import RESTful Service Module using ORDS_REST_WKSP_WEBKUL_Akeneo.sql to your Oracle APEX RESTful services on the path: SQL Workshop->RESTful Data Services->Import

• Create Table and Sequence in your Oracle Apex using the file WebkulTableSequence.sql on the path: SQL Workshop->SQL Scripts->Upload

You need to open the Oracle website and select Oracle Apex.

Once you create the Workspace you will get the Workspace ID, username, and password that needs to be entered here.

Once you enter the details you can open the Oracle database.

You can check the exported data in the SQL workshop with exported job names.

Note- Please explore our Akeneo Development Services and Quality Akeneo Extensions.

Go to the Credentials tab, enter your Rest API URL, Client ID, and Client Secret, and then save your credentials.

Go to Export jobs and Create a job by entering a code, and label, and Selecting Akeneo Oracle Export Job.

You can export the following jobs to export the product data to the Oracle database.

• Association type export
• Attribute export
• Category export
• Channel export
• Currency export
• Family export
• Locale export
• Product export

After creating the job, go to the Content tab and add the necessary filters in FILTER THE DATA and FILTER THE PRODUCTS. After that, Save the job.

Run the job whenever you want to Export data by navigating to Export profiles >> Akeneo Oracle Job and Clicking on Export Now.

Once the exporting starts you can check the progress in the progress bar.

After completion, it will display the success message.

You can check the exported data on the Oracle database.

Note: If the data is already stored im the Oracle database then the export job will throw the error while exporting if the Akeneo version is different. If the exported data is from the same version it will be exported and stored on Oracle.

The user has to remove previously stored job data from the Oracle database.

The user needs to click on the Truncate table option and a popup will open to remove the table.

That’s all about the Oracle Akeneo Connector, for any queries or doubts reach out to us at [email protected]. You can also raise a ticket at our HelpDesk System.