How to disable emails with campaign creation using webservice API calls into Governance
Article ID: 279092
Updated On:
Products
Issue/Introduction
In Identity Governance, when trying to create a campaign using a webservice call Create_Campaign_from_template the campaign is created successfully but it auto-sends escalation emails and also schedules the email.
How can we "disable emails" before creating campaigns in the webservice call?
Environment
Identity Governance 14.4 and higher.
Cause
Create_Campaign_from_template does include the option to enable/disable email which is why it doesn't work. Instead, use the regular "Create Campaign" option and specify the customized template name in the request.
Resolution
Instead of using Create_Campaign_from_Template, use Create_Campaign and specify the customized template that should be used.
Use the CreateCampaign API instead of CreateCampaignFromTemplate.
Get the desired template ID (BUSINESSFLOWID) from the BUSINESSFLOWS table in the Identity portal database.
In the CreateCampaign SOAP request, in addition to setting the email element to False, specify the template ID in these two elements.
<dto:name>certification.campaign.origin.template</dto:name>
and
<cam:id>?</cam:id>
For example,
<dto:name>certification.campaign.origin.template</dto:name>
<dto:value>477</dto:value>
and
<cam:id>477</cam:id>
Additional Information
Documentation on the Governance API can be found here:
https://techdocs.broadcom.com/us/en/symantec-security-software/identity-security/identity-governance/14-5/programming/web-services.html
Below is a sample of a full SOAP request with email disabled and pointing to a customized campaign template:
This XML file does not appear to have any style information associated with it. The document tree is shown below.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.eurekify.com" xmlns:cam="http://campaign.dto.eurekify.com" xmlns:dto="http://dto.eurekify.com">
<soapenv:Body>
<ser:createCampaign>
<ser:in0>
<!-- Optional: -->
<cam:aggregatedProcess>false</cam:aggregatedProcess>
<!-- Optional: -->
<!-- Optional: -->
<cam:auditCardFilter>NONE</cam:auditCardFilter>
<!-- Optional: -->
<cam:autoStartDate>2024-01-25T15:36:17-08:00</cam:autoStartDate>
<!-- Optional: -->
<cam:campaignTaskTypes>
<!-- Zero or more repetitions: -->
<ser:string>DIRECT_USER_ROLE_LINK_APPROVAL</ser:string>
<ser:string>DUAL_USER_ROLE_LINK_APPROVAL</ser:string>
<ser:string>DIRECT_USER_RESOURCE_LINK_APPROVAL</ser:string>
<ser:string>DUAL_USER_RESOURCE_LINK_APPROVAL</ser:string>
</cam:campaignTaskTypes>
<!-- Optional: -->
<cam:completedTasks>0</cam:completedTasks>
<!-- Optional: -->
<cam:creationDate>2024-01-25T15:36:17-08:00</cam:creationDate>
<!-- Optional: -->
<cam:defaultManager>AD1\EAdmin</cam:defaultManager>
<!-- Optional: -->
<cam:description>Here is campaign description</cam:description>
<!-- Optional: -->
<cam:document>ConnectedUniverse_modelConfig</cam:document>
<!-- Optional: -->
<cam:duration>604800000</cam:duration>
<!-- Optional: -->
<cam:enforceRejectionComment>false</cam:enforceRejectionComment>
<!-- Optional: -->
<cam:enforceViolationsComment>false</cam:enforceViolationsComment>
<!-- Optional: -->
<!-- Optional: -->
<cam:executionOnModel>true</cam:executionOnModel>
<!-- Optional: -->
<cam:expirationDate>2024-02-01T15:36:17-08:00</cam:expirationDate>
<!-- Optional: -->
<cam:generateAuditCard>false</cam:generateAuditCard>
<!-- Optional: -->
<cam:id>296</cam:id>
<!-- Optional: -->
<cam:inProgressTasks>0</cam:inProgressTasks>
<!-- Optional: -->
<cam:includeDeltaTasks>true</cam:includeDeltaTasks>
<!-- Optional: -->
<cam:membersList>-1</cam:membersList>
<!-- Optional: -->
<cam:name>WS108 - User Cert - Custom</cam:name>
<!-- Optional: -->
<cam:owner>AD1\EAdmin</cam:owner>
<!-- Optional: -->
<cam:processMapping>1</cam:processMapping>
<!-- Optional: -->
<cam:processProperties>
<!-- Zero or more repetitions: -->
<dto:Property>
<!-- Optional: -->
<dto:name>?</dto:name>
<!-- Optional: -->
<dto:value>?</dto:value>
</dto:Property>
</cam:processProperties>
<!-- Optional: -->
<cam:properties>
<!-- Zero or more repetitions: -->
<dto:Property>
<!-- Optional: -->
<dto:name>certification.template.allowRecurrence</dto:name>
<!-- Optional: -->
<dto:value>false</dto:value>
</dto:Property>
<dto:Property>
<!-- Optional: -->
<dto:name>certification.campaign.reassign.filter</dto:name>
<!-- Optional: -->
<dto:value>All</dto:value>
</dto:Property>
<dto:Property>
<!-- Optional: -->
<dto:name>general.allowSelectAll</dto:name>
<!-- Optional: -->
<dto:value>true</dto:value>
</dto:Property>
<dto:Property>
<!-- Optional: -->
<dto:name>campaign.links</dto:name>
<!-- Optional: -->
<dto:value>0,2,3,5</dto:value>
</dto:Property>
<dto:Property>
<!-- Optional: -->
<dto:name>campaign.archive.after.days</dto:name>
<!-- Optional: -->
<dto:value>30</dto:value>
</dto:Property>
<dto:Property>
<!-- Optional: -->
<dto:name>certification.template.configurationSelection</dto:name>
<!-- Optional: -->
<dto:value>certification.template.selectModelConfiguration</dto:value>
</dto:Property>
<dto:Property>
<!-- Optional: -->
<dto:name>campaign.recertification.calculateDelta</dto:name>
<!-- Optional: -->
<dto:value>true</dto:value>
</dto:Property>
<dto:Property>
<!-- Optional: -->
<dto:name>certification.campaign.schedule.email</dto:name>
<!-- Optional: -->
<dto:value>false</dto:value>
</dto:Property>
<dto:Property>
<!-- Optional: -->
<dto:name>certification.campaign.origin.template</dto:name>
<!-- Optional: -->
<dto:value>296</dto:value>
</dto:Property>
<dto:Property>
<!-- Optional: -->
<dto:name>campaign.typeOption</dto:name>
<!-- Optional: -->
<dto:value>0</dto:value>
</dto:Property>
<dto:Property>
<!-- Optional: -->
<dto:name>certification.campaign.consult.filter</dto:name>
<!-- Optional: -->
<dto:value>All</dto:value>
</dto:Property>
<dto:Property>
<!-- Optional: -->
<dto:name>campaign.recertification.states</dto:name>
<!-- Optional: -->
<dto:value>1,1:2,2:0,0</dto:value>
</dto:Property>
</cam:properties>
<!-- Optional: -->
<cam:reCertificationCampaignReference>-1</cam:reCertificationCampaignReference>
<!-- Optional: -->
<cam:reassignTaskAggEmailTemplate>0</cam:reassignTaskAggEmailTemplate>
<!-- Optional: -->
<cam:reassignTaskEmailTemplate>0</cam:reassignTaskEmailTemplate>
<!-- Optional: -->
<cam:reassignTaskEmailTemplateEnable>false</cam:reassignTaskEmailTemplateEnable>
<!-- Optional: -->
<cam:recertType>?</cam:recertType>
<!-- Optional: -->
<cam:recertificationStates>
<!-- Zero or more repetitions: -->
<dto:Property>
<!-- Optional: -->
<dto:name>APPROVED</dto:name>
<!-- Optional: -->
<dto:value>APPROVED</dto:value>
</dto:Property>
<dto:Property>
<!-- Optional: -->
<dto:name>REJECTED</dto:name>
<!-- Optional: -->
<dto:value>REJECTED</dto:value>
</dto:Property>
<dto:Property>
<!-- Optional: -->
<dto:name>PENDING</dto:name>
<!-- Optional: -->
<dto:value>PENDING</dto:value>
</dto:Property>
</cam:recertificationStates>
<!-- Optional: -->
<cam:removeRoleResourceProcessName>?</cam:removeRoleResourceProcessName>
<!-- Optional: -->
<cam:removeRoleRoleProcess>?</cam:removeRoleRoleProcess>
<!-- Optional: -->
<cam:removeUserResourceProcessName>?</cam:removeUserResourceProcessName>
<!-- Optional: -->
<cam:removeUserRoleProcessName>?</cam:removeUserRoleProcessName>
<!-- Optional: -->
<cam:secondEntityGFilter>?</cam:secondEntityGFilter>
<!-- Optional: -->
<cam:selfAttestation>false</cam:selfAttestation>
<!-- Optional: -->
<cam:startCampaignAggEmailTemplate>0</cam:startCampaignAggEmailTemplate>
<!-- Optional: -->
<cam:startCampaignEmailTemplate>0</cam:startCampaignEmailTemplate>
<!-- Optional: -->
<cam:startCampaignEmailTemplateEnable>false</cam:startCampaignEmailTemplateEnable>
<!-- Optional: -->
<cam:startDate>2024-01-25T15:36:17-08:00</cam:startDate>
<!-- Optional: -->
<cam:state>IN_PROGRESS</cam:state>
<!-- Optional: -->
<cam:totalTasks>0</cam:totalTasks>
<!-- Optional: -->
<cam:type>USER_CERTIFICATION</cam:type>
<!-- Optional: -->
<cam:universe>ConnectedUniverse</cam:universe>
<!-- Optional: -->
<cam:useRaci>true</cam:useRaci>
</ser:in0>
</ser:createCampaign>
</soapenv:Body>
</soapenv:Envelope>
Attachments
Feedback
