Page Properties | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Info | ||
---|---|---|
| ||
|
Overview
The Self-Service Bulk Account Creation Tool is provided to the Issuer (Registries) to act as a Participant via upload of a configurable CSV file, which will be consumed and validated by the CSP.
By updating the field details of an Account Creation Request (acct_001) message in the CSV file, developers are able to perform different account creation test scenarios in bulk.
This service allows developers to submit a fixed CSV file containing the account creation information using a cURL command to a REST endpoint. The templates in the CSV file allow more than one record to be provided.
The REST endpoint translates the CSV file to a ISO XML message (Account Creation Request (acct_001)) which is then submitted to the CSP.
Note |
---|
The maximum CSV file size is 50 kB and the maximum number of records accepted by the Self-Service Tool input via a CSV file is 50 records. The CSV file will be rejected if both or either of these parameters are exceeded. The Self-Service Tool will parse the entire CSV file and ensure a summary of error/s is available to the CHESS user. If a single record is invalid due to errors in the file format, business validity or schema validity, the entire CSV file will be rejected. |
The Self-Service Tool will be provided to the Issuer (Registries) to act as a Participant to perform the following initiated requests:
- Create Sponsored, Direct, Settlement Entrepot, Accumulation and Registration Identifier Accounts of Ownership Type “Single” and Holder Type “Company”;
- Create Sponsored and Registration Identifier Accounts of Ownership Type “Single” and Holder Type “Individual”;
- Create Sponsored Accounts of Ownership Type “Joint” and Holder Type “Company” or ”Individual”; and
- Create a Registration Id (RGID) of Ownership Type "Single" or "Joint".
The Self-Service Tool will allow the Issuer (Registries) to act as a Participant to facilitate and manage their own internal test use cases acting on behalf of a Participant. This can be achieved by the following:
Upload 'CSV' file/s to create Sponsored, Direct, Settlement Entrepot, Accumulation and Registration Identifier Accounts of Ownership Type “Single” and Holder Type “Company”;
Upload 'CSV' file/s to create Sponsored and Registration Identifier Accounts of Ownership Type “Single” and Holder Type “Individual”;
- Upload 'CSV' file/s to create Sponsored Accounts of Ownership Type “Joint” and Holder Type “Company” or ”Individual”; and
- Upload 'CSV' file/s to create an RGID of Ownership Type "Single" or "Joint".
On success, an Account Notification (account_002) will be sent by the CSP to the Participant for which the account was created for.
Info |
---|
For each Account successfully created via the Bulk Account Creation Self-Service Tool, the corresponding Account Type, Account Identifier and Holder Id is returned in the response. |
If the CSV submitted by the Issuer (Registry) is invalid due to errors in the business validity, an Invalid Transaction (comm_808) is received.
If the CSV submitted by the Issuer (Registry) is invalid due to errors in the file format or schema validity, a rejection from the Self-Service Tool is received.
These responses are delivered to the REST endpoint, where it is converted to a JSON response.
The sample below is provided as a reference; additional information on the column names and elements present in the CSV can be found on the Account Creation Overview and /wiki/spaces/CSP/pages/66881185.
Sample Template
The file below contains a Excel file template which is used to build the CSV submitting to the cURL.
When populating the CSV, the developer is required to ensure:
- The message includes the appropriate fields as populated in the attached template; and
- Supplied dates are valid business dates.
Expand | ||
---|---|---|
| ||
|
Connection details
Prior to establishing connection to the ITE1, the Issuer (Registries) acting as a Participant will need to generate and submit a Certificate Signing Request and acquire the ASX root / issuing CA public key (instructions are available on the FTP). The Issuer (Registries) acting as a Participant is also required to populate the CSV sample file above.
Note |
---|
CSV files submitted to the CSP must be encoded in UTF-8 not UTF-8-BOM. For further details refer here. |
The below code snippet demonstrates how to establish connection to the Self-Service Bulk Account Creation:
Code Block | ||||
---|---|---|---|---|
| ||||
curl // Verbose output -v // Informs recipients that the client is about to send a message body in this request and wishes to receive a 100 (continue) interim response -H "Expect: 100-continue" // ASX’s CA’s public keys in pem format --cacert /c/path/to/file.pem // File containing the certificate of the client machine --cert /c/path/to/file.cer // Private key of the client certificate provided in cert option --key /c/path/to/file.key // The URL of Issuer (Registries) self-service bulk account creation // For single bulk account creation, the message name following /xmlIngest/ will be acct001Single. // For single bulk account creation (RGID), the message name following /xmlIngest/ will be acct001SingleRGID. // For joint bulk account creation, the message name following /xmlIngest/ will be acct001Joint. // For joint bulk account creation (RGID), the message name following /xmlIngest/ will be acct001JointRGID. "https://ite1-test-tool.asx.com.au:5000/xmlIngest/acct001###" // Header option to accept json format (not the same as the CSV file) -H "accept: application/json" // Header option to tell curl command that it will be form-data in other words file as input -H "Content-Type: multipart/form-data" // The input CSV file to be sent as part of the request -F "file=@/c/path/to/file.csv" |
In the above code fragment:
- URL: The URL for Self-Service Bulk Account Creation is ite1-test-tool.asx.com.au. The local host DNS needs to be reconfigured to 203.4.179.146 to ensure correct routing.
- Port: The port number exposed for Self-Service Tool.
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|