Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The Availability Object in Maica is used to define the available working hours for a Resource, i.e. when they are able to work.
The table below provides a comprehensive overview of all fields and relationships for the Availability object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Availability Schema.
The Agreement object in Maica represents the specific Products (Support Items) to be delivered as part of the Service Agreement
The table below provides a comprehensive overview of all fields and relationships for the Agreement Item object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Agreement Item Schema.
The list below outlines the Validation Rules applied to the Agreement Item Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
Ensures that the start date cannot be after the end date of any Agreement Item.
Rule Name
VAL_AGREEMENT_ITEM_0001
Error Message
VAL_0001: Start Date cannot be after End Date.
Error Location
Top of Page
The table below outlines the Trigger Handlers applied to the Agreement Item Object in Maica and their Load Order
.
1
2
2
3
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to manage the support items of agreement items in Maica.
Load Order
1
Label
AgreementItemSupportItem_MDTM
This trigger is designed to manage the estimated expenditure of agreement items in Maica.
Load Order
2
Label
AgreementItemEstExpenditure_MDTM
This trigger is designed to manage the rollup of expenditures for agreement items in Maica.
Load Order
2
Label
AgreementItemRollupExpenditure_MDTM
This trigger is designed to manage the total allocation of agreement items in Maica.
Load Order
3
Label
AgreementItemTotalAllocated_MDTM
Learn about the Data Objects used in Maica.
This section contains a list of Maica's primary Data Objects. Each Data Object has its own page which contains information on the following:
The information below is generic and applies to each object.
On each object page you will find a table that provides a comprehensive overview of all Fields and Relationships for the relevant object in Maica. It includes all Fields related to the object, detailing their names, labels and formulas. Additionally, it outlines the various relationships this object has with other objects, such as lookup and master-detail relationships.
On each object page, there will be a list that outlines the Validation Rules applied to the relevant object in Maica. Within each rule, you will find the Rule Name, Error Message, Error Location and Error Condition Formula.
You can deactivate the Validation Rules if they interfere with your business processes, but be mindful that this may affect Maica processes and/or result in data issues. We do not recommend deactivating the Validation Rules.
On each object page, you will find a list of associated Flows that are relevant to that particular object in Maica. Within each Flow, you will find a Summary of the Flow, the API Name, Label and Type of Flow. In addition, you will find a technical description and breakdown of how the Flow is working in Maica.
You can clone and alter Flows as your business processes need; however, please ensure that any changes are thoroughly tested before deployment. Flow modifications can have an impact on Maica processes and/or cause data difficulties.
You can deactivate Flows if they interfere with your business processes, but be mindful that this may affect Maica processes and/or result in data issues. We do not recommend deactivating the Validation Rules.
On each object page, you will find a list of associated Trigger Handlers that are relevant to that particular object in Maica. Within each Trigger, you will find a Summary of the Trigger, the Label and Load Order. In addition, you will find a technical description and breakdown of how the Execution. Logic & Outcome of the Trigger in Maica.
TO BE FILLED
The Checklist object in Maica is used to manage task lists for users, either before, during, or after shifts and appointments including the ability to include external links.
The table below provides a comprehensive overview of all fields and relationships for the Checklist object in Maica. Please refer to the table below for detailed information.
The list below outlines the Validation Rules applied to the Checklist Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
Ensures that the Checklist Start Date cannot be after the End Date.
The Booking Item object in Maica represents funding within an active Service Booking for a given NDIS Category.
The Client Note object in Maica represent Notes that are taken on behalf of the Participant/Client.
In Maica, the Connection object is used to track and manage relationships and connections between individuals (Contacts), including the type or nature of the relationship.
The table below provides a comprehensive overview of all fields and relationships for the Connection object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Connection Schema.
The list below outlines the Validation Rules applied to the Connection Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
This rule is to ensure that the Connection Related Contact has an Email address when Invoice Recipient and/or Statement Recipient = TRUE
This object in Maica represents the specific Budget Items or Funded Supports included in a Participant's NDIS Funding or Home Care Package.
Depending on your Maica package, this Data Object may be called Plan Budget
in your organisation
The table below provides a comprehensive overview of all fields and relationships for the Funding Item object in Maica. Please refer to the table below for detailed information.
The list below outlines the Flows applied to the Funding Item Object in Maica.
Please refer to the list below for more detailed information on each Flow.
Is Active
ValueThis flow is designed to update the Is Active
field value for a Funding Item record based on its Effective Date and End Date.
Updates the Is Active
field for a Funding Item record based on its Effective Date and End Date.
Ensures the Is Active
field reflects the current status of the Funding Item according to the specified dates.
This flow is designed to set attribute values from the related Product before inserting a Funding Item record.
This flow sets the attribute values for a Funding Item record from the related Product before the record is inserted or updated.
It ensures that the Funding Item's Unit of Measurement and Support Purpose Picklist fields are accurately populated.
Represents the specific details of a Participant's funding, i.e. NDIS Funding or Home Care Package.
Depending on your Maica package, this Data Object may be called Plan
in your organisation
The table below provides a comprehensive overview of all fields and relationships for the Funding object in Maica. Please refer to the table below for detailed information.
The list below outlines the Validation Rules applied to the Funding Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
This rule ensures that the End Date is after the Start Date.
Ensures that the Claim Period is provided when the Funding Source is Home Care Package.
The list below outlines the Flows applied to the Funding Object in Maica.
Please refer to the list below for more detailed information on each Flow.
This flow is designed to send an email notification when the start or end date of a Funding record changes.
This flow sends an email notification when the start or end date of a funding record changes.
It determines the recipient based on the email settings.
Sends the email using a specified template.
Triggers on the update of a funding record.
Runs asynchronously after the record is saved.
The list below outlines the Trigger Handlers applied to the Funding Object in Maica.
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to manage the adjustment of recurring invoices for plans in Maica.
A Delivery Activity in Maica captures services delivered to a participant/client including the support item to bill, duration, and date information.
The table below provides a comprehensive overview of all fields and relationships for the Delivery Activity object in Maica. Please refer to the table below for detailed information.
The list below outlines the Trigger Handlers applied to the Delivery Activity Object in Maica.
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to manage the association of delivery activities with appointments in Maica. The outcome is accurate and reliable data for all delivery activities and their associated appointments, ensuring proper management and reporting.
This trigger is designed to manage the invoicing for delivery activities in Maica. Ensures correct generation of invoices for delivery activities, maintaining accurate invoicing data.
The Contact object in Maica is used to manage the details of individuals associated with service delivery, including clients, guardians, and carers.
The table below provides a comprehensive overview of all fields and relationships for the Contact object in Maica. Please refer to the table below for detailed information.
The list below outlines the Validation Rules applied to the Contact Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
Ensures that the NDIS Number is 9 digits.
The list below outlines the Flows applied to the Contact Object in Maica.
Please refer to the list below for more detailed information on each Flow.
This Salesforce Autolaunched Flow is designed to geocode addresses for participants, updating their latitude and longitude based on the provided address information.
This flow facilitates the geocoding of participant addresses by:
Detecting changes to participant records and ensuring address fields are populated.
Calling an Apex action to geocode the address.
Updating the participant record with the geocoded latitude and longitude.
The list below outlines the Trigger Handlers applied to the Contact Object in Maica.
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to manage the geocoding of participants in Maica.
This trigger is designed to manage the updating of connection types for contacts in Maica.
The Appointment object in Maica is used to manage the details of Appointment records in Maica Client Care, such as Start Date/End Date/Resource(s) etc
The table below provides a comprehensive overview of all fields and relationships for the Appointment object in Maica. Please refer to the table below for detailed information.
The list below outlines the Validation Rules applied to the Appointment Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
Ensures that the End Time cannot be set prior to the Start Time.
The checkout date/time must be greater than the checkin date/time.
If the cancellation reason is set, then a cancellation date must be supplied.
The list below outlines the Flows applied to the Appointment Object in Maica.
Please refer to the list below for more detailed information on each Flow.
This flow is designed to geocode the address of an appointment upon creation or update of the appointment record.
This flow geocodes the address of an appointment and updates the appointment record with the latitude and longitude by:
Triggering on the creation or update of an appointment record.
Geocoding the address fields using an Apex action.
Checking for errors in the geocoding process.
Updating the appointment record with the geocoded latitude and longitude if no errors occur.
The table below outlines the Trigger Handlers applied to the Appointment Object in Maica and their Load Order
.
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to manage the timesheets for appointments in Maica. The outcome is accurate and reliable timesheet data for all appointments, ensuring proper time management and reporting.
This trigger is designed to manage the status updates for appointments in Maica. The outcome is accurate and reliable status tracking for all appointments, ensuring proper management and communication.
This trigger is designed to manage the rollup of participants for appointments in Maica.
This trigger is designed to manage the geocoding of appointments in Maica, maintaining accurate geographical data.
This trigger is designed to manage the delivery activities for appointments in Maica.
Click to view and download the complete Checklist Schema.
Click to view and download the complete Booking Item Schema.
Click to view and download the complete Client Note Schema.
Click to view and download the complete Funding Item Schema.
Click to view and download the complete Funding Schema.
Click to view and download the complete Delivery Activity Schema.
Click to view and download the complete Contact Schema.
Click to view and download the complete Appointment Schema.
Rule Name
VAL_CHECKLIST_0001
Error Message
VAL_0001: The Start Date cannot be after the End Date.
Error Location
Start Date
Rule Name
VAL_CONNECTION_0001
Error Message
VAL_0001: The Related Contact must have an Email address when Invoice Recipient and/or Statement Recipient = TRUE
Error Location
Top of Page
Flow Label
Maica - Funding Item - Update Is Active Value
API Name
maica__Maica_Funding_Item_Update_Is_Active_Value
Type
Autolaunched Flow
Rule Name
VAL_FUNDING_0001
Error Message
VAL_0001: The End Date must be after the Start Date.
Error Location
End Date
Rule Name
VAL_FUNDING_0002
Error Message
VAL_0002: Please ensure that the Claim Period is provided when the Funding Source is HCP.
Error Location
Top of Page
Flow Label
Maica - Funding Date Change Email Notification Flow
API Name
maica__Funding_Date_Change_Email_Notification_Flow
Type
Autolaunched Flow
Load Order
1
Label
FundingAdjustRecurringInvoices_MDTM
Load Order
1
Label
DeliveryActivityAppointments_MDTM
Load Order
2
Label
DeliveryActivityInvoices_MDTM
Rule Name
VAL_CONTACT_0001
Error Message
VAL_0001: If provided, the NDIS Number must be 9 characters in length.
Error Location
Top of Page
Flow Label
Maica - Participant Geocoding
API Name
maica__Maica_Participant_Geocoding
Type
Autolaunched Flow
Load Order
1
Label
ParticipantGeocode_MDTM
Load Order
2
Label
ContactUpdateConnectionsType_MDTM
Rule Name
VAL_APPOINTMENT_0001
Error Message
VAL_0001: The End Time cannot be prior to the Start Time.
Error Location
Top of Page
Rule Name
VAL_APPOINTMENT_0002
Error Message
VAL_0002: The checkout date/time must be greater than the checkin date/time.
Error Location
Top of Page
Rule Name
VAL_APPOINTMENT_0003
Error Message
VAL_0003: A Cancellation Date must be entered if a Cancellation Reason is selected.
Error Location
Top of Page
Flow Label
Maica - Appointment Geocoding
API Name
maica__Maica_Appointment_Geocoding
Type
Autolaunched Flow
1
1
2
4
5
Load Order
1
Label
AppointmentTimeSheet_MDTM
Load Order
1
Label
AppointmentStatus_MDTM
Load Order
2
Label
AppointmentRollupParticipants_MDTM
Load Order
4
Label
AppointmentGeocode_MDTM
Load Order
5
Label
AppointmentDeliveryActivities_MDTM
The Invoice Line Item object in Maica represents the specific Item level detail associated with an Invoice.
The table below provides a comprehensive overview of all fields and relationships for the Invoice Line Item object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Invoice Schema.
The list below outlines the Validation Rules applied to the Invoice Line Item Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
This rule makes sure the Support Item is mandatory.
Rule Name
VAL_INVOICE_LINE_ITEM_0001
Error Message
VAL_0001: The Support Item is mandatory.
Error Location
Support Item
The list below outlines the Flows applied to the Invoice Line Item Object in Maica.
Please refer to the list below for more detailed information on each Flow.
This flow evaluates and updates the status of an invoice line item.
Flow Label
Maica - Invoice Line Item Status Management
API Name
maica__Invoice_Line_Item_Status_Management
Type
Autolaunched Flow
This flow ensures that the invoice line item status is accurately updated based on the calculated values and specified conditions.
Starts on invoice line item creation or update.
Evaluates the status based on various conditions and calculations.
Assigns the appropriate status (Entered, Claimed, Fully Paid, Partially Paid, Not Paid).
The list below outlines the Trigger Handlers applied to the Invoice Line Item Object in Maica.
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to manage the rollup of expenditures for invoice line items in Maica.
Load Order
1
Label
InvoiceLineRollupExpenditure_MDTM
This trigger is designed to manage the booking items for invoice line items in Maica.
Load Order
2
Label
InvoiceLineBookingItem_MDTM
The Location object in Maica represents a Location where Services are delivered, i.e. office or home address
The table below provides a comprehensive overview of all fields and relationships for the Location object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Location Schema.
The list below outlines the Flows applied to the Location Object in Maica.
Please refer to the list below for more detailed information on each Flow.
This flow is designed to geocode a location's address upon creation or update of the location record.
Flow Label
Maica - Location Geocoding
API Name
maica__Maica_Location_Geocoding
Type
Autolaunched Flow
This flow geocodes the address of a location and updates the location record with the latitude and longitude by:
Triggering on the creation or update of a location record.
Geocoding the address fields using an Apex action.
Checking for errors in the geocoding process.
Updating the location record with the geocoded latitude and longitude if no errors occur.
The list below outlines the Trigger Handlers applied to the Location Object in Maica.
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to manage the geocoding of locations in Maica.
Load Order
1
Label
LocationGeocode_MDTM
The Preference object in Maica captures the Client/Participant preferences when receiving your services.
The table below provides a comprehensive overview of all fields and relationships for the Preference object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Payment Request Schema.
This object in Maica manages the Log level details of automated processes supporting the Maica package.
The table below provides a comprehensive overview of all fields and relationships for the Log object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Log Schema.
This object in Maica represents the details of a Payment Request claimed from the NDIA - for Clients with an Agency Managed Service Agreement.
The table below provides a comprehensive overview of all fields and relationships for the Payment Request object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Payment Request Schema.
The list below outlines the Validation Rules applied to the Payment Request Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
Paid
When the Payment Request Status is updated to Paid, the Status on the record cannot be changed.
Rule Name
x01_Paid_PR_Cannot_Be_Changed
Error Message
You cannot modify a Paid Payment Request. Payment Request Error x01.
Error Location
Top of Page
The list below outlines the Trigger Handlers applied to the Payment Request Object in Maica.
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to initialise the claim reference for payment requests in Maica.
Load Order
1
Label
PaymentRequestInitClaimReference_MDTM
An Invoice represents the financial component following an instance of Service Delivery.
The table below provides a comprehensive overview of all fields and relationships for the Invoice object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Invoice Schema.
The list below outlines the Validation Rules applied to the Invoice Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
This rule ensures that the Funding Type
is populated when the Invoice is saved.
Rule Name
VAL_INVOICE_0001
Error Message
VAL_0001: Please ensure that the Funding Type is provided.
Error Location
Funding Type
This rule ensures that the Invoice Total Amount
cannot be changed when a corresponding Stripe Invoice exists.
Rule Name
Restrict_Invoice_Amount_Change
Error Message
The Total Amount cannot be be updated as there is a corresponding Stripe Invoice
Error Location
Top of Page
The list below outlines the Flows applied to the Invoice Object in Maica.
Please refer to the list below for more detailed information on each Flow.
This flow is designed to cancel an invoice by updating its status to "Cancelled."
Flow Label
Maica - Cancel Invoice
API Name
maica__Maica_Cancel_Invoice
Type
Screen Flow
This flow is designed to cancel an invoice by updating its status to "Cancelled".
Retrieves an invoice.
Checks the invoice status.
Allows the user to confirm cancellation.
Updates the invoice status to "Cancelled".
Notifies the user of successful cancellation.
This flow evaluates and updates the status of an invoice based on its payment details and other related conditions.
Flow Label
Maica - Invoice Status Management
API Name
maica__Invoice_Status_Management
Type
Autolaunched Flow
This flow ensures that the invoice status is accurately updated based on the payment details and other conditions.
Starts on invoice creation or update.
Evaluates the status based on various conditions.
Assigns the appropriate status (Cancelled, Not Paid, Partially Paid, Fully Paid).
The table below outlines the Trigger Handlers applied to the Invoice Object in Maica and their Load Order
.
1
1
1
2
10
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to manage the claim schedule for invoices in Maica.
Load Order
1
Label
InvoiceManageClaimSchedule_MDTM
This trigger is designed to manage the next scheduled date for invoices in Maica. This ensures correct calculation of the next scheduled date for invoices, maintaining accurate scheduling data.
Load Order
1
Label
InvoiceNextScheduledDate_MDTM
This trigger is designed to manage the default values for invoices in Maica.
Load Order
1
Label
InvoiceDefaults_MDTM
This trigger is designed to manage the rollup of expenditures for invoices in Maica.
Load Order
2
Label
InvoiceRollupExpenditure_MDTM
This trigger is designed to manage the claim process for invoices in Maica. This ensures correct generation of claims for invoices, maintaining accurate claim data.
Load Order
10
Label
InvoiceClaim_MDTM
Price List Entry records connect your products or services with specific Price Lists. This linkage is essential for defining the price of a product or service within a particular Price List.
The Price List object in Maica manages pricing information for your products or services.
The table below provides a comprehensive overview of all fields and relationships for the Price List object in Maica. Please refer to the table below for detailed information.
The list below outlines the Validation Rules applied to the Price List Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
This rule ensures that the Price List End Date is not before the Start Date.
This rule ensures that the Price List Start Date is not after the End Date.
This object represents a period where the Service Agreement will be placed in an On Leave Status.
The table below provides a comprehensive overview of all fields and relationships for the Service Agreement Leave object in Maica. Please refer to the table below for detailed information.
The list below outlines the Flows applied to the Service Agreement Leave Object in Maica.
Please refer to the list below for more detailed information on each Flow.
This scheduled flow handles updates to Service Agreements and Consecutive Leave Counter based on Service Agreement Leave Status updates.
This flow ensures that service agreements and their consecutive leave counters are accurately updated based on the leave status.
Scheduled to run daily.
Evaluates the leave status and updates the service agreement accordingly.
Handles alternate active leave records and updates leave completion status.
This record-triggered flow handles updates to Service Agreements and the Consecutive Leave Counter when the Service Agreement Leave status is updated.
This flow ensures that service agreements and their consecutive leave counters are accurately updated based on the leave status.
Starts on the creation or update of a Service Agreement Leave record.
Evaluates the leave status and updates the service agreement accordingly.
Handles alternate active leave records and updates leave completion status.
The list below outlines the Trigger Handlers applied to the Service Agreement Leave Object in Maica.
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to manage the overlap of leave periods in service agreements within Maica.
This trigger is designed to manage the appointments related to leave periods in service agreements within Maica.
The Resource object in Maica is used to manage the details of your Service Delivery Staff, i.e. Care Workers or Coordinators.
The table below provides a comprehensive overview of all fields and relationships for the Resource object in Maica. Please refer to the table below for detailed information.
The list below outlines the Validation Rules applied to the Resource Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
Ensures that the End Date cannot be before the Start Date.
This validation rule ensures key Resource attributes are populated when the Resource Type is Resource. These attributes are:
Employment Type
Weekly Hours Limit
Daily Hours Limit
Weekly Hours Minimum
Ensures that the Weekly Hours Minimum is less than the Weekly Hours Limit.
Ensures the User lookup is populated when Resource Type = Resource.
The list below outlines the Flows applied to the Resource Object in Maica.
Please refer to the list below for more detailed information on each Flow.
This Salesforce Autolaunched Flow is designed to geocode addresses for resources, updating their latitude and longitude based on the provided address information.
This flow facilitates the geocoding of resource addresses by:
Detecting changes to resource records and ensuring address fields are populated.
Calling an Apex action to geocode the address.
Updating the resource record with the geocoded latitude and longitude.
The list below outlines the Trigger Handlers applied to the Resources Object in Maica.
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to manage the deactivation of resources in Maica.
This trigger is designed to manage the geocoding of resources in Maica.
The Resource Participant object in Maica captures the Participants a particular Resource looks after.
The table below provides a comprehensive overview of all fields and relationships for the Resource Participant object in Maica. Please refer to the table below for detailed information.
The list below outlines the Flows applied to the Resource Participant Object in Maica.
Please refer to the list below for more detailed information on each Flow.
This flow updates the Resource Participant
record based on its Start Date
and End Date
.
This flow ensures that the Resource Participant
record is updated based on its Start Date
and End Date
.
Starts on Resource Participant
record creation or update.
Updates the record on the Start Date
.
Updates the record 1 day after the End Date
.
The list below outlines the Trigger Handlers applied to the Service Agreement Object in Maica.
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to manage the manual sharing of resource participants in Maica.
The Service Agreement object in Maica represents the details of a Service Agreement signed between your organisation and a Client.
The table below provides a comprehensive overview of all fields and relationships for the Service Agreement object in Maica. Please refer to the table below for detailed information.
The list below outlines the Validation Rules applied to the Service Agreement Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
Ensures that the Funding Administrator lookup is populated when the Funding Source is any value other than Self-Funded. Not required for Self and Agency Managed in the NDIS.
Ensures that the Agreement's Start Date cannot be after the End Date.
Ensures the Start and End Date are provided when the Funding Source is NDIS.
Ensures that the Price List is populated.
Ensures that the associated Price List Start Date is less than or equal to the Service Agreement Start Date and the Price List End Date is greater than the Service Agreement Start Date.
The list below outlines the Flows applied to the Service Agreement Object in Maica.
Please refer to the list below for more detailed information on each Flow.
This flow is designed to manage the cancellation of a service agreement. It ensures that service agreements can only be canceled if they are active, providing confirmation screens for user actions and handling any errors that may occur during the process.
This flow facilitates the cancellation process for service agreements by following these steps:
Checking the status of the service agreement.
Confirming the cancellation with the user.
Setting the service agreement as cancelled.
Updating the service agreement record.
Displaying appropriate messages based on the outcome of the process.
This flow is designed to handle the discharge process for Service Agreements. It ensures a smooth and efficient discharge process with appropriate error handling and user guidance.
This flow facilitates the discharge process for Service Agreements by following these steps:
Displaying instructions for discharging a Service Agreement.
Calling a subflow to generate a discharge statement.
Checking for any fault messages from the subflow.
Updating the Service Agreement record with discharge details.
Displaying success or error messages based on the outcome of the process.
This flow generates Statement for period of the claim to the discharge date, then generates the Discharge Statement record.
This flow ensures that a discharge statement is accurately generated based on the service agreement and its related monthly statements.
Starts on service agreement creation or update.
Retrieves and validates the service agreement.
Assigns statement period dates and calls a subflow to generate service agreement statements.
Loops through monthly statements and updates discharge statement counters.
Creates the discharge statement and updates the service agreement.
Fee Invoicing Step 1
This flow is designed to schedule the initialisation of the invoicing process for service agreements, setting their status to "Initialised" to trigger the fee invoicing flow. By automating this process, the flow ensures that service agreements are ready for fee invoicing without manual intervention.
This flow ensures that the invoicing process for service agreements is initialised on a daily basis by:
Running the flow daily at a specified time.
Filtering service agreements based on their status and funding type.
Updating the invoicing flow status to "Initialised" to trigger the fee invoicing flow.
Fee Invoicing Step 2
This flow is designed to trigger the generation of fee invoices and their line items for service agreements. It ensures a streamlined and automated process for generating fee invoices for service agreements, with appropriate error handling and logging mechanisms.
This flow facilitates the generation of invoices and line items for service agreement fees by:
Detecting changes to the invoicing flow status.
Retrieving the relevant service agreement record.
Triggering the Fee Invoice Generation Flow to create invoices and line items.
Updating the service agreement status to complete.
Fee Invoicing Step 3
This flow automates the process of generating fee invoice line items for service agreements. It ensures a streamlined and automated process for generating accurate fee invoices and their associated line items based on the service agreement details.
This flow facilitates the generation of fee invoice line items for service agreements by following these steps:
Starting the flow and retrieving the service agreement.
Retrieving the related plan and service agreement leave records.
Checking if the service agreement is on leave and handling accordingly.
Retrieving and validating the income-tested fee plan budget.
Assigning the income-tested fee rate and adding the budget to the collection.
Checking the type of leave and retrieving the corresponding billable plan budgets.
Validating the existence of billable and claimable plan budgets.
Calling the Invoice Invocable actions to create copayment and claim invoices.
Looping through the billable and claimable plan budgets to assign invoice line item values.
Creating the invoice line items.
Handling errors during the process.
The list below outlines the Trigger Handlers applied to the Service Agreement Object in Maica.
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to ensure that the correct price list is applied to service agreements in Maica.
This trigger is designed to ensure that the service agreement names are formatted correctly in Maica.
This trigger is designed to manage the validation of service agreements in Maica.
Click to view and download the complete Price List Entry Schema.
Click to view and download the complete Price List Schema.
Click to view and download the complete Service Agreement Leave Schema.
Click to view and download the complete Resource Schema.
Click to view and download the complete Resource Participant Schema.
Click to view and download the complete Service Agreement Schema.
Rule Name
VAL_PRICE_LIST_0001
Error Message
VAL_0001: The End Date cannot be before the Start Date.
Error Location
End Date
Rule Name
VAL_PRICE_LIST_0002
Error Message
VAL_0002: The Start Date cannot be after the End Date.
Error Location
Start Date
Flow Label
Maica - Service Agreement Leave - Scheduled Updates
API Name
maica__Maica_Service_Agreement_Leave_Scheduled_Updates
Type
Autolaunched Flow
Flow Label
Maica - Service Agreement Leave - Triggered Updates
API Name
maica__Maica_Service_Agreement_Leave_Triggered_Updates
Type
Autolaunched Flow
Load Order
1
Label
ServiceAgreementLeaveOverlap_MDTM
Load Order
1
Label
ServiceAgreementLeaveAppointments_MDTM
Rule Name
VAL_RESOURCE_0001
Error Message
VAL_0001: The End Date cannot be before the Start Date.
Error Location
Top of Page
Rule Name
VAL_RESOURCE_0002
Error Message
VAL_0002: When the Resource Type is Resource, the following fields are required: Employment Type, Weekly Hours Limit, Daily Hours Limit, Weekly Hours Minimum.
Error Location
Top of Page
Rule Name
VAL_RESOURCE_0003
Error Message
VAL_0003: Weekly Hours Minimum must be less than Weekly Hours Limit.
Error Location
Weekly Hours Minimum
Rule Name
VAL_RESOURCE_0004
Error Message
VAL_0004: A related User is required when Resource Type = Resource.
Error Location
User
Flow Label
Maica - Resource Geocoding
API Name
maica__Maica_Resource_Geocoding
Type
Autolaunched Flow
Load Order
1
Label
ResourceDeactivation_MDTM
Load Order
2
Label
ResourceGeocode_MDTM
Flow Label
Maica - Resource Participant Trigger
API Name
maica__Maica_Resource_Participant_Trigger
Type
Autolaunched Flow
Load Order
1
Label
ResourceParticipantManualShare_MDTM
Rule Name
VAL_SERVICE_AGREEMENT_0001
Error Message
VAL_0001: Please provide the Funding Administrator.
Error Location
Funding Administrator
Rule Name
VAL_SERVICE_AGREEMENT_0002
Error Message
VAL_0002: The Start Date cannot be after the End Date.
Error Location
Start Date
Rule Name
VAL_SERVICE_AGREEMENT_0003
Error Message
VAL_0003: As the Funding Source is NDIS, the Start and End Date are required.
Error Location
Top of Page
Rule Name
VAL_SERVICE_AGREEMENT_0004
Error Message
VAL_0004: Please associate a Price List.
Error Location
Price List
Rule Name
VAL_SERVICE_AGREEMENT_0005
Error Message
VAL_0005: The Price List Start Date must be less than or equal to the Service Agreement Start Date and the Price List End Date must be greater than the Service Agreement Start Date.
Error Location
Price List
Flow Label
Maica - Cancel Service Agreement
API Name
maica__Cancel_Service_Agreement
Type
Screen Flow
Flow Label
Maica - Discharge Service Agreement Screen Flow
API Name
maica__Maica_Discharge_Service_Agreement_Screen_Flow
Type
Screen Flow
Flow Label
Maica - Generate Discharge Statement
API Name
maica__Maica_Generate_Discharge_Statement
Type
Autolaunched
Flow Label
Maica - Service Agreement - Fee Invoicing Initialisation
API Name
maica___Service_Agreement_Fee_Invoicing_Initialisation
Type
Autolaunched
Flow Label
Maica - Service Agreement - Fee Invoice Trigger
API Name
maica__Maica_Service_Agreement_Fee_Invoice_Trigger
Type
Autolaunched
Flow Label
Maica - Service Agreement - Fee Invoice Generation (Autolaunch)
API Name
maica__Maica_Service_Agreement_Fee_Invoice_Generation_Autolaunch
Type
Autolaunched
Load Order
1
Label
ServiceAgreementPriceList_MDTM
Load Order
1
Label
ServiceAgreementNameFormatting_MDTM
Load Order
2
Label
ServiceAgreementValidation_MDTM
The Shift object in Maica represents an available period of work in which Jobs can be scheduled, rostered and delivered.
The table below provides a comprehensive overview of all fields and relationships for the Shift object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Shift Schema.
The list below outlines the Validation Rules applied to the Shift Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
Ensures that the Shift Start Date is before the Shift End Date
Rule Name
VAL_SHIFT_0001
Error Message
VAL_0001: The Shift Start must be before the Shift End.
Error Location
Shift Start
Represents the NIDS Support Category a Support Items or Service Booking may be associated with.
The table below provides a comprehensive overview of all fields and relationships for the Support Category object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Support Category Schema.
The list below outlines the Validation Rules applied to the Shift Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
Ensures that a Category Number and Support Purpose is provided when the Category Source is NDIS.
Rule Name
VAL_SUPPORT_CATEGORY_0001
Error Message
VAL_0001: Please ensure that Category Number and Support Purpose are provided when the Category Source is NDIS.
Error Location
Top of Page
The Service Booking object in Maica represents a PRODA Service Booking (Plan) for a given Participant.
The table below provides a comprehensive overview of all fields and relationships for the Service Booking object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Service Booking Schema.
The list below outlines the Flows applied to the Service Booking Object in Maica.
Please refer to the list below for more detailed information on each Flow.
This flow is designed to send an email notification 90 days before the expiration of a service booking.
Flow Label
Maica - Booking 90 Days Before Expiration Notification
API Name
maica__Booking_90_Days_Before_Expiration_Notification
Type
Autolaunched Flow
This flow sends an email notification 90 days before the expiration of a service booking by:
Detecting changes to service booking records and scheduling the flow to run 90 days before the end date.
Checking if the email template is set and if the end date is in the future.
Determining the email recipient based on the email setting.
Sending the email notification to the determined recipient.
This flow is designed to send an email notification when the utilisation of a service booking crosses a specified threshold.
Flow Label
Maica - Booking Utilisation Change Notification
API Name
maica__Booking_Utilisation_Change_Notification
Type
Autolaunched Flow
This flow sends an email notification when the utilisation of a service booking crosses a specified threshold by:
Detecting changes to service booking records.
Checking if the email template is set.
Determining whether the email notification should be sent based on the utilisation thresholds.
Identifying the email recipient based on the email settings.
Sending the email notification to the determined recipient.
This object represents a financial summary statement of a Service Agreement during the defined claim period. Referenced for claim extracts and monthly client statements.
The table below provides a comprehensive overview of all fields and relationships for the Service Agreement Statement object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Service Agreement Statement Schema.
The list below outlines the Flows applied to the Service Agreement Leave Object in Maica.
Please refer to the list below for more detailed information on each Flow.
This guided flow facilitates the recalculation of an existing Service Agreement Statement record.
Flow Label
Maica - Recalculate Service Agreement Statement Screen Flow
API Name
maica__Maica_Recalculate_Service_Agreement_Statement_Screen_Flow
Type
Screen Flow
This flow guides the user through recalculating an existing Service Agreement Statement record:
Starts from a user-initiated screen flow.
Retrieves the Service Agreement Statement record.
Calls a subflow to perform the recalculation.
Checks for any fault messages and displays appropriate success or error messages based on the recalculation outcome.
This object in Maica represents the Services to be delivered and are associated Support Categories.
The table below provides a comprehensive overview of all fields and relationships for the Support Item object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Support Category Schema.
The list below outlines the Validation Rules applied to the Shift Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
Ensures key NDIS attributes cannot be null if the Funding Source equals NDIS
Rule Name
VAL_SUPPORT_ITEM_0001
Error Message
VAL_0001: When the Funding Source is NDIS, the following fields are required: Support Category, PACE Support Category, Support Item Number, Service Day, Service Time.
Error Location
Top of Page
Ensures that a Category Support Item, or Bucket, cannot be related to an Appointment Service record.
Rule Name
VAL_SUPPORT_ITEM_0002
Error Message
VAL_0002: A Category Support Item, or Bucket, cannot be related to an Appointment Service record.
Error Location
Appointment Service
The list below outlines the Trigger Handlers applied to the Support Item Object in Maica.
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to manage the validation of support item services in Maica.
Load Order
1
Label
SupportItemServiceValidation_MDTM
This trigger is designed to manage the unit of measure for support items in Maica.
Load Order
1
Label
SupportItemUnitOfMeasure_MDTM
Timesheets are used to track the hours worked by a Resource.
The table below provides a comprehensive overview of all fields and relationships for the Timesheet object in Maica. Please refer to the table below for detailed information.
Click here to view and download the complete Timesheet Schema.
This object in Maica is used to define specific dates or periods where the Resource is unavailable, i.e. when they are not able to work.
The table below provides a comprehensive overview of all fields and relationships for the Unavailability object in Maica. Please refer to the table below for detailed information.
The list below outlines the Validation Rules applied to the Unavailability Object in Maica.
Please refer to the list below for more detailed information on each Validation Rule.
Unavailable To
Date Cannot Be Before Unavailable From
DateEnsures that the Unavailable To date cannot be before the Unavailable From date.
The list below outlines the Trigger Handlers applied to the Support Item Object in Maica.
Please refer to the list below for more detailed information on each Trigger Handler.
This trigger is designed to manage the status of unavailability records in Maica.
This trigger is designed to manage the appointments related to unavailability records in Maica.
Timesheet Entries are used to track the hours worked by a Resource for a particular service within a particular Appointment.
Click to view and download the complete Support Category Schema.
Click to view and download the complete Timesheet Entry Schema.
Rule Name
VAL_UNAVAILABILITY_0001
Error Message
VAL_0001: The Unavailable To date cannot be before the Unavailable From date
Error Location
Unavailable To
Load Order
1
Label
UnavailabilityStatus_MDTM
Load Order
2
Label
UnavailabilityAppointments_MDTM