Environment variables


This topic explains the architecture and environment variables for Common REST API (CRA).

Common REST API architecture


CRA Architecture diagram_jbb (2).png


Environment variables

After installation, set the following environment variables to the provided values for the JCL.

Important

You must not add or delete keys to the CRACMNEV member. Adding or deleting keys in CRACMNEV member can cause unexpected behavior from the product. 

Variable

Default value

Description

Where are these specified

Which address space uses this

AMICRA_PORT

15565

CRA server port number

CRACMNEV

UBMCSAMP

AMICRA_HOST

localhost  

CRA server host name 

CRACMNEV

UBMCSAMP

AMICRA_BACKEND_REQUEST_TIMEOUT

60

CRA backend request time out (in seconds)

CRACMNEV

UBMCSAMP

AMICRA_TOKEN_TIMEOUT

15

CRA Server token time out (in minutes)

CRACMNEV

UBMCSAMP

AMICRA_SSL

false

Set as true if the SSL connection is used

CRACMNEV

UBMCSAMP

AMICRA_PROTOCOL

http

Type of connection (http or https)

Must be https if the AMICRA_SSL value is true

CRACMNEV

UBMCSAMP

AMICRA_TRUSTSTORE_TYPE

#

Truststore type

CRACMNEV

UBMCSAMP

AMICRA_TRUSTSTORE_NAME

#

Truststore path
For example, safkeyring://USERID/Racf_Name

CRACMNEV

UBMCSAMP

AMICRA_TRUSTSTORE_PASSWORD

#

Truststore password

CRACMNEV

UBMCSAMP

AMICRA_CLIENT_AUTH

none

Specify one of the following values for the client certificate authorization

  • none
  • need

CRACMNEV

UBMCSAMP

AMICRA_KEYSTORE_TYPE

#

Keystore type

CRACMNEV

UBMCSAMP

AMICRA_KEYSTORE_ALIAS

#

Keystore label

CRACMNEV

UBMCSAMP

AMICRA_KEYSTORE_PASSWORD

#

Keystore password

CRACMNEV

UBMCSAMP

AMICRA_KEYSTORE_NAME

#

Kekystore name

For example, safkeyring://USERID/Racf_Name

CRACMNEV

UBMCSAMP

AMICRA_USE_LIBERTY

no

Set as yes to install Common REST API on a preinstalled WebSphere Liberty server.

Default value: no

Important

You can change the value only during the installation. We strongly recommend not to change this value after installation as it might cause unexpected behavior from the product.

CRACMNEV

UBMCSAMP

AMICRA_LIBERTY_PATH

/shrd/wlp/usr/servers/WLPSVREJ 

Full path of the WebSphere Liberty server directory

CRACMNEV

UBMCSAMP

AMICMF_PORT

15567

CMF server port number

CRACMNEV

UBMCSAMP



 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*