Jobs & parameters

This chapter provides an exemplary overview of the available jobs and their parameters.

AssetExport

Quartz job for the export of assets

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/AssetExportJob.java

Parameters

This job does not require any parameters.

 

AssetImport

Quartz job for the import of assets

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/AssetImportJob.java

Parameters

This job does not require any parameters.

 

AutoAttachArticles

Quartz job for addding articles automatically

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/schedule/jobs/AutoAttachArticlesJob.java

Parameter
Name Description Allowed values
clientIDs Identifiers of the respective clients  

ChangedCategoryMapping

Quartz job for changing category mappings

Java classe

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/ChangedCategoryMappingJob.java

Parameters

This job does not require any parameters.

 

ClickworkerJob

Quartz job that exports data of particular locales and client levels from iPIM to Clickworker and imports data from Clickworker into iPIM

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/ClickworkerJob.java

Parameters
Name Description Allowed values Default values
localeID Identifier of the locale 2 1, 2
clientID Identifier of the client level 1 1

CreateMissingCategoryAttributesJob

Quartz job to subsequently add category attributes with an empty value to products of particular primary taxonomy categories. Hereby, attributes which were specified as category attributes for the respective categories are added.

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/CreateMissingCategoryAttributesJob.java

Parameters
Name Description Allowed values
CategoryIdentifier Topmost category node to which and whose subcategories the job is applied to. If applicable, this is the root node of the respective taxonomy if the job is to be applied to all the categories of a taxonomy.  
VersionIdentifier Identifier of the version of the respective taxonomy  
MandatoryAttribute Parameter with a boolean value to specify whether all the applicable category attributes are added, or whether only mandatory category attributes are added

true: Only mandatory category attributes are added.
false: All the applicable category attributes are added.

maxThreads (optional)   1

DataBackboneResendJob

Quartz job that sends to the failed entries to the data backbone again

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/DataBackboneResendJob.java

Parameters

This job does not require any parameters.

 

Datafeed

Quartz job for the execution of datafeeds

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/DatafeedJob.java

Parameters
Name Description Allowed values Default value
userID Identifier of the respective user   1
clientID Identifier of the respective client    

DatafeedProducts

Quartz job for the execution of datafeeds with a list of products

Java class

PIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/DatafeedProductsJob.java

Parameters
Name Description Allowed values
products List of the products  
progressTrackerID Identifier of the progress tracker  

DirtyWordsSearch

Quartz job that checks the data in iPIM for the use of prohibited words

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/DirtyWordsSearchJob.java

Parameters

This job does not require any parameters.

 

Elastic_Search_Asset_Full_ExportJob

Job for the full export of digital asset data to iPIM Search

 

Elastic_Search_Asset_Incremental_ExportJob

Job for the incremental export of digital asset data to iPIM Search

 

Elastic_Search_Product_Full_ExportJob

Job for the full export of product data to iPIM Search

 

Elastic_Search_Product_Incremental_ExportJob

Job for the incremental export of product data to iPIM Search

 

ErpImport

Quartz for the import of files with ERP data into the ERP import database area and the transformation of the imported item data into main data which is then written into the iPIM database.

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/ErpImportJob.java

Parameters
Name Description Allowed values
fileTypes File types to be imported product, price
productLoadMode Mode for loading products

increment: When eecuting the job, the existing products are updated.

full: When executing the job, the complete set of products is imported. Existing products that are not included in the current import file are deleted.

attributeLoadMode Mode for loading attributes (optional)

increment: When executing the job, it deletes for each item the attributes that are not inluded in the import file and that are not listed under the parameter attributeLoadList.

full: When executing the job, it deletes for each item the attributes that are not inluded in the import file.

attributeLoadList Identifiers of the attributes that are deleted if they are not included in the import file, given in list form (optional)  
valueLoadMode Mode for loading attribute values

replace: When executing the job, the existing attribute values are replaced (default).

add: When executing the job, the imported attribute values are apprehended to the existing attribute values. This only affects attributes that are listed under the parameter attributeAddValueList.

attributeAddValueList Identifiers of the attributes to whose values the imported attribute values are apprehended, given in list form  
clientList List of the clients to be processed  
source Parameter to specify a source. Only data from this source is transfered to iPIM.  
onlyImport Parameter to specify whether ERP data is only imported but not transformed and not written into the iPIM database. If a value is set, the ERP data is only imported. true, on, yes, ja, y, 1, j, x

ErpImportSelectiveExport

Job for executing the ErpImportJobs in dependence to the respective file type

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/ErpImportSelectiveExportJob.java

Parameter
Name Description Allowed values
fileTypes File types to be imported product, price
productLoadMode Mode for loading products

increment, full

attributeLoadMode Mode for loading attributes  
valueLoadMode Mode for loading attribute values  
attributeAddValueList List of the attributes whose values are to be imported  
source Parameter to specify a source. Only data from this source is transfered to iPIM.  

Export

Quartz job for exporting articles

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/ExportJob.java

Parameters
Name Description Allowed values
destination Target path for the export  

ExportVersion

Quartz job for the export of the version of a publication

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/ExportVersionJob.java

Parameters
Name Description Allowed values
versionId Identifier of the respective version  
exportType Export type  
transfer Parameter to specify whether the export is executed

true: The export is executed.
false: The export is not executed.

FullExportJob

Quartz job for the full export of product data

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/FullExportJob.java

 

iMARKETExport

Standard quartz job for the export of product data to iMARKET

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/IMarketExportJob.java

 

ImportSupplierData

Quartz job which imports supplier data for suppliers with “upload = 0” automatically. The trigger for the job is configured in the entity job. The job will write the data into the “JobHistory” table.

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/ImportSupplierDataJob.java

Parameters

This job does not require any parameters.

 

iPrintFullExport

Quartz job for the full iPrint export

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/IprintFullExportJob.java

Parameters
Name Description Alloowed values
localeId Database ID of the locale 1, 2
clientId Identifier of the client 1

iPrintImport

Job for a regualar iPIM print import in order to import new or changed print data

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/dataexport/ipoem/IpoemExportLocale.java

Parameters

This job does not require any parameters.

 

iSHOPFullExport

Quartz job for a full export of product data to iSHOP, whereby the export is done in the XML format.

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/IShopFullExportJob.java

 

IshopAssetFullExportJob

Quartz job for a full export of digital asset data to iSHOP

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/IshopAssetFullExportJob.java

Parameters

This job does not require any parameters.

 

IshopAssetIncrementExportJob

Quartz job for an incremental export of digital asset data to iSHOP

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/IshopAssetIncrementExportJob.java

Parameters
Name Description Allowed values Default value
IshopAssetFullExportJob Reference to the full iSHOP export job that is related to the incremental job    
doMainData Boolean value to specify whether main data is exported

true: Main data is exported.
false: Main data is not exported.

true
needsNewSession Boolean value to specify whether a new session is started for the job

true: A new session is started.
false: The export is run in the original session.

 

true

ProcessQueueGenerateTextJob

Standard job for a near real time text generation for attributes based on templated specified in iPIM CC

 

OxidExport

Quartz job for an export of product data to an OXID eShop

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/OxidExportJob.java

Parameters

This job does not require any parameters.

 

Report

Quartz job for the execution of reports

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/ReportJob.java

Parameters

This job does not require any parameters.

 

Sequence

Quartz job for executing jobs in a specified order

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/SequenceJob.java

Parameters
Name Description Allowed values
Job List of the jobs to be executed  

ShopwareExport

Quartz job for the export of product data to a Shopware shop

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/ShopwareExportJob.java

Parameters
Name Description Allowed values
versionIdentifier Identifier of the version of the respective taxonomy  
stringClientIds Identifier of the respective client  

TranslationJob

Quartz job for the export of product data to external translation agencies and for the import of the translated data

Java class

iPIM_CORE_Server/src/com/novomind/ipim/core/util/scheduler/jobs/TranslationJob.java

Parameters
Name Description Allowed values Default value
eventType Identifier of the respective event type The respective event type’s ID  
system System identifier 2  
format File format of the import file (file name extension) CSV, HTML  
exportFilePrefix File name prefix String value  
exportDatePattern Date format yyyy_MM_dd-HH_mm_ss  
importFilePattern File name of the import file (File name prefix + file name extension) String value  
clientId Identifier of the client 1  
sourceLocaleId Database identifier of the source locale 1, 2  
targetLocaleId Database identifier of the target locale 1, 2  
exportItems Boolean value to specify whether items are exported

true: Items are exported.

false : Items are not exported.

 
textTypeIdentifiers Identifier of the text types to translated String value (comma-separated)  
attributeIdentifiers Identifier of the attributes to be translated String value (comma-separated)  
exportAssets Boolean value to specify if assets are to be exported

true: Assets are exported.

false : Assets are not exported.

false
updateOtherUserChanges Boolean value to specify if changes that were made by users in the meantime are to be overwritten by the import

true: Changes are overwritten.

false: Changes are not overwritten.

true