IICS Asset Management CLI V2 Utility: Command Reference Guide

Version 8

    Contents


    Overview

    You can use the IICS Asset Management CLI V2 Utility to use the IICS REST API and perform SDLC operations on IICS artifacts. The utility is a standalone, command line based utility.

     

    Downloading the IICS Asset Management CLI V2 Utility

    Access the following URL to download the IICS Asset Management CLI V2 utility:

    Tools/IICS Asset Management CLI/v2 at master · InformaticaCloudApplicationIntegration/Tools · GitHub

    Download the utility based on the operating system that you use.

     

    Running the IICS Asset Management CLI V2 Utility

    Perform the following steps to run the utility:

    1. From the command prompt, navigate to the directory where you downloaded the utility.
    2. Run the required command.

    IICS Asset Management CLI Utility Commands

    You can use the following commands with the IICS Asset Management CLI V2 utility:

    • List
    • Export
    • Extract
    • Package
    • Import
    • Publish
    • Log Level
    • Version
    • Help

     

    List Command

    Run the List command to filter IICS artifacts based on multiple queries. You can either view the list of IICS artifacts or write the list of IICS artifacts to an output file.

     

    Arguments

    Use the following arguments with the List command:

     

    ArgumentDescription

    -o,

    --outputFile

    Optional. Defines the path and file name for the output file. The output file contains the list of IICS artifacts that match the queries
    you specify. The path can be a relative path or absolute path.

     

    If you do not specify this argument, the command displays the list of IICS artifacts at the command prompt.

    -p,

    --password

    Defines the password to log in to IICS.

    -q,

    --query
    Specifies the queries to filter the IICS artifacts that you want to include in the artifacts list. You can define
    multiple query parameters separated with a space character. The command performs an AND operation when you define multiple query parameters.
    You can use the following parameters to construct the query:
    • location: Defines where the artifact is stored in IICS. Include the project and folder name in the location.
    • tag: Defines the tag associated with the asset.
    • type: Defines the artifact type. Use one of the following values:
      • AI_CONNECTION (for connections)
      • AI_SERVICE_CONNECTOR (for service connectors)
      • DTEMPLATE (for mappings)
      • GUIDE (for guides)
      • PROCESS (for processes)
      • PROCESS_OBJECT (for process objects)
      • MAPPLET (for mapplets)
      • MTT (for mapping tasks)
      • TASKFLOW (for taskflows)
      • FOLDER (for folders)
      • PROJECT (for projects)
    • updateTime: Defines a filter condition based on the last updated time for the artifact. You can use operators such as <, <=, >, >=, and = in conjunction with the last updated time.
      Note:

      You must specify the URL-encoded value when using operators such as >= or <= in the query. For example:
      Query parameter "updateTime>=2018-05-28T13:54:11Z" must be replaced with "updateTime%3E%3D2018-05-28T13:54:11Z"
      Query parameter "updateTime<=2018-05-28T13:54:11Z" must be replaced with "updateTime%3C%3D 2018-05-28T13:54:11Z"

    • updatedBy: Defines the user name of the user account that last updated the artifact.

    Use the following syntax to define the query parameters:-q "location==<value>" -q "tag==<value>" -q "type==<value>" -q "updateTime==<value>" -q "updatedBy==<value>"
    Note: You must use two == operators between the parameter name and value. If any value contains space characters, you must enclose the parameter-value pair within double quotes.
    -r,
    --region
    Defines the IICS region to which the organization belongs. For example, us, eu, ap.
    -u,--usernameDefines the user name to log in to IICS.

     

    Syntax

    Use the following syntax:

    iics list -r <region> -u <username> -p <password> -o <path and name of the output file> -q "location==<location>" -q "updateTime>==<timestamp_condition>" -q "type==<artifact_type>" -q "updatedBy==<username>"

     

    Samples

    iics list -r us -u user1 -p password1 -q "location==MyProject/MyFolder" -o C:\IICS\ArtifactsList.txt

    iics list -r us -u user1 -p password1 -q "location==_JIRA/CTP-39075" -q "updateTime%3E%3D2018-05-28T13:54:11Z" -q "type==TASKFLOW" -q "updatedBy==user1@informatica.com"

     

    Export Command

    Run the Export command to export IICS artifacts as a zip file into a local workspace directory.

     

    You can run the command in one of the following ways:

    • With the default true value for the --sync argument: In this case, the command will be a blocking call. The command will issue the request and wait for the action to be completed. After the command runs successfully, the export zip file is downloaded to the path and file name you specify in the --zipFilePath argument.
    • With the --sync argument value set to false: In this case, the command will be a non-blocking call. The command will issue the request, but will not wait for the action to be completed. It returns the export ID. You can use the export ID to check the status of the export job and download the export zip file after the export is successful.

     

    Arguments

    Use the following arguments with the Export command:

     

    ArgumentDescription

    -a, --artifacts

    Defines the fully qualified path to the artifact or the root location to be exported, suffixed with a period (.)
    character and the artifact type. Use the following suffixes based on the artifact type:

    • AI_CONNECTION (for connections)

    • AI_SERVICE_CONNECTOR (for service connectors)

    • DTEMPLATE (for mappings)

    • GUIDE (for guides)

    • PROCESS (for processes)

    • PROCESS_OBJECT (for process objects)

    • MAPPLET (for mapplets)

    • MTT (for mapping tasks)

    • TASKFLOW (for taskflows)

    • FOLDER (for folders)
    • PROJECT (for projects)

     

    Examples:

    Explore/ProjectName/FolderName/<MyProcess>.PROCESS

    Explore/ProjectName/<MyConnection>.AI_CONNECTION

    Explore/ProjectName/<MyFolderName>.Folder

    Explore/<MyProjectName>.Project/

     

    You can define multiple paths. Separate entries with a space character.

     

    Note: The -a and -f arguments are mutually exclusive. If the path values contain spaces, you must enclose them within double quotes.

    -f,

    --artifactsFile

    Defines the path and file name of the file that contains a list of artifacts to be exported as a zip file from IICS.


    In the file, define the fully qualified path to the artifact or the root location, suffixed with a period (.)
    character and the artifact type. Use the following suffixes based on the type:

    • AI_CONNECTION (for connections)

    • AI_SERVICE_CONNECTOR (for service connectors)

    • DTEMPLATE (for mappings)

    • GUIDE (for guides)

    • PROCESS (for processes)

    • PROCESS_OBJECT (for process objects)

    • MAPPLET (for mapplets)

    • MTT (for mapping tasks)

    • TASKFLOW (for taskflows)

    • FOLDER (for folders)
    • PROJECT (for projects)

     

    Examples:

    Explore/ProjectName/FolderName/<MyProcess>.PROCESS

    Explore/ProjectName/<MyConnection>.AI_CONNECTION

    Explore/ProjectName/<MyFolderName>.Folder

    Explore/<MyProjectName>.Project/

     

    You can define multiple paths. Separate entries with a space character.

     

    Note: The -a and -f arguments are mutually exclusive. If the path values contain spaces, you must enclose them within double quotes.

    -m,

    --maxWaitTime

    Optional. This argument is applicable only when the --sync argument uses the default value of true. In this case, the command will be a blocking call. The command will issue the request and wait for the action to be completed.

     

    The --maxWaitTime argument defines the maximum time in seconds that the command must wait for the request to complete. Default is 120 seconds. If the command does not complete within the specified time, the command exits.

    -n, --name

    Optional. Defines the name of the request. This value is used as the name of the export job.

    -p,
    --password

    Defines the password to log in to IICS.

    -P,

    --pollingInterval

    Optional. This argument is applicable only when the --sync argument uses the default value of true. In this case, the command will be a blocking call. The command will issue the request and wait for the action to be completed.

     

    The --pollingInterval argument defines how often the command must poll for and display status information. The time interval is in seconds. Default is 15 seconds.

    -r, --region

    Defines the IICS region to which the organization belongs. For example, us, eu, ap.

    -s, --sync

    Optional. Controls whether the command is blocking or non-blocking.


    By default, the --sync argument uses the value true. In this case, the command will be a blocking call. The command will issue the request and wait for the action to be completed.

     

    If you set the value to false, the command will be a non-blocking call. The command will issue the request, but will not wait for the action to be completed. It returns the export ID. You can use the export ID to check the status of the export job and download the export zip file after the export is successful.

    -u,

    --username

    Defines the user name to log in to IICS.

    -z,

    --zipFilePath

    Defines the path and file name for the IICS export zip file that you want to create. The path can be a relative path or absolute path.

     

    You can also use the following commands with the Export command:

     

    Command

    Description

    download

    Downloads the IICS export zip file.

     

    Use the following syntax:

    iics export download --region <region> --username <username> --password <password> --exportId <exportID received from the Export command> --zipFilePath <path and file name for the export zip file>

    status

    Displays the status of the IICS export job. Returns one of the following values:

    • IN_PROGRESS

    • SUCCESSFUL

    • FAILED

     

    Use the following syntax:

    iics export status --region <region> --username <username> --password <password> --exportId <exportID received from the Export command> 

     

    Syntax

    Use one of the following syntax based on your need:

    iics export --region <region> --username <username> --password <password> --artifacts <artifact_location>

     

    iics export --region <region> --username <username> --password <password> --artifacts <artifact_location> --sync false

    iics export download --region <region> --username <username> --password <password> --exportId <exportID received from the Export command> --zipFilePath <path and file name for the export zip file>

    iics export status --region <region> --username <username> --password <password> --exportId <exportID received from the Export command>

     

    Samples

    iics export --region us --username user1 --password password1 --artifacts Explore/MyProject.Project --zipFilePath export.zip

    iics export --region us --username user1 --password password1 --artifacts Explore/MyProject.Project --sync false

    iics export download --region us --username user1 --password password1 --exportId 123412341234 --zipFilePath export.zip

    iics export status --region us --username user1 --password password1 --exportId 123412341234

     

    Extract Command

    Run the Extract command to extract an IICS zip file into a local workspace directory. The command extracts the zip file contents into individual assets.

     

    On extraction, the utility creates one metadata file in the local workspace directory for each project, folder, or artifact. The metadata file resides alongside the project, folder, or artifact file and will have a period character (.) before the file name. For example, if you extract the file /Explore/MyProject/a.PROCESS.xml, a corresponding metadata file /Explore/MyProject/.a.PROCESS.xml is created. Note the period character before the file name.

     

    Note: The metadata files might be hidden by default in some file systems because the file names start with a period character. The metadata files must be preserved along with the project, folder, or artifact file. For example, if you add the workspace contents to a version control system, you must also add the metadata files to the version control system. Similarly, when you check out the contents from a version control system, you must also check out the metadata files from the version control system.

     

    Arguments

    Use the following arguments with the Extract command:

     

    Argument
    Description
    -zDefines the path and file name of the IICS export zip file that you want to extract.
    -wDefines the directory into which you want to extract the zip file as individual assets.

     

    Syntax

    iics extract -z <path and file name of the zip file to be extracted > -w <path where you want to extract the zip file to>

    Note: If the path values contain spaces, you must enclose them within double quotes.

     

    Samples

    Windows:

    iics extract -z C:\Informatica\CloudApplicationIntegration\Utility\ExportZIPs\ExportedAssets.zip -w C:\Informatica\CloudApplicationIntegration\Utility\Workspace

     

    Linux:

    iics extract -z /home/user1/Utility/ExportZIPs/ExportedAssets.zip -w /home/user1/Utility/Workspace

     

    Package Command

    Run the Package command to package IICS artifacts from a local workspace directory into a zip file. You can then import the zip file into IICS. You can specify a list of artifacts to be packaged, a text file with the names of the artifacts that need to be packaged, or a directory that contains the artifacts to be packaged.

     

    Arguments

    Use the following arguments with the Package command:

     

    Argument

    Description

    -a

    Defines the path relative to the workspace where the artifact is available including the file name. You can define multiple paths. Separate entries with a new line.

    -f

    Defines the path and file name of the text file that contains a list of artifacts to be included in the zip.

    -w

    Defines the path of the workspace directory where the individual artifacts are available.

    -z

    Defines the path and file name for the IICS import zip file that you want to create.

     

    Syntax

    iics package -z <path and file name for the IICS import zip file you want to create> -w <path of the workspace directory where the individual artifacts are available>
    -a <path relative to the workspace where artifact1 is available including the file name>
    -a <path relative to the workspace where artifact2 is available including the file name>
    -a <path relative to the workspace where artifactn is available including the file name>

     

    iics package -z <path and file name for the IICS import zip file you want to create> -f <path to the text file that contains a list of files to be included in the zip including the file name>

     

    Note: Use the following rules and guidelines when you run the Package command:

    • If the path values contain spaces, you must enclose them within double quotes.
    • The -f and -a options are mutually exclusive.
    • If you use the -a option and the artifacts are located in different workspace directories, you must run the package command multiple times for each combination of a workspace directory and an artifact. For example, if artifact1 and artifact2 are located in two different workspace directories, you must run the package command twice as shown below:

    iics package -z <path and file name for the IICS import zip file you want to create> -w <path of the workspace root directory where artifact1 is available> -a <path relative to the workspace where artifact1 is available including the file name>
    iics package -z <path and file name for the IICS import zip file you want to create> -w <path of the workspace root directory where artifact2 is available> -a <path relative to the workspace where artifact2 is available including the file name>

     

    Samples

    Windows:

    iics package -z C:\Informatica\CloudApplicationIntegration\Utility\ImportZIPs\ImportedAssets.zip -w C:\Informatica\CloudApplicationIntegration\Utility\Workspace

    -a \ImportAsset1.xml

    -a \ImportAsset2.xml

     

    iics package -z “C:\Informatica\Cloud Application Integration\Utility\ImportZIPs\ ImportedAssets.zip” -f “\Explore\Shared Assets\Service Connectors\Import-Files-List.txt”

     

    Linux:

    iics package -z /home/user1//Utility/ImportZIPs/ImportedAssets.zip -w /home/user1/Utility/Workspace
    -a /ImportAsset1.xml
    -a /ImportAsset2.xml

     

    iics package -z /home/user1/Utility/ImportZIPs/ImportedAssets.zip -f “/home/user1/Explore/Shared Assets/Service Connectors/Import-Files-List.txt”

     

    Import Command

    Run the Import command to import artifacts from a zip file into IICS.

     

    You can run the command in the following ways:

    • With the default true value for the --sync argument: In this case, the command will be a blocking call. The command will issue the request and wait for the action to be completed. After the command runs successfully, the zip file is imported into IICS. The artifacts within the zip file are imported into the same IICS location from where they were previously exported.
    • With the --sync argument value set to false: In this case, the command will be a non-blocking call. The command will issue the request, but will not wait for the action to be completed. It returns the import ID. You can use the import ID to check the status of the import job.

     

    Arguments

    Use the following arguments with the Import command:

     

    ArgumentDescription

    -m,

    --maxWaitTime

    Optional. This argument is applicable only when the --sync argument uses the default value of true. In this case, the command will be a blocking call. The command will issue the request and wait for the action to be completed.

     

    The --maxWaitTime argument defines the maximum time in seconds that the command must wait for the request to complete. Default is 120 seconds. If the command does not complete within the specified time, the command exits.

    -n, --nameOptional. Defines the name of the request. This value is used as the name of the import job.
    -p, --passwordDefines the password to log in to IICS.
    -P, --pollingInterval

    Optional. This argument is applicable only when the --sync argument uses the default value of true. In this case, the command will be a blocking call. The command will issue the request and wait for the action to be completed.

     

    The --pollingInterval argument defines how often the command must poll for and display status information. The time interval is in seconds. Default is 15 seconds.

    -r, --regionDefines the IICS region to which the organization belongs. For example, us, eu, ap.
    -s, --sync

    Optional. Controls whether the command is blocking or non-blocking.


    By default, the --sync argument uses the value true. In this case, the command will be a blocking call. The command will issue the request and wait for the action to be completed.

     

    If you set the value to false, the command will be a non-blocking call. The command will issue the request, but will not wait for the action to be completed. It returns the import ID. You can use the import ID to check the status of the import job.

    -u, --usernameDefines the user name to log in to IICS.
      -z, --zipFilePathDefines the path and file name of the zip file that contains the artifacts you want to import into IICS. The path can be a relative path or absolute path.

     

    You can also use the following command with the Import command:

     

    CommandDescription
    status

    Displays the status of the IICS import job. Returns one of the following values:

    • IN_PROGRESS
    • SUCCESSFUL
    • FAILED

     

    Use the following syntax:

    iics import status --region <region> --username <username> --password <password> --importId <importID received from the Import command>

    Syntax

    Use one of the following syntax based on your need:

    iics import --region <region> --username <username> --password <password> --zipFilePath <path and file name for the import zip file>

     

    iics import --region <region> --username <username> --password <password> --zipFilePath <path and file name for the import zip file> --sync false

    iics import status --region <region> --username <username> --password <password> --importId <importID received from the Import command>

     

    Samples

    iics import --region us --username user1 --password password1 --zipFilePath artifacts-to-import.zip

     

    iics import --region us --username user1 --password password1 --zipFilePath artifacts-to-import.zip --sync false

    iics import status --region us --username user1 --password password1 --importId 123412341243

    Publish Command

    Run the Publish command to publish IICS artifacts. You can publish connections, service connectors, guides, processes, and taskflows.

    After the command runs successfully, the status of the artifact changes to Published in IICS. You can view and copy the generated service URLs from IICS.

     

    Arguments

    Use the following arguments with the Publish command:

     

    ArgumentDescription

    -a,--artifacts

    Defines the fully qualified path to the artifact to be published, suffixed with a period (.) character and the artifact type. Use the following suffixes based on the artifact type:

    • AI_CONNECTION (for connections)

    • AI_SERVICE_CONNECTOR (for service connectors)

    • GUIDE (for guides)

    • PROCESS (for processes)

    • TASKFLOW (for taskflows)

     

    Examples:

    Explore/ProjectName/FolderName/<MyProcess>.PROCESS

    Explore/ProjectName/<MyConnection>.AI_CONNECTION

     

    You can define multiple paths. Separate entries with a space character.

     

    Note: The -a and -f arguments are mutually exclusive. If the path values contain spaces, you must enclose them within double quotes.

    -f,

    --artifactsFile

    Defines the path and file name of the file that contains a list of artifacts to be published.


    In the file, define the fully qualified path to the artifact, suffixed with a period (.) character and the artifact type. Use the following suffixes based on the type:

    • AI_CONNECTION (for connections)

    • AI_SERVICE_CONNECTOR (for service connectors)

    • GUIDE (for guides)

    • PROCESS (for processes)

    • TASKFLOW (for taskflows)

     

    Examples:

    Explore/ProjectName/FolderName/<MyProcess>.PROCESS

    Explore/ProjectName/<MyConnection>.AI_CONNECTION

     

    You can define multiple paths. Separate entries with a space character.

     

    Note: The -a and -f arguments are mutually exclusive. If the path values contain spaces, you must enclose them within double quotes.

    -m,

    --maxWaitTime

    Optional. This argument is applicable only when the --sync argument uses the default value of true. In this case, the command will be a blocking call. The command will issue the request and wait for the action to be completed.

     

    The --maxWaitTime argument defines the maximum time in seconds that the command must wait for the request to complete. Default is 120 seconds. If the command does not complete within the specified time, the command exits.

    -p, --password

    Defines the password to log in to IICS.

    -P, --pollingInterval

    Optional. This argument is applicable only when the --sync argument uses the default value of true. In this case, the command will be a blocking call. The command will issue the request and wait for the action to be completed.


    The --pollingInterval argument defines how often the command must poll for and display status information. The time interval is in seconds. Default is 15 seconds.

    -r, --region

    Defines the IICS region to which the organization belongs. For example, us, eu, ap.

    -s, --sync

    Optional. Controls whether the command is blocking or non-blocking.


    By default, the --sync argument uses the value true. In this case, the command will be a blocking call. The command will issue the request and wait for the action to be completed.

     

    If you set the value to false, the command will be a non-blocking call. The command will issue the request, but will not wait for the action to be completed. It returns the publish ID. You can use the publish ID to check the status of the publishing.

    -u, --username

    Defines the user name to log in to IICS.

     

    You can also use the following command with the Publish command:

     

    Command

    Description

    status

    Displays the status of the IICS publish job. Returns one of the following values:

    • IN_PROGRESS

    • PUBLISHED

    • FAILED

     

    Use the following syntax:

    iics publish status --region <region> --username <username> --password <password> --publishId <publishID received from the Publish command>

     

    Syntax

    Use one of the following syntax based on your need:

    iics publish --region <region> --username <username> --password <password> --artifacts <path and file name of the artifact to be published>

     

    iics publish --region <region> --username <username> --password <password> --artifacts

    <path and file name of the artifact to be published> --sync false

    iics publish status --region <region> --username <username> --password <password> --publishId <publishID received from the Publish command>

     

    Samples

    iics publish --region us --username user1 --password password1 --artifacts Explore/MyProject/MyFolder/Process1.PROCESS

     

    iics publish --region us --username user1 --password password1 --artifacts Explore/MyProject/MyFolder/Process1.PROCESS --sync false

    iics publish status --region us --username user1 --password password1 --publishId 123412341234

     

    Log Level Command

    Run the Log Level command in conjunction with another command to view detailed log information for the command.

     

    Arguments

    Use the following argument with the Log Level command:

     

    Argument

    Description

    -v, --logLevel

    Defines the logging level that will be used for the command. You can set one of the following values:

    • error

    • warn

    • info

    • trace

    The value indicates the maximum logging level that will be used. For example, if you set the value to warn, both error and warn messages will be displayed. If you set the value to trace, all log messages will be displayed.

    Default is info.

     

    Syntax

    iics <command for which you want to view detailed log information> -v

    iics <command for which you want to view detailed log information> --logLevel

     

    Samples

    iics extract -z C:\ExportedAssets\QualifyLead.zip -w C:\ExtractedAssets -v

    iics extract -z C:\ExportedAssets\QualifyLead.zip -w C:\ExtractedAssets --logLevel

     

    Version Command

    Run the Version command to view the version of the utility.

     

    Arguments

    Use the following argument with the Version command:

     

    ArgumentDescription
    versionDisplays the version number of the utility.

     

    Syntax

    iics version

     

    Samples

    iics version

     

    Help Command

    Run the Help command to view information about the available commands along with their arguments and syntax.

     

    Arguments

    Use the following argument with the Help command:

     

    ArgumentDescription
    -h, --helpDisplays help about a particular command.

     

    Syntax

    To view help for all available commands, enter iics -h or iics --help

    To view help for a particular command, enter iics <commandname> -h or iics <commandname> --help

    Samples

    iics -h, iics --help

    iics extract -h, iics extract --help