Skip to main content

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Pre-import action properties

Suggest edit
Updated on April 5, 2022

Use metadata properties to create pre-import action steps that run before every import attempt. The metadata for the incoming archive, for example, the archive name, the list of all the rules it contains, and so on, is available to the pyPreImportCollection rule from properties on the embedded page pxArchiveMetadataPage.

General properties

These properties are included in pxArchiveMetadataPage.

Property nameTypeDescription
pxMissingDBNamesValueListNames of the databases in the archive that are missing from the current schema
pxInvalidDBNamesValueListNames of invalid databases in the archive
pxNewDBNamesValueList New Data-Admin-DB-Names in the archive being inserted into the current schema
pxExistingDBNamesValueList Existing Data-Admin-DB-Names in the archive being inserted into the current schema
pxMissingPrerequisitesValueListMissing dependent rulesets
pxSQLStatementsValueListSQL statements that will be executed when the archive is imported
pxCodeJarNamesValueListCode .jar files in the archive
pxHandlesValueListKey property (pzInsKey) for the achive
pxRuleTypesValueListClass name (pxObjClass) for the archive
pxCodeSetVersionTextCode set version of the archive
pxCodeSetNameTextCode set name of the archive
pxArchiveLengthIntegerLength of the archive

Missing product dependency and hotfix dependency properties

Product and hotfix depencies required by the incoming archive that are not available on the system are listed in the page list pxMissingProductDependecies, of type Embed-Rule-Admin-Product-Dependencies. Each row in the page list has the following properties.

Property nameTypeDescription
pyDependentObjClassTextObject class of the missing product dependencies for the archives
pyDependentProductNameTextProduct name of the missing product dependencies for the archive
pyDependentProductVersionTextProduct version of the missing product dependencies for the archive
pyHotfixIDTextThe ID of the missing hotfix for the archive

Missing non-rule-resolved-rule properties

Rules that are required by the incoming archive that are not available on the system are listed in the page list pxMissingNRRRs, of type Em bed-MissingNonVersionedRules. Each row in the page list has the following properties.

Property nameTypeDescription
pxRuleObjClassTextObject class of the missing non-rule-resolved instance in the archive
pxInstanceNameTextName of the missing non-rule-resolved instance in the archive
pxRuleSetNameTextRuleset name for the missing non-rule-resolved instance in the archive
pxInsKeyTextThe pxInsKey value for the missing non-rule-resolved instance in the archive

Data inventory instance properties

Data instances to be imported from the incoming archive are listed in the page list pxInventoryInstances of type Data-InventoryInstance. If the archive does not include any data-inventory instances, these properties are empty.

Each row in the page list has the following properties.

Property nameTypeDescription
pxAppliesToTextClass name that contains the data-inventory instance in the archive
pxCategoryTextCategory name for the data-inventory instance in the archive
pxCircumstanceDateDateCircumstance rule date for the data-inventory instance in the archive
pxCircumstancePropTextCircumstance property for the data-inventory instance in the archive
pxCircumstanceTypeTextCircumstance property type, for example, text, date, Boolean
pxCircumstanceValTextCircumstance value for the data-inventory instance in the archive
pxClassNameTextClass name for the data-inventory instance in the archive
pxDateTimeDateTimeDate and time on which the data-inventory instance in the archive was created
pxInsNameIdentifierData-inventory instance name in the archive
pxInsTypeTextData-inventory instance type, for example, text, date, Boolean
pxKeyTextThe pzInsKey value for the data-inventory instance in the archive
pxOverideRuleSetTextRuleset of any overridden data-inventory instance in the archive
pxRuleAvailableTextSpecifies whether the data-inventory instance is available
pxRuleEndsDateRuleset end date for the data-inventory instance in the archive
pxRuleSetTextRuleset name and version number of the data-inventory instance in the archive
pxSetVersionTextRuleset version of the data-inventory instance in the archive
pxRuleStartsDateRuleset end date for the data-inventory instance in the archive
pxSetNameTextRuleset name of the data-inventory instance in the archive
pxUpdateOperatorTextOperator performing the import. If there is no data-inventory instance in the archive, you cannot retrieve the operator ID.
pxSaveModeText Specifies how Pega Platform manages data in the data-inventory instance:
  • INSERT: insert new or changed data. Do not change the existing data.
  • UPDATE: Overwrite the existing data with the data from the archive.
  • DELETE: Delete the existing data and do not add any new data from the archive.
  • NOCHANGE: Make no changes to the data.
pyIsSelectedTrueFalseSpecifies whether the data-inventory instance is selected
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us