Declaratively schedule process automation from reports and list views!
Explore the docs »
View Examples · Report Bug · Request Feature
Declaratively schedule process automation from reports and list views!
Explore the docs »
View Examples
·
Report Bug
·
Request Feature
Describe the purpose of this Mass Action Configuration. Your future self and those that come after you will appreciate it.
Pro Tip: After you've saved this record, use the Quick Edit button to edit details without needing to step through the entire wizard each time.
Each step of this wizard includes tips and advice. You can also find more documentation, examples, and support at these resources:
Active configurations can be run manually or on a schedule.
Inactive configurations do not run. If a configuration is scheduled, it's Apex job is unscheduled for future runs until you re-activate it again.
Batch Size controls the number of times the target action from the Choose Action step is invoked per save transaction. As when using Data Loader, you may need to reduce the batch size to stay within governor limits.
Named Credential is optional and is a way to specify the running user performing the actions. That is to say the user who has their name stamped as the "Last Modified By" on any updated records by the target action from the Choose Action step. If not specified, then the user who last activates the configuration, or who manually runs it, is the running user.
Select the source of the records you want to process.
List Views are easy to create and support simple filter criteria. Learn how to create list views with the Create and Customize List Views unit on Trailhead.
Reports are powerful and support complex filter criteria like Cross Filters. Learn how to create reports with the Reports & Dashboards for Lightning Experience module on Trailhead.
SOQL queries are an advanced technique to search for specific records. Simple queries can be helpful when you don't want to deal with the overhead of creating a list view or a report. Learn how to write SOQL queries with the Write SOQL Queries unit on Trailhead.
Apex classes that implement Iterable<Map<String, Object>> are an advanced technique that give you full control over what the source data is.
For example, if you need to make multiple SOQL queries, apply complex data filtering, or retrieve data from an external web service with http callouts.
Learn how to develop custom iterators with the Apex Developer Guide.
Stay within limits. If your source type would return more than its record limit then either modify filters to reduce the row count or use a different source type. For example, a report that returns 30 thousand records would need to be split into three smaller reports or switch to another source type.
| Source Type | Limits |
|---|---|
| List Views | Up to 50 million records. |
| Reports |
Up to 10 thousand records.
Tabular report format only. Report must be saved in a custom folder. |
| SOQL | Up to 50 million records. |
| Apex |
Up to 50 million records.
Class must implement Iterable<Map<String, Object>> and provide a no-argument constructor.
|
Alias SOQL aggregate functions. Aggregate functions like COUNT, MIN, MAX, AVG, SUM and others
must be aliased to be selectable in the Field Mappings step.
For example, consider the query SELECT COUNT(Id) RecordCount, Type FROM Account GROUP BY Type.
Without the RecordCount alias then only the Type field would be available on the Field Mappings step.
Test your data source before automating. Confirm fields and filters by first previewing list views and running reports. Execute SOQL queries in a tool like Developer Console or Data Loader.
Select the target action you want to process the source records.
Note, Process Builders and Flows are grouped together because the REST API does not distinguish between them. You may like to use a naming convention to help you tell them apart. For example, adding the word "Flow" to the names of your flows (e.g. "My Account Flow").
If you don't see the action you want listed, ensure that it is active and is a supported type.
| Action Type | Supported Types |
|---|---|
| Process Builder | Processes that start when invoked by another process, not when a record is created or updated. |
| Flows | Autolaunched flows. Flows that don't require user interaction like screens. |
| Quick Actions | Create a Record, Update a Record, and Log a Call types. |
| Email Alerts | All |
| Workflow Rules | Active rules. |
| Apex |
Classes annotated with @InvocableMethod or anonymous blocks.
For anonymous blocks, your script must include the following method definition,
which will be passed the current batch of source records. Each execution of your script occurs in its own transaction.
Apex classes and anonymous blocks are invoked once per batch of source records, just like the |
Map source fields as inputs to the target action.
For example, some action types like Process Builder, Workflow Rules, and Email Alerts require a record ID to be mapped to them from the source data.
Don't see the Source Field you're looking for?
COUNT, MIN, MAX, AVG, SUM and others
must be aliased to be selectable in the Field Mappings step.
For example, consider the query SELECT COUNT(Id) RecordCount, Type FROM Account GROUP BY Type.
Without the RecordCount alias then only the Type field would be available on the Field Mappings step.
SELECT Id, Name, ( SELECT FirstName FROM Contacts ) FROM Account.
The child relationship query SELECT FirstName FROM Contacts is ignored.
Therefore, and for performance, do not use child relationship queries in your SELECT statement.
Don't see the Target Field you're looking for?
execute method.Choose the schedule frequency when to run this Mass Action Configuration.
On Demand runs only when you click the Run button or if you use Process Builder, Flow, or Apex to
invoke the provided MA_RunConfigInvocable invocable Apex class (labeled "MAS: Run Mass Action").
Scheduled provides simple options to choose the hour, day, month, and year to run the configuration repeatedly.
Custom allows you to specify your own cron expression which allows more advanced options than the provided simple scheduler. Learn more about how to write cron expressions in the "Using the System.Schedule Method" section of the Apex Scheduler documentation.
Note, only active configurations will run regardless the schedule frequency chosen.
Salesforce has a limit on the number of scheduled Apex jobs at one time. Traditionally this is 100 scheduled jobs. If you encounter an error trying to save an active configuration with a scheduled or custom frequency, you may have reached the limit and need to either deactivate other configurations or unschedule other Apex jobs in your org. Learn more about these limits in the "Apex Scheduler Limits" section of the Apex Scheduler documentation.
Example cron expressions for custom schedule frequency:
| Expression | Description |
|---|---|
0 0 13 * * ? |
Runs every day at 1 PM. |
0 0 22 ? * 6L |
Runs the last Friday of every month at 10 PM. |
0 0 10 ? * MON-FRI |
Runs Monday through Friday at 10 AM. |
0 0 20 * * ? 2010 |
Runs every day at 8 PM during the year 2010. |
0 0 8 13 2 ? |
Runs every 13th of February at 8 AM. |
The selected action type has no fields to map.
You may proceed to schedule this configuration.
| Source Field | Target Field |
|---|---|
|
|
|
Select the hours, days of month or weekdays, and months that you want to schedule the action to run.
tag but without the
* ridiculous leading whitespace.
*/
.THIS code.block {
color: #d14;
white-space: pre-line;
display: block;
}
/**
* This CSS selector places the tag name after our class name
* because the `class` attribute we put on
* is applied to the outer DOM element and not on the actual
* `textarea` tag within the component. Therefore, our selector
* needs to cascade to the `textarea` elements in the component.
*/
.THIS textarea[name="inputTargetApexScript"],
.THIS textarea[name="inputSourceSoqlQuery"] {
height: 200px;
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/aura/MA_EditConfigCmp/MA_EditConfigCmpController.js
================================================
/*
Author: Doug Ayers
Website: https://douglascayers.com
GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
License: BSD 3-Clause License
*/
({
onInit : function( component, event, helper ) {
var recordId = component.get( 'v.recordId' );
// initialize wizard to first step
var wizard = component.find( 'wizard' );
wizard.moveToStage( 0 );
component.set( 'v.wizardActiveStageIndex', 0 );
Promise.resolve()
.then( $A.getCallback( function() {
let promises = [];
promises.push( helper.getObjectDescribeAsync( component )
.then( $A.getCallback( function( objectDescribe ) {
component.set( 'v.objectDescribe', objectDescribe );
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Getting Object Describe', err, 'error' );
}))
);
promises.push( helper.getRecordAsync( component, recordId )
.then( $A.getCallback( function( record ) {
component.set( 'v.record', record );
component.set( 'v.sourceType', record.sourceType );
component.set( 'v.targetType', record.targetType );
component.set( 'v.targetSobjectType', record.targetSobjectType );
component.set( 'v.targetInvocableAction', record.targetActionName );
if ( record.targetType === 'Apex' ) {
if ( !$A.util.isEmpty( record.targetActionName ) ) {
component.set( 'v.targetApexType', 'Invocable' );
}
else if ( !$A.util.isEmpty( record.targetApexScript ) ) {
component.set( 'v.targetApexType', 'Anonymous' );
}
}
helper.initScheduleOptions( component );
return record;
})).then( $A.getCallback( function( record ) {
if ( !$A.util.isUndefinedOrNull( record.sourceReportID ) ) {
return helper.getReportAsync( component, record.sourceReportID )
.then( $A.getCallback( function( report ) {
if ( !$A.util.isUndefinedOrNull( report ) ) {
component.set( 'v.sourceReport', report );
component.set( 'v.sourceReportId', ( report.Id && report.Id.substring( 0, 15 ) ) );
component.set( 'v.sourceReportFolderId', ( report.OwnerId && report.OwnerId.substring( 0, 15 ) ) );
component.set( 'v.sourceReportColumnName', record.sourceReportColumnName );
}
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Getting Report', err, 'error' );
}));
}
if ( !$A.util.isUndefinedOrNull( record.sourceListViewID ) ) {
return helper.getListViewAsync( component, record.sourceListViewID )
.then( $A.getCallback( function( listView ) {
if ( !$A.util.isUndefinedOrNull( listView ) ) {
component.set( 'v.sourceListView', listView );
component.set( 'v.sourceListViewId', ( listView.Id && listView.Id.substring( 0, 15 ) ) );
component.set( 'v.sourceListViewSobjectType', listView.SobjectType );
}
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Getting List View', err, 'error' );
}));
}
})).then( $A.getCallback( function() {
// avoid race condition where as the page loads,
// several change handlers call controller methods
// and those methods end up reading/writing attribtues
// before the above async operations have completed.
// https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler/issues/94
component.set( 'v.didInitConfig', true );
return Promise.all([
helper.handleSourceTypeChange( component ),
helper.handleTargetTypeChange( component )
]);
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Getting Mass Action Configuration', err, 'error' );
}))
);
promises.push( helper.getNamedCredentialsAsync( component )
.then( $A.getCallback( function( namedCredentials ) {
var emptyOption = {
'label': '--None--',
'value': null
};
component.set( 'v.targetNamedCredentials', [ emptyOption ].concat( namedCredentials ) );
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Getting Named Credentials', err, 'error' );
}))
);
return Promise.all( promises );
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error initializing component', err, 'error' );
}));
},
handleNavigationButtonClick : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
var wizard = component.find( 'wizard' );
var currentStageIndex = wizard.get( 'v.activeChevron' );
var button = event.getSource();
var buttonLabel = button.get( 'v.label' );
if ( buttonLabel == 'Previous' ) {
wizard.moveToStage( currentStageIndex - 1 );
} else if ( buttonLabel == 'Next' ) {
var inputCmps = []; // fields to validate to proceed to next step
if ( currentStageIndex === 0 ) { // Details
inputCmps = [
component.find( 'inputName' ),
component.find( 'inputDeveloperName' ),
component.find( 'inputDescription' ),
component.find( 'inputActive' ),
component.find( 'inputBatchSize' ),
component.find( 'inputNamedCredential' )
];
} else if ( currentStageIndex === 1 ) { // Choose Source
inputCmps = [
component.find( 'inputSourceType' ),
component.find( 'inputSourceReportFolder' ),
component.find( 'inputSourceReport' ),
component.find( 'inputSourceReportColumn' ),
component.find( 'inputSourceListViewSobjectType' ),
component.find( 'inputSourceListView' ),
component.find( 'inputSourceSoqlQuery' ),
component.find( 'inputSourceApexClass' )
];
} else if ( currentStageIndex === 2 ) { // Choose Action
inputCmps = [
component.find( 'inputTargetType' ),
component.find( 'inputTargetSobjectType' ),
component.find( 'inputTargetAction' ),
component.find( 'inputTargetApexType' ),
component.find( 'inputTargetApexScript' )
];
} else if ( currentStageIndex === 3 ) { // Field Mappings
var inputSourceFieldNames = component.find( 'inputMappingSourceFieldName' );
if ( $A.util.isArray( inputSourceFieldNames ) ) {
for ( var i = 0; i < inputSourceFieldNames.length; i++ ) {
inputCmps.push( inputSourceFieldNames[i] );
}
} else {
inputCmps.push( inputSourceFieldNames );
}
}
helper.validateInputsAsync( component, inputCmps )
.then( $A.getCallback( function( validationResult ) {
var isValidToProceed = !validationResult.hasErrors;
if ( isValidToProceed ) {
return Promise.resolve()
.then( $A.getCallback( function() {
// if advancing to field mappings section then
// determine the action inputs and any current mappings
if ( currentStageIndex === 2 ) {
return helper.renderTargetFieldMappingsAsync( component );
}
})).then( $A.getCallback( function() {
wizard.advanceProgress();
}));
} else {
validationResult.components.forEach( function( validationComponentResult ) {
if ( validationComponentResult.hasError ) {
helper.toastMessage( 'Step Incomplete', validationComponentResult.messageWhenInvalid, 'error' );
validationComponentResult.component.reportValidity();
}
});
}
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Advancing to Next Step', err, 'error' );
}));
}
},
handleSaveButtonClick : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
var inputCmps = [
component.find( 'inputScheduleFrequency' ),
component.find( 'inputScheduleHourOfDay' ),
component.find( 'inputScheduleWeekday' ),
component.find( 'inputScheduleDayOfMonth' ),
component.find( 'inputScheduleMonthOfYear' ),
component.find( 'inputScheduleCron' )
];
helper.validateInputsAsync( component, inputCmps )
.then( $A.getCallback( function( validationResult ) {
var isValidToSave = !validationResult.hasErrors;
if ( isValidToSave ) {
return helper.saveRecordAsync( component )
.then( $A.getCallback( function( result ) {
if ( result.success ) {
helper.toastMessage( 'Save Successful', '', 'success' );
// Cause lightning data service to invalidate it's cache.
// I added this after realizing the compact layout was not
// picking up changes to fields by this component.
// I started out firing the force:refreshView event but
// that only worked if the record already existed, if we
// just saved a new record then we needed to still navigate to it.
// And I didn't know how to listen for the refreshView event to complete
// but I did find that I could use a callback in the LDS reloadRecord method.
var lds = component.find( 'lds' );
lds.set( 'v.recordId', result.recordId );
lds.reloadRecord( true, function() {
helper.navigateToRecord( result.recordId );
});
} else {
helper.toastMessage( 'Save Failed', '', 'error' );
}
}));
} else {
validationResult.components.forEach( function( validationComponentResult ) {
if ( validationComponentResult.hasError ) {
helper.toastMessage( 'Step Incomplete', validationComponentResult.messageWhenInvalid, 'error' );
validationComponentResult.component.reportValidity();
}
});
}
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Saving Configuration', err, 'error' );
}));
},
// ----------------------------------------------------------------------------------
handleInputNameFieldBlur : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
var inputCmp = event.getSource();
var inputValue = inputCmp.get( 'v.value' );
// predict the developer name from the name, a familiar feature to admins
if ( !helper.isEmpty( inputValue ) && helper.isEmpty( component.get( 'v.record.developerName' ) ) ) {
component.set( 'v.record.developerName', inputValue.trim().replace( /[ ]+/g, '_' ) );
}
},
handleOnBlurInputSourceSoqlQuery : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
var inputCmp = event.getSource();
var inputValue = inputCmp.get( 'v.value' );
if ( !$A.util.isUndefinedOrNull( inputValue ) ) {
inputCmp.set( 'v.value', inputValue.trim() );
}
},
handleOnBlurInputTargetApexScript : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
var inputCmp = event.getSource();
var inputValue = inputCmp.get( 'v.value' );
if ( !$A.util.isUndefinedOrNull( inputValue ) ) {
inputCmp.set( 'v.value', inputValue.trim() );
}
},
handleInputListBoxChanged : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
var selectedOptions = event.getParam( 'value' );
if ( !helper.isEmpty( selectedOptions ) ) {
selectedOptions.sort();
}
},
// ----------------------------------------------------------------------------------
handleSourceTypeChange : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
helper.handleSourceTypeChange( component );
},
// ----------------------------------------------------------------------------------
handleSourceReportFolderChange : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
helper.handleSourceReportFolderChange( component );
},
handleSourceReportChange : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
helper.handleSourceReportChange( component );
},
// -----------------------------------------------------------------
handleSourceListViewSobjectTypeChange : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
helper.handleSourceListViewSobjectTypeChange( component );
},
handleSourceListViewChange : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
helper.handleSourceListViewChange( component );
},
// ----------------------------------------------------------------------------------
handleTargetTypeChange : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
helper.handleTargetTypeChange( component );
},
handleTargetApexTypeChange : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
helper.handleTargetTypeChange( component );
},
handleTargetSobjectTypeChange : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
helper.renderTargetInvocableActions( component );
},
handleTargetTypeRequiresSobjectChange : function( component, event, helper ) {
if ( component.get( 'v.didInitConfig' ) !== true ) {
return;
}
helper.renderTargetSobjectTypes( component );
}
})
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/aura/MA_EditConfigCmp/MA_EditConfigCmpHelper.js
================================================
/*
Author: Doug Ayers
Website: https://douglascayers.com
GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
License: BSD 3-Clause License
*/
({
initScheduleOptions : function( component ) {
var helper = this;
var scheduleOptionsHourOfDay = [];
var scheduleOptionsDayOfMonth = [];
var scheduleOptionsMonthOfYear = [];
var scheduleOptionsDayOfWeek = [];
for ( let i = 0; i < 24; i++ ) {
scheduleOptionsHourOfDay.push({
'label' : ( i == 0 ? '12:00 AM' : i == 12 ? '12:00 PM' : ( i < 12 ? i + ':00 AM' : ( i - 12 ) + ':00 PM' ) ).padStart( 8, '0' ),
'value' : i.toString().padStart( 2, '0' ) + '.' + i.toString()
});
}
for ( let i = 1; i <= 31; i++ ) {
scheduleOptionsDayOfMonth.push({
'label' : i.toString(),
'value' : i.toString().padStart( 2, '0' ) + '.' + i.toString()
});
}
var monthValues = [ 'JAN', 'FEB', 'MAR', 'APR', 'MAY', 'JUN', 'JUL', 'AUG', 'SEP', 'OCT', 'NOV', 'DEC' ];
var localeMonthNames = $A.get( '$Locale.nameOfMonths' );
for ( let i = 0; i < localeMonthNames.length; i++ ) {
if ( !helper.isEmpty( localeMonthNames[i].fullName ) ) {
scheduleOptionsMonthOfYear.push({
'label' : localeMonthNames[i].fullName.toUpperCase(), // display in user's locale
'value' : i.toString().padStart( 2, '0' ) + '.' + monthValues[i] // but capture in english for cron expr.
}); // left pad with number for easy sorting
}
}
var weekdayValues = [ 'SUN', 'MON', 'TUE', 'WED', 'THU', 'FRI', 'SAT' ];
var localeWeekdayNames = $A.get( '$Locale.nameOfWeekdays' );
for ( let i = 0; i < localeWeekdayNames.length; i++ ) {
if ( !helper.isEmpty( localeWeekdayNames[i].fullName ) ) {
scheduleOptionsDayOfWeek.push({
'label' : localeWeekdayNames[i].fullName.toUpperCase(), // display in user's locale
'value' : i.toString().padStart( 2, '0' ) + '.' + weekdayValues[i] // but capture in english for cron expr.
}); // left pad with number for easy sorting
}
}
component.set( 'v.scheduleOptionsHourOfDay', scheduleOptionsHourOfDay );
component.set( 'v.scheduleOptionsDayOfMonth', scheduleOptionsDayOfMonth );
component.set( 'v.scheduleOptionsMonthOfYear', scheduleOptionsMonthOfYear );
component.set( 'v.scheduleOptionsDayOfWeek', scheduleOptionsDayOfWeek );
var record = component.get( 'v.record' );
component.set( 'v.scheduleSelectionsFrequency', record.scheduleFrequency );
// add the "NN." prefix to the values used for sorting
// so match the schedule options format so the selections are visually shown on the config page
// exactly one of dayOfMonth or dayOfWeek must be specified and the other must be '?',
// in our case, '?' means no selections for that value as the other field was specified
if ( !$A.util.isUndefinedOrNull( record.scheduleHourOfDay ) ) {
component.set( 'v.scheduleSelectionsHourOfDay', record.scheduleHourOfDay.split(',').map( function( hourOfDay ) { return hourOfDay.padStart( 2, '0' ) + '.' + hourOfDay; } ) );
} else {
component.set( 'v.scheduleSelectionsHourOfDay', [] );
}
if ( !$A.util.isUndefinedOrNull( record.scheduleDayOfMonth ) && record.scheduleDayOfMonth != '?' ) {
component.set( 'v.scheduleSelectionsDayOfMonth', record.scheduleDayOfMonth.split(',').map( function( dayOfMonth ) { return dayOfMonth.padStart( 2, '0' ) + '.' + dayOfMonth; } ) );
} else {
component.set( 'v.scheduleSelectionsDayOfMonth', [] );
}
if ( !$A.util.isUndefinedOrNull( record.scheduleMonthOfYear ) ) {
component.set( 'v.scheduleSelectionsMonthOfYear', record.scheduleMonthOfYear.split(',').map( function( monthOfYear ) { return monthValues.indexOf( monthOfYear ).toString().padStart( 2, '0' ) + '.' + monthOfYear; } ) );
} else {
component.set( 'v.scheduleSelectionsMonthOfYear', [] );
}
if ( !$A.util.isUndefinedOrNull( record.scheduleDayOfWeek ) && record.scheduleDayOfWeek != '?' ) {
component.set( 'v.scheduleSelectionsDayOfWeek', record.scheduleDayOfWeek.split(',').map( function( dayOfWeek ) { return weekdayValues.indexOf( dayOfWeek ).toString().padStart( 2, '0' ) + '.' + dayOfWeek; } ) );
} else {
component.set( 'v.scheduleSelectionsDayOfWeek', [] );
}
},
// ----------------------------------------------------------------------------------
handleSourceTypeChange : function( component ) {
var helper = this;
var promises = [];
var sourceType = component.get( 'v.sourceType' );
var record = component.get( 'v.record' );
if ( sourceType != 'Report' ) {
record.sourceReportID = null;
record.sourceReportColumnName = null;
component.set( 'v.sourceReport', null );
component.set( 'v.sourceReportId', null );
component.set( 'v.sourceReportFolderId', null );
component.set( 'v.sourceReportColumns', null );
component.set( 'v.sourceReportColumnName', null );
} else {
if ( helper.isEmpty( component.get( 'v.sourceReportFolders' ) ) ) {
promises.push( helper.getReportFoldersAsync( component )
.then( $A.getCallback( function( reportFolders ) {
component.set( 'v.sourceReportFolders', reportFolders );
helper.handleSourceReportFolderChange( component );
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Getting Report Folders', err, 'error' );
}))
);
}
}
if ( sourceType != 'ListView' ) {
record.sourceListViewID = null;
component.set( 'v.sourceListView', null );
component.set( 'v.sourceListViewId', null );
component.set( 'v.sourceListViewSobjectType', null );
} else {
if ( helper.isEmpty( component.get( 'v.sourceListViewSobjectTypes' ) ) ) {
promises.push( helper.getObjectNamesWithListViewsAsync( component )
.then( $A.getCallback( function( objectNames ) {
component.set( 'v.sourceListViewSobjectTypes', objectNames );
helper.handleSourceListViewSobjectTypeChange( component );
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Getting Object Names', err, 'error' );
}))
);
}
}
if ( sourceType != 'SOQL' ) {
record.sourceSoqlQuery = null;
}
component.set( 'v.record', record );
component.set( 'v.sourceTypeURL', null );
return Promise.all( promises );
},
handleSourceReportFolderChange : function( component ) {
var helper = this;
var promises = [];
var sourceType = component.get( 'v.sourceType' );
var report = component.get( 'v.sourceReport' );
var folderId = component.get( 'v.sourceReportFolderId' );
if ( sourceType == 'Report' ) {
var reportFolderId = report && report.OwnerId && report.OwnerId.substring( 0, 15 );
folderId = folderId && folderId.substring( 0, 15 );
if ( folderId != reportFolderId ) {
component.set( 'v.sourceReport', null );
component.set( 'v.sourceReportId', null );
component.set( 'v.sourceReportColumnName', null );
component.set( 'v.record.sourceReportID', null );
component.set( 'v.record.sourceReportColumnName', null );
}
promises.push( helper.getReportsByFolderAsync( component, folderId )
.then( $A.getCallback( function( reports ) {
component.set( 'v.sourceReports', reports );
return helper.handleSourceReportChange( component );
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Getting Reports By Folder', err, 'error' );
}))
);
}
return Promise.all( promises );
},
handleSourceReportChange : function( component ) {
var helper = this;
var promises = [];
var sourceType = component.get( 'v.sourceType' );
var reportId = component.get( 'v.sourceReportId' );
if ( sourceType == 'Report' ) {
if ( helper.isEmpty( reportId ) ) {
component.set( 'v.sourceTypeURL', null );
component.set( 'v.sourceReport', null );
component.set( 'v.sourceReportColumns', null );
component.set( 'v.sourceReportColumnName', null );
component.set( 'v.record.sourceReportID', null );
component.set( 'v.record.sourceReportColumnName', null );
} else {
promises.push( helper.getReportAsync( component, reportId )
.then( $A.getCallback( function( report ) {
component.set( 'v.sourceTypeURL', '/lightning/r/Report/' + report.Id + '/view' );
component.set( 'v.sourceReport', report );
component.set( 'v.record.sourceReportID', ( report.Id && report.Id.substring( 0, 15 ) ) );
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Getting Report', err, 'error' );
}))
);
promises.push( helper.getReportColumnsAsync( component, reportId )
.then( $A.getCallback( function( reportColumns ) {
component.set( 'v.sourceReportColumns', reportColumns );
var columnName = component.get( 'v.sourceReportColumnName' );
var columnFound = false;
for ( var i = 0; i < reportColumns.length; i++ ) {
if ( reportColumns[i].value == columnName ) {
columnFound = true;
break;
}
}
if ( !columnFound ) {
component.set( 'v.sourceReportColumnName', null );
component.set( 'v.record.sourceReportColumnName', null );
} else {
component.set( 'v.record.sourceReportColumnName', columnName );
}
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Getting Report Columns', err, 'error' );
}))
);
}
}
return Promise.all( promises );
},
handleSourceListViewSobjectTypeChange : function( component ) {
var helper = this;
var promises = [];
var sourceType = component.get( 'v.sourceType' );
var listView = component.get( 'v.sourceListView' );
var sobjectType = component.get( 'v.sourceListViewSobjectType' );
if ( sourceType == 'ListView' ) {
if ( !$A.util.isUndefinedOrNull( listView ) && listView.SobjectType != sobjectType ) {
component.set( 'v.sourceListViewId', null );
component.set( 'v.record.sourceListViewID', null );
}
promises.push( helper.getListViewsByObjectAsync( component, sobjectType )
.then( $A.getCallback( function( listViews ) {
component.set( 'v.sourceListViews', listViews );
return helper.handleSourceListViewChange( component );
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Getting List Views By Object', err, 'error' );
}))
);
}
return Promise.all( promises );
},
handleSourceListViewChange : function( component ) {
var helper = this;
var promises = [];
var sourceType = component.get( 'v.sourceType' );
var listViewId = component.get( 'v.sourceListViewId' );
if ( sourceType == 'ListView' ) {
if ( helper.isEmpty( listViewId ) ) {
component.set( 'v.sourceTypeURL', null );
component.set( 'v.sourceListView', null );
component.set( 'v.record.sourceListViewID', null );
} else {
promises.push( helper.getListViewAsync( component, listViewId )
.then( $A.getCallback( function( listView ) {
component.set( 'v.sourceTypeURL', '/lightning/o/' + listView.SobjectType + '/list?filterName=' + listView.Id );
component.set( 'v.sourceListView', listView );
component.set( 'v.record.sourceListViewID', ( listView.Id && listView.Id.substring( 0, 15 ) ) );
})).catch( $A.getCallback( function( err ) {
helper.toastMessage( 'Error Getting List View', err, 'error' );
}))
);
}
}
return Promise.all( promises );
},
// ----------------------------------------------------------------------------------
handleTargetTypeChange : function( component ) {
var helper = this;
var promises = [];
var targetType = component.get( 'v.targetType' );
var targetApexType = component.get( 'v.targetApexType' );
var targetActionName = component.get( 'v.targetInvocableAction' );
var record = component.get( 'v.record' );
// if true then we need to display prompt to user
// to choose an object before we can show action options
var targetTypeRequiresSobject = false;
var targetTypeRequiresAction = false;
if ( helper.isEmpty( targetType ) || targetType == 'Workflow' ) {
targetTypeRequiresSobject = false;
targetTypeRequiresAction = false;
targetApexType = null;
targetActionName = null;
record.targetSobjectType = null;
record.targetApexScript = null;
} else if ( targetType == 'Flow' ) {
targetTypeRequiresSobject = false;
targetTypeRequiresAction = true;
targetApexType = null;
//targetActionName = null;
record.targetSobjectType = null;
record.targetApexScript = null;
} else if ( targetType == 'QuickAction' ) {
targetTypeRequiresSobject = true;
targetTypeRequiresAction = true;
targetApexType = null;
//targetActionName = null;
//record.targetSobjectType = null;
record.targetApexScript = null;
} else if ( targetType == 'EmailAlert' ) {
targetTypeRequiresSobject = true;
targetTypeRequiresAction = true;
targetApexType = null;
//targetActionName = null;
//record.targetSobjectType = null;
record.targetApexScript = null;
} else if ( targetType == 'Apex' ) {
targetTypeRequiresSobject = false;
targetTypeRequiresAction = true;
record.targetSobjectType = null;
if ( targetApexType === 'Invocable' ) {
targetTypeRequiresAction = true;
record.targetApexScript = null;
} else if ( targetApexType === 'Anonymous' ) {
targetTypeRequiresAction = false;
targetActionName = null;
// provide a template as convenience
if ( $A.util.isEmpty( record.targetApexScript ) ) {
record.targetApexScript = (
'void execute( List> sourceRecordsBatch ) { \n' +
' // your logic here \n' +
'} \n'
);
}
}
}
component.set( 'v.targetTypeRequiresSobject', targetTypeRequiresSobject );
component.set( 'v.targetTypeRequiresAction', targetTypeRequiresAction );
component.set( 'v.targetApexType', targetApexType );
component.set( 'v.targetInvocableAction', targetActionName );
record.targetActionName = targetActionName;
component.set( 'v.record', record );
promises.push( helper.renderTargetSobjectTypes( component ) );
promises.push( helper.renderTargetInvocableActions( component ) );
return Promise.all( promises );
},
/**
* Determines if conditions are satisfactory to fetch and render
* sobject options that have invocable actions. Designed to be called whenever
* the target type requires sobject input field changes and once conditions met then options appear.
*/
renderTargetSobjectTypes : function( component ) {
var helper = this;
var promises = [];
var targetTypeRequiresSobject = component.get( 'v.targetTypeRequiresSobject' );
if ( targetTypeRequiresSobject === true ) {
var targetType = component.get( 'v.targetType' );
promises.push( helper.getObjectsWithInvocableActionsAsync( component, targetType )
.then( $A.getCallback( function( results ) {
component.set( 'v.targetSobjectTypes', results );
}))
);
} else {
component.set( 'v.targetSobjectType', null );
component.set( 'v.targetSobjectTypes', null );
}
return Promise.all( promises );
},
/**
* Determines if conditions are satisfactory to fetch and render
* the target invocable action options. Designed to be called whenever
* the target input fields change and once conditions met then options appear.
*/
renderTargetInvocableActions : function( component ) {
var helper = this;
var promises = [];
var targetType = component.get( 'v.targetType' );
var targetApexType = component.get( 'v.targetApexType' );
var targetTypeRequiresSobject = component.get( 'v.targetTypeRequiresSobject' );
var targetTypeRequiresAction = component.get( 'v.targetTypeRequiresAction' );
var targetSobjectType = component.get( 'v.targetSobjectType' );
var targetAction = component.get( 'v.targetInvocableAction' );
var isValidToRenderActions = true;
if ( helper.isEmpty( targetType ) ||
( !targetTypeRequiresAction ) ||
( targetTypeRequiresSobject && helper.isEmpty( targetSobjectType ) ) ||
( targetType === 'Apex' && targetApexType !== 'Invocable' ) ) {
isValidToRenderActions = false;
}
if ( isValidToRenderActions ) {
promises.push( helper.getInvocableActionsAsync( component, targetType, ( targetSobjectType || '' ) )
.then( $A.getCallback( function( actions ) {
component.set( 'v.targetInvocableActions', actions );
// if currently selected target action is not in this list then clear the field
var targetActionFound = actions.find( function( elmt ) { return elmt.value === targetAction; } );
component.set( 'v.targetInvocableAction', ( targetActionFound && targetActionFound.value ) );
}))
);
} else {
component.set( 'v.targetInvocableActions', null );
// Don't clear selected target action here because of timing
// this would clear out the record's initial value on component init.
// Instead, we try to handle this in the controller function "handleTargetTypeChange"
//component.set( 'v.targetInvocableAction', null );
}
component.set( 'v.isValidToRenderTargetInvocableActions', isValidToRenderActions );
return Promise.all( promises );
},
renderTargetFieldMappingsAsync : function( component ) {
var helper = this;
var sourceType = component.get( 'v.sourceType' );
var sourceReportId = component.get( 'v.sourceReportId' );
var sourceListViewId = component.get( 'v.sourceListViewId' );
var sourceSoqlQuery = component.get( 'v.record.sourceSoqlQuery' )
var targetType = component.get( 'v.targetType' );
var targetAction = component.get( 'v.targetInvocableAction' );
var targetSobjectType = component.get( 'v.targetSobjectType' );
var sourceFields = []; // columns from source report or list view
var targetFields = []; // inputs from target action
// provide empty option for source field mapping
// so user can unmap a field without navigating away
sourceFields.push({
'label': '--None--',
'vaue': null
});
return Promise.resolve()
.then( $A.getCallback( function() {
if ( sourceType == 'Report' ) {
component.set( 'v.sourceFieldsInputType', 'combobox' );
return helper.getReportColumnsAsync( component, sourceReportId )
.catch( $A.getCallback( function( err ) {
return Promise.reject( 'Error getting report columns: ' + helper.unwrapAuraErrorMessage( err ) );
}));
} else if ( sourceType == 'ListView' ) {
component.set( 'v.sourceFieldsInputType', 'combobox' );
return helper.getListViewColumnsAsync( component, sourceListViewId )
.catch( $A.getCallback( function( err ) {
return Promise.reject( 'Error getting list view columns: ' + helper.unwrapAuraErrorMessage( err ) );
}));
} else if ( sourceType == 'SOQL' ) {
component.set( 'v.sourceFieldsInputType', 'combobox' );
return helper.getSoqlQueryColumnsAsync( component, sourceSoqlQuery )
.catch( $A.getCallback( function( err ) {
return Promise.reject( 'Error getting SOQL query columns: ' + helper.unwrapAuraErrorMessage( err ) );
}));
} else if ( sourceType == 'Apex' ) {
component.set( 'v.sourceFieldsInputType', 'text' );
return null;
}
})).then( $A.getCallback( function( sourceFieldsResult ) {
if ( !$A.util.isEmpty( sourceFieldsResult ) ) {
// performs in-place sort of array
sourceFieldsResult.sort( function( first, second ) {
return first.label.localeCompare( second.label );
});
sourceFields.push( ...sourceFieldsResult );
}
})).then( $A.getCallback( function() {
return helper.getInvocableActionInputsAsync( component, targetType, ( targetAction || '' ), ( targetSobjectType || '' ) );
})).then( $A.getCallback( function( targetFieldsResult ) {
if ( !$A.util.isEmpty( targetFieldsResult ) ) {
// performs in-place sort of array
targetFieldsResult.sort( function( first, second ) {
return first.name.localeCompare( second.name );
});
targetFields.push( ...targetFieldsResult );
}
})).then( $A.getCallback( function() {
// target action types that we don't prompt user for to avoid confusion
var ignoreDataTypes = [ 'SOBJECT', 'BLOB' ];
var recordFieldMappings = component.get( 'v.record.fieldMappings' ); // what currently has been mapped in database
var targetFieldMappings = []; // what user will work with in UI to assign source fields to target fields
for ( var i = 0; i < targetFields.length; i++ ) {
var targetField = targetFields[i];
if ( !ignoreDataTypes.includes( targetField.dataType ) ) {
var recordFieldMapping = { 'sourceFieldName' : null, 'targetFieldName' : null };
// find existing mapping for this target field, if any exists
for ( var j = 0; j < recordFieldMappings.length; j++ ) {
if ( targetField.name == recordFieldMappings[j].targetFieldName ) {
recordFieldMapping = recordFieldMappings[j];
break;
}
}
targetFieldMappings.push({
'targetField' : targetField,
'sourceFieldName' : recordFieldMapping.sourceFieldName
});
}
}
component.set( 'v.sourceFields', sourceFields );
component.set( 'v.targetFields', targetFields );
component.set( 'v.targetFieldMappings', targetFieldMappings );
}));
},
// ----------------------------------------------------------------------------------
/**
* Given an array of aura components representing inputs (have a v.value attribute)
* then returns a validation result object with any errors for each component.
*/
validateInputsAsync : function( component, inputCmps ) {
var helper = this;
var sourceType = component.get( 'v.sourceType' );
var sourceTypeIsReport = ( sourceType === 'Report' );
var sourceTypeIsListView = ( sourceType === 'ListView' );
var sourceTypeIsSoqlQuery = ( sourceType === 'SOQL' );
var sourceTypeIsApex = ( sourceType === 'Apex' );
var targetType = component.get( 'v.targetType' );
var targetTypeIsFlows = ( targetType === 'Flow' );
var targetTypeIsWorkflows = ( targetType === 'Workflow' );
var targetTypeIsQuickActions = ( targetType === 'QuickAction' );
var targetTypeIsEmailAlerts = ( targetType === 'EmailAlert' );
var targetTypeIsApex = ( targetType === 'Apex' );
var targetApexType = component.get( 'v.targetApexType' );
var targetApexTypeIsInvocable = ( targetApexType === 'Invocable' );
var targetApexTypeIsAnonymous = ( targetApexType === 'Anonymous' );
var targetTypeRequiresSobject = component.get( 'v.targetTypeRequiresSobject' );
var targetTypeRequiresAction = component.get( 'v.targetTypeRequiresAction' );
var scheduleFrequency = component.get( 'v.scheduleSelectionsFrequency' );
var scheduleFrequenceIsScheduled = ( scheduleFrequency == 'Scheduled' || ( !$A.util.isUndefinedOrNull( scheduleFrequency ) && scheduleFrequency.length && scheduleFrequency[0] == 'Scheduled' ) );
var scheduleFrequenceIsCustom = ( scheduleFrequency == 'Custom' || ( !$A.util.isUndefinedOrNull( scheduleFrequency ) && scheduleFrequency.length && scheduleFrequency[0] == 'Custom' ) );
var inputScheduleWeekdayIsEmpty = helper.isEmpty( component.get( 'v.scheduleSelectionsDayOfWeek' ) );
var inputScheduleDayOfMonthIsEmpty = helper.isEmpty( component.get( 'v.scheduleSelectionsDayOfMonth' ) );
var objectDescribe = component.get( 'v.objectDescribe' );
return Promise.all( inputCmps.map( function( inputCmp ) {
var validationComponentResult = {
hasError : false,
message : null,
component : inputCmp
};
var inputValidityAsync = Promise.resolve( validationComponentResult );
if ( !$A.util.isUndefinedOrNull( inputCmp ) ) {
var inputLabel = inputCmp.get( 'v.label' );
var inputValue = inputCmp.get( 'v.value' );
var inputIsEmpty = helper.isEmpty( inputValue );
var inputIsInvalid = !inputCmp.checkValidity();
// populate a default error message,
// but don't assign to the validation component result
// unless we indeed determine the input component is invalid
var messageWhenValueMissing = inputLabel + ' is required.';
switch ( inputCmp.getLocalId() ) {
// Details
case 'inputName':
case 'inputDeveloperName':
case 'inputBatchSize':
inputValidityAsync = Promise.resolve({
'invalid': ( inputIsEmpty || inputIsInvalid ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
// Source
case 'inputSourceType':
inputValidityAsync = Promise.resolve({
'invalid': ( inputIsEmpty || inputIsInvalid ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
// Source: Report
case 'inputSourceReportFolder':
case 'inputSourceReport':
case 'inputSourceReportColumn':
inputValidityAsync = Promise.resolve({
'invalid': ( sourceTypeIsReport && ( inputIsEmpty || inputIsInvalid ) ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
// Source: List View
case 'inputSourceListViewSobjectType':
case 'inputSourceListView':
inputValidityAsync = Promise.resolve({
'invalid': ( sourceTypeIsListView && ( inputIsEmpty || inputIsInvalid ) ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
// Source: SOQL Query
case 'inputSourceSoqlQuery':
inputValidityAsync = Promise.resolve({
'invalid': ( sourceTypeIsSoqlQuery && ( inputIsEmpty || inputIsInvalid ) ),
'messageWhenInvalid': messageWhenValueMissing
}).then( $A.getCallback( function( inputValidity ) {
// if we haven't already determined the field to be invalid
// then perform more rigorous soql query validation
if ( sourceTypeIsSoqlQuery && !inputValidity.invalid ) {
return helper.validateSoqlQueryAsync( component, inputValue )
.then( $A.getCallback( function( validationResult ) {
return {
'invalid': !validationResult.valid,
'messageWhenInvalid': validationResult.message
};
}));
}
return inputValidity;
}));
break;
// Source: Apex Class
case 'inputSourceApexClass':
inputValidityAsync = Promise.resolve({
'invalid': ( sourceTypeIsApex && ( inputIsEmpty || inputIsInvalid ) ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
// Target
case 'inputTargetType':
inputValidityAsync = Promise.resolve({
'invalid': ( inputIsEmpty || inputIsInvalid ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
case 'inputTargetSobjectType':
inputValidityAsync = Promise.resolve({
'invalid': ( targetTypeRequiresSobject && ( inputIsEmpty || inputIsInvalid ) ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
case 'inputTargetAction':
inputValidityAsync = Promise.resolve({
'invalid': ( targetTypeRequiresAction && ( inputIsEmpty || inputIsInvalid ) ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
// Target: Apex
case 'inputTargetApexType':
inputValidityAsync = Promise.resolve({
'invalid': ( targetTypeIsApex && ( inputIsEmpty || inputIsInvalid ) ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
case 'inputTargetApexScript':
inputValidityAsync = Promise.resolve({
'invalid': ( targetTypeIsApex && targetApexTypeIsAnonymous && ( inputIsEmpty || inputIsInvalid ) ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
// Target: Field Mappings
case 'inputMappingSourceFieldName':
inputValidityAsync = Promise.resolve({
'invalid': ( ( inputIsEmpty && inputCmp.get( 'v.required' ) ) || inputIsInvalid ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
// Schedule
case 'inputScheduleFrequency':
inputValidityAsync = Promise.resolve({
'invalid': ( inputIsEmpty || inputIsInvalid ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
case 'inputScheduleHourOfDay':
inputValidityAsync = Promise.resolve({
'invalid': ( scheduleFrequenceIsScheduled && ( inputIsEmpty || inputIsInvalid ) ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
case 'inputScheduleWeekday':
inputValidityAsync = Promise.resolve({
'invalid': ( scheduleFrequenceIsScheduled && ( ( inputIsEmpty == inputScheduleDayOfMonthIsEmpty ) || inputIsInvalid ) ),
'messageWhenInvalid': `Select options for either "${objectDescribe.fields.Schedule_DayOfWeek__c.label}" or "${objectDescribe.fields.Schedule_DayOfMonth__c.label}" but not both. Exactly one is required.`
});
break;
case 'inputScheduleDayOfMonth':
inputValidityAsync = Promise.resolve({
'invalid': ( scheduleFrequenceIsScheduled && ( ( inputIsEmpty == inputScheduleWeekdayIsEmpty ) || inputIsInvalid ) ),
'messageWhenInvalid': `Select options for either "${objectDescribe.fields.Schedule_DayOfWeek__c.label}" or "${objectDescribe.fields.Schedule_DayOfMonth__c.label}" but not both. Exactly one is required.`
});
break;
case 'inputScheduleMonthOfYear':
inputValidityAsync = Promise.resolve({
'invalid': ( scheduleFrequenceIsScheduled && ( inputIsEmpty || inputIsInvalid ) ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
case 'inputScheduleCron':
inputValidityAsync = Promise.resolve({
'invalid': ( scheduleFrequenceIsCustom && ( inputIsEmpty || inputIsInvalid ) ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
// Default
default:
inputValidityAsync = Promise.resolve({
'invalid': ( inputIsInvalid ),
'messageWhenInvalid': messageWhenValueMissing
});
break;
}
return Promise.resolve( inputValidityAsync )
.then( $A.getCallback( function( inputValidity ) {
// Consider the input invalid based on either our custom logic above
// or that the input component's natural validation (e.g. required="true") is violated.
validationComponentResult.hasError = inputValidity.invalid;
validationComponentResult.messageWhenInvalid = inputValidity.messageWhenInvalid;
return validationComponentResult;
}));
} else {
return inputValidityAsync;
}
})).then( $A.getCallback( function( validationComponentResults ) {
var validationResult = {
hasErrors : false,
components : validationComponentResults
};
validationComponentResults.forEach( function( validationComponentResult, idx ) {
validationResult.hasErrors = ( validationResult.hasErrors || validationComponentResult.hasError );
});
return validationResult;
}));
},
// ----------------------------------------------------------------------------------
saveRecordAsync : function( component ) {
var helper = this;
var record = component.get( 'v.record' );
// source
record.sourceType = component.get( 'v.sourceType' );
record.sourceReportID = component.get( 'v.sourceReportId' );
record.sourceReportColumnName = component.get( 'v.sourceReportColumnName' );
record.sourceListViewID = component.get( 'v.sourceListViewId' );
// target
record.targetType = component.get( 'v.targetType' );
record.targetSobjectType = component.get( 'v.targetSobjectType' );
record.targetActionName = component.get( 'v.targetInvocableAction' );
// schedule
/*
Unfortunately, the radioGroup component changes the value type to an array,
so even though my source value is a single string I need to check both data types
or introduce a shadow variable to bind to the radio group and use change events
to copy the newly selected value; neither of which I want to do.
https://org62.lightning.force.com/one/one.app#/sObject/0D50M00003LvvAqSAJ/view
*/
var scheduleFrequency = component.get( 'v.scheduleSelectionsFrequency' );
var scheduleHourOfDay = component.get( 'v.scheduleSelectionsHourOfDay' );
var scheduleDayOfWeek = component.get( 'v.scheduleSelectionsDayOfWeek' );
var scheduleDayOfMonth = component.get( 'v.scheduleSelectionsDayOfMonth' );
var scheduleMonthOfYear = component.get( 'v.scheduleSelectionsMonthOfYear' );
record.scheduleFrequency = ( $A.util.isArray( scheduleFrequency ) ? ( scheduleFrequency.length > 0 ? scheduleFrequency[0] : null ) : scheduleFrequency );
// if manual then null the other schedule fields
// if scheduled then parse the schedule fields, null the cron field
// if custom then null the schedule fields except cron field
if ( record.scheduleFrequency == 'Manual' ) {
record.scheduleCron = null;
record.scheduleSecondOfMinute = null;
record.scheduleMinuteOfHour = null;
record.scheduleHourOfDay = null;
record.scheduleDayOfMonth = null;
record.scheduleMonthOfYear = null;
record.scheduleDayOfWeek = null;
}
else if ( record.scheduleFrequency == 'Scheduled' ) {
// parse the "NN." from the values used for sorting then join them by commas.
// exactly one of dayOfMonth or dayOfWeek must be specified and the other must be '?'
record.scheduleCron = null;
record.scheduleSecondOfMinute = '0';
record.scheduleMinuteOfHour = '0';
record.scheduleHourOfDay = scheduleHourOfDay.map( function( hourOfDay ) { return hourOfDay.split('.')[1]; } ).join(',');
record.scheduleDayOfMonth = scheduleDayOfMonth.map( function( dayOfMonth ) { return dayOfMonth.split('.')[1]; } ).join(',') || '?';
record.scheduleMonthOfYear = scheduleMonthOfYear.map( function( monthOfYear ) { return monthOfYear.split('.')[1]; } ).join(',');
record.scheduleDayOfWeek = scheduleDayOfWeek.map( function( dayOfWeek ) { return dayOfWeek.split('.')[1]; } ).join(',') || '?';
}
else if ( record.scheduleFrequency == 'Custom' ) {
record.scheduleSecondOfMinute = null;
record.scheduleMinuteOfHour = null;
record.scheduleHourOfDay = null;
record.scheduleDayOfMonth = null;
record.scheduleMonthOfYear = null;
record.scheduleDayOfWeek = null;
}
// because source fields can be mapped to multiple target fields
// but a target field can only have one mapping then we build up a map
// of target fields to their source field
var targetFieldMappings = {};
component.get( 'v.targetFieldMappings' ).forEach( function( item ) {
targetFieldMappings[item.targetField.name] = item.sourceFieldName;
});
/*
* https://success.salesforce.com/issues_view?id=a1p30000000SyhIAAS
* Due to known issue that execution contexts started from Apex REST endpoints
* cannot schedule or abort jobs, then my first workaround attempt was
* to modify the trigger to emit a platform event to get into a different
* context. However, platform events run as the "Automated Process" user.
* That wouldn't normally be a problem except when our jobs run they make
* API callouts using the either a Named Credential or the user's Session ID.
* If the configuration record doesn't use Named Credentials (one of the major
* features of Version 2.0), then the "Automated Process" user's session id is null
* and the http callout fails. Womp womp.
*
* Therefore, for saving the configuration record, instead of going through
* the Apex REST API and instead of the trigger emitting a platform event,
* this method goes through normal AuraEnabled apex method and the trigger
* schedules and aborts the job synchronously. This ensures the job itself
* runs as a real user with a valid session id.
*/
// return helper.enqueueRestRequest( component, 'saveConfiguration', {
// 'wrapperJson' : record,
// 'fieldMappingsJson' : targetFieldMappings
// });
return helper.enqueueAction( component, 'c.saveConfiguration', {
'wrapperJson' : JSON.stringify( record ),
'fieldMappingsJson' : JSON.stringify( targetFieldMappings )
});
},
// ----------------------------------------------------------------------------------
getObjectDescribeAsync : function( component ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getConfigurationObjectDescribe', {
});
},
getRecordAsync : function( component, recordId ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getConfiguration', {
'recordId' : recordId
});
},
// ----------------------------------------------------------------------------------
getObjectNamesAsync : function( component ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getObjectNames', {
});
},
getObjectNamesWithListViewsAsync : function( component ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getObjectNamesWithListViews', {
});
},
getListViewsByObjectAsync : function( component, objectName ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getListViewsByObject', {
'objectName' : objectName
});
},
getListViewAsync : function( component, listViewId ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getListView', {
'recordId' : listViewId
});
},
getListViewColumnsAsync : function( component, listViewId ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getListViewColumns', {
'listViewId' : listViewId
});
},
// ----------------------------------------------------------------------------------
getReportFoldersAsync : function( component ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getReportFolders', {
});
},
getReportsByFolderAsync : function( component, folderId ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getReportsByFolder', {
'folderId' : folderId
});
},
getReportAsync : function( component, reportId ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getReport', {
'recordId' : reportId
});
},
getReportColumnsAsync : function( component, reportId ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getReportColumns', {
'reportId' : reportId
});
},
// ----------------------------------------------------------------------------------
validateSoqlQueryAsync : function( component, query ) {
// This used to make async calls, but it doesn't anymore.
// I've kept the method name, signature and response
// the same so as to minimize impact to other parts of the
// codebase and because this might become async in the future...
var helper = this;
return Promise.resolve()
.then( $A.getCallback( function() {
if ( helper.isEmpty( query ) ) {
return {
'valid': false,
'message': 'SOQL Query is required.'
};
} else {
// Originally, I used third-party soql-parse library
// to parse the query to know things like what the
// SELECT clause was, and aliases of functions, etc.
// However, the parser was not complete and the effort
// to make a fully compliant SOQL parser is out of scope
// for Mass Action Scheduler. Therefore, my approach now
// is to brute force inspect the query for simple patterns
// so that I can deduce what fields are being selected.
// Whether the query is valid is another story; we'll find
// out soon enough once the configuration runs :)
// ================================================================= //
// Caution with Regular Expressions with asterisks followed by / //
// https://twitter.com/DouglasCAyers/status/1147002313158090752 //
// ================================================================= //
// normalize the spaces in the query string (e.g. no new lines or tabs)
// and uppercase the string so that we can be case-insensitive in our checks
let trimmedQuery = (
query // original query
.replace( /(\s*(\W+)\s*)/g, ' $2 ' ) // include one whitespace around non-words e.g. "(SELECT" => " ( SELECT"
.replace( /\s+/g, ' ' ) // remove new lines, redundant whitespace
.trim() // trim whitespace from start/end of query
.toUpperCase() // uppercase everything so we're case-insensitive
);
// SOQL queries must start with SELECT, quick check this isn't a SOSL query
if ( !trimmedQuery.startsWith( 'SELECT ' ) ) {
return {
'valid': false,
'message': 'SOQL Query must start with a SELECT clause.'
};
}
let indexOfFromClause = trimmedQuery.indexOf( ' FROM ' );
// Make sure there's a FROM clause because
// the real validation is going to be inspecting
// the text between the SELECT and FROM statements
if ( indexOfFromClause < 0 ) {
return {
'valid': false,
'message': 'SOQL Query must include a FROM clause.'
};
}
// At this point we know we have both keywords "SELECT" and "FROM" in our query string
// so now let's grab what's between them to determine what fields were selected
let selectClause = trimmedQuery.substring( 'SELECT '.length, indexOfFromClause );
// SOQL allows child relationship sub-queries in the SELECT clause.
// Mass Action Scheduler doesn't support this, and it makes this brute
// force parsing of the query to determine the actual selected fields.
// Therefore, we don't support sub-queries in the SELECT clause.
if ( selectClause.includes( ' SELECT ' ) ) {
return {
'valid': false,
'message': 'Parent-to-child relationship subqueries are not supported.'
};
}
// Given we have what we need, let's determine the selected fields.
let selectedFields = (
selectClause
.split( ',' )
.filter( field => {
// exclude non-aliased functions
return !( /\)\s*$/.test( field ) )
})
.map( field => {
return (
field.includes( ')' ) ? // is function alias?
field.substring( field.lastIndexOf( ')' ) + 1 ) : // grab the alias
field // it's just a field
).replace( /\s+/g, '' ) // remove all whitespace
})
);
return {
'valid': true,
'selectedFields': selectedFields
};
}
}));
},
getSoqlQueryResultsAsync : function( component, query, batchSize ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getSoqlQueryResults', {
'query' : query,
'batchSize' : batchSize
});
},
getSoqlQueryColumnsAsync : function( component, soqlQuery ) {
var helper = this;
return Promise.resolve()
.then( $A.getCallback( function() {
return helper.validateSoqlQueryAsync( component, soqlQuery )
.then( $A.getCallback( function( validationResult ) {
if ( validationResult.valid ) {
return validationResult.selectedFields.map( fieldName => {
return {
'label': fieldName,
'value': fieldName
}
});
} else {
return Promise.reject( validationResult.message );
}
})).catch( $A.getCallback( function( err ) {
return Promise.reject( 'Error validating SOQL query: ' + helper.unwrapAuraErrorMessage( err ) );
}));
}));
},
// ----------------------------------------------------------------------------------
getNamedCredentialsAsync : function( component ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getNamedCredentials', {
});
},
getObjectsWithInvocableActionsAsync : function( component, actionType ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getObjectsWithInvocableActions', {
'actionType' : actionType
});
},
getInvocableActionsAsync : function( component, actionType, objectName ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getInvocableActions', {
'actionType' : actionType,
'objectName' : objectName
});
},
getInvocableActionInputsAsync : function( component, actionType, actionName, objectName ) {
var helper = this;
return helper.enqueueRestRequest( component, 'getInvocableActionInputs', {
'actionType' : actionType,
'actionName' : actionName,
'objectName' : objectName
});
},
// ----------------------------------------------------------------------------------
/**
* The $A.util.isEmpty() function does not check for blank strings (only whitespace).
* This method trims string arguments first so ' ' is considered empty.
*/
isEmpty : function( value ) {
if ( ( typeof value ).toLowerCase() === 'string' ) {
return $A.util.isEmpty( value.trim() );
} else {
return $A.util.isEmpty( value );
}
},
showSpinner : function( component ) {
$A.util.removeClass( component.find( 'spinner' ), 'slds-hide' );
// Minimize flickering of the spinner hiding/showing
// quickly in succession of multiple async events.
// As you'd do with a type-ahead widget, when an async event
// starts and the spinner is shown then clear the timeout
// that would hide the spinner. This avoids the flickering.
// When the async event ends, it'll call hide spinner again
// which will start a new timer.
let spinnerTimerIds = component.get( 'v.spinnerTimerIds' );
spinnerTimerIds.forEach( ( spinnerTimerId ) => clearTimeout( spinnerTimerId ) );
component.set( 'v.spinnerTimerIds', [] );
},
hideSpinner : function( component ) {
// see comments in `showSpinner` about minimizing flickering
let spinnerTimerId = setTimeout(
$A.getCallback( function() {
$A.util.addClass( component.find( 'spinner' ), 'slds-hide' );
}),
250
);
let spinnerTimerIds = component.get( 'v.spinnerTimerIds' );
spinnerTimerIds.push( spinnerTimerId );
component.set( 'v.spinnerTimerIds', spinnerTimerIds );
},
toastMessage : function( title, message, type ) {
// https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/ref_force_showToast.htm
var helper = this;
// convenience so code can toast errors without
// themselves figuring out how to get the real message from them
if ( message instanceof Error ) {
message = helper.unwrapAuraErrorMessage( message );
}
$A.get( 'e.force:showToast' ).setParams({
title : ( title || 'Message' ),
message : ( message || '' ),
type : ( type || 'info' )
}).fire();
},
navigateToRecord : function( recordId ) {
var event = $A.get( 'e.force:navigateToSObject' );
if ( event ) {
event.setParams({
'recordId' : recordId
}).fire();
} else if ( ( typeof sforce !== 'undefined' ) && ( typeof sforce.one !== 'undefined' ) ) {
sforce.one.navigateToSObject( recordId );
} else {
window.location.href = '/' + recordId;
}
},
navigateToURL : function( url ) {
var event = $A.get( 'e.force:navigateToURL' );
if ( event ) {
event.setParams({
'url' : url
}).fire();
} else if ( ( typeof sforce !== 'undefined' ) && ( typeof sforce.one !== 'undefined' ) ) {
sforce.one.navigateToURL( url );
} else {
window.location.href = url;
}
},
/**
* For posting REST request to the MA_EditConfigRestController apex class.
*
* @param component
* The Lightning component with a 'urlInfo' and 'lc_api' attributes.
* 'urlInfo' is used to generate the REST API URL.
* 'lc_api' is used to invoke the REST API as workaround to Lightning session ids.
* @param operation
* Name of the actual action to invoke in the REST controller.
* @param params
* Parameters to pass to the actual action to invoke.
* @returns a promise.
*/
enqueueRestRequest : function( component, operation, params ) {
var helper = this;
helper.showSpinner( component );
return Promise.resolve()
.then( $A.getCallback( function() {
// return cached value if we've retrieved it before,
// otherwise fetch the url info as a promise
var urlInfo = component.get( 'v.urlInfo' );
if ( helper.isEmpty( urlInfo ) ) {
return component.find( 'lc_url' ).getUrlInfo();
} else {
return urlInfo;
}
})).then( $A.getCallback( function( urlInfo ) {
component.set( 'v.urlInfo', urlInfo );
var nsslash = ( urlInfo.namespace ? urlInfo.namespace + '/' : '' );
return component.find( 'lc_api' ).restRequest({
'url' : urlInfo.orgDomainURL + '/services/apexrest/' + nsslash + 'config/edit?operation=' + operation,
'method' : 'POST',
'body' : JSON.stringify( ( params || {} ) )
});
})).then( $A.getCallback( function( response ) {
helper.hideSpinner( component );
if ( response.success ) {
return response.result;
} else {
return Promise.reject( response.error );
}
})).catch( $A.getCallback( function( err ) {
helper.hideSpinner( component );
console.error( 'Error enqueuing rest request: ' + JSON.stringify({
'operation' : operation,
'params' : params,
'error' : err.message
}, null, 2));
throw err;
}));
},
/**
* For invoking @AuraEnabled apex actions in a normal
* Lightning component fashion.
*
* @param component
* The Lightning component that specifies the Apex controller
* of the @AuraEnabled method to invoke.
* @param actionName
* The @AuraEnabled method name.
* @param params
* The @AuraEnabled method parameters.
* @returns a promise.
*/
enqueueAction : function( component, actionName, params ) {
var helper = this;
var p = new Promise( $A.getCallback( function( resolve, reject ) {
helper.showSpinner( component );
var action = component.get( actionName );
if ( params ) {
action.setParams( params );
}
action.setCallback( helper, function( response ) {
helper.hideSpinner( component );
if ( component.isValid() && response.getState() === 'SUCCESS' ) {
resolve( response.getReturnValue() );
} else {
console.error( 'Error calling action "' + actionName + '" with state: ' + response.getState() );
helper.logActionErrors( response.getError() );
reject( helper.getMessageFromActionResponseError( response.getError() ) );
}
});
$A.enqueueAction( action );
}));
return p;
},
logActionErrors : function( errors ) {
if ( errors ) {
if ( errors.length > 0 ) {
for ( var i = 0; i < errors.length; i++ ) {
console.error( 'Error: ' + errors[i].message );
}
} else {
console.error( 'Error: ' + ( errors.message || errors ) );
}
} else {
console.error( 'Unknown error' );
}
},
getMessageFromActionResponseError : function( errors ) {
var text = '';
if ( errors ) {
if ( errors.length > 0 ) {
for ( var i = 0; i < errors.length; i++ ) {
text += '\n' + errors[i].message;
}
} else {
text = ( errors.message || errors );
}
}
return text;
},
/**
* When using $A.getCallback() function, if an error is thrown
* then it wraps the error in an AuraError. The AuraError, unfortunately,
* has a new message property whose value is "Error in $A.getCallback[YOUR_ORIGINAL_ERROR_MESSAGE]".
* The only way to obtain YOUR_ORIGINAL_ERROR_MESSAGE is to substring
* the AuraError text out of its message.
*/
unwrapAuraErrorMessage : function( err ) {
var message = err.message;
var startStr = 'Error in $A.getCallback() [';
var endStr = ']';
var startIdx = err.message.indexOf( startStr );
var endIdx = err.message.lastIndexOf( endStr );
if ( startIdx >= 0 && endIdx >= 0 ) {
message = err.message.substring( startIdx + startStr.length, endIdx );
}
return message;
}
})
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/aura/MA_FlowStagePathCmp/MA_FlowStagePathCmp.cmp
================================================
================================================
FILE: force-app/main/default/aura/MA_FlowStagePathCmp/MA_FlowStagePathCmp.cmp-meta.xml
================================================
54.0
MA_FlowStagePathCmp
================================================
FILE: force-app/main/default/aura/MA_FlowStagePathCmp/MA_FlowStagePathCmp.design
================================================
================================================
FILE: force-app/main/default/aura/MA_FlowStagePathCmp/MA_FlowStagePathCmpController.js
================================================
/*
Author: Doug Ayers
Website: https://douglascayers.com
GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
License: BSD 3-Clause License
*/
({
init : function( component, event, helper ) {
var progressIndicator = component.find( 'progressIndicator' );
for ( let step of component.get( 'v.stages' ) ) {
$A.createComponent(
'lightning:progressStep',
{
'aura:id': 'step_' + step,
label: step,
value: step
},
function( newProgressStep, status, errorMessage ) {
// Add the new step to the progress array
if ( status === 'SUCCESS' ) {
var body = progressIndicator.get( 'v.body' );
body.push( newProgressStep );
progressIndicator.set( 'v.body', body );
} else if ( status === 'INCOMPLETE' ) {
console.error( 'No response from server, or client is offline.' );
} else if ( status === 'ERROR' ) {
console.error( 'Error: ' + errorMessage );
}
}
);
}
}
});
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/aura/MA_RunConfigCmp/MA_RunConfigCmp.cmp
================================================
Submits background batch job that invokes the target action on the source records.
This Mass Action can't be run because it is inactive.
To run, activate this Mass Action then try again.
================================================
FILE: force-app/main/default/aura/MA_RunConfigCmp/MA_RunConfigCmp.cmp-meta.xml
================================================
54.0
MA_RunConfigCmp
================================================
FILE: force-app/main/default/aura/MA_RunConfigCmp/MA_RunConfigCmpController.js
================================================
({
onInit : function( component, event, helper ) {
helper.enqueueAction( component, 'c.getConfiguration', {
'recordId' : component.get( 'v.recordId' )
}).then( $A.getCallback( function( record ) {
component.set( 'v.record', record );
}));
},
handleRunButtonClick : function( component, event, helper ) {
helper.enqueueAction( component, 'c.enqueueAction', {
'configId' : component.get( 'v.recordId' )
}).then( $A.getCallback( function( result ) {
if ( result.success ) {
helper.toastMessage( 'Job Submitted', result.jobId, 'success' );
} else {
helper.toastMessage( 'Error', result.message, 'error' );
}
$A.get( 'e.force:closeQuickAction' ).fire();
}));
},
handleCancelButtonClick : function( component, event, helper ) {
$A.get( 'e.force:closeQuickAction' ).fire();
}
})
================================================
FILE: force-app/main/default/aura/MA_RunConfigCmp/MA_RunConfigCmpHelper.js
================================================
({
// -----------------------------------------------------------------
showSpinner : function( component ) {
$A.util.removeClass( component.find( 'spinner' ), 'slds-hide' );
},
hideSpinner : function( component ) {
$A.util.addClass( component.find( 'spinner' ), 'slds-hide' );
},
toastMessage : function( title, message, type ) {
// https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/ref_force_showToast.htm
var helper = this;
// convenience so code can toast errors without
// themselves figuring out how to get the real message from them
if ( message instanceof Error ) {
message = helper.unwrapAuraErrorMessage( message );
}
$A.get( 'e.force:showToast' ).setParams({
title : ( title || 'Message' ),
message : ( message || '' ),
type : ( type || 'info' )
}).fire();
},
navigateToRecord : function( recordId ) {
var event = $A.get( 'e.force:navigateToSObject' );
if ( event ) {
event.setParams({
'recordId' : recordId
}).fire();
} else if ( ( typeof sforce !== 'undefined' ) && ( typeof sforce.one !== 'undefined' ) ) {
sforce.one.navigateToSObject( recordId );
} else {
window.location.href = '/' + recordId;
}
},
navigateToURL : function( url ) {
var event = $A.get( 'e.force:navigateToURL' );
if ( event ) {
event.setParams({
'url' : url
}).fire();
} else if ( ( typeof sforce !== 'undefined' ) && ( typeof sforce.one !== 'undefined' ) ) {
sforce.one.navigateToURL( url );
} else {
window.location.href = url;
}
},
/**
* For invoking @AuraEnabled apex actions in a normal
* Lightning component fashion.
*
* @param component
* The Lightning component that specifies the Apex controller
* of the @AuraEnabled method to invoke.
* @param actionName
* The @AuraEnabled method name.
* @param params
* The @AuraEnabled method parameters.
* @returns a promise.
*/
enqueueAction : function( component, actionName, params ) {
var helper = this;
var p = new Promise( $A.getCallback( function( resolve, reject ) {
helper.showSpinner( component );
var action = component.get( actionName );
if ( params ) {
action.setParams( params );
}
action.setCallback( helper, function( response ) {
helper.hideSpinner( component );
if ( component.isValid() && response.getState() === 'SUCCESS' ) {
resolve( response.getReturnValue() );
} else {
console.error( 'Error calling action "' + actionName + '" with state: ' + response.getState() );
helper.logActionErrors( response.getError() );
reject( helper.getMessageFromActionResponseError( response.getError() ) );
}
});
$A.enqueueAction( action );
}));
return p;
},
logActionErrors : function( errors ) {
if ( errors ) {
if ( errors.length > 0 ) {
for ( var i = 0; i < errors.length; i++ ) {
console.error( 'Error: ' + errors[i].message );
}
} else {
console.error( 'Error: ' + ( errors.message || errors ) );
}
} else {
console.error( 'Unknown error' );
}
},
getMessageFromActionResponseError : function( errors ) {
var text = '';
if ( errors ) {
if ( errors.length > 0 ) {
for ( var i = 0; i < errors.length; i++ ) {
text += '\n' + errors[i].message;
}
} else {
text = ( errors.message || errors );
}
}
return text;
},
/**
* When using $A.getCallback() function, if an error is thrown
* then it wraps the error in an AuraError. The AuraError, unfortunately,
* has a new message property whose value is "Error in $A.getCallback[YOUR_ORIGINAL_ERROR_MESSAGE]".
* The only way to obtain YOUR_ORIGINAL_ERROR_MESSAGE is to substring
* the AuraError text out of its message.
*/
unwrapAuraErrorMessage : function( err ) {
var message = err.message;
var startStr = 'Error in $A.getCallback() [';
var endStr = ']';
var startIdx = err.message.indexOf( startStr );
var endIdx = err.message.lastIndexOf( endStr );
if ( startIdx >= 0 && endIdx >= 0 ) {
message = err.message.substring( startIdx + startStr.length, endIdx );
}
return message;
}
})
================================================
FILE: force-app/main/default/aura/MA_WizardCoachingCmp/MA_WizardCoachingCmp.cmp
================================================
{!v.leftTitle}
{!v.leftContent}
{!v.rightTitle}
{!v.rightContent}
================================================
FILE: force-app/main/default/aura/MA_WizardCoachingCmp/MA_WizardCoachingCmp.cmp-meta.xml
================================================
54.0
MA_WizardCoachingCmp
================================================
FILE: force-app/main/default/aura/defaultTokens/defaultTokens.tokens
================================================
================================================
FILE: force-app/main/default/aura/defaultTokens/defaultTokens.tokens-meta.xml
================================================
54.0
A Lightning Component Bundle
================================================
FILE: force-app/main/default/aura/lax/lax.cmp
================================================
================================================
FILE: force-app/main/default/aura/lax/lax.cmp-meta.xml
================================================
54.0
lax
================================================
FILE: force-app/main/default/aura/lax/laxController.js
================================================
/**
* @license
* MIT License
* Copyright (c) 2017 Ruslan Kurchenko
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/**
* The controller of Lax Aura Component
* @namespace LaxController
*/
// eslint-disable-next-line no-unused-expressions,strict
({
/**
* Initialization function called every time Lax Aura Component instantiated
* @memberof LaxController#
* @param component {Object} - the lax component object
*/
onInit: function onInit(component, event, helper) {
helper.init(component, event);
}
});
================================================
FILE: force-app/main/default/aura/lax/laxHelper.js
================================================
/**
* @license
* MIT License
* Copyright (c) 2017 Ruslan Kurchenko
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/**
* The controller of Lax Aura Component
* @namespace LaxHelper
*/
// eslint-disable-next-line no-unused-expressions,strict
(
{
/**
* Initialization function called every time Lax Aura Component instantiated
* @memberof LaxHelper#
* @param component {Object} - the lax component object
*/
init: function init(component) {
var helper = this,
contextComponent = component.get('v.context');
var laxProps = {
_component: {
writable: false,
configurable: false,
enumerable: false,
value: contextComponent
}
};
var laxPrototype = this.getLax(function(globalEventListeners) {
helper.initEventListeners(globalEventListeners, contextComponent, 'onLaxPrototypeInit');
});
var localEventListeners = {};
helper.initEventListeners(localEventListeners, contextComponent, 'onLaxInit');
// Create an object that is inherit all the functionality from
// the Lax object due to prototype inheritance
var lax = Object.create(laxPrototype, laxProps);
lax.getEventListeners = function () {
return localEventListeners;
};
// Create property on the context component object that is refer on
// newly created Lax object
var contextComponentAttribute = component.get('v.attributeName');
var componentProps = {
writable: false,
configurable: false,
enumerable: false,
value: lax
};
Object.defineProperty(contextComponent, contextComponentAttribute, componentProps);
},
/**
* The function creates the Lax object and save it on the helper.
* Helpers of Aura components are static, it allows to share prototype
* Lax object on a helper instance.
* @memberOf LaxHelper#
* @returns {Lax}
*/
getLax: function getLax(onInit) {
if (!this._lax) {
this._lax = this.createLax(onInit);
}
return this._lax;
},
/**
* Creates a prototype Lax object.
* The function calls when the first Lax component in the app instantiates.
* @memberOf LaxHelper#
* @returns {Lax}
*/
createLax: function createLax(onInit) {
var helper = this;
var errors = helper.defineErrors();
var eventListeners = {};
/**
* Creates a unified function to be assign as a callback on the aura action.
* @param resolve {Function} the function called if the action is success
* @param reject {Function} the function called if the action is failed
* @returns {Function}
*/
function actionRouter(resolve, reject, finallyCallback) {
var lax = this;
return function (response) {
var state = response.getState(),
listOfListeners = [
laxPrototype.getEventListeners(), lax.getEventListeners()
];
if (state === 'SUCCESS') {
var resultValue = util
.getEventListenersByName(listOfListeners, 'apexAction.onSuccess')
.reduce(function (val, listener) {
return listener(val);
}, response.getReturnValue());
resolve(resultValue);
} else {
var message = 'Unknown error';
var responseErrors = response.getError();
if (responseErrors && Array.isArray(responseErrors) && responseErrors.length > 0) {
message = responseErrors[0].message;
}
var errorConstructor = state === 'INCOMPLETE' ? errors.IncompleteActionError : errors.ApexActionError;
var err = util
.getEventListenersByName(listOfListeners, 'apexAction.onError')
.reduce(function (err, listener) {
return listener(err);
}, new errorConstructor(message, responseErrors, response));
reject(err);
}
if (finallyCallback) {
finallyCallback();
}
};
}
/**
* Creates a unified function to be assign as a callback on the component creation action.
* @param resolve {Function} the function called if the component creation successfully
* @param reject {Function} the function called if the component failed to create
* @returns {Function}
*/
function createComponentActionRouter(resolve, reject) {
var lax = this;
return function (component, status, message) {
var result = { status: status },
isMultiple = $A.util.isArray(message),
listOfListeners = [
laxPrototype.getEventListeners(), lax.getEventListeners()
];
if (isMultiple) {
result.components = component;
result.statusMessages = message;
} else {
result.component = component;
result.message = message;
}
if (status === 'SUCCESS') {
var resultComponent = util
.getEventListenersByName(listOfListeners, 'createComponentAction.onSuccess')
.reduce(function (cmp, listener) {
return listener(cmp)
}, component);
resolve(resultComponent);
} else {
var errorConstructor = status === 'INCOMPLETE' ? errors.IncompleteActionError : errors.CreateComponentError,
error = null;
if (isMultiple) {
var msg = 'An error occurred while a component creation process.';
error = new errorConstructor(msg, result.statusMessages, result);
} else {
error = new errorConstructor(message, null, result);
}
var resultError = util
.getEventListenersByName(listOfListeners, 'createComponentAction.onError')
.reduce(function (e, listener) {
return listener(e);
}, error);
reject(resultError);
}
};
}
/**
* Creates a unified function to assign it as a callback on the LDS action.
* The returned function is a router for the result of the action.
* @param resolve {Function} the function called if the action is success
* @param reject {Function} the function called if the action is failed
* @returns {Function}
*/
function ldsActionRouter(resolve, reject) {
var lax = this;
return function(result) {
var listOfListeners = [
laxPrototype.getEventListeners(), lax.getEventListeners()
];
if (result.state === 'SUCCESS' || result.state === 'DRAFT') {
var resultValue = util
.getEventListenersByName(listOfListeners, 'ldsAction.onSuccess')
.reduce(function (val, listener) {
return listener(val);
}, result);
resolve(resultValue);
} else {
var error = null;
if (result.state === 'ERROR') {
var message = 'Unknown error';
if (result.error && Array.isArray(result.error) && result.error.length > 0) {
message = result.error[0].message;
}
error = new errors.LdsActionError(message, result.error, result);
} else if (result.state === 'INCOMPLETE') {
error = new errors.IncompleteActionError('You are currently offline.', result.error, result);
} else {
error = new Error('Unknown action state');
}
var resultError = util
.getEventListenersByName(listOfListeners, 'ldsAction.onError')
.reduce(function (e, listener) {
return listener(e);
}, error);
reject(resultError);
}
};
}
var util = {
/**
* Create an object and bind it with passed in Promise prototype.
* It has own chaining functions (then, catch),
* with Aura context functionality. It allows to avoid of $A.getCallback
* on callback functions.
* @param promise {Promise}
* @returns {LaxPromise}
*/
createAuraContextPromise: function (promise) {
var lp = Object.create(null, {
_contextPromise: {
writable: false,
configurable: false,
enumerable: true,
value: promise
}
});
// eslint-disable-next-line no-use-before-define
return Object.assign(lp, laxPromise);
},
removeAuraErrorMessagePrefix: function (message) {
var result = message;
var prefix = 'Error in $A.getCallback() [';
if (message && message.indexOf(prefix) > -1) {
result = message.replace(prefix, '').slice(0, -1)
}
return result;
},
assignCatchFilters: function (handleErrors, callback, promise) {
return function routeError(error) {
for (var i = 0; i < handleErrors.length; i = i + 1) {
var errorType = handleErrors[i];
if (errorType === Error ||
(errorType !== null && errorType.prototype instanceof Error)) {
if (error instanceof errorType || error.name === errorType.name) {
return util.tryCatch(callback).call(promise, error);
}
}
}
return Promise.reject(error);
};
},
tryCatch: function (callback) {
return function tryCallback() {
try {
return callback.apply(this, arguments);
} catch (e) {
return Promise.reject(e);
}
};
},
registerError: function (error) {
errors[error.name] = error;
},
isApplicationEvent: function (eventName) {
return eventName.indexOf('e.') === 0 && eventName.indexOf(':') > 0;
},
getEventListenersByName: function (listOfListeners, eventHandlerName) {
var handlers = [];
listOfListeners.forEach(function (listeners) {
util.pushIfValueExist(
handlers,
util.delve(listeners, eventHandlerName)
);
});
return handlers;
},
/**
* {@link https://github.com/developit/dlv}
*/
delve: function (obj, key, def, p) {
p = 0;
key = key.split ? key.split('.') : key;
while (obj && p < key.length) obj = obj[key[p++]];
return (obj === undefined || p < key.length) ? def : obj;
},
pushIfValueExist: function (arr, value) {
if (!$A.util.isUndefinedOrNull(value)) arr.push(value);
}
};
/**
* The container of the actual context promise.
* It helps to call chain function (then, catch)
* in the Aura context. The client can avoid of $A.getCallback calls.
* @class LaxPromise
*/
var laxPromise =
/**
* @lends LaxPromise#
*/
{
/**
* Attaches callbacks for the resolution and/or rejection of the Promise.
* @param onSuccess {Function|undefined} The callback to execute when the Promise is resolved.
* @param onError {Function=} The callback to execute when the Promise is rejected.
* @returns {LaxPromise} A {@link LaxPromise} for the completion of which ever callback is executed.
*/
then: function (onSuccess, onError) {
var promise = this._contextPromise.then(
(onSuccess ? $A.getCallback(onSuccess) : undefined),
(onError ? $A.getCallback(onError) : undefined)
);
return util.createAuraContextPromise(promise);
},
/**
* Attaches a callback for only the rejection of the Promise.
* @param onError {Function} The callback to execute when the Promise is rejected.
* @returns {LaxPromise} A {@link LaxPromise} for the completion of the callback.
* @example
* component.lax.enqueue('c.save', { record: record })
* .then(id => {
* component.set('v.record.id', id);
* })
* .catch(errors => {
* console.error(errors);
* });
*/
catch: function (onError) {
var promise;
var callback = onError;
var len = arguments.length;
if (len > 1) {
var errorTypes = new Array(len - 1);
for (var i = 0; i < len - 1; i = i + 1) {
errorTypes[i] = arguments[i];
}
var onErrorCallback = arguments[len - 1];
callback = util.assignCatchFilters(errorTypes, onErrorCallback, this);
}
promise = this.then(undefined, function(e) {
e.message = util.removeAuraErrorMessagePrefix(e.message);
return callback(e);
});
return util.createAuraContextPromise(promise);
},
/**
* The method returns a {@link LaxPromise}.
* When the Promise is settled, whether fulfilled or rejected, the specified callback function is executed.
* This provides a way for code that must be executed once the Promise has been dealt with to be run
* whether the promise was fulfilled successfully or rejected.
*
* This lets you avoid duplicating code in both the promise's then() and catch() handlers.
* @param callback {Function} The function to run whe the Promise is settled
* @returns {LaxPromise}
*/
finally: function (callback) {
var self = this,
promise;
if (typeof Promise.prototype.finally === 'function') {
promise = self._contextPromise.finally($A.getCallback(callback));
} else {
promise = this
.then(function(value) {
return self._contextPromise.constructor.resolve($A.getCallback(callback)()).then(function() { return value; });
})
.catch(function(reason) {
return self._contextPromise.constructor.resolve($A.getCallback(callback)()).then(function() { throw reason; });
});
}
return util.createAuraContextPromise(promise);
},
/**
* Attaches a callback for only the rejection of the Promise
* and for only actions that returns "ERROR" state
* @param onError {Function} The callback to execute when the Promise is rejected.
* @returns {LaxPromise} A {@link LaxPromise} for the completion of the callback.
*/
error: function (onError) {
var fn = util.assignCatchFilters([errors.ApexActionError, errors.CreateComponentError], onError, this);
return this.then(undefined, fn);
},
/**
* Attaches a callback for only the rejection of the Promise
* and for only actions that returns "INCOMPLETE" state
* @param onIncomplete {Function} The callback to execute when the Promise is rejected.
* @returns {LaxPromise} A {@link LaxPromise} for the completion of the callback.
*/
incomplete: function (onIncomplete) {
var fn = util.assignCatchFilters([errors.IncompleteActionError], onIncomplete, this);
return this.then(undefined, fn);
}
};
/**
* The container of the actual Lightning Data Service (LDS). It delegates
* actions to LDS and provide and API to chain them. Actions callback functions don't
* require $A.getCallback() wrapper.
* @class LaxDataService
*/
var laxDataService =
/**
* @lends LaxDataService#
*/
{
/**
* The function to save the record that loaded to LDS edit EDIT mode.
* It used to create a record and save it or to save the changes to an existing one.
* @see https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/data_service_save_record.htm
* @returns {LaxPromise}
*/
saveRecord: function () {
var self = this;
var promise = new Promise(function (resolve, reject) {
self._service.saveRecord(ldsActionRouter.call(self, resolve, reject));
});
return util.createAuraContextPromise(promise);
},
/**
* The function to load a record template to the LDS targetRecord attribute.
* It doesn't return a result to callback function.
* It simply prepares an empty record and assigns it to the targetRecord attribute.
* @param sobjectType {String=} the object API name for the new record.
* @param recordTypeId {String=} the 18 character ID of the record type for the new record.
* If not specified, the default record type for the object is used, as defined in the user’s profile.
* @param skipCache {Boolean=} whether to load the record template from the server instead of the
* client-side Lightning Data Service cache. Defaults to false.
* @returns {LaxPromise}
*/
getNewRecord: function (sobjectType, recordTypeId, skipCache) {
var self = this;
var promise = new Promise(function (resolve) {
function getNewRecordCallback () {
resolve();
}
self._service.getNewRecord(sobjectType, recordTypeId, skipCache, getNewRecordCallback);
});
return util.createAuraContextPromise(promise);
},
/**
* The function to delete a record using LDS.
* @returns {LaxPromise}
*/
deleteRecord: function () {
var self = this;
var promise = new Promise(function (resolve, reject) {
self._service.deleteRecord(ldsActionRouter.call(self, resolve, reject));
});
return util.createAuraContextPromise(promise);
}
};
/**
* The object based on builder pattern to call Aura action.
* It is instantiated to be used by {@link Lax} as a prototype of actual actions.
* This type of action does not use Promise approach and subsequently can be called as storable.
* @class LaxActionBuilder
*/
var laxActionBuilder =
/**
* @lends LaxActionBuilder#
*/
{
/**
* Assign the success callback on Aura action
* @param callback {Function}
* @returns {LaxActionBuilder}
*/
setThen: function setThen(callback) {
this._resolveCallback = callback;
return this;
},
/**
* Assigns the failure callback on Aura action. This function called when the error occurs.
* @param callback {Function}
* @returns {LaxActionBuilder}
*/
setCatch: function setCatch(callback) {
this._rejectCallback = callback;
return this;
},
/**
* Assigns the finally callback on Aura action. This function called after success or failure callback. It doesn't
* depend on the result of an action.
* @param callback {Function}
* @returns {LaxActionBuilder}
*/
setFinally: function setFinally(callback) {
this._finallyCallback = callback;
return this;
},
/**
* Sets parameters for the action.
* @param params {Object}
* @returns {LaxActionBuilder}
*/
setParams: function setParams(params) {
this._action.setParams(params);
return this;
},
/**
* Marks the action as a {@link https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/controllers_server_storable_actions.htm|Storable}
* @returns {LaxActionBuilder}
*/
setStorable: function setStorable() {
this._action.setStorable();
return this;
},
/**
* Marks the action as a {@link https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/controllers_server_background_actions.htm|Background}
* @returns {LaxActionBuilder}
*/
setBackground: function setBackground() {
this._action.setBackground();
return this;
},
/**
* Enqueues the action. The function do not return the object itself and should be
* called at the end of the builder chain.
* @returns {void}
*/
enqueue: function enqueue() {
this._action.setCallback(this._component,
actionRouter.call(this._lax, this._resolveCallback, this._rejectCallback, this._finallyCallback));
$A.enqueueAction(this._action);
}
};
/**
* The object based on builder pattern to fire Lightning Application or Component events.
* @class LaxEventBuilder
*/
var laxEventBuilder =
/**
* @lends LaxEventBuilder#
*/
{
/**
* Sets data for the event attributes. A parameter’s name must match the name attribute
* of one of the event’s aura:attribute tags.
* @param params {Object} the data of event attributes
* @returns {LaxEventBuilder}
*/
setParams: function setParams(params) {
this._event.setParams(params);
return this;
},
/**
* Fires the event.
* @returns {void}
*/
fire: function fire() {
this._event.fire();
}
};
/**
* The object with list of Aura Server-Side action options
* @typedef {Object} ActionOptions
* @property storable {Boolean} Marks action as a Storable
* @property background {Boolean} Marks action as a Background
* @property abortable {Boolean} Marks action as a Abortable
*/
/**
* The object that contains a properties for Aura Server-Side Action
* @typedef {Object} ActionProperties
* @property name {String} The name of the action. It must be the same as Apex @AuraEnabled method
* @property params {Object} The object with parameters values for the action. It is based on Apex @AuraEnabled method
* @property options {Object} The object with list of options that can be applied to the action
*/
/**
* The action main object of the component that is used as a shared prototype across all lax components
* created in the application. See init function of the laxHelper.js where the lax assigned as prototype.
* @class Lax
*/
var laxPrototype =
/**
* @lends Lax#
*/
{
/**
* Enqueues the action by the name and with passed in params and options.
* The function returns Promise, subsequently client can chain the actions
* by assigning then callbacks or handle the error by catch callback.
* @param actionName {String} the name of the action (Apex controller method name)
* @param params [Object] the object that contains parameters for the action
* @param options [ActionOptions] the object with list of options for the action
* @returns {LaxPromise}
* @example
* component.lax.enqueue('c.getContact', { id: recordId }, { background: true })
* .then(contact => {
* component.set('v.record', contact);
* });
*/
enqueue: function enqueue(actionName, params, options) {
var self = this;
var promise = new Promise(function (resolve, reject) {
var action = self._component.get(actionName);
if (params) {
action.setParams(params);
}
if (options) {
if (options.background) {
action.setBackground();
}
if (options.storable) {
action.setStorable();
}
}
action.setCallback(self._component, actionRouter.call(self, resolve, reject));
$A.enqueueAction(action);
});
return util.createAuraContextPromise(promise);
},
/**
* Enqueues the list of actions parallel.
* The function return {@link Promise} that subsequently can be used to chain callback.
* The success callback assigned on the {@link Promise} called after all actions ready and an error have not thrown.
* @param actions {ActionProperties[]}
* @returns {LaxPromise}
* @example
* component.lax.enqueueAll([
* // { name : '...', params: {...}, options: {...} }
* { name: 'c.getContacts' },
* { name: 'c.getAccounts' },
* { name: 'c.getOpportunities' }
* ])
* .then(results => {
* // results: [ [contacts], [accounts], [opportunities] ]
* var contacts = results[0];
* var accounts = results[1];
* var opportunities = results[2];
* });
*/
enqueueAll: function enqueueAll(actions) {
var self = this;
var promises = actions.map(function (a) {
return self.enqueue.call(self, a.name, a.params, a.options);
});
return util.createAuraContextPromise(Promise.all(promises));
},
/**
* Creates the action linked to {@link LaxActionBuilder} by the provided name.
* @param actionName {String} the name of the action (Apex controller method)
* @returns {LaxActionBuilder}
* @example
* component.lax
* .action('c.getContact')
* .setStorable()
* .setParams({ id: recordId })
* .setThen(contact => {
* component.set('v.record', contact)
* })
* .setCatch(error => {
* console.error(error);
* })
* .enqueue();
*/
action: function action(actionName) {
var c = this._component;
var props = {
_component: {
writable: false,
configurable: false,
enumerable: false,
value: c
},
_action: {
writable: false,
configurable: false,
enumerable: false,
value: c.get(actionName)
},
_lax: {
writable: false,
configurable: false,
enumerable: false,
value: this
}
};
return Object.create(laxActionBuilder, props);
},
/**
* Creates an object with {LaxEventBuilder} prototype with the context
* event by provided name. The function apply Application and Component event name.
* @param eventName {String} the name of the event
* @returns {LaxEventBuilder}
*/
event: function event(eventName) {
var props = {
_event: {
writable: false,
configurable: false,
enumerable: false,
value: util.isApplicationEvent(eventName) ? $A.get(eventName) : this._component.getEvent(eventName)
}
};
return Object.create(laxEventBuilder, props);
},
/**
* Creates a container of actual Lightning Data Service object.
* @param id {String} the aura:id of the force:record (Lightning Data Service) tag
* @returns {LaxDataService}
*/
lds: function lds(id) {
var service = this._component.find(id);
var serviceProp = {
_service: {
writable: false,
configurable: false,
enumerable: false,
value: service
}
};
return Object.create(laxDataService, serviceProp);
},
/**
* Create a component from a type and a set of attributes.
* It accepts the name of a type of component, a map of attributes,
* and returns {LaxPromise} to assign a callback function to notify caller.
* @param {String} type The type of component to create, e.g. "ui:button".
* @param {Object} attributes A map of attributes to send to the component. These take the same form as on the markup,
* including events {"press":component.getReference("c.handlePress")}, and id {"aura:id":"myComponentId"}.
* @example
* lax.createComponent("aura:text",{value:'Hello World'})
* .then(function(auraTextComponent){
* // auraTextComponent - is an instance of aura:text containing the value Hello World
* });
* @returns {LaxPromise}
*/
createComponent: function createComponent(type, attributes) {
var self = this;
var promise = new Promise(function (resolve, reject) {
$A.createComponent(type, attributes, createComponentActionRouter.call(self, resolve, reject));
});
return util.createAuraContextPromise(promise);
},
/**
* Create an array of components from a list of types and attributes.
* It accepts a list of component names and attribute maps, and returns
* {LaxPromise} to assign a callback function to notify caller.
* @param {Array} components The list of components to create, e.g. ["ui:button",{"press":component.getReference("c.handlePress")}]
* @example
* lax.createComponents([
* ["aura:text",{value:'Hello'}],
* ["ui:button",{label:'Button'}],
* ["aura:text",{value:'World'}]
* ])
* .then(function(components) {
* // components - is an array of 3 components
* // 0 - Text Component containing Hello
* // 1 - Button Component with label Button
* // 2 - Text component containing World
* });
* @return {LaxPromise}
*/
createComponents: function createComponents(components) {
var self = this;
var promise = new Promise(function (resolve, reject) {
$A.createComponents(components, createComponentActionRouter.call(self, resolve, reject));
});
return util.createAuraContextPromise(promise);
},
getEventListeners: function () {
return eventListeners;
},
util: {
registerError: util.registerError
},
errors: errors
};
if (onInit) {
// callback to decorate events workflow (ApexAction)
onInit(eventListeners);
}
return laxPrototype;
},
initEventListeners: function (listenersContainer, component, auraMethodName) {
var method = component[auraMethodName];
if (method) {
Object.assign(listenersContainer, method.call(component));
}
},
defineErrors: function () {
function ApexActionError(message, entries, action) {
this.name = 'ApexActionError';
this.message = message;
this.entries = entries;
this.action = action;
this.stack = (new Error()).stack;
}
ApexActionError.prototype = Object.create(Error.prototype);
function IncompleteActionError(message, entries, action) {
this.name = 'IncompleteActionError';
this.message = message;
this.entries = entries;
this.action = action;
this.stack = (new Error()).stack;
}
IncompleteActionError.prototype = Object.create(Error.prototype);
function LdsActionError(message, entries, action) {
this.name = 'LdsActionError';
this.message = message;
this.entries = entries;
this.action = action;
this.stack = (new Error()).stack;
}
LdsActionError.prototype = Object.create(Error.prototype);
function CreateComponentError(message, entries, action) {
this.name = 'CreateComponentError';
this.message = message;
this.entries = entries;
this.action = action;
this.stack = (new Error()).stack;
}
CreateComponentError.prototype = Object.create(Error.prototype);
return {
ApexActionError: ApexActionError,
IncompleteActionError: IncompleteActionError,
LdsActionError: LdsActionError,
CreateComponentError: CreateComponentError
};
}
});
================================================
FILE: force-app/main/default/aura/slds_label/slds_label.cmp
================================================
================================================
FILE: force-app/main/default/aura/slds_label/slds_label.cmp-meta.xml
================================================
54.0
slds_label
================================================
FILE: force-app/main/default/aura/slds_section/slds_section.cmp
================================================
{!v.title}
================================================
FILE: force-app/main/default/aura/slds_section/slds_section.cmp-meta.xml
================================================
54.0
slds_section
================================================
FILE: force-app/main/default/aura/strike_evt/strike_evt.evt
================================================
================================================
FILE: force-app/main/default/aura/strike_evt/strike_evt.evt-meta.xml
================================================
54.0
strike_evt
================================================
FILE: force-app/main/default/aura/strike_wizard/strike_wizard.cmp
================================================
{!v.advanceButtonText}
{!v.body}
================================================
FILE: force-app/main/default/aura/strike_wizard/strike_wizard.cmp-meta.xml
================================================
54.0
A Lightning Component Bundle
================================================
FILE: force-app/main/default/aura/strike_wizard/strike_wizard.css
================================================
/*
Strike by Appiphony
Version: 0.8.0
Website: http://www.lightningstrike.io
GitHub: https://github.com/appiphony/Strike-Components
License: BSD 3-Clause License
*/
.THIS .sw-advance-button {
min-width: 240px;
}
.THIS .slds-tabs--path .slds-tabs--path__item.slds-is-lost+.slds-tabs--path__item:before {
background-color: t(colorBackgroundDestructive);
}
.THIS .slds-tabs--path .slds-tabs--path__item.slds-is-lost:hover,
.THIS .slds-tabs--path .slds-tabs--path__item.slds-is-lost:hover+.slds-tabs--path__item:before {
background-color: t(colorBackgroundDestructiveActive);
}
.THIS .slds-tabs--path .slds-tabs--path__item.slds-is-complete+.slds-is-lost:before {
background-color: t(colorBackgroundPathComplete);
}
.THIS .slds-tabs--path .slds-tabs--path__item.slds-is-complete:hover+.slds-is-lost:before {
background-color: t(colorBackgroundPathCompleteHover);
}
.THIS .slds-tabs--path .slds-tabs--path__item.slds-is-active+.slds-is-lost:before {
background-color: t(colorBackgroundInverse);
}
.THIS .slds-tabs--path .slds-tabs--path__item.slds-is-active:hover+.slds-is-lost:before {
background-color: t(colorBackgroundAltInverse);
}
.THIS .slds-path__mark-current[disabled]:hover,
.THIS .slds-path__mark-current[disabled]:focus {
background-color: t(colorBackgroundShade);
}
/*
Copyright 2017 Appiphony, LLC
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/aura/strike_wizard/strike_wizardController.js
================================================
/*
Strike by Appiphony
Version: 0.8.0
Website: http://www.lightningstrike.io
GitHub: https://github.com/appiphony/Strike-Components
License: BSD 3-Clause License
*/
({
init: function(component, event, helper) {
var displayMode = component.get('v.displayMode').toLowerCase();
helper.buildInitState(component, displayMode);
},
advanceButtonClick: function(component, event, helper) {
if (component.get('v.processComplete')) return;
if (component.get('v.error')) return;
var currentChevron = component.get('v.currentChevron');
helper.renderAdvanceButtonClick(component, currentChevron);
},
chevronClick: function(component, event, helper) {
if (component.get('v.processComplete')) return;
var targetChevron = Number(event.currentTarget.id);
helper.moveToChevron(component, targetChevron);
},
changeChevronMethod: function(component, event, helper) {
var params = event.getParam('arguments');
helper.moveToChevron(component, params.targetChevron);
},
showErrorMethod: function(component, event, helper) {
component.set('v.error', true);
},
hideErrorMethod: function(component, event, helper) {
component.set('v.error', false);
},
toggleBody: function(component, event, helper) {
component.set('v.toggleBodyView', !component.get('v.toggleBodyView'));
var chevronBody = component.find("chevron-body");
$A.util.toggleClass(chevronBody, "toggle");
},
toastMessage: function(component, event, helper) {
helper.showToast(component, event)
},
handleErrorState: function(component, event, helper) {
var error = event.getParam('value');
(error) ? helper.showErrorState(component) : helper.hideErrorState(component);
}
})
/*
Copyright 2017 Appiphony, LLC
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/aura/strike_wizard/strike_wizardHelper.js
================================================
/*
Strike by Appiphony
Version: 0.8.0
Website: http://www.lightningstrike.io
GitHub: https://github.com/appiphony/Strike-Components
License: BSD 3-Clause License
*/
({
buildInitState: function(component, displayMode) {
var stageNames = component.get('v.stageNames');
var activeChevron = component.get('v.activeChevron');
var forceProcessFlow = component.get('v.forceProcessFlow');
var disableBackwardNavOnComplete = component.get('v.disableBackwardNavOnComplete');
var disableForwardNavOnIncomplete = component.get('v.disableForwardNavOnIncomplete');
var error = component.get('v.error');
var chevrons = [];
for (var i = 0; i < stageNames.length; i++) {
if (displayMode == 'simple') {
chevrons.push({
'active': (i == activeChevron) ? true : false,
'class': (i == activeChevron) ? 'slds-is-active' : 'slds-is-incomplete',
'current': false,
'name': stageNames[i],
'status': 'incomplete',
'disabled': false
})
} else if (displayMode == 'wizard') {
if (activeChevron == 0 && i == 0) {
chevrons.push({
'active': (i == activeChevron) ? true : false,
'class': (i == activeChevron) ? (error) ? 'slds-is-current slds-is-lost' : 'slds-is-current' : 'slds-is-incomplete',
'current': (i == activeChevron) ? true : false,
'name': stageNames[i],
'status': 'incomplete',
'disabled': forceProcessFlow
})
} else {
if (i == activeChevron) {
chevrons.push({
'name': stageNames[i],
'active': true,
'current': true,
'class': (error) ? 'slds-is-current slds-is-lost' : 'slds-is-current',
'status': 'incomplete',
'disabled': false
})
} else if (i > activeChevron) {
chevrons.push({
'name': stageNames[i],
'active': false,
'current': false,
'class': 'slds-is-incomplete',
'status': 'incomplete',
'disabled': forceProcessFlow || disableForwardNavOnIncomplete
})
component.set('v.toggleButtonStyle', true);
} else {
chevrons.push({
'name': stageNames[i],
'active': false,
'current': false,
'class': 'slds-is-complete',
'status': 'complete',
'disabled': forceProcessFlow || disableBackwardNavOnComplete
})
component.set('v.toggleButtonStyle', false);
}
}
}
}
if (activeChevron != 0) component.set('v.initialized', true);
(activeChevron == 0) ? component.set('v.currentChevron', 1): component.set('v.currentChevron', activeChevron);
component.set('v.chevrons', chevrons);
component.set('v.processComplete', false);
component.set('v.advanceButtonText', component.get('v.advanceButtonNextLabel'));
},
renderSimpleMode: function(component, targetChevron) {
var chevrons = component.get('v.chevrons');
var results = {};
for (var i = 0; i < chevrons.length; i++) {
var chevron = chevrons[i];
chevron.class = '';
if (i == targetChevron) {
chevron.active = true;
chevron.current = false;
results.current = i || 0;
chevron.class += 'slds-is-active slds-is-incomplete';
} else {
chevron.active = false;
chevron.current = false;
results.current = i || 0;
chevron.class += 'slds-is-incomplete';
}
}
component.set('v.activeChevron', targetChevron);
component.set('v.chevrons', chevrons);
this.sendResultsToParent(component, results, 'click');
},
renderWizardMode: function(component, targetChevron) {
var chevrons = component.get('v.chevrons');
var results = {};
var error = component.get('v.error');
var setNextAsCurrent = false;
if (component.get('v.forceProcessFlow') == true) return;
for (var i = 0; i < chevrons.length; i++) {
var chevron = chevrons[i];
chevron.class = '';
if (i == targetChevron) {
if (chevron.current == true) {
chevron.active = false;
results.current = i || 0;
chevron.class = 'slds-is-current';
if (error) chevron.class += ' slds-is-lost';
component.set('v.advanceButtonText', component.get('v.advanceButtonNextLabel'));
component.set('v.toggleButtonStyle', true);
setNextAsCurrent = true;
} else {
results.active = i || 0;
chevron.active = true;
chevron.class = 'slds-is-active';
component.set('v.advanceButtonText', component.get('v.advanceButtonSelectLabel'));
component.set('v.toggleButtonStyle', false);
(chevron.status == 'complete') ? chevron.class += ' slds-is-complete': chevron.class += ' slds-is-incomplete';
}
} else {
if (chevron.current == true) {
results.current = i || 0;
chevron.class = 'slds-is-current';
if (error) chevron.class += ' slds-is-lost';
} else {
chevron.current = false;
(chevron.status == 'complete') ? chevron.class += ' slds-is-complete': chevron.class += ' slds-is-incomplete';
}
chevron.active = false;
}
}
if (setNextAsCurrent) component.set('v.currentChevron', targetChevron + 1);
else component.set('v.currentChevron', targetChevron);
component.set('v.chevrons', chevrons);
this.sendResultsToParent(component, results, 'click');
},
showErrorState: function(component) {
var chevrons = component.get('v.chevrons');
var activeChevron = component.get('v.activeChevron');
var processComplete = component.get('v.processComplete');
if (!processComplete) {
for (var i = 0; i < chevrons.length; i++) {
var chevron = chevrons[i];
if (chevron.class.indexOf('slds-is-active') >= 0) { // If selected
chevron.class = 'slds-is-active';
} else {
chevron.class = '';
}
if (i == activeChevron) {
chevron.active = false;
chevron.class += ' slds-is-current slds-is-lost';
chevron.current = true;
chevron.status = 'incomplete';
} else if (i < activeChevron) {
chevron.active = false;
chevron.class += ' slds-is-complete';
chevron.current = false;
chevron.status = 'complete';
} else if (i > activeChevron) {
chevron.active = false;
chevron.class += ' slds-is-incomplete';
chevron.current = false;
chevron.status = 'incomplete';
}
}
}
component.set('v.chevrons', chevrons);
},
hideErrorState: function(component) {
var chevrons = component.get('v.chevrons');
chevrons.forEach(function(chevron) {
chevron.class = chevron.class.replace('slds-is-lost', '');
});
component.set('v.chevrons', chevrons);
},
renderAdvanceButtonClick: function(component, activeChevron) {
var disableBackwardNavOnComplete = component.get('v.disableBackwardNavOnComplete');
var disableForwardNavOnIncomplete = component.get('v.disableForwardNavOnIncomplete');
var forceProcessFlow = component.get('v.forceProcessFlow');
if (component.get('v.displayMode').toLowerCase() == 'simple') return;
var chevrons = component.get('v.chevrons');
var error = component.get('v.error');
var results = {};
if (activeChevron == chevrons.length) {
chevrons[activeChevron - 1].class = 'slds-is-complete';
chevrons[activeChevron - 1].status = 'complete';
chevrons[activeChevron - 1].active = true;
chevrons[activeChevron - 1].current = false;
component.set('v.chevrons', chevrons);
component.set('v.advanceButtonText', component.get('v.advanceButtonCompletedLabel'));
component.set('v.activeChevron', null);
component.set('v.processComplete', true);
return;
}
(component.get('v.initialized') == true) ? activeChevron += 1 : activeChevron;
for (var i = 0; i < chevrons.length; i++) {
if (i == activeChevron) {
chevrons[i].class = 'slds-is-current';
if (error) chevrons[i].class += ' slds-is-lost';
chevrons[i].status = 'incomplete';
chevrons[i].current = true;
chevrons[i].disabled = false;
component.set('v.currentChevron', i + 1);
component.set('v.activeChevron', i);
} else if (i < activeChevron) {
chevrons[i].class = 'slds-is-complete';
chevrons[i].status = 'complete';
chevrons[i].current = false;
chevrons[i].disabled = forceProcessFlow || disableBackwardNavOnComplete;
} else if (i > activeChevron) {
chevrons[i].current = false;
chevrons[i].status = 'incomplete';
chevrons[i].class = 'slds-is-incomplete';
chevrons[i].disabled = forceProcessFlow || disableForwardNavOnIncomplete;
}
if (chevrons[i].current == true) results.current = i || 0;
if (chevrons[i].active == true) results.active = i || 0;
}
component.set('v.advanceButtonText', component.get('v.advanceButtonNextLabel'));
component.set('v.toggleButtonStyle', true);
component.set('v.chevrons', chevrons);
component.set('v.initialized', false);
this.sendResultsToParent(component, results, 'save');
},
moveToChevron : function(component, targetChevron) {
var helper = this;
var chevrons = component.get('v.chevrons');
var chevron = chevrons[targetChevron];
if (chevron.disabled == true) return;
if (!component.get('v.advanceButton') && component.get('v.displayMode').toLowerCase() == 'wizard') {
helper.renderAdvanceButtonClick(component, targetChevron);
} else {
(component.get('v.displayMode').toLowerCase() == 'wizard' && component.get('v.advanceButton') == true) ? helper.renderWizardMode(component, targetChevron) : helper.renderSimpleMode(component, targetChevron);
}
},
sendResultsToParent: function(component, results, type) {
var clickEvent = component.getEvent('strike_evt_chevron');
clickEvent.setParams({
data: {
'results': results,
'type': type
}
})
clickEvent.fire();
},
showToast: function(component, event) {
if (component.get('v.displayMode').toLowerCase() == 'simple') return;
var params = event.getParam('arguments');
var toastEvent = $A.get("e.force:showToast");
if (typeof(toastEvent) !== 'undefined') {
if (params) {
toastEvent.setParams({
"title": params.title,
"message": params.message,
"key": params.key,
"duration": params.duration,
"type": params.type,
"mode": params.mode
});
}
toastEvent.fire();
}
}
})
/*
Copyright 2017 Appiphony, LLC
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/LC_URLController.cls
================================================
/**
* Author: Doug Ayers
* Website: https://douglascayers.com
* GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
* License: BSD 3-Clause License
*/
public with sharing class LC_URLController {
@AuraEnabled
public static Map getUrlInfo() {
String namespace = getNamespaceOfClass( 'LC_URLController' );
String orgDomainURL = URL.getOrgDomainUrl().toExternalForm();
String salesforceBaseURL = URL.getSalesforceBaseUrl().toExternalForm();
Map result = new Map();
result.put( 'orgDomainURL', orgDomainURL );
result.put( 'salesforceBaseURL', salesforceBaseURL );
result.put( 'namespace', namespace );
return result;
}
private static String getNamespaceOfClass( String className ) {
String namespace = [ SELECT NamespacePrefix FROM ApexClass WHERE Name = :className LIMIT 1 ].NamespacePrefix;
return ( String.isBlank( namespace ) ? '' : namespace );
}
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/LC_URLController.cls-meta.xml
================================================
54.0
Active
================================================
FILE: force-app/main/default/classes/LC_URLControllerTest.cls
================================================
/**
* Author: Doug Ayers
* Website: https://douglascayers.com
* GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
* License: BSD 3-Clause License
*/
@IsTest
private class LC_URLControllerTest {
@IsTest
static void test_get_url_info() {
String namespace = [ SELECT NamespacePrefix FROM ApexClass WHERE Name = 'LC_URLController' LIMIT 1 ].NamespacePrefix;
namespace = ( String.isBlank( namespace ) ? '' : namespace );
Test.startTest();
Map urlInfo = LC_URLController.getUrlInfo();
System.assertEquals( URL.getOrgDomainUrl().toExternalForm(), urlInfo.get( 'orgDomainURL' ) );
System.assertEquals( URL.getSalesforceBaseUrl().toExternalForm(), urlInfo.get( 'salesforceBaseURL' ) );
System.assertEquals( namespace, urlInfo.get( 'namespace' ) );
Test.stopTest();
}
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/LC_URLControllerTest.cls-meta.xml
================================================
54.0
Active
================================================
FILE: force-app/main/default/classes/LC_VisualforceDomainController.cls
================================================
/*
Author: Doug Ayers
Website: https://douglascayers.com
GitHub: https://github.com/douglascayers/sfdx-lightning-api-component
License: BSD 3-Clause License
*/
public with sharing class LC_VisualforceDomainController {
// Aura Component
@AuraEnabled( cacheable = true )
public static String getVisualforceDomainURL() {
PageReference vfPage = Page.LC_VisualforceDomainPage;
return ( Test.isRunningTest() ? 'https://visualforce.com' : vfPage.getContent().toString().trim() );
}
// -----------------------------------------------------------------------------
// Visualforce Page
public String getDomainURL() {
URL requestURL = URL.getCurrentRequestUrl();
return requestURL.toExternalForm().substringBefore( requestURL.getPath() );
}
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/LC_VisualforceDomainController.cls-meta.xml
================================================
54.0
Active
================================================
FILE: force-app/main/default/classes/LC_VisualforceDomainControllerTest.cls
================================================
/*
Author: Doug Ayers
Website: https://douglascayers.com
GitHub: https://github.com/douglascayers/sfdx-lightning-api-component
License: BSD 3-Clause License
*/
@IsTest
private class LC_VisualforceDomainControllerTest {
// Aura Component
@IsTest
static void test_get_visualforce_domain_url() {
Test.startTest();
String vfDomainURL = LC_VisualforceDomainController.getVisualforceDomainURL();
System.assertEquals( 'https://visualforce.com', vfDomainURL );
Test.stopTest();
}
// -----------------------------------------------------------------------------
// Visualforce Page
@IsTest
static void test_get_domain_url() {
Test.setCurrentPage( Page.LC_VisualforceDomainPage );
Test.startTest();
LC_VisualforceDomainController controller = new LC_VisualforceDomainController();
String domainURL = controller.getDomainURL();
// The test is not running in Visualforce context,
// so best we can get here is domain in Apex context.
System.assertEquals( URL.getSalesforceBaseUrl().toExternalForm(), domainURL );
Test.stopTest();
}
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/LC_VisualforceDomainControllerTest.cls-meta.xml
================================================
54.0
Active
================================================
FILE: force-app/main/default/classes/MA_AnonymousApexExecuteResult.cls
================================================
/**
* Author: Doug Ayers
* Website: https://douglascayers.com
* GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
* License: BSD 3-Clause License
*/
/*
* Represents some parts of an XML response from Anonymous Apex SOAP API.
* https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/sforce_api_calls_executeanonymous_result.htm
*/
public inherited sharing class MA_AnonymousApexExecuteResult {
public Integer column { get; set; }
public String compileProblem { get; set; }
public Boolean compiled { get; set; }
public String exceptionMessage { get; set; }
public String exceptionStackTrace { get; set; }
public Integer line { get; set; }
public Boolean success { get; set; }
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/MA_AnonymousApexExecuteResult.cls-meta.xml
================================================
54.0
Active
================================================
FILE: force-app/main/default/classes/MA_AsyncApexJobMock.cls
================================================
/**
* Author: Doug Ayers
* Website: https://douglascayers.com
* GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
* License: BSD 3-Clause License
*/
/*
* Test coverage provided by MA_MassActionBatchUtilsTest.
*/
public inherited sharing class MA_AsyncApexJobMock {
// These are fake job ids that parse via ID.valueOf()
// but don't actually exist. This allows test/mock code
// to instantiate AsyncApexJobs or pass job ids to methods
// and reliably get back a test/mock job record later.
// Checkmarx security scanner labels these "low risk hardcoded ids".
// They are hardcoded on purpose for testing/mocking purposes.
public static final ID QUEUED_JOB_ID = '707f40000000001';
public static final ID PREPARING_JOB_ID = '707f40000000002';
public static final ID PROCESSING_JOB_ID = '707f40000000003';
public static final ID ABORTED_JOB_ID = '707f40000000004';
public static final ID FAILED_JOB_ID = '707f40000000005';
public static final ID COMPLETED_JOB_ID = '707f40000000006';
public static final ID COMPLETED_WITH_ERRORS_JOB_ID = '707f40000000007';
public static final Set MOCK_JOB_IDS = new Set{
QUEUED_JOB_ID,
PREPARING_JOB_ID,
PROCESSING_JOB_ID,
ABORTED_JOB_ID,
FAILED_JOB_ID,
COMPLETED_JOB_ID,
COMPLETED_WITH_ERRORS_JOB_ID
};
private static final Map MOCK_JOBS_MAP = new Map{
QUEUED_JOB_ID => mockJob( QUEUED_JOB_ID, 'Queued', null, null, null, null ),
PREPARING_JOB_ID => mockJob( PREPARING_JOB_ID, 'Preparing', null, null, null, null ),
PROCESSING_JOB_ID => mockJob( PROCESSING_JOB_ID, 'Processing', null, 2, 0, 0 ),
ABORTED_JOB_ID => mockJob( ABORTED_JOB_ID, 'Aborted', null, 2, 1, 0 ),
FAILED_JOB_ID => mockJob( FAILED_JOB_ID, 'Failed', 'Test Job Failed', 2, 0, 2 ),
COMPLETED_JOB_ID => mockJob( COMPLETED_JOB_ID, 'Completed', null, 2, 2, 0 ),
COMPLETED_WITH_ERRORS_JOB_ID => mockJob( COMPLETED_WITH_ERRORS_JOB_ID, 'Completed', 'Test Job Completed with Errors', 2, 0, 2 )
};
public static AsyncApexJob getJobById( ID jobId ) {
return MOCK_JOBS_MAP.get( jobId );
}
private static AsyncApexJob mockJob( ID jobId, String status, String extendedStatus, Integer totalJobItems, Integer jobItemsProcessed, Integer numberOfErrors ) {
// this object has non-writable fields so we use the json serialization trick to populate a mock record
return (AsyncApexJob) JSON.deserialize( JSON.serialize( new Map{
'Id' => jobId,
'Status' => status,
'ExtendedStatus' => extendedStatus,
'TotalJobItems' => totalJobItems,
'JobItemsProcessed' => jobItemsProcessed,
'NumberOfErrors' => numberOfErrors,
'CreatedDate' => DateTime.now(),
'CompletedDate' => DateTime.now()
}), AsyncApexJob.class );
}
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/MA_AsyncApexJobMock.cls-meta.xml
================================================
54.0
Active
================================================
FILE: force-app/main/default/classes/MA_BatchApexErrorEventInvocable.cls
================================================
/**
* Author: Doug Ayers
* Website: https://douglascayers.com
* GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
* License: BSD 3-Clause License
*/
/*
* This class explicitly uses 'without sharing' because it runs not as a real user
* but rather as the Automated Process user, an entity we can't grant permissions to.
*/
public without sharing class MA_BatchApexErrorEventInvocable {
@InvocableMethod(
label = 'MAS: Batch Apex Error Event Handler'
description = 'Creates Mass Action Logs from batch job errors when running Mass Action Configurations.'
)
public static List execute( List requests ) {
List responses = new List();
System.debug( 'MA_BatchApexErrorEventInvocable.execute: size=' + requests.size() );
Set jobIds = new Set();
for ( Request evt : requests ) {
if ( String.isNotBlank( evt.asyncApexJobId ) ) {
jobIds.add( ID.valueOf( evt.asyncApexJobId ) );
}
}
Map jobIdToJobMap = MA_MassActionBatchUtils.getJobsByJobIdMap( jobIds );
Map jobIdtoParentLogMap = MA_MassActionBatchUtils.getParentLogsByJobIdMap( jobIdToJobMap.values() );
List jobStatusEvents = new List();
for ( Request evt : requests ) {
ID asyncApexJobId = ID.valueOf( evt.AsyncApexJobId );
AsyncApexJob job = jobIdToJobMap.get( asyncApexJobId );
Mass_Action_Log__c parentLog = jobIdToParentLogMap.get( asyncApexJobId );
// if either the job or parent log are null then
// this batch error event is not for mass action scheduler, skip it
if ( job != null && parentLog != null ) {
jobStatusEvents.add( new Mass_Action_Batch_Apex_Status_Event__e(
Job_ID__c = job.Id,
Phase__c = evt.Phase,
Message_Type__c = 'Error',
Message__c = 'Error in job phase ' + evt.Phase + ': ' + evt.Message,
Long_Message__c = (
'Phase: ' + evt.Phase + '\n' +
'Message: ' + evt.Message + '\n' +
'ExceptionType: ' + evt.ExceptionType + '\n' +
'StackTrace: ' + evt.StackTrace
),
Job_Scope__c = evt.JobScope,
// It is very important that we use the event's created date
// and not when we're processing the event because platform events
// are handled asynchronously. If we use "now" vs. "then" then
// our log records will be out of order chronologically.
// The logs would appear in the order we got to insert them
// rather than the real time of when the cause occurred.
Timestamp__c = String.valueOf( evt.CreatedDate.getTime() )
));
}
}
List results = MA_MassActionBatchUtils.publish( jobStatusEvents );
for ( Database.SaveResult result : results ) {
responses.add( new Response( result ) );
}
return responses;
}
/**
* Mirrors the BatchApexErrorEvent record.
* Designed for process builder to map the fields to this invocable request parameter.
* https://developer.salesforce.com/docs/atlas.en-us.220.0.platform_events.meta/platform_events/sforce_api_objects_batchapexerrorevent.htm
*/
public inherited sharing class Request {
@InvocableVariable(
label = 'Async Apex Job ID'
description = 'ID of the batch Apex job that fired this event.'
required = true
)
public String asyncApexJobId;
@InvocableVariable(
label = 'Phase'
description = 'The phase of the batch job when it encountered an error. One of START, EXECUTE, or FINISH.'
required = true
)
public String phase;
@InvocableVariable(
label = 'Job Scope'
description = 'The Record IDs that are in scope if the event was fired from the execute() method of a batch job.'
required = true
)
public String jobScope;
@InvocableVariable(
label = 'Message'
description = 'Exception message text.'
required = true
)
public String message;
@InvocableVariable(
label = 'Exception Type'
description = 'The Apex exception type name.'
required = true
)
public String exceptionType;
@InvocableVariable(
label = 'Stack Trace'
description = 'The Apex stacktrace of the exception, if available.'
required = true
)
public String stackTrace;
@InvocableVariable(
label = 'Replay ID'
description = 'ID value that is populated by the system and refers to the position of the event in the event stream.'
required = true
)
public String replayId;
@InvocableVariable(
label = 'Request ID'
description = 'The unique ID of the batch job that fired the event.'
required = true
)
public String requestId;
@InvocableVariable(
label = 'Created By ID'
description = 'Who published this event.'
required = true
)
public ID createdById;
@InvocableVariable(
label = 'Created Date'
description = 'When the event was published.'
required = true
)
public DateTime createdDate;
public Request() {}
public Request( BatchApexErrorEvent evt ) {
this.asyncApexJobId = evt.AsyncApexJobId;
this.phase = evt.Phase;
this.jobScope = evt.JobScope;
this.message = evt.Message;
this.exceptionType = evt.ExceptionType;
this.stackTrace = evt.StackTrace;
this.replayId = evt.ReplayId;
this.requestId = evt.RequestId;
this.createdById = evt.CreatedById;
this.createdDate = evt.CreatedDate;
}
}
public inherited sharing class Response {
@InvocableVariable(
label = 'Event ID'
description = 'ID of the published Mass_Action_Batch_Apex_Status_Event__e event.'
)
public ID eventId;
@InvocableVariable(
label = 'Success'
description = 'True if the event was published, false otherwise.'
)
public Boolean success;
@InvocableVariable(
label = 'Errors'
description = 'List of errors trying to publish the event.'
)
public List errors = new List();
public Response() {}
public Response( Database.SaveResult result ) {
this.eventId = result.id;
this.success = result.success;
for ( Database.Error err : result.getErrors() ) {
errors.add( err.getStatusCode() + ' : ' + err.getMessage() );
}
}
}
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/MA_BatchApexErrorEventInvocable.cls-meta.xml
================================================
54.0
Active
================================================
FILE: force-app/main/default/classes/MA_BatchApexErrorEventInvocableTest.cls
================================================
/**
* Author: Doug Ayers
* Website: https://douglascayers.com
* GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
* License: BSD 3-Clause License
*/
@IsTest
private class MA_BatchApexErrorEventInvocableTest {
@IsTest
static void test_invocable() {
AsyncApexJob job = MA_AsyncApexJobMock.getJobById( MA_AsyncApexJobMock.PROCESSING_JOB_ID );
Mass_Action_Configuration__c config = new Mass_Action_Configuration__c(
Name = 'Test Config',
DeveloperName__c = 'Test_Config',
Active__c = true
);
insert config;
Map logRecordTypeInfosMap = Mass_Action_Log__c.SObjectType.getDescribe().getRecordTypeInfosByDeveloperName();
Mass_Action_Log__c parentLog = new Mass_Action_Log__c(
RecordTypeId = logRecordTypeInfosMap.get( 'Parent_Log' ).getRecordTypeId(),
Mass_Action_Configuration__c = config.Id,
Job_ID__c = job.Id,
Submitted_Date__c = DateTime.now(),
Timestamp__c = String.valueOf( DateTime.now().getTime() ),
Message__c = 'Batch job enqueued',
Message_Type__c = 'Informational'
);
insert parentLog;
Test.startTest();
BatchApexErrorEvent evt = (BatchApexErrorEvent) JSON.deserialize( JSON.serialize( new Map{
'AsyncApexJobId' => job.Id,
'Phase' => 'START',
'Message' => 'TEST ERROR MESSAGE',
'ExceptionType' => 'TEST EXCEPTION TYPE',
'StackTrace' => 'TEST STACK TRACE',
'JobScope' => 'TEST JOB SCOPE',
'ReplayId' => 'TEST REPLAY ID',
'RequestId' => 'TEST REQUEST ID',
'CreatedById' => UserInfo.getUserId(),
'CreatedDate' => DateTime.now()
}), BatchApexErrorEvent.class );
List requests = new List{
new MA_BatchApexErrorEventInvocable.Request( evt )
};
List responses = MA_BatchApexErrorEventInvocable.execute( requests );
Test.stopTest();
Test.getEventBus().deliver();
System.assertEquals( requests.size(), responses.size() );
System.assertEquals( true, responses[0].success );
parentLog = [
SELECT
Id, Message__c, Message_Type__c,
( SELECT Message_Type__c, Message__c, Job_Scope__c FROM Mass_Action_Logs__r )
FROM
Mass_Action_Log__c
WHERE
Id = :parentLog.Id
];
System.assertEquals( 'Batch job ' + job.Status.toLowerCase(), parentLog.Message__c );
System.assertEquals( 'Informational', parentLog.Message_Type__c );
System.assertEquals( 1, parentLog.Mass_Action_Logs__r.size() );
System.assertEquals( 'Error in job phase ' + evt.Phase + ': ' + evt.Message, parentLog.Mass_Action_Logs__r[0].Message__c );
System.assertEquals( 'Error', parentLog.Mass_Action_Logs__r[0].Message_Type__c );
System.assertEquals( evt.JobScope, parentLog.Mass_Action_Logs__r[0].Job_Scope__c );
}
@IsTest
static void instantiate_request_and_response() {
// Gotta get that code coverage!
Test.startTest();
MA_BatchApexErrorEventInvocable.Request req = new MA_BatchApexErrorEventInvocable.Request();
MA_BatchApexErrorEventInvocable.Response res = new MA_BatchApexErrorEventInvocable.Response();
Test.stopTest();
}
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/MA_BatchApexErrorEventInvocableTest.cls-meta.xml
================================================
54.0
Active
================================================
FILE: force-app/main/default/classes/MA_BatchApexStatusEventTriggerHandler.cls
================================================
/**
* Author: Doug Ayers
* Website: https://douglascayers.com
* GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
* License: BSD 3-Clause License
*/
/*
* This class explicitly uses 'without sharing' because it runs not as a real user
* but rather as the Automated Process user, an entity we can't grant permissions to.
*/
public without sharing class MA_BatchApexStatusEventTriggerHandler {
public MA_BatchApexStatusEventTriggerHandler() {}
// -------------------------------------------------------
// INSERT
// -------------------------------------------------------
public void handleAfterInsert( List newList, Map newMap ) {
System.debug( 'MA_BatchApexStatusEventTriggerHandler.handleAfterInsert' );
Set jobIds = new Set();
for ( Mass_Action_Batch_Apex_Status_Event__e evt : newList ) {
if ( String.isNotBlank( evt.Job_ID__c ) ) {
jobIds.add( ID.valueOf( evt.Job_ID__c ) );
}
}
Map jobIdToJobMap = MA_MassActionBatchUtils.getJobsByJobIdMap( jobIds );
Map jobIdtoParentLogMap = MA_MassActionBatchUtils.getParentLogsByJobIdMap( jobIdToJobMap.values() );
Map logRecordTypeInfosMap = Mass_Action_Log__c.SObjectType.getDescribe().getRecordTypeInfosByDeveloperName();
Map parentLogsToUpdateMap = new Map();
List childLogsToInsertList = new List();
// Platform event triggers may receive up to 2,000 events.
// Apex triggers are limited to 200 records per batch.
// Since we are doing DML in this event handler, to mitigate exceeding a governor limit
// then we'll chunk the events into smaller batches.
// https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_events_subscribe_batch_resume.htm
Integer BATCH_LIMIT = 200;
Integer batchLimitCounter = 0;
String lastEventReplayId;
for ( Mass_Action_Batch_Apex_Status_Event__e evt : newList ) {
batchLimitCounter++;
if ( batchLimitCounter > BATCH_LIMIT ) {
System.debug( 'MA_BatchApexStatusEventTriggerHandler.handleAfterInsert: reached batch limit of ' + BATCH_LIMIT + ', will requeue remaining ' + ( newList.size() - BATCH_LIMIT ) + ' events for processing' );
break;
}
System.debug( 'MA_BatchApexStatusEventTriggerHandler.handleAfterInsert: event=' + JSON.serializePretty( evt ) );
ID asyncApexJobId = ID.valueOf( evt.Job_ID__c );
AsyncApexJob job = jobIdToJobMap.get( asyncApexJobId );
Mass_Action_Log__c parentLog = jobIdToParentLogMap.get( asyncApexJobId );
// if either the job or parent log are null then
// this batch error event is not for mass action scheduler, skip it
if ( job != null && parentLog != null ) {
Mass_Action_Log__c parentLogToUpdate = parentLogsToUpdateMap.get( parentLog.Id );
if ( parentLogToUpdate == null ) {
Boolean jobFailed = ( job.Status == 'Failed' );
Boolean jobHasErrors = ( String.isNotBlank( job.ExtendedStatus ) || job.NumberOfErrors > 0 );
String messageType = (
( job.Status == 'Aborted' || job.Status == 'Failed' || jobHasErrors ) ? 'Error' :
( job.CompletedDate != null && job.TotalJobItems == job.JobItemsProcessed ) ? 'Success' :
'Informational'
);
String message = 'Batch job ' + (
( job.Status == 'Completed' && jobHasErrors ) ? 'completed with errors' :
String.isBlank( job.Status ) ? 'information' :
job.Status.toLowerCase()
);
parentLogsToUpdateMap.put( parentLog.Id, new Mass_Action_Log__c(
Id = parentLog.Id,
Message_Type__c = messageType,
Message__c = message,
Submitted_Date__c = job.CreatedDate,
Total_Batches__c = job.TotalJobItems,
Processed_Batches__c = job.JobItemsProcessed,
Failed_Batches__c = job.NumberOfErrors
));
}
childLogsToInsertList.add( new Mass_Action_Log__c(
RecordTypeId = logRecordTypeInfosMap.get( 'Child_Log' ).getRecordTypeId(),
Mass_Action_Configuration__c = parentLog.Mass_Action_Configuration__c,
Parent_Log__c = parentLog.Id,
Job_ID__c = parentLog.Job_ID__c,
Message_Type__c = evt.Message_Type__c,
Message__c = evt.Message__c,
Long_Message__c = evt.Long_Message__c,
Job_Scope__c = evt.Job_Scope__c,
Timestamp__c = evt.Timestamp__c
));
}
lastEventReplayId = evt.ReplayId;
}
System.debug( 'MA_BatchApexStatusEventTriggerHandler.handleAfterInsert: inserting child logs and updating parent logs' );
Database.DMLOptions dmo = new Database.DMLOptions();
dmo.allowFieldTruncation = true;
Database.insert( childLogsToInsertList, dmo );
Database.update( parentLogsToUpdateMap.values(), dmo );
// When the trigger stops its flow of execution, either intentionally or because of an unhandled exception,
// such as a limit exception, it fires again with a new batch (the sObject list in Trigger.New).
// The new batch starts with the event message after the one with the replay ID that you set.
// Therefore, we don't want to set this resume checkpoint until we know that the above DML operations complete.
// https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_events_subscribe_batch_resume.htm
if ( String.isNotBlank( lastEventReplayId ) ) {
System.debug( 'MA_BatchApexStatusEventTriggerHandler.handleAfterInsert: setting resume checkpoint: lastEventReplayId=' + lastEventReplayId );
EventBus.TriggerContext.currentContext().setResumeCheckpoint( lastEventReplayId );
}
}
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/MA_BatchApexStatusEventTriggerHandler.cls-meta.xml
================================================
54.0
Active
================================================
FILE: force-app/main/default/classes/MA_BatchApexStatusEventTriggerTest.cls
================================================
/**
* Author: Doug Ayers
* Website: https://douglascayers.com
* GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
* License: BSD 3-Clause License
*/
@IsTest
private class MA_BatchApexStatusEventTriggerTest {
@IsTest
static void test_publish() {
AsyncApexJob job = MA_AsyncApexJobMock.getJobById( MA_AsyncApexJobMock.COMPLETED_JOB_ID );
Mass_Action_Configuration__c config = new Mass_Action_Configuration__c(
Name = 'Test Config',
DeveloperName__c = 'Test_Config',
Active__c = true
);
insert config;
Map logRecordTypeInfosMap = Mass_Action_Log__c.SObjectType.getDescribe().getRecordTypeInfosByDeveloperName();
Mass_Action_Log__c parentLog = new Mass_Action_Log__c(
RecordTypeId = logRecordTypeInfosMap.get( 'Parent_Log' ).getRecordTypeId(),
Mass_Action_Configuration__c = config.Id,
Job_ID__c = job.Id,
Submitted_Date__c = DateTime.now(),
Timestamp__c = String.valueOf( DateTime.now().getTime() ),
Message__c = 'Batch job enqueued',
Message_Type__c = 'Informational'
);
insert parentLog;
Test.startTest();
Mass_Action_Batch_Apex_Status_Event__e evt = new Mass_Action_Batch_Apex_Status_Event__e(
Job_ID__c = job.Id,
Phase__c = 'FINISH',
Message_Type__c = 'Success',
Message__c = 'TEST MESSAGE',
Long_Message__c = 'TEST LONG MESSAGE',
Job_Scope__c = 'TEST JOB SCOPE',
Timestamp__c = 'TEST TIMESTAMP'
);
EventBus.publish( evt );
Test.stopTest();
Test.getEventBus().deliver();
parentLog = [
SELECT
Id, Message__c, Message_Type__c,
( SELECT Message_Type__c, Message__c, Job_Scope__c FROM Mass_Action_Logs__r )
FROM
Mass_Action_Log__c
WHERE
Id = :parentLog.Id
];
System.assertEquals( 'Batch job ' + job.Status.toLowerCase(), parentLog.Message__c );
System.assertEquals( 'Success', parentLog.Message_Type__c );
System.assertEquals( 1, parentLog.Mass_Action_Logs__r.size() );
System.assertEquals( evt.Message__c, parentLog.Mass_Action_Logs__r[0].Message__c );
System.assertEquals( 'Success', parentLog.Mass_Action_Logs__r[0].Message_Type__c );
System.assertEquals( evt.Job_Scope__c, parentLog.Mass_Action_Logs__r[0].Job_Scope__c );
}
@IsTest
static void test_publish_bulk() {
AsyncApexJob job = MA_AsyncApexJobMock.getJobById( MA_AsyncApexJobMock.COMPLETED_JOB_ID );
Mass_Action_Configuration__c config = new Mass_Action_Configuration__c(
Name = 'Test Config',
DeveloperName__c = 'Test_Config',
Active__c = true
);
insert config;
Map logRecordTypeInfosMap = Mass_Action_Log__c.SObjectType.getDescribe().getRecordTypeInfosByDeveloperName();
Mass_Action_Log__c parentLog = new Mass_Action_Log__c(
RecordTypeId = logRecordTypeInfosMap.get( 'Parent_Log' ).getRecordTypeId(),
Mass_Action_Configuration__c = config.Id,
Job_ID__c = job.Id,
Submitted_Date__c = DateTime.now(),
Timestamp__c = String.valueOf( DateTime.now().getTime() ),
Message__c = 'Batch job enqueued',
Message_Type__c = 'Informational'
);
insert parentLog;
Test.startTest();
List events = new List();
for ( Integer i = 0; i < 201; i++ ) {
events.add( new Mass_Action_Batch_Apex_Status_Event__e(
Job_ID__c = job.Id,
Phase__c = 'FINISH',
Message_Type__c = 'Success',
Message__c = 'TEST MESSAGE ' + i,
Long_Message__c = 'TEST LONG MESSAGE ' + i,
Job_Scope__c = 'TEST JOB SCOPE ' + i,
Timestamp__c = 'TEST TIMESTAMP ' + i
));
}
// Our event trigger handler chunks the published events
// into batches of 200 to keep the scope low because the
// handler performs DML operations. By default, the event bus
// could deliver up to 2,000 events at a time. We could run
// into SOQL and DML governor limits in this trigger handler.
// The test, then, is to ensure that multiple waves will occur
// and that the expected number of mass action logs are created.
// Publish 201 events
EventBus.publish( events );
// Delivers 201 events, but the handler will set a resume checkpoint
// after processing the first 200 events.
Test.getEventBus().deliver();
parentLog = [
SELECT
Id, Message__c, Message_Type__c,
( SELECT Message_Type__c, Message__c, Job_Scope__c FROM Mass_Action_Logs__r )
FROM
Mass_Action_Log__c
WHERE
Id = :parentLog.Id
];
Integer firstWaveCountOfLogs = parentLog.Mass_Action_Logs__r.size();
System.debug( 'FIRST WAVE' );
System.debug( JSON.serializePretty( parentLog ) );
// Publish all events after the resume checkpoint.
// In this test, that would be the 201st event.
Test.getEventBus().deliver();
parentLog = [
SELECT
Id, Message__c, Message_Type__c,
( SELECT Message_Type__c, Message__c, Job_Scope__c FROM Mass_Action_Logs__r )
FROM
Mass_Action_Log__c
WHERE
Id = :parentLog.Id
];
Integer secondWaveCountOfLogs = parentLog.Mass_Action_Logs__r.size();
System.debug( 'SECOND WAVE' );
System.debug( JSON.serializePretty( parentLog ) );
Test.stopTest();
// assert total events published in each wave and overall
System.assertEquals( firstWaveCountOfLogs + 1, secondWaveCountOfLogs );
System.assertEquals( events.size(), secondWaveCountOfLogs );
}
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/MA_BatchApexStatusEventTriggerTest.cls-meta.xml
================================================
54.0
Active
================================================
FILE: force-app/main/default/classes/MA_EditConfigCmpController.cls
================================================
/**
* Author: Doug Ayers
* Website: https://douglascayers.com
* GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
* License: BSD 3-Clause License
*/
public with sharing class MA_EditConfigCmpController {
/**
* This method accepts the JSON serialization of the configuration and field mappings
* because when defining the method params as the custom class type was getting internal server error.
* I think possibly related to general serialization bugs with Lightning:
* https://developer.salesforce.com/forums/?id=906F00000005GiwIAE
* https://blog.texei.com/lightning-components-auraenabled-method-parameters-whats-working-and-what-s-not-83c351356104
*/
@AuraEnabled
public static Map saveConfiguration( String wrapperJson, String fieldMappingsJson ) {
SavePoint sp = Database.setSavepoint();
try {
return MA_MassActionUtils.saveConfiguration( wrapperJson, fieldMappingsJson );
} catch ( Exception e ) {
Database.rollback( sp );
System.debug( LoggingLevel.ERROR, 'MA_EditConfigCmpController.saveConfiguration: ' + e.getMessage() + ' : ' + e.getStackTraceString() );
throw new AuraHandledException( e.getMessage() );
}
}
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/MA_EditConfigCmpController.cls-meta.xml
================================================
54.0
Active
================================================
FILE: force-app/main/default/classes/MA_EditConfigCmpControllerTest.cls
================================================
/**
* Author: Doug Ayers
* Website: https://douglascayers.com
* GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
* License: BSD 3-Clause License
*/
@IsTest
private class MA_EditConfigCmpControllerTest {
@IsTest
static void test_saveConfiguration() {
MA_MassActionConfigWrapper wrapper = new MA_MassActionConfigWrapper();
wrapper.name = 'Test Config';
wrapper.developerName = 'Test_Config';
wrapper.active = false;
wrapper.batchSize = 200;
wrapper.namedCredential = 'Mass_Action_Test_Named_Credential';
wrapper.sourceType = 'ListView';
wrapper.sourceListViewID = '00Bf40000017w5h';
wrapper.targetType = 'Flow';
wrapper.targetActionName = 'Test_Flow';
wrapper.scheduleFrequency = 'Custom';
wrapper.scheduleCron = '0 0 1 * * ?';
String wrapperJson = JSON.serialize( wrapper );
String fieldMappingsJson = JSON.serialize( new Map{
'TargetField' => 'SourceField'
});
Test.startTest();
// Test Success
Map result = MA_EditConfigCmpController.saveConfiguration( wrapperJson, fieldMappingsJson );
System.assertEquals( true, result.get( 'success' ) );
Mass_Action_Configuration__c config = MA_MassActionUtils.getConfiguration( (ID) result.get( 'recordId' ) );
System.assertEquals( wrapper.name, config.Name );
System.assertEquals( wrapper.active, config.Active__c );
System.assertEquals( wrapper.batchSize, config.Batch_Size__c );
System.assertEquals( wrapper.namedCredential, config.Named_Credential__c );
System.assertEquals( wrapper.sourceType, config.Source_Type__c );
System.assertEquals( wrapper.sourceListViewID, config.Source_List_View_ID__c );
System.assertEquals( wrapper.targetType, config.Target_Type__c );
System.assertEquals( wrapper.targetActionName, config.Target_Action_Name__c );
System.assertEquals( wrapper.scheduleFrequency, config.Schedule_Frequency__c );
System.assertEquals( wrapper.scheduleCron, config.Schedule_Cron__c );
System.assertEquals( 1, config.Mass_Action_Mappings__r.size() );
System.assertEquals( 'TargetField', config.Mass_Action_Mappings__r[0].Target_Field_Name__c );
System.assertEquals( 'SourceField', config.Mass_Action_Mappings__r[0].Source_Field_Name__c );
// Test Error
try {
MA_EditConfigCmpController.saveConfiguration( null, null );
System.assert( false, 'should fail' );
} catch ( Exception e ) {
System.assert( true, 'should fail' );
}
Test.stopTest();
}
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/MA_EditConfigCmpControllerTest.cls-meta.xml
================================================
54.0
Active
================================================
FILE: force-app/main/default/classes/MA_EditConfigRestController.cls
================================================
/**
* Author: Doug Ayers
* Website: https://douglascayers.com
* GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
* License: BSD 3-Clause License
*/
@RestResource( urlMapping = '/config/edit/*' )
global with sharing class MA_EditConfigRestController {
/**
* Entry point into this REST class.
*
* Expects one URL parameter named 'operation',
* which translates to an actual Apex method in this class.
*
* Expects JSON body with parameters to pass to the actual
* Apex method indicated by the 'operation' URL parameter.
*
* Example:
* POST: /services/apexrest/dca_mass_action/config/edit?operation=getReportsByFolder
* {
* "reportId" : "00lf4000000pezaAAA"
* }
*
* See handleRequestOperation(..) method comments for full details.
*/
@HttpPost
global static void handlePost() {
RestRequest req = RestContext.request;
RestResponse res = RestContext.response;
Map requestUrlParams;
Map requestBodyParams;
Map responseBodyParams;
try {
System.debug( 'MA_EditConfigRestController.handlePost: request: ' + req );
requestUrlParams = req.params;
requestBodyParams = (Map) JSON.deserializeUntyped( ( req.requestBody == null ) ? '{}' : req.requestBody.toString() );
responseBodyParams = new Map{ 'success' => true };
String operation = requestUrlParams.get( 'operation' );
System.debug( 'MA_EditConfigRestController.handlePost: requestUrlParams: ' + JSON.serializePretty( requestUrlParams ) );
System.debug( 'MA_EditConfigRestController.handlePost: requestBody: ' + JSON.serializePretty( requestBodyParams ) );
handleRequestOperation( operation, requestBodyParams, responseBodyParams );
} catch ( Exception e ) {
System.debug( LoggingLevel.ERROR, e.getMessage() + ' : ' + e.getStackTraceString() );
responseBodyParams = new Map{
'success' => false,
'error' => e.getMessage()
};
}
res.responseBody = Blob.valueOf( JSON.serializePretty( responseBodyParams ) );
res.statusCode = 200;//( (Boolean) responseBodyParams.get( 'success' ) ) ? 200 : 400;
// To avoid customers having to setup their own CORS Whitelist then
// I whitelist their VF domain for them on the fly in the http response.
// https://github.com/douglascayers/sfdx-lightning-api-component-component#access-denied-or-no-access-control-allow-origin-header-is-present-on-the-requested-resource-origin-httpsyourinstancevisualforcecom-is-therefore-not-allowed-access
res.addHeader( 'Access-Control-Allow-Origin', req.headers.get( 'Origin' ) );
res.addHeader( 'Content-Type', 'application/json; charset=utf-8' );
System.debug( 'MA_EditConfigRestController.handlePost: response: ' + res );
System.debug( 'MA_EditConfigRestController.handlePost: responseBody: ' + res.responseBody.toString() );
}
/**
* This method serves as a translation layer between the REST API request and
* the actual implementation methods. Originally, the implementation methods
* for each operation were @AuraEnabled and called directly from Lightning components.
*
* To adapt those operations for use with the LC_API component then this class was
* introduced as a pure REST API endpoint for the same operations. However, since
* Apex REST services can only include a single @HttpGet, @HttpPost, etc. methods
* then I chose a single REST class and http method to handle all operations rather
* than creating a separate REST class for each operation. Thus, the need for this
* translation method.
*
* @param operation
* Which implementation method to call.
* These are the same names as the original AuraEnabled methods.
* @param requestBody
* Map of key=value parameters from the REST request.
* Method arguments will be pulled from these.
* @param responseBody
* Map of key=value parameters for the REST response.
* This method puts 'result' key into the map, or 'success=false' and 'error=...' entries if operation is not supported.
*
* Exceptions bubble up to calling method.
*/
private static void handleRequestOperation( String operation, Map requestBody, Map responseBody ) {
switch on ( operation ) {
// -----------------------------------------------------------------------------
when 'getObjectsWithInvocableActions' {
responseBody.put( 'result', getObjectsWithInvocableActions(
MA_MassActionUtils.REST_API_SERVICES_URL,
(String) requestBody.get( 'actionType' )
));
}
when 'getInvocableActions' {
responseBody.put( 'result', getInvocableActions(
MA_MassActionUtils.REST_API_SERVICES_URL,
(String) requestBody.get( 'actionType' ),
(String) requestBody.get( 'objectName' )
));
}
when 'getInvocableActionInputs' {
responseBody.put( 'result', getInvocableActionInputs(
MA_MassActionUtils.REST_API_SERVICES_URL,
(String) requestBody.get( 'actionType' ),
(String) requestBody.get( 'actionName' ),
(String) requestBody.get( 'objectName' )
));
}
// -----------------------------------------------------------------------------
when 'getReportFolders' {
responseBody.put( 'result', getReportFolders() );
}
when 'getReportsByFolder' {
responseBody.put( 'result', getReportsByFolder(
(ID) requestBody.get( 'folderId' )
));
}
when 'getReport' {
responseBody.put( 'result', getReport(
(ID) requestBody.get( 'recordId' )
));
}
when 'getReportColumns' {
responseBody.put( 'result', getReportColumns(
(String) requestBody.get( 'reportId' )
));
}
// -----------------------------------------------------------------------------
when 'getObjectNames' {
responseBody.put( 'result', getObjectNames() );
}
when 'getObjectNamesWithListViews' {
responseBody.put( 'result', getObjectNamesWithListViews() );
}
when 'getListViewsByObject' {
responseBody.put( 'result', getListViewsByObject(
(String) requestBody.get( 'objectName' )
));
}
when 'getListView' {
responseBody.put( 'result', getListView(
(ID) requestBody.get( 'recordId' )
));
}
when 'getListViewColumns' {
responseBody.put( 'result', getListViewColumns(
MA_MassActionUtils.REST_API_SERVICES_URL,
(ID) requestBody.get( 'listViewId' )
));
}
// -----------------------------------------------------------------------------
when 'getSoqlQueryResults' {
responseBody.put( 'result', getSoqlQueryResults(
MA_MassActionUtils.REST_API_SERVICES_URL,
(String) requestBody.get( 'query' ),
(Integer) requestBody.get( 'batchSize' )
));
}
when 'getSoqlQueryNextRecordsResults' {
responseBody.put( 'result', getSoqlQueryNextRecordsResults(
MA_MassActionUtils.REST_API_SERVICES_URL,
(String) requestBody.get( 'nextRecordsId' ),
(Integer) requestBody.get( 'batchSize' )
));
}
// -----------------------------------------------------------------------------
when 'getNamedCredentials' {
responseBody.put( 'result', getNamedCredentials() );
}
// -----------------------------------------------------------------------------
when 'getConfiguration' {
responseBody.put( 'result', getConfiguration(
(ID) requestBody.get( 'recordId' )
));
}
when 'getConfigurationObjectDescribe' {
responseBody.put( 'result', getConfigurationObjectDescribe() );
}
when 'saveConfiguration' {
responseBody.put( 'result', saveConfiguration(
JSON.serialize( requestBody.get( 'wrapperJson' ) ),
JSON.serialize( requestBody.get( 'fieldMappingsJson' ) )
));
}
// -----------------------------------------------------------------------------
when else {
responseBody.put( 'success', false );
responseBody.put( 'error', 'Unsupported operation value: ' + operation );
}
}
}
// -----------------------------------------------------------------------------
/**
* This method is primarily designed for showing list of objects for Email Alerts and Quick Actions.
* Rather than display user a list of all objects in their org that may or may not have actions setup
* we instead use the Actions REST API to know the objects (if any) that have actions configured for them.
* This has the benefit of reducing the unusable object options the user must sift through.
*
* @param baseURL
* The 'baseURL' parameter can either be a Named Credential (e.g. 'callout:YourNC'),
* or the org's My Domain URL without any path (e.g. 'https://yourdomain.my.salesforce.com').
* @param actionType
* Value from picklist Mass_Action_Configuration__c.Target_Type__c (e.g. 'QuickAction', 'EmailAlert')
*/
private static List> getObjectsWithInvocableActions( String baseURL, String actionType ) {
Map globalDescribeMap = Schema.getGlobalDescribe();
List wrappers = new List();
for ( String objectName : MA_MassActionUtils.getObjectsWithInvocableActions( baseURL, actionType ) ) {
if ( globalDescribeMap.containsKey( objectName ) ) {
DescribeSObjectResult objDescribe = globalDescribeMap.get( objectName ).getDescribe();
wrappers.add( new ObjectNameWrapper( objDescribe.getLabel(), objDescribe.getName() ) );
}
}
wrappers.sort();
List> options = new List>();
for ( ObjectNameWrapper wrapper : wrappers ) {
options.add( new Map{
'label' => String.format( '{0} ({1})', new String[] { wrapper.objectLabel, wrapper.objectName } ),
'value' => wrapper.objectName
});
}
return options;
}
/**
* Get list of actions that can be invoked.
* Used when user is configuring the target action to invoke.
*
* @param baseURL
* The 'baseURL' parameter can either be a Named Credential (e.g. 'callout:YourNC'),
* or the org's My Domain URL without any path (e.g. 'https://yourdomain.my.salesforce.com').
* @param actionType
* Specific kind of actions to retrieve like Flows or Email Alerts.
* Value should match API value of Mass_Action_Configuration__c.Target_Type__c picklist entry.
* @param objectName
* Only required for certain action types like Quick Actions or Email Alerts.
* In the REST API, some actions are object specific and this indicates for which object to return their actions.
*/
private static List> getInvocableActions( String baseURL, String actionType, String objectName ) {
List> options = new List>();
for ( Map action : MA_MassActionUtils.getInvocableActions( baseURL, actionType, objectName ) ) {
options.add( new Map{
'label' => action.get( 'label' ),
'value' => action.get( 'name' )
});
}
return options;
}
/**
* Get list of action inputs.
* Used when user is configuring the target action to invoke.
*
* @param baseURL
* The 'baseURL' parameter can either be a Named Credential (e.g. 'callout:YourNC'),
* or the org's My Domain URL without any path (e.g. 'https://yourdomain.my.salesforce.com').
* @param actionType
* Specific kind of action like Flows or Email Alerts.
* Value should match API value of Mass_Action_Configuration__c.Target_Type__c picklist entry.
* @param actionName
* Specific action name whose inputs to retrieve like the Flow API name or Quick Action API name.
* @param objectName
* Only required for certain action types like Quick Actions or Email Alerts.
* In the REST API, some actions are object specific and this indicates for which object to return their actions.
*/
private static List> getInvocableActionInputs( String baseURL, String actionType, String actionName, String objectName ) {
List> options = new List>();
if ( actionType == 'Workflow' ) {
options.add( new Map{
'label' => 'Record ID',
'name' => 'ContextId',
'dataType' => 'ID',
'required' => true
});
} else {
for ( Map input : MA_MassActionUtils.getInvocableActionInputs( baseURL, actionType, actionName, objectName ) ) {
options.add( new Map{
'label' => input.get( 'label' ),
'name' => input.get( 'name' ),
'dataType' => String.valueOf( input.get( 'type' ) ).toUpperCase(),
'required' => Boolean.valueOf( input.get( 'required' ) ),
'description' => String.valueOf( input.get( 'description' ) )
});
}
}
return options;
}
// -----------------------------------------------------------------------------
private static List> getReportFolders() {
List> options = new List>();
for ( Folder folder : [ SELECT id, name FROM Folder WHERE type = 'Report' AND developerName != null ORDER BY name ] ) {
options.add( new Map{
'label' => folder.name,
'value' => String.valueOf( folder.id ).left( 15 )
});
}
return options;
}
private static List> getReportsByFolder( ID folderId ) {
List> options = new List>();
for ( Report record : [ SELECT id, name FROM Report WHERE ownerId = :folderId AND format = 'Tabular' ORDER BY name ] ) {
options.add( new Map{
'label' => record.name,
'value' => String.valueOf( record.id ).left( 15 )
});
}
return options;
}
private static Report getReport( ID recordId ) {
Report rpt = null;
for ( Report record : [ SELECT id, name, ownerId, owner.name, folderName FROM Report WHERE id = :recordId LIMIT 1 ] ) {
rpt = record;
}
return rpt;
}
private static List> getReportColumns( ID reportId ) {
List> options = new List>();
if ( String.isNotBlank( reportId ) ) {
Reports.ReportExtendedMetadata metadata = Reports.ReportManager.describeReport( reportId ).getReportExtendedMetadata();
Map reportColumnsMap = metadata.getDetailColumnInfo();
for ( Reports.DetailColumn column : reportColumnsMap.values() ) {
options.add( new Map{
'label' => column.getLabel(),
'value' => column.getName(),
'dataType' => String.valueOf( column.getDataType().name() ).toUpperCase()
});
}
}
return options;
}
// -----------------------------------------------------------------------------
private static List> getObjectNames() {
Map globalDescribeMap = Schema.getGlobalDescribe();
List wrappers = new List();
for ( String key : globalDescribeMap.keySet() ) {
DescribeSObjectResult objDescribe = globalDescribeMap.get( key ).getDescribe();
wrappers.add( new ObjectNameWrapper( objDescribe.getLabel(), objDescribe.getName() ) );
}
wrappers.sort();
List> options = new List>();
for ( ObjectNameWrapper wrapper : wrappers ) {
options.add( new Map{
'label' => String.format( '{0} ({1})', new String[] { wrapper.objectLabel, wrapper.objectName } ),
'value' => wrapper.objectName
});
}
return options;
}
private static List> getObjectNamesWithListViews() {
Set sobjectsWithListViews = new Set();
for ( AggregateResult result : [
SELECT SObjectType
FROM ListView
WHERE IsSoqlCompatible = true AND SObjectType != null
GROUP BY SObjectType
ORDER BY SObjectType ASC
LIMIT 2000
]) {
// lowercase the object names to match keys in the global describe map
// because the Set method `contains` is case-sensitive
sobjectsWithListViews.add( ( (String) result.get( 'SObjectType' ) ).toLowerCase() );
}
Map globalDescribeMap = Schema.getGlobalDescribe();
List wrappers = new List();
for ( String key : globalDescribeMap.keySet() ) {
if ( sobjectsWithListViews.contains( key ) ) {
DescribeSObjectResult objDescribe = globalDescribeMap.get( key ).getDescribe();
wrappers.add( new ObjectNameWrapper( objDescribe.getLabel(), objDescribe.getName() ) );
}
}
wrappers.sort();
List> options = new List>();
for ( ObjectNameWrapper wrapper : wrappers ) {
options.add( new Map{
'label' => String.format( '{0} ({1})', new String[] { wrapper.objectLabel, wrapper.objectName } ),
'value' => wrapper.objectName
});
}
return options;
}
private static List> getListViewsByObject( String objectName ) {
List> options = new List>();
for ( ListView record : [ SELECT id, name FROM ListView WHERE sobjectType = :objectName AND IsSoqlCompatible = true ORDER BY name ] ) {
options.add( new Map{
'label' => record.name,
'value' => String.valueOf( record.id ).substring( 0, 15 )
});
}
return options;
}
private static ListView getListView( ID recordId ) {
ListView lv = null;
for ( ListView record : [ SELECT id, name, sobjectType FROM ListView WHERE id = :recordId LIMIT 1 ] ) {
lv = record;
}
return lv;
}
/**
* The 'baseURL' parameter can either be a Named Credential (e.g. 'callout:YourNC'),
* or the org's My Domain URL without any path (e.g. 'https://yourdomain.my.salesforce.com').
*/
private static List> getListViewColumns( String baseURL, ID listViewId ) {
List> options = new List>();
if ( String.isNotBlank( listViewId ) ) {
MA_ListViewDescribeResult describeResult = MA_MassActionUtils.describeListView( baseURL, listViewId );
for ( Map column : describeResult.columns ) {
options.add( new Map{
'label' => column.get( 'label' ),
'value' => column.get( 'fieldNameOrPath' ),
'dataType' => String.valueOf( column.get( 'type' ) ).toUpperCase()
});
}
}
return options;
}
// -----------------------------------------------------------------------------
/**
* The 'baseURL' parameter can either be a Named Credential (e.g. 'callout:YourNC'),
* or the org's My Domain URL without any path (e.g. 'https://yourdomain.my.salesforce.com').
*/
private static MA_SoqlQueryExecuteResult getSoqlQueryResults( String baseURL, String query, Integer batchSize ) {
return MA_MassActionUtils.executeSoqlQuery( baseURL, query, batchSize );
}
/**
* The 'baseURL' parameter can either be a Named Credential (e.g. 'callout:YourNC'),
* or the org's My Domain URL without any path (e.g. 'https://yourdomain.my.salesforce.com').
*/
private static MA_SoqlQueryExecuteResult getSoqlQueryNextRecordsResults( String baseURL, String nextRecordsId, Integer batchSize ) {
return MA_MassActionUtils.executeSoqlQueryNextRecords( baseURL, nextRecordsId, batchSize );
}
// -----------------------------------------------------------------------------
private static List> getNamedCredentials() {
List> options = new List>();
// for production use, filter out our test named credential
String whereClause = ' WHERE developerName != \'Mass_Action_Test_Named_Credential\' ';
// for code coverage, this is a separate if statement rather than if/else
// because with if/else one of the paths would never get tested =/
if ( Test.isRunningTest() ) {
whereClause = ' WHERE developerName = \'Mass_Action_Test_Named_Credential\' ';
}
String query =
' SELECT ' +
' id, masterLabel, developerName ' +
' FROM ' +
' NamedCredential ' +
whereClause
;
for ( NamedCredential credential : Database.query( query ) ) {
options.add( new Map{
'label' => credential.masterLabel,
'value' => credential.developerName
});
}
return options;
}
// -----------------------------------------------------------------------------
private static MA_MassActionConfigWrapper getConfiguration( ID recordId ) {
// return json without org's namespace so our code doesn't have to worry about it
return new MA_MassActionConfigWrapper( MA_MassActionUtils.getConfiguration( recordId ) );
}
private static Map getConfigurationObjectDescribe() {
String objectName = MA_NamespaceUtils.NAMESPACE_API + 'Mass_Action_Configuration__c';
// https://salesforce.stackexchange.com/questions/218982/why-is-schema-describesobjectstypes-slower-than-schema-getglobaldescribe
DescribeSObjectResult objectDescribe = ( (SObject) Type.forName( objectName ).newInstance() ).getSObjectType().getDescribe();
Map describeMap = new Map{
'name' => objectDescribe.getName(),
'localName' => objectDescribe.getLocalName(),
'label' => objectDescribe.getLabel(),
'labelPlural' => objectDescribe.getLabelPlural(),
'keyPrefix' => objectDescribe.getKeyPrefix(),
'fields' => getFieldDescribeMaps( objectDescribe.fields.getMap() )
};
return describeMap;
}
/**
* This method accepts the JSON serialization of the configuration and field mappings
* because when defining the method params as the custom class type was getting internal server error.
* I think possibly related to general serialization bugs with Lightning:
* https://developer.salesforce.com/forums/?id=906F00000005GiwIAE
* https://blog.texei.com/lightning-components-auraenabled-method-parameters-whats-working-and-what-s-not-83c351356104
*/
private static Map saveConfiguration( String wrapperJson, String fieldMappingsJson ) {
SavePoint sp = Database.setSavepoint();
try {
return MA_MassActionUtils.saveConfiguration( wrapperJson, fieldMappingsJson );
} catch ( Exception e ) {
Database.rollback( sp );
System.debug( LoggingLevel.ERROR, 'MA_EditConfigRestController.saveConfiguration: ' + e.getMessage() + ' : ' + e.getStackTraceString() );
throw e;
}
}
// -----------------------------------------------------------------------------
private static Map> getFieldDescribeMaps( Map fieldsMap ) {
Map> describeMaps = new Map>();
for ( String fieldName : fieldsMap.keySet() ) {
DescribeFieldResult fieldDescribe = fieldsMap.get( fieldName ).getDescribe();
// using local name to stay namespace agnostic wherever this code runs
describeMaps.put( fieldDescribe.getLocalName(), new Map{
'name' => fieldDescribe.getName(),
'localName' => fieldDescribe.getLocalName(),
'label' => fieldDescribe.getLabel(),
'helpText' => fieldDescribe.getInlineHelpText(),
'byteLength' => fieldDescribe.getByteLength(),
'length' => fieldDescribe.getLength(),
'type' => fieldDescribe.getType(),
'picklistValues' => getPicklistValuesMaps( fieldDescribe.getPicklistValues() ),
'isAccessible' => fieldDescribe.isAccessible(),
'isCreateable' => fieldDescribe.isCreateable(),
'isUpdateable' => fieldDescribe.isUpdateable()
});
}
return describeMaps;
}
private static List> getPicklistValuesMaps( List picklistEntries ) {
List> options = new List>();
for ( PicklistEntry pke : picklistEntries ) {
if ( pke.isActive() ) {
options.add( new Map{
'label' => pke.getLabel(),
'value' => pke.getValue()
});
}
}
return options;
}
private class ObjectNameWrapper implements Comparable {
private String objectLabel { get; set; }
private String objectName { get; set; }
public ObjectNameWrapper( String objectLabel, String objectName ) {
this.objectLabel = objectLabel;
this.objectName = objectName;
}
public Integer compareTo( Object other ) {
ObjectNameWrapper thisWrapper = this;
ObjectNameWrapper thatWrapper = (ObjectNameWrapper) other;
Integer compareResult = ( thisWrapper.objectLabel.compareTo( thatWrapper.objectLabel ) );
if ( compareResult == 0 ) {
compareResult = ( thisWrapper.objectName.compareTo( thatWrapper.objectName ) );
}
return compareResult;
}
}
}
/*
BSD 3-Clause License
Copyright (c) 2017-2023, Doug Ayers, douglascayers.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
================================================
FILE: force-app/main/default/classes/MA_EditConfigRestController.cls-meta.xml
================================================
54.0
Active
================================================
FILE: force-app/main/default/classes/MA_EditConfigRestControllerTest.cls
================================================
/**
* Author: Doug Ayers
* Website: https://douglascayers.com
* GitHub: https://github.com/sfdx-mass-action-scheduler/sfdx-mass-action-scheduler
* License: BSD 3-Clause License
*/
@IsTest
private class MA_EditConfigRestControllerTest {
@IsTest
static void test_getObjectsWithInvocableActions_Flow() {
String operation = 'getObjectsWithInvocableActions';
Map params = new Map{
'actionType' => 'Flow'
};
Test.startTest();
Map responseBodyMap = test_handlePost( operation, params );
Test.stopTest();
List