(Deprecated) IICS Asset Management CLI Utility Version 1.0.0: Command Reference Guide

Version 16

    Deprecation Notice

    This utility has been replaced with its version 2 you can find at IICS Asset Management CLI V2 Utility: Command Reference Guide.

     

    Contents

     

     

    Overview

    You can use the IICS Asset Management CLI utility to augment import and export operations on IICS artifacts. The utility is a standalone, command line based utility. After you export a zip file from IICS by using the Export option in the browser or the Export API, you can use the IICS Asset Management CLI utility to extract the zip file into individual assets in a local workspace directory. You can also selectively package assets into a zip file for import into IICS by specifying a folder path, specific file names, or a text file with the names of the files that need to be packaged.

     

    Downloading the IICS Asset Management CLI Utility

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

    Download the utility based on the operating system you use.

     

    Running the IICS Asset Management CLI 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 utility:

    • extract
    • package
    • help
    • version

     

    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:

    -z: Defines the path and file name of the IICS export zip file that you want to extract.

    -w: Defines the path of the folder 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.

     

    Sample

     

    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 artifacts from a local workspace directory into a zip file. You can then import the zip file into IICS. You can specify a folder path, specific file names, or a text file with the names of the files that need to be imported.

     

    Arguments

    -z: Defines the path and file name for the IICS import zip file you want to create.

    -w: Defines the path of the workspace directory where the individual assets are available.

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

    -f: Defines the path to the text file that contains a list of files to be included in the zip including the file name.

     

    Syntax

    Use one of the following syntax based on your need:

     

    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 assets are available>

     

    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 assets are available>
    -a <path relative to the workspace where asset1 is available including the file name>
    -a <path relative to the workspace where asset2 is available including the file name>
    -a <path relative to the workspace where assetn 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 -w and -a options are mutually exclusive.
    • If you use the -a option and the assets are located in different workspace directories, you must run the package command multiple times for each combination of a workspace directory and an asset. For example, if asset1 and asset2 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 directory where asset1 is available> -a <path relative to the workspace where asset1 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 directory where asset2 is available> -a <path relative to the workspace where asset2 is available including the file name>

     

    Sample

     

    Windows:

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

     

    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

     

    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”

     

    Help Command

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

     

    Arguments

    -h: enter -h or help to view 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

     

    Sample

    iics -h, iics --help
    iics extract -h, iics extract --help

     

    Version Command

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

     

    Arguments

    Version: enter version to view the version of the utility.

     

    Syntax

    iics version

     

    Sample

    iics version

     

    Verbose Command

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

     

    Arguments

    -v: enter -v to view detailed log information for a command.

     

    Syntax

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

     

    Sample

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

    When you run this sample command, the utility prints the following detailed log information:

    The image displays verbose output for the extract command.

    The image displays verbose output for the extract command.

     

    Using the IICS Asset Management CLI Utility in Conjunction with IICS REST V3 APIs

     

    You can use the IICS Asset Management CLI utility in conjunction with IICS REST V3 APIs to perform SDLC operations on IICS artifacts. For more information, refer to the attached presentation named AssetManagementCLI.pptx.

     

    You can also use the attached IICS REST V3 APIs Postman collection named V3 API_Public_Mar2019.postman_collection.json to make the REST API calls.

     

    Achieving full SDLC using IICS REST APIs and the IICS Asset Management CLI Utility

     

    Now that we know how to use the IICS Asset Management CLI Utility to extract IICS export ZIP file into individual IICS asset ZIP files and vice versa through package, let us see how we can combine them with the IICS REST APIs to achieve full SDLC. The details of this are outlined in Slide 3 of the attached PPT.

     

    You will need to setup cURL (or any other REST Client like Postman) for this:

     

    Export Flow

     

    Step 1: Export IICS assets as a zip file from IICS using IICS REST APIs

    cd %CURL_BIN%

    curl -d @data.json -H "Accept: application/zip" -H "Content-type: application/json" -X POST https://na1.ai.dm-us.informaticacloud.com/active-bpel/public/rt/6w10pMc8bwmkGpCQs9xkSM/Get_IICS_Export_Package -o response.zip

     

    This will download response.zip to the %CURL_BIN% directory. This is the asset export zip

     

    You will also need to have the data.json file (the API request file) in %CURL_BIN%

    Sample data.json file is here:

     

    {

    "IICS Username": "<IICS username>",

    "IICS Password": "<IICS password>",

    "IICS Hostname": "Your org hostname from which you want to export the assets e.g. dm-us.informaticacloud.com",

    "Object Path": "<Name of the object you want to export>",

    "Object Type": "<Type of the object you want to export e.g. PROJECT or FOLDER or AI_PROCESS etc."

    }

     

    Step 2: Extract IICS Export ZIP file into individual IICS asset ZIP files

     

    Use the response.zip file obtained in Step 1 and follow steps under Extract Command to perform this action.

     

    Import Flow

     

    Step 1: Package individual IICS asset ZIP files into one IICS Import ZIP file

     

    Use the individual zip files that you need to import to IICS and follow steps under Package Command to package them into a single zip file

     

    Step 2: Import IICS assets zip file into IICS using IICS REST APIs

     

    COMING SOON