Specify property values

In this example, you can see an indented multiline payload value.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
schema: SimV1

connections:
  - name: http

services:
  - name: Welcome
    steps:
      - name: Request
      - name: Response
        message:
          payload: 
            <?xml version="1.0" encoding="utf-8"?>
            <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
              <soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
                  <wsse:Security soapenv:mustUnderstand="false" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
                    <wsse:UsernameToken wsu:Id="UsernameToken-1" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                        <wsse:Username>acs_devel_111</wsse:Username>
                        <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">PASSWORD</wsse:Password>
                    </wsse:UsernameToken>
                  </wsse:Security>
                  <wsa:To>http://sensetrunkcn1:1080/STS/services/SecurityTokenService</wsa:To>
                  <wsa:ReplyTo>
                    <wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address>
                  </wsa:ReplyTo>
                  <wsa:MessageID>urn:uuid:9667500f-4751-46c3-bb2a-5a2c27f757c6</wsa:MessageID>
                  <wsa:Action>http://docs.oasis-open.org/ws-sx/ws-trust/200512/RST/Issue</wsa:Action>
              </soapenv:Header>

With the expression +3M-1d, you add three months to the base date and deduct one day.

The expression {DATE[2022-05-23][+3M-1d][]} returns 2022-08-22.

In the following examples, you use the value of a buffer as the base date:

• If the buffer date is 2022-11-10, the expression {DATE[{B[Variable]}][+1M+1d][]} returns 2022-12-11.

• If the buffer date is 2022-12-20, the expression {DATE[{B[Variable]}][-1M][01.MM.yyyy]} returns 01.11.2022.

• If the buffer date is 2022-12-24T12:34:56Z, the expression {TIME[{B[Variable]}][+2d+1h][]} returns 2022-12-26T13:34:56Z.

In this example, you want to use the value {[Hi]} as plain text. Therefore, you enter "{[Hi]}".

In this example, you want to use the value {"Text"} as plain text. Therefore, you enter "{""Text""}".

In this example, you run a service named Service02:

1. The inbound step contains two properties:

   • The trigger property to wait for a message containing any value as the value of the Path property.

   • The buffer property to create a buffer named myBuffer, which stores the value of the Path property. The property range specifies that you only want to store characters 1 to 5 of the Path property.

2. The outbound step property insert writes the value of the buffer named myBuffer into the payload.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
schema: SimV1
name: buffer
description: set buffer and readout bufferd value

connections:
- name: myConnection
  port: 8080

services:

- name: Service02
  steps:
  - direction: In
    trigger:
    - uri: '*'
    buffer:
    - type: Path
      name: myBuffer
      range: 1..5
  - direction: Out
    insert:
    - value: '{B[myBuffer]}'

In this example, you run a service named Service02:

1. The inbound step contains two properties:

   • The trigger property to wait for a message containing any value as the value of the Path property.

   • The buffer property to create a buffer named myDate, which stores the value of the current date.

2. The outbound step writes the value of the buffer named myDate directly to the payload.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
schema: SimV1
name: buffer
description: set buffer and readout bufferd value

connections:
- name: myConnection
  port: 8080

services:

- name: Service02
  steps:
  - direction: In
    trigger:
    - uri: '*'
    buffer:
    - name: myDate
      value: "{DATE}"
  - direction: Out
    message:
      payload: |-
        "{
          "a": {
            "c:" %{myDate}
          }
        }"

In this example, you run a service named Service04:

1. The inbound step contains two properties:

   • The trigger property to wait for a message that contains any value as the value of the Path property.

   • The buffer property to create a split buffer named myBuffer, which stores the value of the message payload. For each value separated by a semicolon, API simulation creates a separate buffer with consecutive numbers. For example, if the payload is 123;456;789;ABC, you get the following buffers: MyBuffer1 with the value 123, MyBuffer2 with 456, MyBuffer3 with 789, and MyBuffer4 with ABC.

2. The insert outbound step property writes the value of the buffer named myBuffer1 to the payload: 123.

1
2
3
4
5
6
7
8
9
10
11
12
13
schema: SimV1

- name: Service04
  steps:
  - direction: In
    trigger:
    - uri: '*'
    buffer:
    - name: myBuffer
      value: '{SPLITBUFFER[;]}'
  - direction: Out
    insert:
    - value: '{B[myBuffer1]}'

In this example, you run a service named Service03:

1. The inbound step contains two properties:

   • The trigger property to wait for a message that contains any value as the value of the Path property.

   • The buffer property to create two XBuffers named OrderID and CustomerID to store the values of the message payload. API simulation buffers the OrderID, which is located between Transfer order and has been created. It also buffers the CustomerID, which is located after for customer.

2. The insert outbound step property writes the value of the buffer named OrderID to the payload.

1
2
3
4
5
6
7
8
9
10
11
12
schema: SimV1

- name: Service03
  steps:
  - direction: In
    trigger:
    - uri: '*'
    buffer:
    - value: Transfer order {XB[OrderID]} has been created for customer {XB[CustomerID]}
  - direction: Out
    insert:
    - value: '{B[OrderID]}'

This example creates a 7-digit number:

1
2
3
4
5
6
7
8
9
10
schema: SimV1

- name: Service05 
  steps:
  - direction: In
    trigger:
    - uri: '*'
  - direction: Out
    insert:
    - value: '{RND[7]}'

This example creates an integer number between -789 and 123:

1
2
3
4
5
6
7
8
9
10
schema: SimV1

- name: Service06 
  steps:
  - direction: In
    trigger:
    - uri: '*'
  - direction: Out
    insert:
    - value: '{RND[-789][123]}'

In this example, you generate a unique ID that ranges from 0 to 9:

1
2
3
4
5
6
7
8
9
10
schema: SimV1

- name: Service07 
  steps:
  - direction: In
    trigger:
      - uri: '*'
  - direction: Out
    insert:
      - value: '{UNIQUEID[1]}'

In this example, you run a service named Service03:

1. With the trigger inbound step property , the service waits for a message that contains telephone numbers in various possible formats as the value of the Path property.

   The pattern includes:

   • (((00|\+)(420|43))|0): finds 00420, 0043, +420, +43, or 0

   • \s?: possible space

   • \d+: one or more digits

   • /?: possible forward slash

   • (\s?\d)+: string of digits with possible whitespace in between

   The possible search results include +43664 1234567, 0699 1234 5678 9, or 00420669/1 23 456 7.

2. If the telephone number matches, the insert outbound step property writes the value valid phone number to the payload.

1
2
3
4
5
6
7
8
9
10
11
schema: SimV1

- name: Service08 
  steps:
  - direction: In
    trigger:
      - type: Path
        value: '{REGEX["(((00|\+)(420|43))|0)\s?\d+/?(\s?\d)+"]}'
  - direction: Out
    insert:
      - value: 'valid phone number'

The expression {REGEX["^\d{1,2}[ /.-]\d{1,2}[ /.-](\d{4}|\d{2})$"]} searches for dates in various possible formats.

The pattern includes:

• ^: beginning of the line

• \d{1,2}: day (one or two digits long)

• [ /.-]: separators (space, forward slash, dot, or hyphen)

• \d{1,2}: month (one or two digits)

• [ /.-]: separators (space, forward slash, dot, or hyphen)

• (\d{4}|\d{2}): year (two or four digits)

• $: end of line

Possible search results are 9/3, 12.12.87, 1-1-1999, 11.1986, 04/23/2007, or 01.03.2000, 4.8.

Use the expression {REGEX["^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$"]} to search for combined date and time in Coordinated Universal Time (UTC) in ISO 8601 format.

The pattern includes:

• ^: beginning of line

• \d{4}: year (four digits)

• -: separator (hyphen)

• \d{2}: month (two digits)

• -: separator (hyphen)

• \d{2}: day (two digits)

• T: delimiter between date and time

• \d{2}: exactly two digits

• :: separator (colon)

• \d{2}: hour (two digits)

• :: separator (colon)

• \d{2}: second (two digits)

• Z: time zone designator (UTC)

• $: end of line

Possible search results are 2013-10-03T12:00:00Z, 1776-07-04T13:37:11Z, or 1993-01-01T00:00:00Z.

In this example, {RANDOMREGEX["^[A-Z][a-z]+[0-9]{4}$"]} creates a value that starts with an uppercase letter between A and Z, followed by any number of lowercase letters, and exactly four ciphers between 0 and 9. The ^ character marks the beginning of the line, and $ marks the end of the line.

This expression creates, for instance, Ecqwp1989.

This example illustrates how to increase the value of the buffer A by 1:

{MATH[{B[A]}+1]}

In this example the step property Insert writes the value of the variable named my_password into the header.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
schema: SimV1

connections:
  - name: token provider
    endpoint: www.my-token-provider.com
    listen: false

services:
  - name: get valid token
    steps:
    - to: token provider
      insert:
        - type: Header
          name: authentication
          value: '{VAR[my_password]}'
    - buffer:
        - name: token