> For the complete documentation index, see [llms.txt](https://docs.opsmx.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opsmx.com/ssd/security-risk-and-prioritization/user-guide/scan-now/artifact-scan.md).

# Artifact Scan

The Artifact Scan, scans the artifacts from the selected platforms or the configured ones. 

This page explains the process of Adhoc Artifact Scan for **Amazon Elastic Container Registry (ECR)**.

* Before starting with the scan, you need to integrate ECR with the OpsMx platform. Follow the steps provided in [Integrating ECR](https://docs.opsmx.com/opsmx-delivery-shield-platform/getting-started/integrating-registry-in-delivery-shield/ecr) to complete the process.
* If ECR data needs to be mapped to a specific team, you need to create the team first. If no team-level segregation is required, skip this step. Follow the steps provided in [Managing Teams](https://docs.opsmx.com/opsmx-delivery-shield-platform/user-guide/manage-teams-and-access) to complete the process. 

### To Access Artifact Scan <a href="#to-access-source-scan" id="to-access-source-scan"></a>

* Click on **Scan Now** button at the top right corner of the screen.

<figure><img src="https://docs.opsmx.com/~gitbook/image?url=https%3A%2F%2F2047464521-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MBEa1hoX6SqpDj-ymNs%252Fuploads%252FrJIKrYmqJVFzsym10w2D%252Fscan%2520now%2520.png%3Falt%3Dmedia%26token%3D56c19f36-9c4c-4212-80d3-43a1d9853d03&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=4d2e53fd&#x26;sv=2" alt=""><figcaption></figcaption></figure>

* In the screen that appears, select **Artifact Scan** from the left panel.

<figure><img src="/files/m6hOF2JKPIlMi7tOEAdm" alt=""><figcaption></figcaption></figure>

* If the ECR account needs to be associated with a specific team, select the Teams before proceeding else, the ECR account will be added at the organization level.

<figure><img src="/files/0Z3klChvrIm24YmJHKiM" alt=""><figcaption></figcaption></figure>

Now you can **Add Project** or **Upload Project** and proceed with the scan.

### To Add a Project&#x20;

* To add or update a new project with artifact scan configurations, click **Add Project**.&#x20;
* The **Create Project** details page is displayed as shown below. Enter the details for the following fields:

<figure><img src="/files/PVRv9THGwHn8iDi0tsbe" alt=""><figcaption></figcaption></figure>

* **Name** : Enter a name for the project.&#x20;
* **Team** : Select the desired team from the dropdown menu.&#x20;
* **Scan Type** : The default type is Artifact Scan.&#x20;
* **Platform** : Select the platform type, ECR.
* **Account** : Choose the needed account that has been integrated for the selected platform. If no account is available for the selected platform then click **Add Account**.
  * The integration page is displayed. You can add a new account.&#x20;
* **Registry**: Select the Registry URL from the dropdown menu.
* **Organization / Workspace** : Choose the organization or workspace that the selected account has access to.&#x20;
* **Scan Level** : Select the scan level; either organization level or repository level that needs to be scanned.&#x20;
* **Artifact Configuration** : Set the configuration details, and schedule the auto scan time.
* **Artifact Name**: Select the artifact name from the dropdown menu.
* **Artifact Tag**: Choose one of the three available options based on your requirement: All, Latest , Tags Pattern

{% hint style="info" %}
If **All** option is selected in Artifact Tag, then all the tags will be displayed in the Tags section.<br>
{% endhint %}

* Click Save.&#x20;

The project gets added for scanning.

#### To Upload a Project

* To upload a project from your local, click **Upload Project**.
* Click **Upload File** and select the json file you want to add for scanning. &#x20;

<figure><img src="/files/4yAcKKhKYm5iN6VWVbrN" alt=""><figcaption></figcaption></figure>

The project gets added for scanning.

### To Integrate JIRA at Project Level

JIRA can be integrated at project level to create tickets whenever an alert is identified.&#x20;

* To integrate JIRA, click the Integrations icon on expanding the project.&#x20;

<figure><img src="/files/D87SrN8JKJlZ7rfSXbON" alt=""><figcaption></figcaption></figure>

* The JIRA integration page is displayed. Click **Add Account** and enter the details.&#x20;

<figure><img src="/files/zfsM6BarJXhWpjlfjjR2" alt=""><figcaption></figcaption></figure>

* Enter the values for the following fields:
  * **Account Name -** Enter the JIRA account name.&#x20;
  * **Jira Project Key -** Enter the name of your Jira project.&#x20;
  * **Jira** **URL -** Enter your Jira host Url&#x20;
  * **Jira Email Id -** Enter the username to access Jira.&#x20;
  * **Token -** Enter the password / token for the Jira account.&#x20;
  * Enable **Automatically create Jira tickets during the scan** to create JIRA ticket to the team owner when the alerts are identified.&#x20;
  * **Trigger Type** - Indicates at which level Jira tickets should be created.&#x20;
    * **Create Jira ticket at the Component Alert level** - Jira tickets will be created for each individual impacted component.&#x20;
    * **Create Jira ticket at the Deduplication Alert level** -  A single Jira ticket will be created for all the impacted components.&#x20;
    * **Creation Scope** - If Vulnerabilities is selected, Jira is created only for Critical and High alerts. If All Policies is selected Jira is created for all alerts.&#x20;
  * Enable **Assign the Jira ticket to the Team owner** if you want to assign the ticket to the team owner.&#x20;
  * **Fields -** Enter the labels that need to be added in the created Jira ticket.&#x20;
  * **Values -** Enter the values that need to be given in the Jira ticket. The given variables are replaced with actual values when the tickets are created.&#x20;
  * **Status Keyword Mapping** - You can set the keywords for the status.&#x20;
* Click **Test** to check if the entered values are valid.
* Once validated, click **Save**. The tool is connected.

### To View and Interpret Scan Results <a href="#to-view-and-interpret-scan-results" id="to-view-and-interpret-scan-results"></a>

Once the scan is complete, a confirmation message is updated within the project and OpsMx generates the overall results. They are displayed as shown below:

* Repos Registered
* Total Artifact Tags
* Total Scans
* Total Projects
* Auto Scan Enabled Repos

<figure><img src="/files/8STpmAyYyWvo8BcVck4M" alt=""><figcaption></figcaption></figure>

The panel at the bottom displays the project details. On expanding each project you can view the complete details of it.

{% hint style="info" %}
The current status of the scan (completed, pending or failed) is displayed to notify the status of the project.&#x20;
{% endhint %}

* If the scan fails, the error message will be displayed in the project's message section as shown:

<figure><img src="/files/QeUICiVUWbZKzraPNLMx" alt=""><figcaption></figcaption></figure>

* To edit the configuration details of the project, click the **Edit Configuration** button.&#x20;
* Click the **View** option in the **Action** button, to view the SAST and SCA scan results of the project.&#x20;

<figure><img src="/files/EYq3U2nZvnLkFa3focTg" alt=""><figcaption></figcaption></figure>

* The results page displays the complete data of the scan details.&#x20;
  * On clicking the **Download** button, the scan results are downloaded in .json or .csv format.
  * On clicking Report, the scan results are downloaded in a report format.&#x20;
  * On clicking Go to Artifact Page, you are redirected to the related artifact page.&#x20;

<figure><img src="/files/MgSc3lS7SxwmShw8sLYy" alt=""><figcaption></figcaption></figure>