On this page

Configuring webhook for SGI-Crawler service

Some SSL handshake problems may occur between the webhook on Teamwork Cloud server and the SGI-Crawler service on the Web Application Platform server. To avoid these issues, register the SSL certificate of Teamwork Cloud server in the Java JRE used by the Web Application Platform server:

  1. Go to <install_root>/TeamworkCloud/configuration.
  2. Execute the following Linux command:
    sudo openssl pkcs12 -in keystore.p12 -out OUTFILE.crt –nokeys
  3. Go to Java JRE directory used by the Web Application Platform server.
  4. Go to bin and execute the following command:
    sudo /etc/alternatives/jre_17/bin/keytool -importcert -trustcacerts -keystore /etc/alternatives/jre_17/lib/security/cacerts -storepass changeit -file <install_root>/TeamworkCloud/configuration/OUTFILE.crt


To configure webhook for SGI-Crawler service

  1. Go to the Settings application and select Webhooks on the left side of the screen.
  2. In the bottom right corner of the screen, click to open the wizard for creating a webhook.
  3. Enter a new name for the new webhook, for example, sgi-crawler-webhook.
  4. In the webhook URL field, enter https://<WebAppPlatform_server_Host_Name>:8443/sgi-crawler/api/v1/sgi-crawler/fullIngest?dsUrl=<encoded_3DExperienceURL>
    Below is an example of an encoded 3DEXPERIENCE URL (any online encoder can be used):
    https://devopsaoi9ygia29645-euw1-26dsw40726-ifwe.3dx-staging.3ds.com
    The URL above becomes:
    https%3A%2F%2Fdevopsaoi9ygia29645-euw1-26dsw40726-ifwe.3dx-staging.3ds.com
    For each 3DEXPERIENCE Cloud platform registered in the SGI-Crawler service, a new dedicated webhook must be created by specifying the dsUrl query parameter value by the correct encoded 3DEXPERIENCE Cloud platform URL.
  5. Specify the Webhook scope field to Resource and specify the Event field to Commit.
  6. For the webhook to work, keep the option Enabled turned on.
  7. Enable the Protect webhook URL with basic authentication option.
  8. In the Username and Password fields, enter the credentials of the dedicated Teamwork Cloud user.
  9. Click Next.
  10. Select the resource scope of the webhook. This scope should cover the list of Teamwork Cloud resources on which the webhook listens to all commit events. The webhook calls the SGI-Crawler service to index the new Teamwork Cloud data of the commit into the 3DEXPERIENCE Cloud platform declared in the dsURL parameter.

Monitoring indexation

To check project indexation

  1. Access the indexation supervision page by choosing it from the left side panel:

    In this page, you can supervise the correct indexation of projects in SGI.
  2. Choose the configuration URL. You can have different 3DEXPERIENCE URLs where each URL indexes a set of SGI projects.
  3. After choosing the URL, a table with all the projects and their indexation state appears:


    ColumnInformation displayed
    IndexedDisplays the current state of the project in SGI. Possible states are INDEXING, DELETING, NOT_INDEXED, or COMPLETED.
    Last indexed revisionDisplays the actual revision that is indexed in SGI. Sometimes projects have new revisions that were not indexed in SGI. You can track unindexed revisions and index them manually.
    Standard profileA standard project is a project that is necessary for another project to work. A standard project is not a real project on its own.
    Status

    Displays any errors during indexation. Green indicates that indexation was successful, red indicates errors.

Additionally, you can filter the data in the table by clicking on the column header. You can also perform a search using the search bar and you can refresh the table with the refresh button  on the right.

Viewing dependencies 

A project may rely on another project to function correctly. Therefore, both the project and all its dependencies need to be indexed in SGI to ensure proper operation.
You can track dependencies by clicking > Dependencies on the right in each row. This shows an additional row with all the projects and their indexed revisions and helps you see if all the correct project resources in SGI are indexed.

Viewing indexed project dependencies.

Indexing projects manually

In rare cases, project indexation can fail. If that happens, you can index projects manually using different methods.

Indexing projects in bulk

You can select multiple projects and click to start bulk indexation. This indexes all selected projects up to their latest revisions.


Selecting projects to index them in bulk.


Indexing specific revisions

You can choose to index only specific revisions, Note that this option works only with one project at a time.

To index specific revisions, click in the row of the project you want and select Index revisions.

Indexing specific revisions.

You have three options:

  • Latest: indexes the latest available revision of a project.
  • Range: you can select a range of the revisions you want to index. The range numbers are included in the indexation.
  • List: you can provide a list of specific revision numbers. Only positive integers are allowed.
Whichever indexation option you choose, you can see the indexation state of the projects in the Indexed column. The Status column shows if there are errors.

Deleting projects

To delete a project

  1. In SGI Project indexation, select the project or projects you want to delete.
  2. Click and then confirm your choice in the dialog that appears.

You can see the status of the deletion from SGI in the Indexed column. The Status column shows if there are errors.