polyspace-access -create-project

Create project folder in Polyspace Access web interface

collapse all in page

    Syntax

    polyspace-access -create-project <folderPath> -host <hostname> [login options] [output options]

    Description

    The system command polyspace-access -create-project creates a new project folder in the Polyspace® Access™ database.

    polyspace-access -create-project <folderPath> -host <hostname> [login options] [output options] creates a project folder in the Polyspace Access web interface. The folder can be at the top of the project hierarchy or a subfolder under an existing project folder. The command outputs the folder location and project ID.

    example

    Examples

    collapse all

    Upload a set of findings to Polyspace Access generated with Polyspace Bug Finder™ Server™ or Polyspace Code Prover™ Server, and authorize only some team members to view these findings.

    Create a project folder restrictedProject at the top of the project hierarchy.

    polyspace-access -create-project restrictedProject ^
-host myAccessServer -port 1234

    Connecting to https://myAccessServer:1234
Connecting as userA
PROJECT_CREATED restrictedProject
PROJECT_ID 5678
Command Completed

    Set roles for users jsmith and rroll, and the group Authorized Users, authorizing them to access the project folder as contributors. If a user name or group name contains spaces, enclose it in double quotes.

    polyspace-access -set-role contributor ^
-user jsmith -user rroll -group "Authorized Users" -project-path restrictedProject ^
-host myAccessServer -port 1234
    Aside from the creator of the project folder and the users and group with the role contributor, no other user can view or access any findings uploaded to restrictedProject.

    Upload Bug Finder project findings from project My Example Project to parent folder Restricted.

    polyspace-access -upload "C:\Polyspace_Workspace\My Example Project\Module1\ps_results.psbf" ^
-host myAccessServer -parent-project Restricted -port 1234
    The uploaded findings are stored in the folder restrictedProject/My_Example_Project (Bug Finder). The polyspace access -upload command outputs information about the upload including a URL to view the uploaded results in the Polyspace Access interface.

    See also Manage Project Permissions.

    Input Arguments

    collapse all

    Manage and View Projects

    Absolute path of project folder specified as a string. If the name includes spaces, use double quotes. Specify the full path to the folder starting from the parent folder within Polyspace Access.

    If your folder path involves a folder that does not already exist, the folder is created.

    Example: topFolder

    Example: "topFolder/subFolder/Folder has spaces"

    Connection Configuration

    Polyspace Access machine hostname that you specify in the URL of the Polyspace Access interface, such as https://hostname:portNumber/metrics/index.html. If you are unsure about which hostname to use, contact your Polyspace Access administrator.

    You must specify a hostname with all polyspace-access commands, except the -generate-migration-commands and -encrypt-password commands.

    Example: -host myAccessServer

    Port number that you specify in the URL of the Polyspace Access interface, such as https://hostname:portNumber/metrics/index.html. If you are unsure about which port number to use, contact your Polyspace Access administrator.

    HTTP protocol used to access Polyspace Access, specified as http or https.

    Full path to the text file where you store your login credentials. Use this option if you use a command that requires your Polyspace Access credentials in a script but you do not want to store your credentials in that script. While the script runs, someone inspecting currently running processes cannot see your credentials.

    You can store only one set of credentials in the file, either as -login and -encrypted-password entries on separate lines, for instance: 

    -login jsmith
-encrypted-password LAMMMEACDMKEFELKMNDCONEAPECEEKPL
    You can also store credentials as an -api-key entry:
    -api-key keyValue123
    Make sure that the file where you store your credentials is UTF-8 encoded and that you restrict the read and write permissions on the file. For example, to restrict read and write permissions on file login.txt in Linux®, use this command:
    chmod go-rwx login.txt

    API key you use as a login credential instead of providing your login and encrypted password. To assign an API key to a user, see Configure User Manager or contact your Polyspace Access administrator.

    Use the API key if you use a command that requires your Polyspace Access login credentials as part of an automation script with a CI tool such as Jenkins®. If a user updates their password, you do not need to update the API key associated with that user in your scripts.

    It is recommended that you store the API key in a text file and pass that file to the command by using the -credentials-file option.

    Login username that you use to interact with Polyspace Access.

    Use the options -login and -encryped-password together. If you do not use these two options together, you are prompted to enter your credentials at the command line, unless you use -api-key.

    Login password you use to interact with Polyspace Access. <ENCRYPTED_PASSWORD> is the output of the polyspace-access -encrypt-password command.

    Use the options -login and -encryped-password together. If you do not use these two options together, you are prompted to enter your credentials at the command line, unless you use the -api-key option.

    Number of times the polyspace-access command retries to upload results when you upload from a client machine to the server machine that hosts Polyspace Access before failing. Specify this option to retry the upload command in the event of sporadic network outages. The command waits 10 seconds between retries.

    Full path to command outputs.

    Path to the folder for storing temporary files generated by polyspace-access commands. The default folder path depends on your platform:

    • Windows — C:\Users\%username%\AppData\Local\Temp\ps_results_server

    • Linux — tmp/ps_results_server

    File path where you store the command output log. By default the command does not generate a log file.

    Version History

    Introduced in R2019a

    See Also

    Topics