Activity import - convert to apiv4

[eileenmcnaughton]

Overview

Activity import - convert to apiv4

Before

Activity import uses apiv3

After

uses apiv4

Technical Details

all mappings are namespaced - ie activity.id target_contact.id - as this is a very flat import this is fairly simple (conceptually _

Comments

[civibot]

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...

• If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
• A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
• A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
• If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
• Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
• A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
• To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
• For more information about contributing, see CONTRIBUTING.md.

Quick links for reviewers...

• ➡️ PR Demo site (can be rebuilt with the command test this please).
• 📖 Review standards
• 🗒️ Review template (brief or verbose)

➡️ Online demo of this PR 🔗

[colemanw]

@eileenmcnaughton I just want to check about one thing here...
In SearchKit (and API4.get in general) the base entity is not namespaced. So a search for activities would simply select "subject", "activity_type_id", etc. And then every joined entity would get an alias-prefix, so if you join on a Contact AS contact_1, you'd select contact_1.display_name, etc.

Is there a reason not to do it that way in CiviImport?

[eileenmcnaughton]

@colemanw no - I can do it that way - so it will be no namespace for activity but namespaces for the contacts.

[colemanw]

In Api4 generally the these pseudo-fields end in _id. Not sure if important to keep that consistent here.

civicrm-core/Civi/Api4/Service/Spec/Provider/ActivitySpecProvider.php

Lines 52 to 85 in ddcc28a

	$field = new FieldSpec('source_contact_id', 'Activity', 'Integer');
	$field->setTitle(ts('Source Contact'));
	$field->setLabel(ts('Added by'));
	$field->setColumnName('id');
	$field->setDescription(ts('Contact who created this activity.'));
	$field->setRequired($action === 'create');
	$field->setFkEntity('Contact');
	$field->setInputType('EntityRef');
	$field->setSqlRenderer([__CLASS__, 'renderSqlForActivityContactIds']);
	$spec->addFieldSpec($field);
	$field = new FieldSpec('target_contact_id', 'Activity', 'Array');
	$field->setTitle(ts('Target Contacts'));
	$field->setLabel(ts('With Contacts'));
	$field->setColumnName('id');
	$field->setDescription(ts('Contacts involved in this activity.'));
	$field->setFkEntity('Contact');
	$field->setInputType('EntityRef');
	$field->setInputAttrs(['multiple' => TRUE]);
	$field->setSerialize(\CRM_Core_DAO::SERIALIZE_COMMA);
	$field->setSqlRenderer([__CLASS__, 'renderSqlForActivityContactIds']);
	$spec->addFieldSpec($field);
	$field = new FieldSpec('assignee_contact_id', 'Activity', 'Array');
	$field->setTitle(ts('Assignee Contacts'));
	$field->setLabel(ts('Assigned to'));
	$field->setColumnName('id');
	$field->setDescription(ts('Contacts assigned to this activity.'));
	$field->setFkEntity('Contact');
	$field->setInputType('EntityRef');
	$field->setInputAttrs(['multiple' => TRUE]);
	$field->setSerialize(\CRM_Core_DAO::SERIALIZE_COMMA);
	$field->setSqlRenderer([__CLASS__, 'renderSqlForActivityContactIds']);
	$spec->addFieldSpec($field);

[eileenmcnaughton]

@colemanw no - a feature of the importer is that it handles a mix of things on those fields - ids, names, labels, abbreviations with flexibility around case sensitivity. I know you won't like that :-) but it is not only because of legacy code - it really is the case that users are pretty sloppy with their thinking about the differences between those things