Newer Version Available

This content describes an older version of this product. View Latest

call(action, args)

This method calls one of the available AddressUpdateHelperFunctions actions and passes arguments to that action.

Signature

public Object call(String action, Map<String, Object> args)

Parameters

action
Type: String
The action to call. The value must be one of the following:
  • getAddressUpdateAttrs — Fetches the list of Service Process attributes for the Address Update request.
  • convertArrayToKeyValuePairs — Converts the formats of Financial Account numbers.
  • ConvertToList — Converts document type data to list format.
  • convertAndMergeAccounts — Converts Financial Account data to list format.
  • convertUploadedDocuments — Converts uploaded files metadata json for OS.
  • ifUploadContainsMultipleFiles — Indicates if a single file input element in OS contains multiple uploads.
  • convertAddresses — Converts the account level addresses to consumable format for the OmniScript.
  • callCreateCaseApi — Creates a new Case and a related Service Process record with the address data.
args
Type: Map<String, Object>
The first three keys must be input, output, and options. The required content for each depends on the action:
  • getAddressUpdateAttrs
    • String svcCatalogRequestId — Id of the request created using the Address Update OmniScript.
  • convertArrayToKeyValuePairs
    • List<Object> financialAccountsObj — List of financial account objects for transformation.
  • ConvertToList
    • Object args — String of comma-separated document types.
  • convertAndMergeAccounts
    • List<Object> args — list of financial accounts.
  • convertUploadedDocuments
    • List<Object> args — list of uploaded documents from the OmniScript data.
  • ifUploadContainsMultipleFiles
    • List<Object> args — list of uploaded documents from the OmniScript data.
  • convertAddresses
    • Map<String,Object> args — Account level addresses.
  • callCreateCaseApi
    • Map<String,Object>

Return Value

Type: Map<String, Object>

The return values of the corresponding action.

Usage

To use this class in an Integration Procedure, specify the class in the Remote Class property, the action in the Remote Method property, and the arguments in the Additional Input property.

Examples

Input and output JSON examples for some of the actions are as follows.

convertArrayToKeyValuePairs

Input format:

1[
2    {
3      "AccountName": "Priority Checking",
4      "Address1": "33 Ridgemond Street",
5      "City": "San Fransisco",
6      "FinancialAccountId": "a0FRN000000Dt6C2AS",
7      "PostalCode": "512534",
8      "Country": "United States",
9      "State": "CA",
10      "FinancialAccountNumber": "700021878"
11    },
12    {
13      "AccountName": "Cash Rewards Credit Card",
14      "Address1": "91 Town Road",
15      "City": "Naples",
16      "FinancialAccountId": "a0FRN000000Dt7Z2AS",
17      "PostalCode": "514534",
18      "Country": "United State",
19      "State": "Florisa",
20      "FinancialAccountNumber": "78000130"
21    },
22    {
23      "AccountName": "Regular Savings",
24      "Address1": "33 Ridgemond Street",
25      "City": "San Fransisco",
26      "FinancialAccountId": "a0FRN000000Dt7U2AS",
27      "PostalCode": "51345",
28      "Country": "United States",
29      "State": "CA",
30      "FinancialAccountNumber": "200048376"
31    }
32]
33

Output format:

1[
2    {
3      "isSelected": null,
4      "ConvertedFinancialAccountNumber": "1878",
5      "FinancialAccountNumber": "700021878",
6      "State": "CA",
7      "Country": "United States",
8      "PostalCode": "512534",
9      "FinancialAccountId": "a0FRN000000Dt6C2AS",
10      "City": "San Fransisco",
11      "Address1": "33 Ridgemond Street",
12      "AccountName": "Priority Checking"
13    },
14    {
15      "isSelected": null,
16      "ConvertedFinancialAccountNumber": "0130",
17      "FinancialAccountNumber": "78000130",
18      "State": "Florisa",
19      "Country": "United State",
20      "PostalCode": "514534",
21      "FinancialAccountId": "a0FRN000000Dt7Z2AS",
22      "City": "Naples",
23      "Address1": "91 Town Road",
24      "AccountName": "Cash Rewards Credit Card"
25    },
26    {
27      "isSelected": null,
28      "ConvertedFinancialAccountNumber": "8376",
29      "FinancialAccountNumber": "200048376",
30      "State": "CA",
31      "Country": "United States",
32      "PostalCode": "51345",
33      "FinancialAccountId": "a0FRN000000Dt7U2AS",
34      "City": "San Fransisco",
35      "Address1": "33 Ridgemond Street",
36      "AccountName": "Regular Savings"
37    }
38]
39
convertAndMergeAccounts

Input format:

1[
2    {
3      "Id": "REC0",
4      "isSelected": true,
5      "ConvertedFinancialAccountNumber": "1878",
6      "FinancialAccountNumber": "700021878",
7      "State": "CA",
8      "Country": "United States",
9      "PostalCode": "512534",
10      "FinancialAccountId": "a0FRN000000Dt6C2AS",
11      "City": "San Fransisco",
12      "Address1": "33 Ridgemond Street",
13      "AccountName": "Priority Checking",
14      "uniqueKey": "REC0",
15      "_flex": {
16        "uniqueKey": "REC0"
17      }
18    },
19    {
20      "Id": "REC1",
21      "isSelected": true,
22      "ConvertedFinancialAccountNumber": "0130",
23      "FinancialAccountNumber": "78000130",
24      "State": "Florisa",
25      "Country": "United State",
26      "PostalCode": "514534",
27      "FinancialAccountId": "a0FRN000000Dt7Z2AS",
28      "City": "Naples",
29      "Address1": "91 Town Road",
30      "AccountName": "Cash Rewards Credit Card",
31      "uniqueKey": "REC1",
32      "_flex": {
33        "uniqueKey": "REC1"
34      }
35    }
36  ]
37

Output format:

1[
2    "700021878",
3    "78000130"
4]
5
convertAddresses

Input format:

1{
2    "Name": "Julia Green",
3    "ShippingAddress": "33 Ridgemond Street,San Fransisco,CA,613654,United States",
4    "BillingAddress": "33 Ridgemond Street,San Fransisco,CA,67136,United States"
5}
6

Output format:

1[
2    {
3      "isSelected": null,
4      "type": "Shipping",
5      "Address": "33 Ridgemond Street San Fransisco CA 613654 United States"
6    },
7    {
8      "isSelected": null,
9      "type": "Billing",
10      "Address": "33 Ridgemond Street San Fransisco CA 67136 United States"
11    }
12]
13
convertUploadedDocuments

Input format:

1[
2  {
3    "DocumentType-Block": {
4      "DocumentType": "Passport"
5    },
6    "Files": [
7      {
8        "data": "069RN00000033O1YAI",
9        "filename": "Passport.pdf",
10        "vId": "068RN00000038q3YAA",
11        "size": 5385,
12        "deleteLabel": "Delete Passport.pdf"
13      }
14    ]
15  },
16  {
17    "DocumentType-Block": {
18      "DocumentType": "Medicard"
19    },
20    "Files": [
21      {
22        "data": "069RN00000033O6YAI",
23        "filename": "Passport.pdf",
24        "vId": "068RN00000038q8YAA",
25        "size": 5385,
26        "deleteLabel": "Delete Passport.pdf"
27      }
28    ]
29  }
30]
31

Output format:

1[
2  {
3    "typeId": "0deRN000000009UYAQ",
4    "docType": "Passport",
5    "name": "Passport.pdf",
6    "id": "069RN00000033O1YAI"
7  },
8  {
9    "typeId": "0deRN00000000CnYAI",
10    "docType": "Medicard",
11    "name": "Passport.pdf",
12    "id": "069RN00000033O6YAI"
13  }
14]
15
ifUploadContainsMultipleFiles

Input format:

1[
2  {
3    "DocumentType-Block": {
4      "DocumentType": "Passport"
5    },
6    "Files": [
7      {
8        "data": "069RN00000033O1YAI",
9        "filename": "Passport.pdf",
10        "vId": "068RN00000038q3YAA",
11        "size": 5385,
12        "deleteLabel": "Delete Passport.pdf"
13      }
14    ]
15  },
16  {
17    "DocumentType-Block": {
18      "DocumentType": "Medicard"
19    },
20    "Files": [
21      {
22        "data": "069RN00000033O6YAI",
23        "filename": "Passport.pdf",
24        "vId": "068RN00000038q8YAA",
25        "size": 5385,
26        "deleteLabel": "Delete Passport.pdf"
27      }
28    ]
29  }
30]
31

Output format: None

callCreateCaseApi

The input map contains these key-value pairs:

1AddressLine1 (String): "32 baker street" 
2AddressLine2 (String): "abc"
3PostalCode: 63164
4City: "San Francisco"
5State: "CA"
6CountryCode: "United States"
7accountId: "001RN0000037rzqYAA"
8effectiveDate: "2022-12-31"
9svcCatalogItemDefApiName: "AddressUpdate"
10defaultAccountStatus:
11caseSubject: "Address Update Service Request"
12

FinancialAccounts input format:

1[
2  {
3    "Id": "REC0",
4    "isSelected": true,
5    "ConvertedFinancialAccountNumber": "1878",
6    "FinancialAccountNumber": "700021878",
7    "State": "CA",
8    "Country": "United States",
9    "PostalCode": "512534",
10    "FinancialAccountId": "a0FRN000000Dt6C2AS",
11    "City": "San Fransisco",
12    "Address1": "33 Ridgemond Street",
13    "AccountName": "Priority Checking",
14    "uniqueKey": "REC0",
15    "_flex": {
16      "uniqueKey": "REC0"
17    }
18  },
19  {
20    "Id": "REC1",
21    "isSelected": true,
22    "ConvertedFinancialAccountNumber": "0130",
23    "FinancialAccountNumber": "78000130",
24    "State": "Florisa",
25    "Country": "United States",
26    "PostalCode": "514534",
27    "FinancialAccountId": "a0FRN000000Dt7Z2AS",
28    "City": "Naples",
29    "Address1": "91 Town Road",
30    "AccountName": "Cash Rewards Credit Card",
31    "uniqueKey": "REC1",
32    "_flex": {
33      "uniqueKey": "REC1"
34    }
35  }
36]
37

customerLevelAddresses input format:

1[
2  {
3    "Id": "REC0",
4    "isSelected": true,
5    "type": "Shipping",
6    "Address": "33 Ridgemond Street San Fransisco CA 613654 United State",
7    "uniqueKey": "REC0",
8    "_flex": {
9      "uniqueKey": "REC0"
10    }
11  },
12  {
13    "Id": "REC1",
14    "isSelected": true,
15    "type": "Billing",
16    "Address": "33 Ridgemond Street San Fransisco CA 67136 United State",
17    "uniqueKey": "REC1",
18    "_flex": {
19      "uniqueKey": "REC1"
20    }
21  }
22]
23

documentInfo input format:

1[
2  {
3    "typeId": "0deRN000000009UYAQ",
4    "docType": "Passport",
5    "name": "Passport.pdf",
6    "id": "069RN00000033O1YAI"
7  },
8  {
9    "typeId": "0deRN00000000CnYAI",
10    "docType": "Medicard",
11    "name": "Passport.pdf",
12    "id": "069RN00000033O6YAI"
13  }
14]
15

Output format: None