Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Warning

This documentation is no longer maintained and may contain obsolete information. You should instead refer to https://github.com/CAST-Extend/com.castsoftware.aip.console.tools for more information about automating source code delivery/analysis with AIP Console.


Panel

In this section:

Table of Contents
maxLevel4

Target audience:

  • CAST administrators

...

OptionsDescription
-serverUrl

Required: enter the URL you use to access the CAST AIC Portal in which you want to create the new domain, for example:

No Format
http://server:8080/CAST-AICP

Note that you must omit the trailing forward slash ( / ) at the end of the URL.

-usernameRequired: enter the username to access the CAST AIC Portal. The user name must have the Platform Administrator role in order to be able to create a new Domain. Please see CAST AIC Portal - Configuring user authentication for more information.
-passwordRequired unless the -authkey option is present: enter the password that corresponds to the username you entered. This password is passed in clear text - if you need to enter an encrypted password, please use the -authkey parameter instead.
-authkey

Required unless the -password option is present: enter the authentication key that you have generated for the clear text password that corresponds to the username you entered. You can use the -password option instead if you do not need to use an encrypted password.

Info
See the -authkey section for more information about how to use this.


-authorizeGroups

Optional: these two options enable you to grant the Delivery Manager role to groups and/or usernames for the new Domain (and therefore all its Applications). If you want to add multiple groups and multiple users, they must be separated with a semi-colon ( ; ):

  • corp.delivery.company;corp.admins.company
  • JHU;FRA;LWI

You are not obliged to use these options when you create the Domain, however, if you do, you must follow the instructions located in Configure the Delivery Manager role particularly if you are using Default Authentication.

-authorizeUsers
-verbosity

Optional: use this option to change the verbosity of the output. The default setting is error:

No Format
[debug|info|warn|error|off ]

Error status codes

JRE_NOT_FOUNDJava runtime not found. Please define the JAVA_HOME environment variable or put java.exe into your execution path
DYSFUNCTIONThe software had an unexpected dysfunction
INVALID_COMMANDThe command's syntax is not correct
SERVER_NOT_AVAILABLEThe CAST AIC Portal specified by the provided URL does not respond
INVALID_URLThe provided URL is invalid
INVALID_CREDENTIALSCould not authenticate with the provided credentials
NOT_PERMITTEDThe account with the provided credentials is not permitted to perform the operation
INVALID_NAMEThe provided name is invalid: it is empty or it is too long or it contains forbidden characters
DUPLICATEThe operations violates a uniqueness constraint
INVALID_GUIDThe provided GUID is invalid
DOMAIN_NOT_FOUNDThe referenced domain cannot be found
INVALID_AUTH_KEYInvalid authentication key
INVALID_DELIVERY_MANAGERSThe provided list of delivery managers is invalid: at least one name is empty or it is too long or it contains forbidden characters


...

OptionsDescription
-serverUrl

Required: enter the URL you use to access the CAST AIC Portal in which you want to create the new Application, for example:

No Format
http://server:8080/CAST-AICP

Note that you must omit the trailing forward slash ( / ) at the end of the URL.

-usernameRequired: enter the username to access the CAST AIC Portal. The user name must have the Platform Administrator role in order to be able to create a new Application. Please see CAST AIC Portal - Configuring user authentication for more information.
-passwordRequired unless the -authkey option is present: enter the password that corresponds to the username you entered. This password is passed in clear text - if you need to enter an encrypted password, please use the -authkey parameter instead.
-authkey

Required unless the -password option is present: enter the authentication key that you have generated for the clear text password that corresponds to the username you entered. You can use the -password option instead if you do not need to use an encrypted password.

Info
See the -authkey section for more information about how to use this.


-domainRequired: specify the name of the domain to which you want to associate the new Application. This domain must already exist.
-verbosity

Optional: use this option to change the verbosity of the output. The default setting is error:

No Format
[debug|info|warn|error|off ]

Error status codes

JRE_NOT_FOUNDJava runtime not found. Please define the JAVA_HOME environment variable or put java.exe into your execution path
DYSFUNCTIONThe software had an unexpected dysfunction
INVALID_COMMANDThe command's syntax is not correct
SERVER_NOT_AVAILABLEThe AIC Portal specified by the provided URL does not respond
INVALID_URLThe provided URL is invalid
INVALID_CREDENTIALSCould not authenticate with the provided credentials
NOT_PERMITTEDThe account with the provided credentials is not permitted to perform the operation
INVALID_NAMEThe provided name is invalid: it is empty or it is too long or it contains forbidden characters
DUPLICATEThe operations violates a uniqueness constraint
INVALID_GUIDThe provided GUID is invalid
DOMAIN_NOT_FOUNDThe referenced domain cannot be found
INVALID_AUTH_KEYInvalid authentication key
INVALID_DELIVERY_MANAGERSThe provided list of delivery managers is invalid: at least one name is empty or it is too long or it contains forbidden characters


...

OptionsDescription
-serverUrl

Required: enter the URL you use to access the CAST AIC Portal in which you want to register the existing Application, for example:

No Format
http://server:8080/CAST-AICP

Note that you must omit the trailing forward slash ( / ) at the end of the URL.

-usernameRequired: enter the username to access the CAST AIC Portal. The user name must have the Platform Administrator role in order to be able to register and existing Application. Please see CAST AIC Portal - Configuring user authentication for more information.
-passwordRequired unless the -authkey option is present: enter the password that corresponds to the username you entered. This password is passed in clear text - if you need to enter an encrypted password, please use the -authkey parameter instead.
-authkey

Required unless the -password option is present: enter the authentication key that you have generated for the clear text password that corresponds to the username you entered. You can use the -password option instead if you do not need to use an encrypted password.

Info
See the -authkey section for more information about how to use this.


-domainRequired: specify the name of the domain to which you want to associate the existing Application. This domain must already exist.
-verbosity

Optional: use this option to change the verbosity of the output. The default setting is error:

No Format
[debug|info|warn|error|off ]

Error status codes

JRE_NOT_FOUNDJava runtime not found. Please define the JAVA_HOME environment variable or put java.exe into your execution path
DYSFUNCTIONThe software had an unexpected dysfunction
INVALID_COMMANDThe command's syntax is not correct
SERVER_NOT_AVAILABLEThe AIC Portal specified by the provided URL does not respond
INVALID_URLThe provided URL is invalid
INVALID_CREDENTIALSCould not authenticate with the provided credentials
NOT_PERMITTEDThe account with the provided credentials is not permitted to perform the operation
INVALID_NAMEThe provided name is invalid: it is empty or it is too long or it contains forbidden characters
DUPLICATEThe operations violates a uniqueness constraint
INVALID_GUIDThe provided GUID is invalid
DOMAIN_NOT_FOUNDThe referenced domain cannot be found
INVALID_AUTH_KEYInvalid authentication key
INVALID_DELIVERY_MANAGERSThe provided list of delivery managers is invalid: at least one name is empty or it is too long or it contains forbidden characters


"%APPLICATION_GUID%"Enter (between double quote marks) the GUID of the Application you have copied and now want to register.

...